Documentation

Sensu event handler

Sensu is a service that provides infrastructure, service, and application monitoring as well as other metrics. Kapacitor can be configured to send alert messages to Sensu.

Configuration

Configuration as well as default option values for the Sensu event handler are set in your kapacitor.conf. Below is an example configuration:

[sensu]
  enabled = true
  addr = "sensu-client:3030"
  source = "Kapacitor"
  handlers = ["hander1-name", "handler2-name"]

enabled

Set to true to enable the Sensu event handler.

addr

The Sensu Client host:port address.

source

Default “Just-in-Time” (JIT) source.

handlers

List of Sensu handlers to use.

Options

The following Sensu event handler options can be set in a handler file or when using .sensu() in a TICKscript.

Name Type Description
source string Sensu source for which to post messages.
handlers list of strings Sensu handler list. If empty, uses the handler list from the configuration.
metadata map of key value pairs Adds key values pairs to the Sensu API request.

Example: handler file

id: handler-id
topic: topic-name
kind: sensu
options:
  source: Kapacitor
  handlers:
    - handler1-name
    - handler2-name
  metadata:
    key1: value1
    key2: 5
    key3: 5.0

Example: TICKscript

|alert()
  // ...
  .sensu()
    .source('Kapacitor')
    .handlers('handler1-name', 'handler2-name')
    .metadata('key1', 'value1')
    .metadata('key2', 5)
    .metadata('key3', 5.0)

Using the Sensu event handler

With the Sensu event handler enabled and configured in your kapacitor.conf, use the .sensu() attribute in your TICKscripts to send alerts to Sensu or define a Sensu handler that subscribes to a topic and sends published alerts to Sensu.

Sensu settings in kapacitor.conf

[sensu]
  enabled = true
  addr = "123.45.67.89:3030"
  source = "Kapacitor"
  handlers = ["tcp", "transport"]

Send alerts to Sensu from a TICKscript

The following TICKscript uses the .sensu() event handler to send the message, “Hey, check your CPU”, to Sensu whenever idle CPU usage drops below 10%.

sensu-cpu-alert.tick

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .sensu()      

Send alerts to Sensu from a defined handler

The following setup sends an alert to the cpu topic with the message, “Hey, check your CPU”. A Sensu handler is added that subscribes to the cpu topic and publishes all alert messages to Sensu.

Create a TICKscript that publishes alert messages to a topic. The TICKscript below sends an alert message to the cpu topic any time idle CPU usage drops below 10%.

cpu_alert.tick

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .topic('cpu')

Add and enable the TICKscript:

kapacitor define cpu_alert -tick cpu_alert.tick
kapacitor enable cpu_alert

Create a handler file that subscribes to the cpu topic and uses the Sensu event handler to send alerts to Sensu.

sensu_cpu_handler.yaml

id: sensu-cpu-alert
topic: cpu
kind: sensu
options:
  source: Kapacitor
  handlers:
    - tcp
    - transport

Add the handler:

kapacitor define-topic-handler sensu_cpu_handler.yaml

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

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.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: