Documentation

victorops.event() function

Flux 0.108.0+

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

The victorops.event() function sends an event to VictorOps.

VictorOps is now Splunk On-Call

Splunk acquired VictorOps and VictorOps is now Splunk On-Call.

import "contrib/bonitoo-io/victorops"

victorops.event(
  url: "https://alert.victorops.com/integrations/generic/00000000/alert/${api_key}/${routing_key}",
  monitoringTool: "",
  messageType: "CRITICAL",
  entityID: "",
  entityDisplayName: "",
  stateMessage: "",
  timestamp: now()
)

Parameters

url

(Required) VictorOps REST endpoint integration URL.

VictorOps URL example
https://alert.victorops.com/integrations/generic/00000000/alert/<api_key>/<routing_key>

Replace <api_key> and <routing_key> with valid VictorOps API and routing keys.

monitoringTool

Monitoring agent name. Default is "".

messageType

(Required) VictorOps message type (alert behavior).

Valid values:

  • CRITICAL
  • WARNING
  • INFO

entityID

Incident ID. Default is "".

entityDisplayName

Incident display name or summary. Default is "".

stateMessage

Verbose incident message. Default is "".

timestamp

Incident start time. Default is now().

Examples

Send the last reported value and incident type to VictorOps
import "contrib/bonitoo-io/victorops"
import "influxdata/influxdb/secrets"

apiKey = secrets.get(key: "VICTOROPS_API_KEY")
routingKey = secrets.get(key: "VICTOROPS_ROUTING_KEY")

lastReported =
  from(bucket: "example-bucket")
    |> range(start: -1m)
    |> filter(fn: (r) => r._measurement == "cpu" and r._field == "usage_idle")
    |> last()
    |> findRecord(fn: (key) => true, idx: 0)

victorops.event(
  url: "https://alert.victorops.com/integrations/generic/00000000/alert/${apiKey}/${routingKey}",
  messageType:
    if lastReported._value < 1.0 then "CRITICAL"
    else if lastReported._value < 5.0 then "WARNING"
    else "INFO",
  entityID: "example-alert-1",
  entityDisplayName: "Example Alert 1",
  stateMessage: "Last reported cpu_idle was ${string(v: r._value)}."
)

Package author and maintainer

Github: @alespour, @bonitoo-io
InfluxDB Slack: @Ales Pour


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.