Documentation

zenoss.event() function

zenoss.event() is a user-contributed function maintained by the package author.

zenoss.event() sends an event to Zenoss.

Function type signature
(
    severity: A,
    url: string,
    ?action: B,
    ?apiKey: C,
    ?collector: D,
    ?component: E,
    ?device: F,
    ?eventClass: G,
    ?eventClassKey: H,
    ?message: I,
    ?method: J,
    ?password: string,
    ?summary: K,
    ?tid: L,
    ?type: M,
    ?username: string,
) => int where C: Equatable
For more information, see Function type signatures.

Parameters

url

(Required) Zenoss router endpoint URL.

username

Zenoss username to use for HTTP BASIC authentication. Default is "" (no authentication).

password

Zenoss password to use for HTTP BASIC authentication. Default is "" (no authentication).

apiKey

Zenoss cloud API key. Default is "" (no API key).

action

Zenoss router name. Default is “EventsRouter”.

method

EventsRouter method. Default is “add_event”.

type

Event type. Default is “rpc”.

tid

Temporary request transaction ID. Default is 1.

summary

Event summary. Default is "".

device

Related device. Default is "".

component

Related component. Default is "".

severity

(Required) Event severity level.

Supported values:

  • Critical
  • Warning
  • Info
  • Clear

eventClass

Event class. Default is "".

eventClassKey

Event class key. Default is "".

collector

Zenoss collector. Default is "".

message

Related message. Default is "".

Examples

Send the last reported value and severity to Zenoss

import "contrib/bonitoo-io/zenoss"
import "influxdata/influxdb/secrets"

username = secrets.get(key: "ZENOSS_USERNAME")
password = secrets.get(key: "ZENOSS_PASSWORD")

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)

zenoss.event(
    url: "https://tenant.zenoss.io:8080/zport/dmd/evconsole_router",
    username: username,
    username: password,
    device: lastReported.host,
    component: "CPU",
    eventClass: "/App",
    severity:
        if lastReported._value < 1.0 then
            "Critical"
        else if lastReported._value < 5.0 then
            "Warning"
        else if lastReported._value < 20.0 then
            "Info"
        else
            "Clear",
)

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB 3.0

The new core of InfluxDB built with Rust and Apache Arrow. Available today in InfluxDB Cloud Dedicated.

Learn more

State of the InfluxDB Cloud Serverless documentation

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.