fixed telegraf plugin links and structure, closes #1891

pull/1893/head
Scott Anderson 2020-11-25 12:11:40 -07:00
parent 3967ec695d
commit b22f6e7d32
1 changed files with 21 additions and 30 deletions

View File

@ -59,7 +59,7 @@ input:
id: kinesis_consumer
description: |
The Amazon Kinesis Consumer input plugin reads from a Kinesis data stream and creates
metrics using one of the supported [input data formats](https://docs.influxdata.com/telegraf/latest/data_formats/input).
metrics using one of the supported [input data formats](/telegraf/latest/data_formats/input).
introduced: 1.10.0
tags: [linux, macos, windows, cloud, messaging]
@ -408,7 +408,7 @@ input:
- name: Exec
id: exec
description: |
The Exec input plugin parses supported [Telegraf input data formats](https://docs.influxdata.com/telegraf/latest/data_formats/input/)
The Exec input plugin parses supported [Telegraf input data formats](/telegraf/latest/data_formats/input/)
(line protocol, JSON, Graphite, Value, Nagios, Collectd, and Dropwizard) into metrics.
Each Telegraf metric includes the measurement name, tags, fields, and timestamp.
introduced: 0.1.5
@ -418,7 +418,7 @@ input:
id: execd
description: |
The Execd input plugin runs an external program as a daemon. Programs must output metrics in an accepted
[Telegraf input data format](https://docs.influxdata.com/telegraf/latest/data_formats/input/)
[Telegraf input data format](/telegraf/latest/data_formats/input/)
on its standard output. Configure `signal` to send a signal to the daemon running on each collection interval.
The program output on standard error is mirrored to the Telegraf log.
introduced: 1.14.0
@ -450,7 +450,7 @@ input:
then use the [Tail input plugin](#tail).
> To parse metrics from multiple files that are formatted in one of the supported
> [input data formats](https://docs.influxdata.com/telegraf/latest/data_formats/input),
> [input data formats](/telegraf/latest/data_formats/input),
> use the [Multifile input plugin](#multifile).
introduced: 1.8.0
tags: [linux, macos, windows, systems]
@ -557,7 +557,7 @@ input:
id: http
description: |
The HTTP input plugin collects metrics from one or more HTTP (or HTTPS) endpoints.
The endpoint should have metrics formatted in one of the [supported input data formats](https://docs.influxdata.com/telegraf/latest/data_formats/input/).
The endpoint should have metrics formatted in one of the [supported input data formats](/telegraf/latest/data_formats/input/).
Each data format has its own unique set of configuration options which can be added to the input configuration.
introduced: 1.6.0
tags: [linux, macos, windows, servers, web]
@ -638,13 +638,14 @@ input:
To collect data on an InfluxDB 2.x instance running on localhost, the configuration for the
Prometheus input plugin would be:
<div class="keep-url">
<div class="keep-url"></div>
```toml
[[inputs.prometheus]]
## An array of urls to scrape metrics from.
urls = ["http://localhost:8086/metrics"]
```
</div>
introduced: 1.8.0
tags: [linux, macos, windows, data-stores]
@ -652,7 +653,7 @@ input:
id: influxdb_listener
description: |
The InfluxDB Listener input plugin listens for requests sent
according to the [InfluxDB HTTP API](https://docs.influxdata.com/influxdb/latest/guides/writing_data/).
according to the [InfluxDB HTTP API](/influxdb/v1.8/guides/writing_data/).
The intent of the plugin is to allow Telegraf to serve as a proxy, or router,
for the HTTP `/write` endpoint of the InfluxDB HTTP API.
@ -673,26 +674,16 @@ input:
tags: [linux, macos, windows, data-stores]
- name: InfluxDB v2 Listener
id: influxdb_listener
id: influxdb_v2_listener
description: |
The InfluxDB Listener input plugin listens for requests sent
according to the [InfluxDB HTTP API](https://docs.influxdata.com/influxdb/latest/guides/writing_data/).
The InfluxDB v2 Listener input plugin listens for requests sent
according to the [InfluxDB HTTP API](/influxdb/latest/reference/api/).
The intent of the plugin is to allow Telegraf to serve as a proxy, or router,
for the HTTP `/write` endpoint of the InfluxDB HTTP API.
for the HTTP `/api/v2/write` endpoint of the InfluxDB HTTP API.
> This plugin was previously known as `http_listener`.
> To send general metrics via HTTP, use the [HTTP Listener v2 input plugin](#http_listener_v2) instead.
>
> This plugin is compatible with **InfluxDB 2.x** only.
The `/write` endpoint supports the `precision` query parameter and can be set
to one of `ns`, `u`, `ms`, `s`, `m`, `h`. All other parameters are ignored and
The `/api/v2/write` endpoint supports the `precision` query parameter and can be set
to one of `ns`, `u`, `ms`, or `s`. All other parameters are ignored and
defer to the output plugins configuration.
When chaining Telegraf instances using this plugin, `CREATE DATABASE` requests
receive a `200 OK` response with message body `{"results":[]}` but they are not
relayed. The output configuration of the Telegraf instance which ultimately
submits data to InfluxDB determines the destination database.
introduced: 1.16.0
tags: [linux, macos, windows, data-stores]
@ -990,7 +981,7 @@ input:
id: mqtt_consumer
description: |
The MQTT Consumer input plugin reads from specified MQTT topics and adds messages to InfluxDB.
Messages are in the [Telegraf input data formats](https://docs.influxdata.com/telegraf/latest/data_formats/input/).
Messages are in the [Telegraf input data formats](/telegraf/latest/data_formats/input/).
introduced: 0.10.3
tags: [linux, macos, windows, messaging, IoT]
@ -1002,7 +993,7 @@ input:
This is often useful creating custom metrics from the `/sys` or `/proc` filesystems.
> To parse metrics from a single file formatted in one of the supported
> [input data formats](https://docs.influxdata.com/telegraf/latest/data_formats/input),
> [input data formats](/telegraf/latest/data_formats/input),
> use the [file input plugin](#file).
introduced: 1.10.0
tags: [linux, macos, windows]
@ -1018,7 +1009,7 @@ input:
id: nats_consumer
description: |
The NATS Consumer input plugin reads from specified NATS subjects and adds messages to InfluxDB.
Messages are expected in the [Telegraf input data formats](https://docs.influxdata.com/telegraf/latest/data_formats/input/).
Messages are expected in the [Telegraf input data formats](/telegraf/latest/data_formats/input/).
A Queue Group is used when subscribing to subjects so multiple instances of Telegraf
can read from a NATS cluster in parallel.
introduced: 0.10.3
@ -1484,7 +1475,7 @@ input:
description: |
The Socket Listener input plugin listens for messages from streaming (TCP, UNIX)
or datagram (UDP, unixgram) protocols. Messages are expected in the
[Telegraf Input Data Formats](https://docs.influxdata.com/telegraf/latest/data_formats/input/).
[Telegraf Input Data Formats](/telegraf/latest/data_formats/input/).
introduced: 1.3.0
tags: [linux, macos, windows, networking]
@ -1904,7 +1895,7 @@ output:
id: cloud_pubsub
description: |
The Google PubSub output plugin publishes metrics to a [Google Cloud PubSub](https://cloud.google.com/pubsub)
topic as one of the supported [output data formats](https://docs.influxdata.com/telegraf/latest/data_formats/output).
topic as one of the supported [output data formats](/telegraf/latest/data_formats/output).
introduced: 1.10.0
tags: [linux, macos, windows, messaging, cloud]
@ -2009,7 +2000,7 @@ output:
id: mqtt
description: |
The MQTT Producer output plugin writes to the MQTT server using
[supported output data formats](https://docs.influxdata.com/telegraf/latest/data_formats/output/).
[supported output data formats](/telegraf/latest/data_formats/output/).
introduced: 0.2.0
tags: [linux, macos, windows, messaging, IoT]