Documentation

ServiceNow event handler

ServiceNow provides service management software with a comprehensive managed workflow that supports features such as real-time communication, collaboration, and resource sharing. Configure Kapacitor to send alert messages to ServiceNow.

Configuration

Configuration and default option values for the ServiceNow event handler are set in your kapacitor.conf. The example below shows the default configuration:

[servicenow]
  # Configure ServiceNow.
  enabled = false
  # The ServiceNow URL for the target table (Alert or Event). Replace this instance with your hostname.
  url = "https://instance.service-now.com/api/now/v1/table/em_alert"
  # Default source identification.
  source = "Kapacitor"
  # Username for HTTP BASIC authentication
  username = ""
  # Password for HTTP BASIC authentication
  password = ""

enabled

Set to true to enable the ServiceNow event handler.

url

The ServiceNow instance address.

source

Default “Kapacitor” source.

username

Username to use for basic HTTP authentication.

password

Password to use for basic HTTP authentication.

Options

The following ServiceNow event handler options can be set in a handler file or when using .serviceNow() in a TICKscript. These options set corresponding fields in the ServiceNow alert or event. For information about ServiceNow alerts, see Manually create an alert.

NameTypeDescription
nodestringServiceNow node to associate with the event.
typestringServiceNow type used to identify an event record from which alerts are created, for example, disk or CPU.
resourceAdds key values pairs to the Sensu API request.
metricNamestringUnique name that describes metrics collected for which the alert has been created.
messageKeystringUnique event identifier used to identify multiple events related to the same alert. If empty, this is generated from the source, node, type, resource, and metricName field values.
sourcestringSource that generated the event.
messagestringAlert message.
alert IDstringUnique ID used to identify the alert.

All the handler options above support templates with the following variables: ID, Name, TaskName, Fields, Tags, same as in the AlertNode.message.

By default, the handler maps the Kapacitor values below to the ServiceNow Alert or Event fields as follows:

ValueField
sourceSource
messageDescription
alert IDMessage key

TICKscript examples

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_user" > 90)
    .stateChangesOnly()
    .message('Hey, check your CPU')
    .serviceNow()
stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_user" > 90)
    .message('Hey, check your CPU')
    .serviceNow()
        .node('{{ index .Tags "host" }}')
        .type('CPU')
        .resource('CPU-Total')
        .metricName('usage_user')
        .messageKey('Alert: {{ .ID }}')

New! Cloud or OSS?

InfluxDB OSS 2.0 now generally available!

InfluxDB OSS 2.0 is now generally available and ready for production use. See the InfluxDB OSS 2.0 release notes.

For information about upgrading to InfluxDB OSS 2.0, see: