The OCTimer API provides the ability to track the length of time it takes for a function to complete.

The OCTimer API requires the On-Call Scheduling (com.snc.on_call_rotation) plugin to be activated. For more information, refer to the topic Activate On-Call Scheduling.

OCTimer - log (String name, String entry)

Logs the entry based on the function name.

Table 1. Parameters
Name Type Description
name String Function name.
entry String Text that will be part of the output in the log.
Table 2. Returns
Type Description
void

OCTimer - millisToTime (Integer millis)

Takes a millisecond value and returns a formatted duration.

Table 3. Parameters
Name Type Description
millis Integer Duration in miliseconds.
Table 4. Returns
Type Description
String A formatted duration.

OCTimer - result ()

Calculates the time taken for each function registered.

Table 5. Parameters
Name Type Description
None
Table 6. Returns
Type Description
String Time taken for each function registered.

Example

The following code example benchmarks the time taken by a REST API to fetch IP addresses from devices in Network Gear and then inserts them into IP Address table. API calls may require some time to process, so it is advisable to benchmark execution time before executing them in production.

var user = "<user name>"; // ServiceNow login user name
var password = "<password>";  // ServiceNow login password
var instance = "<instance name>";   // ServiceNow instance name

// Insert new IP address to IP address table using REST API
function insertIPAddress(ip_address) {
 var request = new sn_ws.RESTMessageV2();
 request.setEndpoint('https://' + instance + '.service-now.com/api/now/table/cmdb_ci_ip_address');
 request.setHttpMethod('POST');

 request.setBasicAuth(user,password);
 request.setRequestHeader("Accept","application/json");
 request.setRequestHeader('Content-Type','application/json');request.setRequestBody("{\"ip_address\":\"" + ip_address + "\"}");
 var response = request.execute();
}

// Retrieve IP address from devices in Network gear
function getIPAddresses() {
 var request = new sn_ws.RESTMessageV2();
 request.setEndpoint('https://' + instance + '.service-now.com/api/now/table/cmdb_ci_netgear?sysparm_fields=ip_address');
 request.setHttpMethod('GET');

 request.setBasicAuth(user,password);
 request.setRequestHeader("Accept","application/json");

 var response = request.execute();
 return response.getBody();
}

var timer = new OCTimer();             // create OCTimer object

// get the IP addresses from Network Gear table
timer.start("getIPAddresses");         // start timer to time fetching IP addresses from Network Gear table
var ipAddressStr = getIPAddresses();
timer.stop('getIPAddresses');          // stop timer

// insert IP addresses to IP Address table
var ipAddressJson = JSON.parse(ipAddressStr);  // parse result
var ipAddressList = ipAddressJson.result;      // extract IP addresses to a list
for (var i=0; i<ipAddressList.length;i++) {    // loop through
 var ip_address = ipAddressList[i]["ip_address"].trim();
 if (ip_address.length > 0) {
  timer.start("insertIPAddress");    // start timer to time inserting IP address to IP Address table
  insertIPAddress(ip_address);       // insert IP address
  timer.stop('insertIPAddress');     // end timer
 }
}

var result = timer.result();         // get timer results
gs.info(result);                     // output timer result

Output:

getIPAddresses method was invoked 1 time and took 00.288 seconds
insertIPAddress method was invoked 37 times and took 02.352 seconds

OCTimer - start (String name)

Initializes a timer based on the name provided.

Table 7. Parameters
Name Type Description
name String Function name.
Table 8. Returns
Type Description
void

Example

The following code example benchmarks the time taken by a REST API to fetch IP addresses from devices in Network Gear and then inserts them into IP Address table. API calls may require some time to process, so it is advisable to benchmark execution time before executing them in production.

var user = "<user name>"; // ServiceNow login user name
var password = "<password>";  // ServiceNow login password
var instance = "<instance name>";   // ServiceNow instance name

// Insert new IP address to IP address table using REST API
function insertIPAddress(ip_address) {
 var request = new sn_ws.RESTMessageV2();
 request.setEndpoint('https://' + instance + '.service-now.com/api/now/table/cmdb_ci_ip_address');
 request.setHttpMethod('POST');

 request.setBasicAuth(user,password);
 request.setRequestHeader("Accept","application/json");
 request.setRequestHeader('Content-Type','application/json');request.setRequestBody("{\"ip_address\":\"" + ip_address + "\"}");
 var response = request.execute();
}

// Retrieve IP address from devices in Network gear
function getIPAddresses() {
 var request = new sn_ws.RESTMessageV2();
 request.setEndpoint('https://' + instance + '.service-now.com/api/now/table/cmdb_ci_netgear?sysparm_fields=ip_address');
 request.setHttpMethod('GET');

 request.setBasicAuth(user,password);
 request.setRequestHeader("Accept","application/json");

 var response = request.execute();
 return response.getBody();
}

var timer = new OCTimer();             // create OCTimer object

// get the IP addresses from Network Gear table
timer.start("getIPAddresses");         // start timer to time fetching IP addresses from Network Gear table
var ipAddressStr = getIPAddresses();
timer.stop('getIPAddresses');          // stop timer

// insert IP addresses to IP Address table
var ipAddressJson = JSON.parse(ipAddressStr);  // parse result
var ipAddressList = ipAddressJson.result;      // extract IP addresses to a list
for (var i=0; i<ipAddressList.length;i++) {    // loop through
 var ip_address = ipAddressList[i]["ip_address"].trim();
 if (ip_address.length > 0) {
  timer.start("insertIPAddress");    // start timer to time inserting IP address to IP Address table
  insertIPAddress(ip_address);       // insert IP address
  timer.stop('insertIPAddress');     // end timer
 }
}

var result = timer.result();         // get timer results
gs.info(result);                     // output timer result

Output:

getIPAddresses method was invoked 1 time and took 00.288 seconds
insertIPAddress method was invoked 37 times and took 02.352 seconds

OCTimer - stop (String name)

Registers the end of the timer for the provided name.

Table 9. Parameters
Name Type Description
name String Function name.
Table 10. Returns
Type Description
void

Example

The following code example benchmarks the time taken by a REST API to fetch IP addresses from devices in Network Gear and then inserts them into IP Address table. API calls may require some time to process, so it is advisable to benchmark execution time before executing them in production.

var user = "<user name>"; // ServiceNow login user name
var password = "<password>";  // ServiceNow login password
var instance = "<instance name>";   // ServiceNow instance name

// Insert new IP address to IP address table using REST API
function insertIPAddress(ip_address) {
 var request = new sn_ws.RESTMessageV2();
 request.setEndpoint('https://' + instance + '.service-now.com/api/now/table/cmdb_ci_ip_address');
 request.setHttpMethod('POST');

 request.setBasicAuth(user,password);
 request.setRequestHeader("Accept","application/json");
 request.setRequestHeader('Content-Type','application/json');request.setRequestBody("{\"ip_address\":\"" + ip_address + "\"}");
 var response = request.execute();
}

// Retrieve IP address from devices in Network gear
function getIPAddresses() {
 var request = new sn_ws.RESTMessageV2();
 request.setEndpoint('https://' + instance + '.service-now.com/api/now/table/cmdb_ci_netgear?sysparm_fields=ip_address');
 request.setHttpMethod('GET');

 request.setBasicAuth(user,password);
 request.setRequestHeader("Accept","application/json");

 var response = request.execute();
 return response.getBody();
}

var timer = new OCTimer();             // create OCTimer object

// get the IP addresses from Network Gear table
timer.start("getIPAddresses");         // start timer to time fetching IP addresses from Network Gear table
var ipAddressStr = getIPAddresses();
timer.stop('getIPAddresses');          // stop timer

// insert IP addresses to IP Address table
var ipAddressJson = JSON.parse(ipAddressStr);  // parse result
var ipAddressList = ipAddressJson.result;      // extract IP addresses to a list
for (var i=0; i<ipAddressList.length;i++) {    // loop through
 var ip_address = ipAddressList[i]["ip_address"].trim();
 if (ip_address.length > 0) {
  timer.start("insertIPAddress");    // start timer to time inserting IP address to IP Address table
  insertIPAddress(ip_address);       // insert IP address
  timer.stop('insertIPAddress');     // end timer
 }
}

var result = timer.result();         // get timer results
gs.info(result);                     // output timer result

Output:

getIPAddresses method was invoked 1 time and took 00.288 seconds
insertIPAddress method was invoked 37 times and took 02.352 seconds