You can customize a pull metric connector to collect raw metric information from an external source.

The custom metric connector script must:

• Be written in JavaScript.
• In the connector definition, be specified in the JavaScript to run field.
• Include the retrieveKpi() method. The connector framework uses the retrieveKpi() method to collect metrics. In this method, include the logic for reading data from the external source system and transform to the RawMetric object (in ServiceNow format).
• Read the required connector instance parameters defined in the probe object.
• Collect raw metric data from the metric source.
• Prepare a RawMetric record. The RawMetric object can be created by passing these attributes in the constructor:

  Table 1. RawMetric record description

  Element	Description
  metricType	Name of the metric.
  metricTypeId	SysId of the metric, if available. Otherwise pass the value null
  resource	Information about the resource for which metric data is being collected.
  node	IP, FQDN, name of the CI, or host. For example, the name of the Linux server where the disks are installed.
  ci	SysId of the CI if available. Otherwise use the provided information as part of ciIdentifier for the binding.
  value	Value of the metric.
  timestamp	Epoch timestamp of the metric in milliseconds.
  ciIdentifier	List of key-value pairs to identify the CI.
  source	Data source that is monitoring the metric type.
  sourceInstance	Source instance.
  monitoredObjType	Monitored Object Type

• Use the handleMetric function to add the raw metric information from the RawMetric record to be processed in the MID Server. To get access to the MetricHandle object, make the following call to the MetricFactory:

  var metricHandler = MetricFactory.getMetricHandler()

  Then for each RawMetric object execute:

  metricHandler.handleMetric(rawMetric)

• Write error logs to the MID Server log using ms.log. You can use the debugLog() function in the MetricCollector script as an example to write debug messages.
  Note: You can use the MetricCollector MID Server script include that is provided in the base instance as an example for these items.

Test connector requirements - Implement the testConnection() function. The function returns either Success or Failure. If Failure, check the writeError() function for a failure message. You can also check the sa_performance_statistics table to see that metrics are being received. For an example of test connector script, see the SolarWindsJS Mid Server script include.