Talk event handler
This page documents an earlier version of Kapacitor. Kapacitor v1.6 is the latest stable version.
Deprecated
The Talk event handler is deprecated in Kapacitor 1.5.
Talk is a service that aggregates information into a centralized hub. Kapacitor can be configured to send alert messages to Talk.
Configuration
Configuration as well as default option values for the Talk event
handler are set in your kapacitor.conf
.
Below is an example configuration:
[talk]
enabled = true
url = "https://jianliao.com/v2/services/webhook/uuid"
author_name = "Kapacitor"
enabled
Set to true
to enable the Talk event handler.
url
The Talk webhook URL.
author_name
The default authorName.
Options
The following Talk event handler options can be set in a
handler file or when using
.talk()
in a TICKscript.
Name | Type | Description |
---|---|---|
Title | string | Message title. |
Text | string | Message text. |
Example: handler file
id: handler-id
topic: topic-name
kind: talk
options:
title: 'Message Title'
text: 'This is the text included in the message.'
Example: TICKscript
|alert()
// ...
.talk()
.title('Message Title')
.text('This is the text included in the message.')
Talk Setup
Create a new incoming webhook to allow Kapacitor to send alerts to Talk.
- Sign into your Talk account.
- Under the “Team” tab, click “Integrations”.
- Select “Customize service” and click the Incoming Webhook “Add” button.
- Choose the topic to connect with and click “Confirm Add” button.
- Once the service is created, you’ll see the “Generate Webhook url”.
- Place the generated Webhook URL as the
url
in the[talk]
section of yourkapacitor.conf
.
Using the Talk event handler
With the Talk event handler enabled and configured in your kapacitor.conf
,
use the .talk()
attribute in your TICKscripts to send alerts to Talk or define
a Talk handler that subscribes to a topic and sends published alerts to Talk.
Send alerts to Talk from a TICKscript
The following TICKscript sends the message, “Hey, check your CPU”, to Talk
whenever idle CPU usage drops below 10% using the .talk()
event handler.
talk-cpu-alert.tick
stream
|from()
.measurement('cpu')
|alert()
.crit(lambda: "usage_idle" < 10)
.message('Hey, check your CPU')
.talk()
.title('Alert from Kapacitor')
Send alerts to Talk from a defined handler
The following setup sends an alert to the cpu
topic with the message,
“Hey, check your CPU”.
A Talk handler is added that subscribes to the cpu
topic and publishes all
alert messages to Talk.
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 Talk event
handler to send alerts to Talk.
talk_cpu_handler.yaml
id: talk-cpu-alert
topic: cpu
kind: talk
options:
title: Alert from Kapacitor
Add the handler:
kapacitor define-topic-handler talk_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: