sensu.endpoint() function

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

Function type: Output

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.

Data type: String

apiKey

Required Sensu API Key.

Data type: String

handlers

Sensu handlers to execute. Default is [].

Data type: Array of strings

namespace

Sensu namespace. Default is default.

Data type: String

entityName

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

Data type: String

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.

Data type: Function

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
    })
  )()