Documentation

opsgenie.sendAlert() function

opsgenie.sendAlert() is a user-contributed function maintained by the package author.

opsgenie.sendAlert() sends an alert message to Opsgenie.

Function type signature
(
    apiKey: string,
    message: string,
    ?actions: A,
    ?alias: string,
    ?description: string,
    ?details: B,
    ?entity: string,
    ?priority: string,
    ?responders: [string],
    ?tags: C,
    ?url: string,
    ?visibleTo: [string],
) => int where B: Stringable

For more information, see Function type signatures.

Parameters

url

Opsgenie API URL. Defaults to https://api.opsgenie.com/v2/alerts.

apiKey

(Required) (Required) Opsgenie API authorization key.

message

(Required) (Required) Alert message text. 130 characters or less.

alias

Opsgenie alias usee to de-deduplicate alerts. 250 characters or less. Defaults to message.

description

Alert description. 15000 characters or less.

priority

Opsgenie alert priority.

Valid values include:

  • P1
  • P2
  • P3 (default)
  • P4
  • P5

responders

List of responder teams or users. Use the user: prefix for users and teams: prefix for teams.

tags

Alert tags.

entity

Alert entity used to specify the alert domain.

actions

List of actions available for the alert.

details

Additional alert details. Must be a JSON-encoded map of key-value string pairs.

visibleTo

List of teams and users the alert will be visible to without sending notifications. Use the user: prefix for users and teams: prefix for teams.

Examples

Send the last reported status to a Opsgenie

import "influxdata/influxdb/secrets"
import "contrib/sranka/opsgenie"

apiKey = secrets.get(key: "OPSGENIE_APIKEY")

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

opsgenie.sendAlert(
    apiKey: apiKey,
    message: "Disk usage is: ${lastReported.status}.",
    alias: "example-disk-usage",
    responders: ["user:john@example.com", "team:itcrowd"],
)

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

InfluxDB 3 Open Source Now in Public Alpha

InfluxDB 3 Open Source is now available for alpha testing, licensed under MIT or Apache 2 licensing.

We are releasing two products as part of the alpha.

InfluxDB 3 Core, is our new open source product. It is a recent-data engine for time series and event data. InfluxDB 3 Enterprise is a commercial version that builds on Core’s foundation, adding historical query capability, read replicas, high availability, scalability, and fine-grained security.

For more information on how to get started, check out: