servicenow

README

ServiceNow Package

Use this package to send events to ServiceNow.

Event fields are described in Create Event ServiceNow documentation topic.

servicenow.event

servicenow.event sends event to ServiceNow. It has the following arguments:

Name	Type	Description
url	string	ServiceNow web service URL.
username	string	HTTP BASIC authentication username.
password	string	HTTP BASIC authentication username.
source	string	Source name. Default: "Flux"
node	string	Node name or IP address related to the event. Default is empty string.
metricType	string	Metric type related to the event (eg. "CPU"). Default is empty string.
resource	string	Resource related to the event (eg. "CPU-1"). Default is empty string.
metricName	string	Metric name related to the event (eg. usage_idle). Default is empty string.
messageKey	string	Unique identifier of the event (eg. InfluxDB alert ID). Default is empty string (ServiceNow fills in the value).
description	string	Event description.
severity	string	Severity of the event. Possible values: "critical", "major", "minor", "warning", "info", "clear".
additionalInfo	record	More information about the event. Optional parameter.

Example:

import "contrib/bonitoo-io/servicenow"
import "influxdata/influxdb/secrets"
import "strings"

username = secrets.get(key: "SERVICENOW_USERNAME")
password = secrets.get(key: "SERVICENOW_PASSWORD")

lastReported =
  from(bucket: "example-bucket")
    |> range(start: -1m)
    |> filter(fn: (r) => r._measurement == "cpu" and r._field == "usage_idle")
    |> last()
    |> tableFind(fn: (key) => true)
    |> getRecord(idx: 0)

servicenow.event(
    url: "https://tenant.service-now.com/api/global/em/jsonv2",
    username: username,
    password: password,
    node: lastReported.host,
    metricType: strings.toUpper(v: lastReported._measurement),
    resource: lastReported.instance,
    metricName: lastReported._field,
    severity:
        if lastReported._value < 1.0 then "critical"
        else if lastReported._value < 5.0 then "warning"
        else "info",
)

servicenow.endpoint

servicenow.endpoint creates a factory function that creates a target function for pipeline |> to send events to ServiceNow for each row. Parameters:

Name	Type	Description
url	string	ServiceNow web service URL.
username	string	HTTP BASIC authentication username.
password	string	HTTP BASIC authentication username.
source	string	Source name. Default: "Flux"

The returned factory function accepts a mapFn parameter. The mapFn function accepts a row and returns an object with the following fields:

Name	Type	Description
node	string	Node name or IP address related to the event. Default is empty string.
metricType	string	Metric type related to the event (eg. "CPU"). Default is empty string.
resource	string	Resource related to the event (eg. "CPU-1"). Default is empty string.
metricName	string	Metric name related to the event (eg. "usage_idle"). Default is empty string.
messageKey	string	Unique identifier of the event (eg. InfluxDB alert ID). Default is empty string (ServiceNow fills in the value).
description	string	Event description.
severity	string	Severity of the event. Possible values: "critical", "major", "minor", "warning", "info", "clear".
additionalInfo	record	More information about the event. Optional field.

Example:

import "contrib/bonitoo-io/servicenow"
import "influxdata/influxdb/secrets"
import "strings"

username = secrets.get(key: "SERVICENOW_USERNAME")
password = secrets.get(key: "SERVICENOW_PASSWORD")

endpoint = servicenow.endpoint(
    url: "https://tenant.service-now.com/api/global/em/jsonv2",
    username: username,
    password: password
)

from(bucket: "example-bucket")
  |> range(start: -1m)
  |> filter(fn: (r) => r._measurement == "cpu" and r._field == "usage_idle")
  |> last()
  |> endpoint(mapFn: (r) => ({
      node: r.host,
      metricType: strings.toUpper(v: r._measurement),
      resource: r.instance,
      metricName: r._field,
      severity:
          if r._value < 1.0 then "critical"
          else if r._value < 5.0 then "warning"
          else "info",
      additionalInfo: { "devId": r.dev_id }
    })
  )()

Contact

• Author: Ales Pour / Bonitoo
• Email: alespour@bonitoo.io
• Github: @alespour, @bonitoo-io
• Influx Slack: @Ales Pour