Zenoss event handler
Zenoss is a hybrid IT monitoring service for monitoring virtual and physical IT environments. Configure Kapacitor to send events to Zenoss.
Configuration
Configuration as well as default option values for the Zenoss event
handler are set in your kapacitor.conf.
Below is an example configuration:
[zenoss]
enabled = true
url = "https://tenant.zenoss.io:8080/zport/dmd/evconsole_router"
username = ""
password = ""
action = "EventsRouter"
method = "add_event"
type = "rpc"
tid = 1
collector = "Kapacitor"
severity-map = {OK = "Clear", Info = "Info", Warning = "Warning", Critical = "Critical"}
global = false
state-changes-only = false
enabled
Set to true to enable the Zenoss event handler.
url
Zenoss router endpoint URL.
For example: https://tenant.zenoss.io:8080/zport/dmd/evconsole_router.
username
Zenoss username to use for HTTP BASIC authentication.
For no authentication, set as an empty string ("").
password
Zenoss password to use for HTTP BASIC authentication.
For no authentication, set as an empty string ("").
action
Zenoss router name.
For example: "EventsRouter".
method
EventsRouter method.
For example: "add_event".
type
Event type.
For example: "rpc".
tid
Temporary request transaction ID.
For example: 1.
collector
Zenoss collector name.
For example: "Kapacitor".
severity-map
Map Kapacitor alert levels to Zenoss event severity levels.
{ OK = "Clear", Info = "Info", Warning = "Warning", Critical = "Critical" }
global
If true, all alerts are sent to Zenoss without explicitly specifying Zenoss
in the TICKscript.
state-changes-only
Set all alerts in state-changes-only mode, meaning alerts will only be sent if
the alert state changes.
Only applies if global is true.
Options
The following Zenoss event handler options can be set in a
handler file or when using
.zenoss() in a TICKscript.
| Name | Type | Description |
|---|---|---|
| action | string | Zenoss router name |
| method | string | Zenoss router method |
| type | string | Zenoss event type |
| tid | integer | Temporary request transaction ID |
| summary | string | Event summary |
| device | string | Device related to the event |
| component | string | Component related to the event |
| evclasskey | string | Zenoss event class key |
| evclass | string | Zenoss event class |
| collector | string | Zenoss collector |
| message | string | Event message |
| customField | map | Custom fields to append to event |
Example: handler file
id: handler-id
topic: topic-name
kind: zenoss
options:
action: EventsRouter
method: add_event
type: rpc
tid: 1
summary: Example event summary.
device: example-device
component: example-component
evclasskey: example-event-class-key
evclass: example-event-class
collector: Kapacitor
message: Example event message.
customField:
customField1: customValue1
customField2: customValue2
Example: TICKscript
|alert()
// ...
.zenoss()
.action('EventsRouter')
.method('add_event')
.type('rpc')
.tid(1)
.summary('Example event summary.')
.device('example-device')
.component('example-component')
.evclasskey('example-event-class-key')
.evclass('example-event-class')
.collector('Kapacitor')
.message('Example event message.')
.customField('customField1', 'customValue1')
.customField('customField2', 'customValue2')
To avoid posting a message every alert interval, use AlertNode.StateChangesOnly so only events where the alert changed state are sent to Zenoss.
The examples below use the following Zenoss configurations defined in the kapacitor.conf:
Zenoss settings in kapacitor.conf
[zenoss]
enabled = true
url = "https://tenant.zenoss.io:8080/zport/dmd/evconsole_router"
username = ""
password = ""
action = "EventsRouter"
method = "add_event"
type = "rpc"
tid = 1
collector = "Kapacitor"
severity-map = {OK = "Clear", Info = "Info", Warning = "Warning", Critical = "Critical"}
global = false
state-changes-only = false
Send alerts to Zenoss from a TICKscript
The following TICKscript uses the .zenoss() event handler to send the message,
“Hey, check your CPU”, to the #alerts Zenoss channel whenever idle CPU usage
drops below 20%.
zenoss-cpu-alert.tick
stream
|from()
.measurement('cpu')
|alert()
.warn(lambda: "usage_idle" < 20)
.stateChangesOnly()
.message('Hey, check your CPU')
.zenoss()
Send alerts to Zenoss from a defined handler
The following setup sends an alert to the cpu topic with the message,
“Hey, check your CPU”.
A Zenoss handler is added that subscribes to the cpu topic and publishes all
alert messages to Zenoss.
Create a TICKscript that publishes alert messages to a topic.
The TICKscript below sends an critical alert message to the cpu topic any time
idle CPU usage drops below 5%.
cpu_alert.tick
stream
|from()
.measurement('cpu')
|alert()
.crit(lambda: "usage_idle" < 5)
.stateChangesOnly()
.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 Zenoss
event handler to send alerts to Zenoss.
zenoss_cpu_handler.yaml
id: zenoss-cpu-alert
topic: cpu
kind: zenoss
options:
summary: High CPU usage
device: example-device
component: example-component
evclasskey: example-event-class-key
evclass: example-event-class
Add the handler:
kapacitor define-topic-handler zenoss_cpu_handler.yaml
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Kapacitor and this documentation. To find support, use the following resources: