Kapacitor link audit (#1380)

* fixed links in kapacitor 1.5

* fixed links in kapacitor 1.4
pull/1387/head
Scott Anderson 2020-09-01 08:45:09 -06:00 committed by Scott Anderson
parent 5bc9fbd786
commit 38bb4812e8
32 changed files with 38 additions and 38 deletions

View File

@ -302,7 +302,7 @@ stream
```
The API exposes endpoints to query the state of each alert and endpoints for configuring alert handlers.
See the [API docs](/kapacitor/v1.4/api/api/) for more details.
See the [API docs](/kapacitor/v1.4/working/api/) 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.
@ -389,7 +389,7 @@ stream
New API endpoints have been added to be able to configure InfluxDB clusters and alert handlers dynamically without needing to restart the Kapacitor daemon.
Along with the ability to dynamically configure a service, API endpoints have been added to test the configurable services.
See the [API docs](/kapacitor/v1.4/api/api/) for more details.
See the [API docs](/kapacitor/v1.4/working/api/) for more details.
>NOTE: The `connect_errors` stat from the query node was removed since the client changed, all errors are now counted in the `query_errors` stat.

View File

@ -10,7 +10,7 @@ menu:
Kapacitor is open source and we welcome contributions from the community.
If you want Kapacitor to be able to output to you own endpoint see this [How To](/kapacitor/v1.5/about_the_project/custom_output/).
If you want Kapacitor to be able to output to you own endpoint see this [How To](/kapacitor/v1.5/working/custom_output/).
## [Release Notes/Changelog](/kapacitor/v1.5/about_the_project/releasenotes-changelog/)

View File

@ -8,7 +8,7 @@ menu:
---
* [Startup](#startup)
* [Kapacitor configuration file](#the-kapacitor-configuration-file)
* [Kapacitor configuration file](#kapacitor-configuration-file)
* [Kapacitor environment variables](#kapacitor-environment-variables)
* [Configuring with the HTTP API](#configuring-with-the-http-api)

View File

@ -16,7 +16,7 @@ handlers. Currently, Kapacitor can send alert messages to specific log files and
specific URLs, as well as to many third party applications.
These documents outline configuration options, setup instructions,
[handler file](#handler-file) and [TICKscript](/kapacitor/v1.5/tick/introduction/)
[handler file](#create-a-topic-handler-with-a-handler-file) and [TICKscript](/kapacitor/v1.5/tick/introduction/)
syntax for officially supported Kapacitor event handlers.
[Aggregate](/kapacitor/v1.5/event_handlers/aggregate/)
@ -64,7 +64,7 @@ Enable the event handler in your `kapacitor.conf` if applicable. Once
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-tickscripts).
- [Use a handler in a TICKscripts](#use-a-handler-in-a-tickscript).
> **Note:** Not all event handlers can be used in TICKscripts.

View File

@ -15,7 +15,7 @@ interval into an aggregated topic.
## Options
The following aggregate event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file).
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file).
| Name | Type | Description |
| ---- | ---- | ----------- |

View File

@ -48,7 +48,7 @@ Default origin of alert.
## Options
The following Alerta event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.alerta()` in a TICKscript.
<span style="color: #ff9e46; font-style: italic; font-size: .8rem;">* Required</span>

View File

@ -89,7 +89,7 @@ _This is necessary if using a self-signed certificate._
## Options
Set the following Discord event handler options in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.discord()` in a TICKscript.
| Name | Type | Description |

View File

@ -70,7 +70,7 @@ Only applies if `global` is `true`.
## Options
The following Email event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.email()` in a TICKscript.
| Name | Type | Description |

View File

@ -14,7 +14,7 @@ Event data is passed over STDIN to the process.
## Options
The following exec event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.exec()` in a TICKscript.
| Name | Type | Description |

View File

@ -57,7 +57,7 @@ This only applies if the `global` is also set to `true`.
## Options
The following HipChat event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.hipchat()` in a TICKscript.
| Name | Type | Description |

View File

@ -76,7 +76,7 @@ _This is necessary if using a self-signed certificate._
## Options
The following Kafka event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.kafka()` in a TICKscript.
| Name | Type | Description |

View File

@ -14,7 +14,7 @@ If the specified log file does not exist, it will be created.
## Options
The following log event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.log()` in a TICKscript.
| Name | Type | Description |

View File

@ -14,14 +14,14 @@ menu:
- [Set up a Teams](#set-up-teams)
- [Configuration](#configuration)
- [Handler file options](#handler-file-options)
- [Example Teams handler file](#example-teams-handler-file)
- [Example Teams handler file](#example-handler-file)
- [Example alerts](#example-alerts)
- [Send an alert to Teams](#send-an-alert-to-teams)
- [Send an alert to Teams](#example-alerts)
## Set up Teams
1. Log in to Teams, and then [create a new incoming webhook](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/connectors#setting-up-a-custom-incoming-webhook) for a Teams channel.
2. In your `kapacitor.conf` file, add a `[teams]` section with [configuration options](#Teams-configuration-options) for the Microsoft Teams event
2. In your `kapacitor.conf` file, add a `[teams]` section with [configuration options](#configuration) for the Microsoft Teams event
handler, including the incoming webhook URL as the `channelurl`. For example:
```toml
@ -61,7 +61,7 @@ _Only applies if `global` is `true`._
### Handler file options
The following options can be set in a Microsoft Teams event [handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
The following options can be set in a Microsoft Teams event [handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.teams()` in a TICKscript.
| Name | Type | Description |

View File

@ -75,7 +75,7 @@ MQTT password.
## Options
The following MQTT event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.mqtt()` in a TICKscript.
| Name | Type | Description |

View File

@ -59,7 +59,7 @@ The team and recipients can still be overridden.
## Options
The following OpsGenie v1 event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.opsGenie()` in a TICKscript.
| Name | Type | Description |

View File

@ -62,7 +62,7 @@ The team and recipients can still be overridden.
## Options
The following OpsGenie v2 event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.opsGenie2()` in a TICKscript.
| Name | Type | Description |

View File

@ -47,7 +47,7 @@ PagerDuty in TICKscripts.
## Options
The following PagerDuty v1 event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.pagerDuty()` in a TICKscript.
| Name | Type | Description |

View File

@ -48,7 +48,7 @@ PagerDuty in TICKscripts.
## Options
The following PagerDuty v2 event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.pagerDuty2()` in a TICKscript.
| Name | Type | Description |

View File

@ -111,7 +111,7 @@ KAPACITOR_HTTPPOST_1_HEADERS_Example2 = "header2"
## Options
The following post event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.post()` in a TICKscript.
| Name | Type | Description |

View File

@ -13,7 +13,7 @@ The publish event handler publishes events to another topic.
## Options
The following publish event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file).
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file).
| Name | Type | Description |
| ---- | ---- | ----------- |

View File

@ -40,7 +40,7 @@ The URL for the Pushover API. _**This should not need to be changed.**_
## Options
The following Pushover event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.pushover()` in a TICKscript.
| Name | Type | Description |

View File

@ -41,7 +41,7 @@ List of [Sensu handlers](https://docs.sensu.io/sensu-core/1.3/guides/intro-to-ha
## Options
The following Sensu event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.sensu()` in a TICKscript.
| Name | Type | Description |

View File

@ -85,7 +85,7 @@ _This is necessary if using a self-signed certificate._
## Options
The following Slack event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.slack()` in a TICKscript.
| Name | Type | Description |

View File

@ -39,7 +39,7 @@ Number of retries when sending traps.
## Options
The following SNMP trap event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.snmpTrap()` in a TICKscript.
| Name | Type | Description |

View File

@ -37,7 +37,7 @@ The default authorName.
## Options
The following Talk event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.talk()` in a TICKscript.
| Name | Type | Description |

View File

@ -12,7 +12,7 @@ menu:
The TCP event handler sends JSON encoded alert data to a TCP endpoint.
## Options
The following TCP event handler options can be set in a [handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using `.tcp()` in a TICKscript.
The following TCP event handler options can be set in a [handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using `.tcp()` in a TICKscript.
| Name | Type | Description |
| ---- | ---- | ----------- |

View File

@ -69,7 +69,7 @@ This only applies if the `global` is also set to `true`.
## Options
The following Telegram event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.telegram()` in a TICKscript.
| Name | Type | Description |

View File

@ -55,7 +55,7 @@ _The routing key can still be overridden._
## Options
The following VictorOpas event handler options can be set in a
[handler file](/kapacitor/v1.5/event_handlers/#handler-file) or when using
[handler file](/kapacitor/v1.5/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
`.victorOps()` in a TICKscript.
| Name | Type | Description |

View File

@ -246,7 +246,7 @@ Complete the following steps to ensure log files and communication channels aren
```
If a connection error appears, for example: `getsockopt: connection refused` (Linux) or `connectex: No connection could be made...` (Windows),
verify the Kapacitor service is running (see [Installing and Starting Kapacitor](#installing-and-starting-kapacitor)).
verify the Kapacitor service is running (see [Installing and Starting Kapacitor](/kapacitor/v1.5/introduction/installation/)).
If Kapacitor is running, check the firewall settings of the host machine and ensure that port `9092` is accessible.
Also, check messages in `/var/log/kapacitor/kapacitor.log`. If there's an issue with the `http` or other configuration in `/etc/kapacitor/kapacitor.conf`, the issue appears in the log.
If the Kapacitor service is running on another host machine, set the `KAPACITOR_URL` environment variable in the local shell to the Kapacitor endpoint on the remote machine.

View File

@ -19,9 +19,9 @@ menu:
Nodes represent process invocation units that either take data as a batch or a point-by-point stream, and then alter the data, store the data, or trigger some other activity based on changes in the data (e.g., an alert).
The property methods for these two nodes define the type of task that you are running, either
[stream](/kapacitor/v1.5/introduction/getting-started/#triggering-alerts-from-stream-data)
[stream](/kapacitor/v1.5/introduction/getting-started/#trigger-alerts-from-stream-data)
or
[batch](/kapacitor/v1.5/introduction/getting-started/#triggering-alerts-from-batch-data).
[batch](/kapacitor/v1.5/introduction/getting-started/#trigger-alerts-from-batch-data).
Below is a complete list of the available nodes. For each node, the associated property methods are described.

View File

@ -25,7 +25,7 @@ Where applicable, it links to outstanding issues on Github.
**Performance**
- [Do you get better performance with running one complex script or having multiple scripts running in parallel?](#do-you-get-better-performance-with-running-one-complex-script-or-having-multiple-scripts-running-in-parallel)
- [Do template-based scripts use less resources or are they just an ease-of-use tool?](#do-template-based-scripts-use-less-resources-r-are-they-just-an-ease-of-use-tool)
- [Do template-based scripts use less resources or are they just an ease-of-use tool?](#do-template-based-scripts-use-less-resources-or-are-they-just-an-ease-of-use-tool)
- [How does Kapacitor handle high load?](#how-does-kapacitor-handle-high-load)
- [How can I optimize Kapacitor tasks?](#how-can-i-optimize-kapacitor-tasks)

View File

@ -28,7 +28,7 @@ passwords, it can also be configured using the [Kapacitor HTTP API](/kapacitor/v
## Push to handler
Pushing messages to a handler is the basic approach presented in the
[Getting started with Kapacitor](/kapacitor/v1.5/introduction/getting-started/#triggering-alerts-from-stream-data)
[Getting started with Kapacitor](/kapacitor/v1.5/introduction/getting-started/#trigger-alerts-from-stream-data)
guide. This involves simply calling the relevant chaining method made available
through the `alert` node. Messages can be pushed to `log()` files, the `email()`
service, the `httpOut()` cache and many [third party services](#list-of-handlers).