Documentation

victorops.alert() function

victorops.alert() is a user-contributed function maintained by the package author.

victorops.alert() sends an alert to VictorOps.

Function type signature
(
    messageType: A,
    url: string,
    ?entityDisplayName: B,
    ?entityID: C,
    ?monitoringTool: D,
    ?stateMessage: E,
    ?timestamp: F,
) => int

For more information, see Function type signatures.

Parameters

url

(Required) VictorOps REST endpoint integration 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.alert(
    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)}.",
)

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

New in InfluxDB 3.4

Key enhancements in InfluxDB 3.4 and the InfluxDB 3 Explorer 1.2.

See the Blog Post

InfluxDB 3.4 is now available for both Core and Enterprise, which introduces offline token generation for use in automated deployments and configurable license type selection that lets you bypass the interactive license prompt. InfluxDB 3 Explorer 1.2 is also available, which includes InfluxDB cache management and other new features.

For more information, check out: