nowmetric

README

ServiceNow Metrics serializer

The ServiceNow Metrics serializer outputs metrics in the ServiceNow Operational Intelligence format or optionally with the ServiceNow JSONv2 format

It can be used to write to a file using the file output, or for sending metrics to a MID Server with Enable REST endpoint activated using the standard telegraf HTTP output. If you are using the HTTP output, this serializer knows how to batch the metrics so you do not end up with an HTTP POST per metric.

An example Operational Intelligence format event looks like:

[
  {
    "metric_type": "Disk C: % Free Space",
    "resource": "C:\\",
    "node": "lnux100",
    "value": 50,
    "timestamp": 1473183012000,
    "ci2metric_id": {
        "node": "lnux100"
    },
    "source": "Telegraf"
  }
]

An example of the JSONv2 format even looks like:

{
  "records": [
    {
      "metric_type": "Disk C: % Free Space",
      "resource": "C:\\",
      "node": "lnux100",
      "value": 50,
      "timestamp": 1473183012000,
      "ci2metric_id": {
        "node": "lnux100"
      },
      "source": "Telegraf"
    }
  ]
}

Using with the HTTP output

To send this data to a ServiceNow MID Server with Web Server extension activated, you can use the HTTP output, there are some custom headers that you need to add to manage the MID Web Server authorization, here's a sample config for an HTTP output:

[[outputs.http]]
  ## URL is the address to send metrics to
  url = "http://<mid server fqdn or ip address>:9082/api/mid/sa/metrics"

  ## Timeout for HTTP message
  # timeout = "5s"

  ## HTTP method, one of: "POST" or "PUT"
  method = "POST"

  ## HTTP Basic Auth credentials
  username = 'evt.integration'
  password = 'P@$$w0rd!'

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

  ## Data format to output.
  ## Each data format has it's own unique set of configuration options, read
  ## more about them here:
  ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
  data_format = "nowmetric"

  ## Format Type
  ## By default, the serializer returns an array of metrics matching the
  ## Now Metric Operational Intelligence format or with the option set to 'oi'.
  ## Optionally, if set to 'jsonv2' the output format will involve the newer
  ## JSON object based format.
  # nowmetric_format = "oi"

  ## Additional HTTP headers
  [outputs.http.headers]
  #   # Should be set manually to "application/json" for json data_format
  Content-Type = "application/json"
  Accept = "application/json"

Starting with the London release, you also need to explicitly create event rule to allow binding of metric events to host CIs.

Metric Format

The following describes the two options of the nowmetric_format option:

The Operational Intelligence format is used along with the /api/mid/sa/metrics API endpoint. The payload is requires a JSON array full of metrics. This is the default settings and used when set to oi. See the ServiceNow KB0853084 for more details on this format.

Another option is the use of the JSONv2 web service. This service requires a different format that is JSON object based. This option is used when set to jsonv2.

Using with the File output

You can use the file output to output the payload in a file. In this case, just add the following section to your telegraf config file

[[outputs.file]]
  ## Files to write to, "stdout" is a specially handled file.
  files = ["C:/Telegraf/metrics.out"]

  ## Data format to output.
  ## Each data format has its own unique set of configuration options, read
  ## more about them here:
  ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
  data_format = "nowmetric"

Documentation

Index

• type OIMetric
• type OIMetrics
• type OIMetricsObj
• type Serializer
  • func (s *Serializer) Init() error
  • func (s *Serializer) InitFromConfig(_ *serializers.Config) error
  • func (s *Serializer) Serialize(metric telegraf.Metric) (out []byte, err error)
  • func (s *Serializer) SerializeBatch(metrics []telegraf.Metric) (out []byte, err error)

Types

type OIMetric

type OIMetric struct {
	Metric    string            `json:"metric_type"`
	Resource  string            `json:"resource"`
	Node      string            `json:"node"`
	Value     interface{}       `json:"value"`
	Timestamp int64             `json:"timestamp"`
	CiMapping map[string]string `json:"ci2metric_id"`
	Source    string            `json:"source"`
}

type OIMetrics

type OIMetrics []OIMetric

type OIMetricsObj

type OIMetricsObj struct {
	Records []OIMetric `json:"records"`
}

type Serializer

type Serializer struct {
	Format string `toml:"nowmetric_format"`
}

func (*Serializer) Init

func (s *Serializer) Init() error

func (*Serializer) InitFromConfig

func (s *Serializer) InitFromConfig(_ *serializers.Config) error

InitFromConfig is a compatibility function to construct the parser the old way

func (*Serializer) Serialize

func (s *Serializer) Serialize(metric telegraf.Metric) (out []byte, err error)

func (*Serializer) SerializeBatch

func (s *Serializer) SerializeBatch(metrics []telegraf.Metric) (out []byte, err error)