Skip to content

Commit

Permalink
document adding a new alert handler
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanielc committed Jan 4, 2017
1 parent ce1eb28 commit 4665bb3
Show file tree
Hide file tree
Showing 5 changed files with 480 additions and 1 deletion.
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,33 @@

### Release Notes

A new system for working with alerts has been introduced.
This alerting system allows you to configure topics for alert events and then configure handlers for various topics.
This way alert generation is decoupled from alert handling.

Existing TICKscripts will continue to work without modification.

To use this new alerting system remove any explicit alert handlers from your TICKscript and specify a topic.
Then configure the handlers for the topic.

```
stream
|from()
.measurement('cpu')
.groupBy('host')
|alert()
// Specify the topic for the alert
.topic('cpu')
.info(lambda: "value" > 60)
.warn(lambda: "value" > 70)
.crit(lambda: "value" > 80)
// No handlers are configured in the script, they are instead defined on the topic via the API.
```

The API exposes endpoints to query the state of each alert and endpoints for configuring alert handlers.
See the API docs for more details.
The kapacitor CLI has been updated with commands for defining alert handlers.

This release introduces a new feature where you can window based off the number of points instead of their time.
For example:

Expand All @@ -29,6 +56,8 @@ stream
- [#898](https://github.com/influxdata/kapacitor/issues/898): Now when the Window node every value is zero, the window will be emitted immediately for each new point.
- [#1052](https://github.com/influxdata/kapacitor/issues/1052): Move alerta api token to header and add option to skip TLS verification.
- [#251](https://github.com/influxdata/kapacitor/issues/251): Enable markdown in slack attachments.
- [#1095](https://github.com/influxdata/kapacitor/pull/1095): Add new alert API, with support for configuring handlers and topics.


### Bugfixes

Expand Down
1 change: 0 additions & 1 deletion alert/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Kapacitor exposes the state of the alerts via topics in the HTTP API.
The maximum level of all events withing a topic as well as the state of each event within the topic can be queried.
See the API docs for more details.


## Two ways to setup alert handlers

There are two ways to setup handlers for your alerts in Kapacitor.
Expand Down
Loading

0 comments on commit 4665bb3

Please sign in to comment.