update 1.26 to 1.27
Josh Powers
parent
353bb09afb
commit
d7df6ad9eb
|
|
@ -1,16 +1,16 @@
|
|||
---
|
||||
title: Telegraf 1.26 documentation
|
||||
title: Telegraf 1.27 documentation
|
||||
description: >
|
||||
Documentation for Telegraf, the plugin-driven server agent of the InfluxData
|
||||
time series platform, used to collect and report metrics. Telegraf supports four categories of plugins -- input, output, aggregator, and processor.
|
||||
menu:
|
||||
telegraf_1_27:
|
||||
name: Telegraf v1.26
|
||||
name: Telegraf v1.27
|
||||
weight: 1
|
||||
related:
|
||||
- /resources/videos/intro-to-telegraf/
|
||||
- /telegraf/v1.26/install/
|
||||
- /telegraf/v1.26/get_started/
|
||||
- /telegraf/v1.27/install/
|
||||
- /telegraf/v1.27/get_started/
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Configuration options
|
||||
description: Overview of the Telegraf configuration file, enabling plugins, and setting environment variables.
|
||||
aliases:
|
||||
- /telegraf/v1.26/administration/configuration/
|
||||
- /telegraf/v1.27/administration/configuration/
|
||||
menu:
|
||||
telegraf_1_27_ref:
|
||||
|
||||
|
|
@ -12,7 +12,7 @@ menu:
|
|||
|
||||
The Telegraf configuration file (`telegraf.conf`) lists all available Telegraf plugins. See the current version here: [telegraf.conf](https://github.com/influxdata/telegraf/blob/master/etc/telegraf.conf).
|
||||
|
||||
> To quickly get started with Telegraf, see [Get started](/telegraf/v1.26/get_started/).
|
||||
> To quickly get started with Telegraf, see [Get started](/telegraf/v1.27/get_started/).
|
||||
|
||||
## Generate a configuration file
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ style Aggregate text-align:left
|
|||
|
||||
**Processor plugins** process metrics as they pass through and immediately emit
|
||||
results based on the values they process. For example, this could be printing
|
||||
all metrics or adding a tag to all metrics that pass through. For a list of processor plugins and links to their detailed configuration options, see [processor plugins](/telegraf/v1.26/plugins/#processor-plugins).
|
||||
all metrics or adding a tag to all metrics that pass through. For a list of processor plugins and links to their detailed configuration options, see [processor plugins](/telegraf/v1.27/plugins/#processor-plugins).
|
||||
|
||||
**Aggregator plugins**, on the other hand, are a bit more complicated. Aggregators
|
||||
are typically for emitting new _aggregate_ metrics, such as a running mean,
|
||||
|
|
@ -43,7 +43,7 @@ of metrics that each _aggregate_ represents. In other words, the emitted
|
|||
_aggregate_ metric will be the aggregated value of the past `period` seconds.
|
||||
Since many users will only care about their aggregates and not every single metric
|
||||
gathered, there is also a `drop_original` argument, which tells Telegraf to only
|
||||
emit the aggregates and not the original metrics. For a list of aggregator plugins and links to their detailed configuration options, see [aggregator plugins](/telegraf/v1.26/plugins/#aggregator-plugins).
|
||||
emit the aggregates and not the original metrics. For a list of aggregator plugins and links to their detailed configuration options, see [aggregator plugins](/telegraf/v1.27/plugins/#aggregator-plugins).
|
||||
|
||||
{{% note %}}
|
||||
#### Behavior of processors and aggregators when used together
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ menu:
|
|||
parent: Configure plugins
|
||||
---
|
||||
|
||||
Telegraf input plugins are used with the InfluxData time series platform to collect metrics from the system, services, or third-party APIs. All metrics are gathered from the inputs you enable and configure in the [Telegraf configuration file](/telegraf/v1.26/configuration/).
|
||||
Telegraf input plugins are used with the InfluxData time series platform to collect metrics from the system, services, or third-party APIs. All metrics are gathered from the inputs you enable and configure in the [Telegraf configuration file](/telegraf/v1.27/configuration/).
|
||||
|
||||
For a complete list of input plugins and links to their detailed configuration options, see [input plugins](/{{< latest "telegraf" >}}/plugins/inputs/).
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ menu:
|
|||
|
||||
This example walks through using the Telegraf HTTP input plugin to collect live metrics on Citi Bike stations in New York City. Live station data is available in JSON format directly from [Citi Bike](https://ride.citibikenyc.com/system-data).
|
||||
|
||||
For the following example to work, configure [`influxdb_v2` output plugin](/telegraf/v1.26/plugins/#output-influxdb_v2). This plugin is what allows Telegraf to write the metrics to InfluxDB.
|
||||
For the following example to work, configure [`influxdb_v2` output plugin](/telegraf/v1.27/plugins/#output-influxdb_v2). This plugin is what allows Telegraf to write the metrics to InfluxDB.
|
||||
|
||||
## Configure the HTTP Input plugin in your Telegraf configuration file
|
||||
|
||||
|
|
@ -85,7 +85,7 @@ The format used to interpret the designated `timestamp_key`. The `last_reported`
|
|||
|
||||
## Start Telegraf and verify data appears
|
||||
|
||||
[Start the Telegraf service](/telegraf/v1.26/get_started/#start-telegraf).
|
||||
[Start the Telegraf service](/telegraf/v1.27/get_started/#start-telegraf).
|
||||
|
||||
To test that the data is being sent to InfluxDB, run the following (replacing `telegraf.conf` with the path to your configuration file):
|
||||
|
||||
|
|
|
|||
|
|
@ -8,8 +8,8 @@ menu:
|
|||
Parent: Configure plugins
|
||||
weight: 79
|
||||
aliases:
|
||||
- /telegraf/v1.26/administration/troubleshooting/
|
||||
- /telegraf/v1.26/administration/troubleshooting/
|
||||
- /telegraf/v1.27/administration/troubleshooting/
|
||||
- /telegraf/v1.27/administration/troubleshooting/
|
||||
---
|
||||
|
||||
## Validate your Telegraf configuration with `--test`
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
weight: 30
|
||||
parent: Input data formats
|
||||
aliases:
|
||||
- /telegraf/v1.26/data_formats/template-patterns/
|
||||
- /telegraf/v1.27/data_formats/template-patterns/
|
||||
---
|
||||
|
||||
The `dropwizard` data format can parse a [Dropwizard JSON representation](http://metrics.dropwizard.io/3.1.0/manual/json/) representation of a single metrics registry. By default, tags are parsed from metric names as if they were actual InfluxDB Line Protocol keys (`measurement<,tag_set>`) which can be overridden using custom [template patterns](#templates). All field value types are supported, including `string`, `number` and `boolean`.
|
||||
|
|
@ -179,10 +179,10 @@ dropwizard_tags_path = "tags"
|
|||
# tag2 = "tags.tag2"
|
||||
```
|
||||
|
||||
## Templates <!--This content is duplicated in /telegraf/v1.26/data_formats/input/graphite/-->
|
||||
## Templates <!--This content is duplicated in /telegraf/v1.27/data_formats/input/graphite/-->
|
||||
|
||||
Template patterns are a mini language that describes how a dot-delimited
|
||||
string should be mapped to and from [metrics](/telegraf/v1.26/concepts/metrics/).
|
||||
string should be mapped to and from [metrics](/telegraf/v1.27/concepts/metrics/).
|
||||
|
||||
A template has the following format:
|
||||
```
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
weight: 40
|
||||
parent: Input data formats
|
||||
aliases:
|
||||
- /telegraf/v1.26/data_formats/template-patterns/
|
||||
- /telegraf/v1.27/data_formats/template-patterns/
|
||||
---
|
||||
|
||||
The Graphite data format translates Graphite *dot* buckets directly into
|
||||
|
|
@ -56,7 +56,7 @@ By default, the separator is left as `.`, but this can be changed using the
|
|||
## Templates
|
||||
|
||||
Template patterns are a mini language that describes how a dot-delimited
|
||||
string should be mapped to and from [metrics](/telegraf/v1.26/concepts/metrics/).
|
||||
string should be mapped to and from [metrics](/telegraf/v1.27/concepts/metrics/).
|
||||
|
||||
A template has the following format:
|
||||
```
|
||||
|
|
@ -87,7 +87,7 @@ Any part of the template that isn't a keyword is treated as a tag key, which can
|
|||
The most basic template is to specify a single transformation to apply to all
|
||||
incoming metrics.
|
||||
|
||||
##### Template <!--This content is duplicated in /telegraf/v1.26/data_formats/input/graphite/-->
|
||||
##### Template <!--This content is duplicated in /telegraf/v1.27/data_formats/input/graphite/-->
|
||||
|
||||
```toml
|
||||
templates = [
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ For the metrics to completely align with the 1.x endpoint, add a Starlark proces
|
|||
|
||||
### Configuration
|
||||
|
||||
Use the [`inputs.http_listener_v2`](/telegraf/v1.26/plugins/#input-http_listener_v2) plug and set `data_format = "prometheusremotewrite"`
|
||||
Use the [`inputs.http_listener_v2`](/telegraf/v1.27/plugins/#input-http_listener_v2) plug and set `data_format = "prometheusremotewrite"`
|
||||
|
||||
```toml
|
||||
[[inputs.http_listener_v2]]
|
||||
|
|
|
|||
|
|
@ -6,24 +6,24 @@ menu:
|
|||
name: Get started
|
||||
weight: 30
|
||||
aliases:
|
||||
- /telegraf/v1.26/introduction/getting-started/
|
||||
- /telegraf/v1.26/get_started/
|
||||
- /telegraf/v1.27/introduction/getting-started/
|
||||
- /telegraf/v1.27/get_started/
|
||||
---
|
||||
|
||||
After you've [downloaded and installed Telegraf](/telegraf/v1.26/install/), you're ready to begin collecting and sending data. To collect and send data, do the following:
|
||||
After you've [downloaded and installed Telegraf](/telegraf/v1.27/install/), you're ready to begin collecting and sending data. To collect and send data, do the following:
|
||||
|
||||
1. [Configure Telegraf](#configure-telegraf)
|
||||
2. [Start Telegraf](#start-telegraf)
|
||||
3. Use [plugins available in Telegraf](/telegraf/v1.26/plugins/) to gather, transform, and output data.
|
||||
3. Use [plugins available in Telegraf](/telegraf/v1.27/plugins/) to gather, transform, and output data.
|
||||
|
||||
## Configure Telegraf
|
||||
|
||||
Define which plugins Telegraf will use in the configuration file. Each configuration file needs at least one enabled [input plugin](/telegraf/v1.26/plugins/inputs/) (where the metrics come from) and at least one enabled [output plugin](/telegraf/v1.26/plugins/outputs/) (where the metrics go).
|
||||
Define which plugins Telegraf will use in the configuration file. Each configuration file needs at least one enabled [input plugin](/telegraf/v1.27/plugins/inputs/) (where the metrics come from) and at least one enabled [output plugin](/telegraf/v1.27/plugins/outputs/) (where the metrics go).
|
||||
|
||||
The following example generates a sample configuration file with all available plugins, then uses `filter` flags to enable specific plugins.
|
||||
|
||||
{{% note %}}
|
||||
For details on `filter` and other flags, see [Telegraf commands and flags](/telegraf/v1.26/commands/).
|
||||
For details on `filter` and other flags, see [Telegraf commands and flags](/telegraf/v1.27/commands/).
|
||||
{{% /note %}}
|
||||
|
||||
1. Run the following command to create a configuration file:
|
||||
|
|
@ -35,11 +35,11 @@ For details on `filter` and other flags, see [Telegraf commands and flags](/tele
|
|||
* Linux debian and RPM packages: `/etc/telegraf/telegraf.conf`
|
||||
* Standalone Binary: see the next section for how to create a configuration file
|
||||
|
||||
> **Note:** You can also specify a remote URL endpoint to pull a configuration file from. See [Configuration file locations](/telegraf/v1.26/configuration/#configuration-file-locations).
|
||||
> **Note:** You can also specify a remote URL endpoint to pull a configuration file from. See [Configuration file locations](/telegraf/v1.27/configuration/#configuration-file-locations).
|
||||
|
||||
3. Edit the configuration file using `vim` or a text editor. Because this example uses [InfluxDB V2 output plugin](https://github.com/influxdata/telegraf/blob/release-1.21/plugins/outputs/influxdb_v2/README.md), we need to add the InfluxDB URL, authentication token, organization, and bucket details to this section of the configuration file.
|
||||
|
||||
> **Note:** For more configuration file options, see [Configuration options](/telegraf/v1.26/configuration/).
|
||||
> **Note:** For more configuration file options, see [Configuration options](/telegraf/v1.27/configuration/).
|
||||
|
||||
4. For this example, specify two inputs (`cpu` and `mem`) with the `--input-filter` flag.
|
||||
Specify InfluxDB as the output with the `--output-filter` flag.
|
||||
|
|
|
|||
|
|
@ -6,8 +6,8 @@ menu:
|
|||
name: Install
|
||||
weight: 20
|
||||
aliases:
|
||||
- /telegraf/v1.26/introduction/installation/
|
||||
- /telegraf/v1.26/install/
|
||||
- /telegraf/v1.27/introduction/installation/
|
||||
- /telegraf/v1.27/install/
|
||||
---
|
||||
|
||||
This page provides directions for installing, starting, and configuring Telegraf. To install Telegraf, do the following:
|
||||
|
|
@ -27,7 +27,7 @@ Installation of the Telegraf package may require `root` or administrator privile
|
|||
|
||||
### Networking
|
||||
|
||||
Telegraf offers multiple service [input plugins](/telegraf/v1.26/plugins/inputs/) that may
|
||||
Telegraf offers multiple service [input plugins](/telegraf/v1.27/plugins/inputs/) that may
|
||||
require custom ports.
|
||||
Modify port mappings through the configuration file (`telegraf.conf`).
|
||||
|
||||
|
|
@ -118,7 +118,7 @@ telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>
|
|||
```
|
||||
|
||||
For more advanced configuration details, see the
|
||||
[configuration documentation](/telegraf/v1.26/administration/configuration/).
|
||||
[configuration documentation](/telegraf/v1.27/administration/configuration/).
|
||||
{{% /tab-content %}}
|
||||
<!---------- BEGIN RedHat & CentOS ---------->
|
||||
{{% tab-content %}}
|
||||
|
|
@ -161,7 +161,7 @@ telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>
|
|||
```
|
||||
|
||||
For more advanced configuration details, see the
|
||||
[configuration documentation](/telegraf/v1.26/administration/configuration/).
|
||||
[configuration documentation](/telegraf/v1.27/administration/configuration/).
|
||||
{{% /tab-content %}}
|
||||
<!---------- BEGIN SLES & openSUSE ---------->
|
||||
{{% tab-content %}}
|
||||
|
|
@ -192,7 +192,7 @@ telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>
|
|||
```
|
||||
|
||||
For more advanced configuration details, see the
|
||||
[configuration documentation](/telegraf/v1.26/administration/configuration/).
|
||||
[configuration documentation](/telegraf/v1.27/administration/configuration/).
|
||||
{{% /tab-content %}}
|
||||
<!---------- BEGIN FreeBSD/PC-BSD ---------->
|
||||
{{% tab-content %}}
|
||||
|
|
@ -223,7 +223,7 @@ telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>
|
|||
```
|
||||
|
||||
For more advanced configuration details, see the
|
||||
[configuration documentation](/telegraf/v1.26/administration/configuration/).
|
||||
[configuration documentation](/telegraf/v1.27/administration/configuration/).
|
||||
{{% /tab-content %}}
|
||||
<!---------- BEGIN macOS ---------->
|
||||
{{% tab-content %}}
|
||||
|
|
@ -267,7 +267,7 @@ telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>
|
|||
```
|
||||
|
||||
For more advanced configuration details, see the
|
||||
[configuration documentation](/telegraf/v1.26/configuration/).
|
||||
[configuration documentation](/telegraf/v1.27/configuration/).
|
||||
{{% /tab-content %}}
|
||||
<!---------- BEGIN Windows ---------->
|
||||
{{% tab-content %}}
|
||||
|
|
@ -363,7 +363,7 @@ Use the Telegraf custom builder tool to compile Telegraf with only the plugins y
|
|||
### Requirements
|
||||
|
||||
- Ensure you've installed [Go](https://go.dev/) version is 1.18.0 or later.
|
||||
- Create your Telegraf configuration file with the plugins you want to use. For details, see [Configuration options](/telegraf/v1.26/configuration/).
|
||||
- Create your Telegraf configuration file with the plugins you want to use. For details, see [Configuration options](/telegraf/v1.27/configuration/).
|
||||
|
||||
### Build and run the custom builder
|
||||
|
||||
|
|
|
|||
|
|
@ -25,5 +25,5 @@ representation in order to be transmitted or viewed. Telegraf provides [output d
|
|||
Protocol][line protocol], which provides a high performance and one-to-one
|
||||
direct mapping from Telegraf metrics.
|
||||
|
||||
[output data formats]: /telegraf/v1.26/data_formats/output/
|
||||
[line protocol]: /telegraf/v1.26/data_formats/output/influx/
|
||||
[output data formats]: /telegraf/v1.27/data_formats/output/
|
||||
[line protocol]: /telegraf/v1.27/data_formats/output/influx/
|
||||
|
|
|
|||
Loading…
Reference in New Issue