Kapacitor 1.6.3 release notes edits (#3718)

* Kapacitor release notes update

* updated PigPanda and Alerta

* Added additonal detail from Emrys' feedback

* misc edits

* add new topic-buffer-length setting and event handler updates (#3711)

* added topic-buffer-length setting

* updated alert and bigpanda handlers

Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
pull/3301/head^2
kelseiv 2022-01-25 09:33:28 -08:00 committed by GitHub
parent 4d57e39075
commit 932daa7f5d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 32 additions and 15 deletions

View File

@ -7,24 +7,26 @@ menu:
name: Release notes
---
## v1.6.3 [2022-01-20]
## v1.6.3 [2022-01-25]
### Features
- Add support for custom `attributes` field in [Alerta event handler](/kapacitor/v1.6/event_handlers/alerta/).
- Add `host` and `attribute` options to [BigPanda event handler](/kapacitor/v1.6/event_handlers/bigpanda/).
- `host`: Corresponds to host alert payload parameter; identifies the main object that caused the alert.
- `attribute`: Option to add additional attribute(s) to the alert payload.
- Add support for custom `attributes` field in [Alerta event handler](/kapacitor/v1.6/event_handlers/alerta/).
- Add `host` and `attribute` options to [BigPanda event handler](/kapacitor/v1.6/event_handlers/bigpanda/):
- `host`: Identifies the main object that caused the alert.
- `attribute`: Adds additional attribute(s) to the alert payload.
- Add new `auto-attributes` configuration option to BigPanda node.
- Ability to add new headers to HTTP posts directly in `env var` config.
- Ability to add new headers to HTTP posts directly in `env var` config.
- `Topic queue length` is now configurable. This allows you to set a `topic-buffer-length` parameter in the Kapacitor config file in the
[alert](https://docs.influxdata.com/kapacitor/v1.6/administration/configuration/#alert) section. The default is 5000. Minimum length
[alert](https://docs.influxdata.com/kapacitor/v1.6/administration/configuration/#alert) section. The default is 5000. Minimum length
is 1000.
- Add new `address template` to email alert. Email addresses no longer need to be hardcoded; can be derived directly from data.
### Bug fixes
- Deprecation in response to [sweet32](https://sweet32.info/): stopped using block ciphers.
- Add additional detail to the error message `missing flux data`. This error is generated when issues occur when running a **Flux** query within a Batch TICKscript.
- Deprecated ciphers identified as "weak" in response to the [sweet32](https://sweet32.info/) attack.
- Add additional detail to the error message `missing flux data`. This error is generated when issues occur when running a **Flux** query within a batch TICKscript.
## v1.6.2 [2021-09-24]

View File

@ -579,6 +579,9 @@ Use the `[alert]` group to globally configure alerts created by the
# Persisting topics can become an I/O bottleneck under high load.
# This setting disables them entirely.
persist-topics = false
# This setting sets the topic queue length.
# Default is 5000. Minimum length is 1000.
topic-buffer-length = 5000
# ...
```

View File

@ -71,7 +71,7 @@ The following Alerta event handler options can be set in a
| correlate | list of strings | List of related events, for example, `event1`, `event2`. |
| service | list of strings | List of effected Services. |
| timeout | duration string | Alerta timeout. Default is 24 hours. |
| attributes | map of key value pairs | Alerta alert attributes.
> **Note:** The `resource` and `event` properties are required.
> Alerta cannot be configured globally because of these required properties.
@ -93,6 +93,10 @@ options:
service: ['service1', 'service2']
correlate: ['service1', 'service2']
timeout: 24h
attributes:
key1: value1
key2: 8
booleanAttribute: TRUE
```
### Example: TICKscript
@ -113,6 +117,8 @@ options:
.service('service1', 'service2')
.correlated('service1', 'service2')
.timeout(24h)
.attribute('booleanAttribute', TRUE)
.attribute('key1', 'value1')
```
## Using the Alerta event handler

View File

@ -51,11 +51,13 @@ The following BigPanda event handler options can be set in a
[handler file](/kapacitor/v1.6/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.bigPanda()` in a TICKscript.
| Name | Type | Description |
| ---- | ---- | ----------- |
| appKey | string | BigPanda appKey |
| primaryProperty | string | BigPanda primary property |
| secondaryProperty | string | BigPanda secondary property |
| Name | Type | Description |
| ----------------- | ------ | ----------------------------------------------------------- |
| appKey | string | BigPanda appKey |
| primaryProperty | string | BigPanda primary property |
| secondaryProperty | string | BigPanda secondary property |
| host | string | Host alert payload parameter (object that caused the alert) |
| attributes | map of key value pairs | Option to add additional attribute(s) to the alert payload |
BigPanda uses the [primary property](https://docs.bigpanda.io/docs/primary_property) to construct the title
and the [secondary property](https://docs.bigpanda.io/docs/secondary_property) to construct the subtitle of an incident.
@ -107,4 +109,8 @@ stream
.crit(lambda: "total_used" > 90)
.stateChangesOnly()
.appKey('...')
bigPanda()
.host('{{ .Tags.host }}')
.attribute('monitor_link', 'http://example.com/monitor?node={{ .Tags.host }}')
.attribute('x_total_used', '{{ .Fields.total_used }}')
```