Documentation

sensu.endpoint() function

Flux 0.90.0+

The sensu.endpoint() function is a user-contributed function maintained by the package author and can be updated or removed at any time.

The sensu.endpoint() function sends an event to the Sensu Events API using data from table rows.

import "contrib/sranka/sensu"

sensu.endpoint(
  url: "http://localhost:8080",
  apiKey: "mYSuP3rs3cREtApIK3Y",
  handlers: [],
  namespace: "default",
  entityName: "influxdb"
)

Parameters

url

(Required) Base URL of Sensu API without a trailing slash. Example: http://localhost:8080.

apiKey

(Required) Sensu API Key.

handlers

Sensu handlers to execute. Default is [].

namespace

Sensu namespace. Default is default.

entityName

Event source. Use alphanumeric characters, underscores (_), periods (.), and hyphens (-). All other characters are replaced with an underscore. Default is influxdb.

Usage

sensu.endpoint is a factory function that outputs another function. The output function requires a mapFn parameter.

mapFn

A function that builds the object used to generate the POST request. Requires an r parameter.

mapFn accepts a table row (r) and returns an object that must include the following fields:

  • checkName
  • text
  • status

For more information, see sensu.event() parameters.

Examples

Send critical status events to Sensu
import "influxdata/influxdb/secrets"
import "contrib/sranka/sensu"

token = secrets.get(key: "TELEGRAM_TOKEN")
endpoint = sensu.endpoint(
  url: "http://localhost:8080",
  apiKey: apiKey
)

crit_statuses = from(bucket: "example-bucket")
  |> range(start: -1m)
  |> filter(fn: (r) => r._measurement == "statuses" and status == "crit")

crit_statuses
  |> endpoint(mapFn: (r) => ({
      checkName: "critStatus",
      text: "Status is critical",
      status: 2
    })
  )()

Package author and maintainer

Github: @sranka
InfluxDB Slack: @sranka


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.