pagerduty.endpoint() function

The pagerduty.endpoint() returns a function that can be used to send a message to PagerDuty that includes output data.

Function type: Output

import "pagerduty"

toPagerDuty = pagerduty.endpoint(
  url: "https://events.pagerduty.com/v2/enqueue"
)

Parameters

url

The PagerDuty v2 Events API URL. Defaults to https://events.pagerduty.com/v2/enqueue.

Data type: String

Usage

pagerduty.endpoint is a factory function that outputs another function. The output function requires a mapFn parameter. See the PagerDuty v2 Events API documentation for more information about these parameters.

mapFn

(Required) A function that builds the record used to generate the POST request. Requires an r parameter.

Data type: Function

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

• routingKey
• client
• client_url
• class
• eventAction
• group
• severity
• component
• source
• summary
• timestamp

For more information, see pagerduty.sendEvent()

Examples

Send critical statuses to a PagerDuty endpoint

import "pagerduty"
import "influxdata/influxdb/secrets"

routingKey = secrets.get(key: "PAGERDUTY_ROUTING_KEY")
toPagerDuty = pagerduty.endpoint()

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

crit_statuses
  |> toPagerDuty(mapFn: (r) => ({ r with
      routingKey: routingKey,
      client: r.client,
      clientURL: r.clientURL,
      class: r.class,
      eventAction: r.eventAction,
      group: r.group,
      severity: r.severity,
      component: r.component,
      source: r.source,
      summary: r.summary,
      timestamp: r._time,
    })
  )()