Kapacitor 1.6 new configuration settings (#2693)

* kapacitor config doc cleanup * updated heading and links * added new kapacitor 1.6 config options, closes #2616, closes #2609 * updated slack instructions
influxdata · Jun 10, 2021 · 7b39280 · 7b39280
1 parent aa00bd4
commit 7b39280
Show file tree

Hide file tree

Showing 31 changed files with 616 additions and 476 deletions.
diff --git a/content/kapacitor/v1.6/about_the_project/releasenotes-changelog.md b/content/kapacitor/v1.6/about_the_project/releasenotes-changelog.md
@@ -88,7 +88,7 @@ If you’ve installed this release, please roll back to v1.5.7 as soon as possib
 
 - Add [Microsoft Teams event handler](/kapacitor/v1.6/event_handlers/microsoftteams/), thanks @mmindenhall!
 - Add [Discord event handler](/kapacitor/v1.6/event_handlers/discord/), thanks @mattnotmitt!
-- Add [support for TLS 1.3](/kapacitor/v1.6/administration/configuration/#transport-layer-security-tls-settings).
+- Add [support for TLS 1.3](/kapacitor/v1.6/administration/configuration/#transport-layer-security-tls).
 
 ### Bug fixes
 

diff --git a/content/kapacitor/v1.6/administration/configuration.md b/content/kapacitor/v1.6/administration/configuration.md
diff --git a/content/kapacitor/v1.6/event_handlers/_index.md b/content/kapacitor/v1.6/event_handlers/_index.md
@@ -19,34 +19,7 @@ These documents outline configuration options, setup instructions,
 [handler file](#create-a-topic-handler-with-a-handler-file) and [TICKscript](/kapacitor/v1.6/tick/introduction/)
 syntax for officially supported Kapacitor event handlers.
 
-[Aggregate](/kapacitor/v1.6/event_handlers/aggregate/)  
-[Alerta](/kapacitor/v1.6/event_handlers/alerta/)  
-[Discord](/kapacitor/v1.6/event_handlers/discord/)  
-[Email](/kapacitor/v1.6/event_handlers/email/)  
-[Exec](/kapacitor/v1.6/event_handlers/exec/)  
-[Hipchat](/kapacitor/v1.6/event_handlers/hipchat/)  
-[Kafka](/kapacitor/v1.6/event_handlers/kafka/)  
-[Log](/kapacitor/v1.6/event_handlers/log/)
-[Microsoft Teams](/kapacitor/v1.6/event_handlers/microsoftteams/)
-[MQTT](/kapacitor/v1.6/event_handlers/mqtt/)  
-[Opsgenie](/kapacitor/v1.6/event_handlers/opsgenie/v2/)  
-[Pagerduty](/kapacitor/v1.6/event_handlers/pagerduty/v2/)  
-[Post](/kapacitor/v1.6/event_handlers/post/)  
-[Publish](/kapacitor/v1.6/event_handlers/publish/)
-[Pushover](/kapacitor/v1.6/event_handlers/pushover/)
-[Sensu](/kapacitor/v1.6/event_handlers/sensu/)
-[ServiceNow](/kapacitor/v1.6/event_handlers/servicenow/)
-[Slack](/kapacitor/v1.6/event_handlers/slack/)  
-[Snmptrap](/kapacitor/v1.6/event_handlers/snmptrap/)  
-[Talk](/kapacitor/v1.6/event_handlers/talk/)  
-[TCP](/kapacitor/v1.6/event_handlers/tcp/)  
-[Telegram](/kapacitor/v1.6/event_handlers/telegram/)  
-[Victorops](/kapacitor/v1.6/event_handlers/victorops/)  
-
-> **Note:** Setup instructions are not currently available for all supported
-> event handlers, but additional information will be added over time. If
-> you are familiar with the setup process for a specific event handler, please
-> feel free to [contribute](https://github.com/influxdata/docs.influxdata.com/blob/master/CONTRIBUTING.md).
+{{< children type="list" >}}
 
 ## Configure event handlers
 
@@ -67,7 +40,9 @@ enabled, do one of the following:
 - [Create a topic handler with a handler file](#create-a-topic-handler-with-a-handler-file), and then [add the handler](#add-the-handler).
 - [Use a handler in a TICKscripts](#use-a-handler-in-a-tickscript).
 
-    > **Note:** Not all event handlers can be used in TICKscripts.
+    {{% note %}}
+**Note:** Not all event handlers can be used in TICKscripts.
+    {{% /note %}}
 
 ### Create a topic handler with a handler file
 
@@ -79,15 +54,15 @@ For some handler types, using handler files is the only option.
 
 The handler file contains the following:
 
-<span style="color: #ff9e46; font-style: italic; font-size: .8rem;">* Required</span>
+{{< req type="key" >}}
 
-- **ID**<span style="color: #ff9e46; font-style: italic;">\*</span>: The unique ID
+- {{< req "\*" >}} **ID**: The unique ID
   of the handler.
-- **Topic**<span style="color: #ff9e46; font-style: italic;">\*</span>: The topic
+- {{< req "\*" >}} **Topic**: The topic
   to which the handler subscribes.
 - **Match**: A lambda expression to filter matching alerts. By default, all alerts
   match. Learn more about [match expressions](/kapacitor/v1.6/working/alerts/#match-expressions).
-- **Kind**<span style="color: #ff9e46; font-style: italic;">\*</span>: The kind of
+- {{< req "\*" >}} **Kind**: The kind of
   handler.
 - **Options**: Configurable options determined by the handler kind. If none are
   provided, default values defined for the handler in the `kapacitor.conf` are used.
@@ -130,6 +105,9 @@ stream
     .slack()
 ```
 
-> Events are sent to handlers if the alert is in a state other than ‘OK’ or the
-alert just changed to the ‘OK’ state from a non ‘OK’ state (the alert
-recovered). Use the [AlertNode.StateChangesOnly](/kapacitor/v1.6/nodes/alert_node/#statechangesonly) property to send events to handlers only if the alert state changes.
+{{% note %}}
+Events are sent to handlers if the alert is in a state other than ‘OK’ or the
+alert just changed to the ‘OK’ state from a non ‘OK’ state (the alert recovered).
+Use the [AlertNode.StateChangesOnly](/kapacitor/v1.6/nodes/alert_node/#statechangesonly)
+property to send events to handlers only if the alert state changes.
+{{% /note %}}
diff --git a/content/kapacitor/v1.6/event_handlers/aggregate.md b/content/kapacitor/v1.6/event_handlers/aggregate.md
@@ -1,5 +1,6 @@
 ---
 title: Aggregate event handler
+list_title: Aggregate
 description: >
   The aggregate event handler allows you to aggregate alerts messages over a specified interval. This page includes aggregate options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/alerta.md b/content/kapacitor/v1.6/event_handlers/alerta.md
@@ -1,5 +1,6 @@
 ---
 title: Alerta event handler
+list_title: Alerta
 description: >
   The Alerta event handler allows you to send Kapacitor alerts to Alerta. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/bigpanda.md b/content/kapacitor/v1.6/event_handlers/bigpanda.md
@@ -1,5 +1,6 @@
 ---
 title: BigPanda event handler
+list_title: BigPanda
 description: >
   The BigPanda event handler lets you to send Kapacitor alerts to BigPanda. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/discord.md b/content/kapacitor/v1.6/event_handlers/discord.md
@@ -1,5 +1,6 @@
 ---
 title: Discord event handler
+list_title: Discord
 description: >
   The Discord event handler lets you send Kapacitor alerts to Discord. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/email.md b/content/kapacitor/v1.6/event_handlers/email.md
@@ -1,5 +1,6 @@
 ---
-title: Email event handler
+title: Email (SMTP) event handler
+list_title: Email (SMTP)
 description: >
   The "email" event handler allows you to send Kapacitor alerts via email. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/exec.md b/content/kapacitor/v1.6/event_handlers/exec.md
@@ -1,5 +1,6 @@
 ---
 title: Exec event handler
+list_title: Exec
 description: >
   The "exec" event handler allows you to execute external programs when Kapacitor alert messages are triggered. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/hipchat.md b/content/kapacitor/v1.6/event_handlers/hipchat.md
@@ -1,5 +1,6 @@
 ---
 title: HipChat event handler
+list_title: HipChat
 description: >
   The HipChat event handler allows you to send Kapacitor alerts to HipChat. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/kafka.md b/content/kapacitor/v1.6/event_handlers/kafka.md
@@ -1,5 +1,6 @@
 ---
 title: Kafka event handler
+list_title: Kafka
 description: >
   The Kafka event handler allows you to send Kapacitor alerts to an Apache Kafka cluster. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/log.md b/content/kapacitor/v1.6/event_handlers/log.md
@@ -1,5 +1,6 @@
 ---
 title: Log event handler
+list_title: Log
 description: >
   The "log" event handler allows you to send Kapacitor alert messages to a log file. This page includes options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/microsoftteams.md b/content/kapacitor/v1.6/event_handlers/microsoftteams.md
@@ -1,5 +1,6 @@
 ---
 title: Microsoft Teams event handler
+list_title: Microsoft Teams
 description: >
   The Microsoft Teams event handler lets you send Kapacitor alerts to a Microsoft Teams channel. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/mqtt.md b/content/kapacitor/v1.6/event_handlers/mqtt.md
@@ -1,5 +1,6 @@
 ---
 title: MQTT event handler
+list_title: MQTT
 description: >
   The MQTT event handler allows you to send Kapacitor alert messages to an MQTT handler. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/opsgenie/v1.md b/content/kapacitor/v1.6/event_handlers/opsgenie/v1.md
@@ -1,5 +1,6 @@
 ---
 title: OpsGenie v1 event handler
+list_title: OpsGenie v1
 description: >
   The OpsGenie v1 event handler allows you to send Kapacitor alerts to OpsGenie. This page includes configuration options and usage examples.
 ---

diff --git a/content/kapacitor/v1.6/event_handlers/opsgenie/v2.md b/content/kapacitor/v1.6/event_handlers/opsgenie/v2.md
@@ -1,5 +1,6 @@
 ---
 title: OpsGenie v2 event handler
+list_title: OpsGenie v2
 description: >
   The OpsGenie v2 event handler allows you to send Kapacitor alerts to OpsGenie. This page includes configuration options and usage examples.
 aliases:

diff --git a/content/kapacitor/v1.6/event_handlers/pagerduty/v1.md b/content/kapacitor/v1.6/event_handlers/pagerduty/v1.md
@@ -1,5 +1,6 @@
 ---
 title: PagerDuty v1 event handler
+list_title: PagerDuty v1
 description: >
   The PagerDuty v1 event handler allows you to send Kapacitor alerts to PagerDuty. This page includes configuration options and usage examples.
 ---

diff --git a/content/kapacitor/v1.6/event_handlers/pagerduty/v2.md b/content/kapacitor/v1.6/event_handlers/pagerduty/v2.md
@@ -1,5 +1,6 @@
 ---
 title: PagerDuty v2 event handler
+list_title: PagerDuty v2
 description: >
   The PagerDuty v2 event handler allows you to send Kapacitor alerts to PagerDuty. This page includes configuration options and usage examples.
 aliases:

diff --git a/content/kapacitor/v1.6/event_handlers/post.md b/content/kapacitor/v1.6/event_handlers/post.md
@@ -1,5 +1,6 @@
 ---
-title: Post event handler
+title: Post (HTTP) event handler
+list_title: Post (HTTP)
 description: >
   The "post" event handler allows you to POST Kapacitor alert data to an HTTP endpoint. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/publish.md b/content/kapacitor/v1.6/event_handlers/publish.md
@@ -1,5 +1,6 @@
 ---
 title: Publish event handler
+list_title: Publish
 description: >
   The "publish" event handler allows you to publish Kapacitor alerts messages to mulitple Kapacitor topics. This page includes options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/pushover.md b/content/kapacitor/v1.6/event_handlers/pushover.md
@@ -1,5 +1,6 @@
 ---
 title: Pushover event handler
+list_title: Pushover
 description: >
   The Pushover event handler allows you to send Kapacitor alerts to Pushover. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/sensu.md b/content/kapacitor/v1.6/event_handlers/sensu.md
@@ -1,5 +1,6 @@
 ---
 title: Sensu event handler
+list_title: Sensu
 description: >
   The Sensu event handler allows you to send Kapacitor alerts to Sensu. This page includes configuration options and usage examples.
 menu:

diff --git a/content/kapacitor/v1.6/event_handlers/servicenow.md b/content/kapacitor/v1.6/event_handlers/servicenow.md
@@ -1,5 +1,6 @@
 ---
 title: ServiceNow event handler
+list_title: ServiceNow
 description: >
   The ServiceNow event handler lets you to send Kapacitor alerts to ServiceNow. This page includes configuration options and usage examples.
 menu: