Documentation

Sensu event handler

This page documents an earlier version of Kapacitor. Kapacitor v1.6 is the latest stable version. View this page in the v1.6 documentation.

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.

NameTypeDescription
sourcestringSensu source for which to post messages.
handlerslist of stringsSensu handler list. If empty, uses the handler list from the configuration.
metadatamap of key value pairsAdds 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!


Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx 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.