docs-v2/content/flux/v0.x/stdlib/contrib/bonitoo-io/tickscript/alert.md

title	description	menu	weight	aliases	related	flux/v0.x/tags	introduced
tickscript.alert() function	The `tickscript.alert()` function identifies events of varying severity levels and writes them to the `statuses` measurement in the InfluxDB `_monitoring` system bucket.	flux_0_x_ref name parent tickscript.alert tickscript	302	/influxdb/v2.0/reference/flux/stdlib/contrib/tickscript/alert/ /influxdb/cloud/reference/flux/stdlib/contrib/tickscript/alert/	/{{< latest "kapacitor" >}}/nodes/alert_node/, Kapacitor AlertNode	transformations	0.111.0

The tickscript.alert() function identifies events of varying severity levels and writes them to the statuses measurement in the InfluxDB [_monitoring system bucket](/{{< latest "influxdb" >}}/reference/internals/system-buckets/).

This function is comparable to the [Kapacitor AlertNode](/{{< latest "kapacitor" >}}/nodes/alert_node/).

import "contrib/bonitoo-io/tickscript"

tickscript.alert(
    check: {id: "000000000000", name: "Example check name", type: "threshold", tags: {}},
    id: (r) => "000000000000",
    details: (r) => "",
    message: (r) => "Threshold Check: ${r._check_name} is: ${r._level}",
    crit: (r) => false,
    warn: (r) => false,
    info: (r) => false,
    ok: (r) => true,
    topic: "",
)

Parameters

check

({{< req >}}) InfluxDB check data. See tickscript.defineCheck().

id

Function that returns the InfluxDB check ID provided by the check record. Default is (r) => "${r._check_id}".

details

Function to return the InfluxDB check details using data from input rows. Default is (r) => "".

message

Function to return the InfluxDB check message using data from input rows. Default is (r) => "Threshold Check: ${r._check_name} is: ${r._level}".

crit

Predicate function to determine crit status. Default is (r) => false.

warn

Predicate function to determine warn status. Default is (r) => false.

info

Predicate function to determine info status. Default is (r) => false.

ok

Predicate function to determine ok status. Default is (r) => true.

topic

Check topic. Default is "".

tables

Input data. Default is piped-forward data (<-).

Examples

Store alert statuses for error counts

{{< code-tabs-wrapper >}} {{% code-tabs %}} Flux TICKscript {{% /code-tabs %}} {{% code-tab-content %}}

import "contrib/bonitoo-io/tickscript"

option task = {name: "Example task", every: 1m}

check = tickscript.defineCheck(id: "000000000000", name: "Errors", type: "threshold")

from(bucket: "example-bucket")
    |> range(start: -task.every)
    |> filter(fn: (r) => r._measurement == "errors" and r._field == "value")
    |> count()
    |> tickscript.alert(
        check: {check with _check_id: "task/${r.service}"},
        message: "task/${r.service} is ${r._level} value: ${r._value}",
        crit: (r) => r._value > 30,
        warn: (r) => r._value > 20,
        info: (r) => r._value > 10,
    )

{{% /code-tab-content %}} {{% code-tab-content %}}

data = batch
  |query('SELECT count(value) from errors')
    .every(1m)

data
  |alert()
    .id('kapacitor/{{ index .Tags "service" }}')
    .message('{{ .ID }} is {{ .Level }} value:{{ index .Fields "value" }}')
    .info(lambda: "value" > 10)
    .warn(lambda: "value" > 20)
    .crit(lambda: "value" > 30)

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}