diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14ae0a0b3..c85d54e4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -431,6 +431,20 @@ The following parameters are available: {{< keybind mac="⇧⌘P" linux="Ctrl+Shift+P" win="Ctrl+Shift+Alt+P" >}} ``` +### Diagrams +Use the `{{< diagram >}}` shortcode to dynamically build diagrams. +The shortcode uses [mermaid.js](https://github.com/mermaid-js/mermaid) to convert +simple text into SVG diagrams. +For information about the syntax, see the [mermaid.js documentation](https://mermaid-js.github.io/mermaid/#/). + +```md +{{< diagram >}} +flowchart TB + This --> That + That --> There +{{< /diagram >}} +``` + ### High-resolution images In many cases, screenshots included in the docs are taken from high-resolution (retina) screens. Because of this, the actual pixel dimension is 2x larger than it needs to be and is rendered 2x bigger than it should be. diff --git a/assets/styles/layouts/_article.scss b/assets/styles/layouts/_article.scss index 3e81e09c5..5dd3eaa48 100644 --- a/assets/styles/layouts/_article.scss +++ b/assets/styles/layouts/_article.scss @@ -102,6 +102,7 @@ "article/children", "article/code", "article/cloud", + "article/diagrams", "article/enterprise", "article/expand", "article/feedback", diff --git a/assets/styles/layouts/article/_diagrams.scss b/assets/styles/layouts/article/_diagrams.scss new file mode 100644 index 000000000..d2201ad74 --- /dev/null +++ b/assets/styles/layouts/article/_diagrams.scss @@ -0,0 +1,44 @@ +.mermaid { + opacity: 0; + color: $article-bg; + margin: 3rem 0; + transition: opacity .5s; + + + .arrowheadPath, .arrowMarkerPath { fill: $diagram-arrow !important; } + .edgePath .path, .flowchart-link { stroke: $diagram-arrow !important; } + .label { color: $article-text !important; } + .cluster-label .nodeLabel { + color: $article-code !important; + } + .edgeLabel { + color: $article-text !important; + background: $article-code-bg !important; + font-size: .85em; + font-weight: $medium; + } + + .node { + rect, + circle, + ellipse, + polygon, + path { + fill: $article-bg !important; + stroke: $diagram-arrow !important; + stroke-width: 2px !important; + } + .label { color: $article-text !important; } + } + + .cluster { + rect, + circle, + ellipse, + polygon, + path { + fill: $article-code-bg !important; + stroke: none !important; + } + } +} diff --git a/assets/styles/themes/_theme-dark.scss b/assets/styles/themes/_theme-dark.scss index 1b61b492b..2bdaabcbc 100644 --- a/assets/styles/themes/_theme-dark.scss +++ b/assets/styles/themes/_theme-dark.scss @@ -209,6 +209,9 @@ $svg-geo-s2-cell: $b-dodger; $svg-geo-region: $p-comet; $svg-geo-point: $br-chartreuse; +// Diagram colors +$diagram-arrow: $g6-smoke; + @import "dark/telegraf", "dark/chronograf", "dark/kapacitor"; diff --git a/assets/styles/themes/_theme-light.scss b/assets/styles/themes/_theme-light.scss index b6d1661ed..9d6612f6b 100644 --- a/assets/styles/themes/_theme-light.scss +++ b/assets/styles/themes/_theme-light.scss @@ -209,6 +209,9 @@ $svg-geo-s2-cell: $b-hydrogen !default; $svg-geo-region: $br-galaxy !default; $svg-geo-point: $p-potassium !default; +// Diagram colors +$diagram-arrow: $g14-chromium !default; + @import "light/telegraf", "light/chronograf", "light/kapacitor"; diff --git a/content/enterprise_influxdb/v1.5/concepts/clustering.md b/content/enterprise_influxdb/v1.5/concepts/clustering.md index 7da493082..80482f956 100644 --- a/content/enterprise_influxdb/v1.5/concepts/clustering.md +++ b/content/enterprise_influxdb/v1.5/concepts/clustering.md @@ -15,30 +15,16 @@ This document describes in detail how clustering works in InfluxEnterprise. It s An InfluxEnterprise installation consists of three separate software processes: Data nodes, Meta nodes, and the Enterprise Web server. To run an InfluxDB cluster, only the meta and data nodes are required. Communication within a cluster looks like this: -```text - ┌───────┐ ┌───────┐ - │ │ │ │ - │ Meta1 │◀───▶│ Meta2 │ - │ │ │ │ - └───────┘ └───────┘ - ▲ ▲ - │ │ - │ ┌───────┐ │ - │ │ │ │ - └─▶│ Meta3 │◀─┘ - │ │ - └───────┘ - -───────────────────────────────── - ╲│╱ ╲│╱ - ┌────┘ └──────┐ - │ │ - ┌───────┐ ┌───────┐ - │ │ │ │ - │ Data1 │◀────────▶│ Data2 │ - │ │ │ │ - └───────┘ └───────┘ -``` +{{< diagram >}} +flowchart TB + subgraph meta[Meta Nodes] + Meta1 <-- TCP :8089 --> Meta2 <-- TCP :8089 --> Meta3 + end + meta <-- HTTP :8091 --> data + subgraph data[Data Nodes] + Data1 <-- TCP :8088 --> Data2 + end +{{< /diagram >}} The meta nodes communicate with each other via a TCP protocol and the Raft consensus protocol that all use port `8089` by default. This port must be reachable between the meta nodes. The meta nodes also expose an HTTP API bound to port `8091` by default that the `influxd-ctl` command uses. diff --git a/content/enterprise_influxdb/v1.6/concepts/clustering.md b/content/enterprise_influxdb/v1.6/concepts/clustering.md index 00e9249a0..8faec191e 100644 --- a/content/enterprise_influxdb/v1.6/concepts/clustering.md +++ b/content/enterprise_influxdb/v1.6/concepts/clustering.md @@ -15,30 +15,16 @@ This document describes in detail how clustering works in InfluxDB Enterprise. I An InfluxDB Enterprise installation consists of three separate software processes: Data nodes, Meta nodes, and the Enterprise Web server. To run an InfluxDB cluster, only the meta and data nodes are required. Communication within a cluster looks like this: -```text - ┌───────┐ ┌───────┐ - │ │ │ │ - │ Meta1 │◀───▶│ Meta2 │ - │ │ │ │ - └───────┘ └───────┘ - ▲ ▲ - │ │ - │ ┌───────┐ │ - │ │ │ │ - └─▶│ Meta3 │◀─┘ - │ │ - └───────┘ - -───────────────────────────────── - ╲│╱ ╲│╱ - ┌────┘ └──────┐ - │ │ - ┌───────┐ ┌───────┐ - │ │ │ │ - │ Data1 │◀────────▶│ Data2 │ - │ │ │ │ - └───────┘ └───────┘ -``` +{{< diagram >}} +flowchart TB + subgraph meta[Meta Nodes] + Meta1 <-- TCP :8089 --> Meta2 <-- TCP :8089 --> Meta3 + end + meta <-- HTTP :8091 --> data + subgraph data[Data Nodes] + Data1 <-- TCP :8088 --> Data2 + end +{{< /diagram >}} The meta nodes communicate with each other via a TCP protocol and the Raft consensus protocol that all use port `8089` by default. This port must be reachable between the meta nodes. The meta nodes also expose an HTTP API bound to port `8091` by default that the `influxd-ctl` command uses. diff --git a/content/enterprise_influxdb/v1.7/concepts/clustering.md b/content/enterprise_influxdb/v1.7/concepts/clustering.md index 5714420aa..a5f09fa36 100644 --- a/content/enterprise_influxdb/v1.7/concepts/clustering.md +++ b/content/enterprise_influxdb/v1.7/concepts/clustering.md @@ -15,30 +15,16 @@ This document describes in detail how clustering works in InfluxDB Enterprise. I An InfluxDB Enterprise installation consists of three separate software processes: data nodes, meta nodes, and the Enterprise web server. To run an InfluxDB cluster, only the meta and data nodes are required. Communication within a cluster looks like this: -```text - ┌───────┐ ┌───────┐ - │ │ │ │ - │ Meta1 │◀───▶│ Meta2 │ - │ │ │ │ - └───────┘ └───────┘ - ▲ ▲ - │ │ - │ ┌───────┐ │ - │ │ │ │ - └─▶│ Meta3 │◀─┘ - │ │ - └───────┘ - -───────────────────────────────── - ╲│╱ ╲│╱ - ┌────┘ └──────┐ - │ │ - ┌───────┐ ┌───────┐ - │ │ │ │ - │ Data1 │◀────────▶│ Data2 │ - │ │ │ │ - └───────┘ └───────┘ -``` +{{< diagram >}} +flowchart TB + subgraph meta[Meta Nodes] + Meta1 <-- TCP :8089 --> Meta2 <-- TCP :8089 --> Meta3 + end + meta <-- HTTP :8091 --> data + subgraph data[Data Nodes] + Data1 <-- TCP :8088 --> Data2 + end +{{< /diagram >}} The meta nodes communicate with each other via a TCP protocol and the Raft consensus protocol that all use port `8089` by default. This port must be reachable between the meta nodes. The meta nodes also expose an HTTP API bound to port `8091` by default that the `influxd-ctl` command uses. diff --git a/content/enterprise_influxdb/v1.8/administration/ports.md b/content/enterprise_influxdb/v1.8/administration/ports.md index f40bfef6b..bac619108 100644 --- a/content/enterprise_influxdb/v1.8/administration/ports.md +++ b/content/enterprise_influxdb/v1.8/administration/ports.md @@ -8,23 +8,53 @@ menu: parent: Administration --- +![InfluxDB Enterprise network diagram](/img/enterprise/1-8-network-diagram.png) + ## Enabled ports -![](/img/enterprise/1-8-network-diagram.png) +### 8086 -### `8086` The default port that runs the InfluxDB HTTP service. +It is used for the primary public write and query API. +Clients include the CLI, Chronograf, InfluxDB client libraries, Grafana, curl, or anything that wants to write and read time series data to and from InfluxDB. [Configure this port](/enterprise_influxdb/v1.8/administration/config-data-nodes/#bind-address-8088) in the data node configuration file. -**Resources** [API Reference](/influxdb/v1.8/tools/api/) +_See also: [API Reference](/influxdb/v1.8/tools/api/)._ ### 8088 -The default port used for RPC calls used for inter-node communication and by the CLI for backup and restore operations (`influxdb backup` and `influxd restore`). + +Data nodes listen on this port. +Primarily used by other data nodes to handle distributed reads and writes at runtime. +Used to control a data node (e.g., tell it to write to a specific shard or execute a query). +It's also used by meta nodes for cluster-type operations (e.g., tell a data node to join or leave the cluster). + +This is the default port used for RPC calls used for inter-node communication and by the CLI for backup and restore operations +(`influxdb backup` and `influxd restore`). [Configure this port](/influxdb/v1.8/administration/config#bind-address-127-0-0-1-8088) in the configuration file. -**Resources** [Backup and Restore](/influxdb/v1.8/administration/backup_and_restore/) +This port should not be exposed outside the cluster. + +_See also: [Backup and Restore](/influxdb/v1.8/administration/backup_and_restore/)._ + +### 8089 + +Used for communcation between meta nodes. +It is used by the Raft consensus protocol. +The only clients using `8089` should be the other meta nodes in the cluster. + +This port should not be exposed outside the cluster. + +### 8091 + +Meta nodes listen on this port. +It is used for the meta service API. +Primarily used by data nodes to stay in sync about databases, retention policies, shards, users, privileges, etc. +Used by meta nodes to receive incoming connections by data nodes and Chronograf. +Clients also include the `influxd-ctl` command line tool and Chronograph, + +This port should not be exposed outside the cluster. ## Disabled ports diff --git a/content/enterprise_influxdb/v1.8/concepts/clustering.md b/content/enterprise_influxdb/v1.8/concepts/clustering.md index 7bb700c9d..0bee38e31 100644 --- a/content/enterprise_influxdb/v1.8/concepts/clustering.md +++ b/content/enterprise_influxdb/v1.8/concepts/clustering.md @@ -17,30 +17,17 @@ This document describes in detail how clustering works in InfluxDB Enterprise. I An InfluxDB Enterprise installation consists of three separate software processes: data nodes, meta nodes, and the Enterprise web server. To run an InfluxDB cluster, only the meta and data nodes are required. Communication within a cluster looks like this: -```text - ┌───────┐ ┌───────┐ - │ │ │ │ - │ Meta1 │◀───▶│ Meta2 │ - │ │ │ │ - └───────┘ └───────┘ - ▲ ▲ - │ │ - │ ┌───────┐ │ - │ │ │ │ - └─▶│ Meta3 │◀─┘ - │ │ - └───────┘ +{{< diagram >}} +flowchart TB + subgraph meta[Meta Nodes] + Meta1 <-- TCP :8089 --> Meta2 <-- TCP :8089 --> Meta3 + end + meta <-- HTTP :8091 --> data + subgraph data[Data Nodes] + Data1 <-- TCP :8088 --> Data2 + end +{{< /diagram >}} -───────────────────────────────── - ╲│╱ ╲│╱ - ┌────┘ └──────┐ - │ │ - ┌───────┐ ┌───────┐ - │ │ │ │ - │ Data1 │◀────────▶│ Data2 │ - │ │ │ │ - └───────┘ └───────┘ -``` The meta nodes communicate with each other via a TCP protocol and the Raft consensus protocol that all use port `8089` by default. This port must be reachable between the meta nodes. The meta nodes also expose an HTTP API bound to port `8091` by default that the `influxd-ctl` command uses. diff --git a/content/influxdb/cloud/query-data/influxql.md b/content/influxdb/cloud/query-data/influxql.md index 1a6f449c0..e82f7eebc 100644 --- a/content/influxdb/cloud/query-data/influxql.md +++ b/content/influxdb/cloud/query-data/influxql.md @@ -147,6 +147,7 @@ To learn more about InfluxQL, see [Influx Query Language (InfluxQL)](/{{< latest - `DELETE`* - `DROP MEASUREMENT`* +- `EXPLAIN ANALYZE` - `SELECT` _(read-only)_ - `SHOW DATABASES` - `SHOW MEASUREMENTS` diff --git a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/_index.md b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/_index.md index 3cd22a890..baefee1b7 100644 --- a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/_index.md +++ b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/_index.md @@ -17,41 +17,4 @@ related: - /influxdb/cloud/query-data/flux/scalar-values/ --- -Use stream and table functions to extract a table from a stream of tables and access its -columns and records. - -{{< children type="functions" >}} - -### Example stream and table functions - -##### Recommended usage -```js -data = from(bucket:"example-bucket") - |> range(start: -5m) - |> filter(fn:(r) => r._measurement == "cpu") - -// Extract the "_value" column from the table -data - |> findColumn(fn: (key) => key._field == "usage_idle", column: "_value") - -// Extract the first record from the table -data - |> findRecord(fn: (key) => key._field == "usage_idle", idx: 0) - -``` - -##### Alternate usage -```js -data = from(bucket:"example-bucket") - |> range(start: -5m) - |> filter(fn:(r) => r._measurement == "cpu") - -// Extract the first available table for which "_field" is equal to "usage_idle" -t = data |> tableFind(fn: (key) => key._field == "usage_idle") - -// Extract the "_value" column from the table -values = t |> getColumn(column: "_value") - -// Extract the first record from the table -r0 = t |> getRecord(idx: 0) -``` +{{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/findcolumn.md b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/findcolumn.md index 33c5f7738..5df8a690a 100644 --- a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/findcolumn.md +++ b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/findcolumn.md @@ -12,43 +12,4 @@ related: - /influxdb/cloud/query-data/flux/scalar-values/ --- -The `findColumn()` function returns an array of values in a specified column from the -first table in a stream of tables where the group key values match the specified predicate. -The function returns an empty array if no table is found or if the column label -is not present in the set of columns. - -_**Function type:** Stream and table_ - -```js -findColumn( - fn: (key) => key._field == "fieldName") - column: "_value" -) -``` - -## Parameters - -### fn -A predicate function for matching keys in a table's group key. -Expects a `key` argument that represents a group key in the input stream. - -_**Data type:** Function_ - -### column -Name of the column to extract. - -_**Data type:** String_ - -## Example -```js -vs = from(bucket:"example-bucket") - |> range(start: -5m) - |> filter(fn:(r) => r._measurement == "cpu") - |> findColumn( - fn: (key) => key._field == "usage_idle", - column: "_value" - ) - -// Use column values -x = vs[0] + vs[1] -``` +{{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/findrecord.md b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/findrecord.md index 86794c9e3..0a0618ad1 100644 --- a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/findrecord.md +++ b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/findrecord.md @@ -20,7 +20,7 @@ _**Function type:** Stream and table_ ```js findRecord( - fn: (key) => key._field == "fieldName", + fn: (key) => key._field == "fieldName"), idx: 0 ) ``` diff --git a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getcolumn.md b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getcolumn.md index 8bbfd2785..33e063809 100644 --- a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getcolumn.md +++ b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getcolumn.md @@ -14,37 +14,4 @@ related: - /influxdb/cloud/query-data/flux/scalar-values/ --- -The `getColumn()` function extracts a column from a table given its label. -If the label is not present in the set of columns, the function errors. - -_**Function type:** Stream and table_ - -```js -getColumn(column: "_value") -``` - -{{% note %}} -#### Use tableFind() to extract a single table -`getColumn()` requires a single table as input. -Use [`tableFind()`](/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/tablefind/) -to extract a single table from a stream of tables. -{{% /note %}} - -## Parameters - -### column -Name of the column to extract. - -_**Data type:** String_ - -## Example -```js -vs = from(bucket:"example-bucket") - |> range(start: -5m) - |> filter(fn:(r) => r._measurement == "cpu") - |> tableFind(fn: (key) => key._field == "usage_idle") - |> getColumn(column: "_value") - -// Use column values -x = vs[0] + vs[1] -``` +{{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getrecord.md b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getrecord.md index 10bdd9be5..a479b8fbb 100644 --- a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getrecord.md +++ b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getrecord.md @@ -14,37 +14,4 @@ related: - /influxdb/cloud/query-data/flux/scalar-values/ --- -The `getRecord()` function extracts a record from a table given the record's index. -If the index is out of bounds, the function errors. - -_**Function type:** Stream and table_ - -```js -getRecord(idx: 0) -``` - -{{% note %}} -#### Use tableFind() to extract a single table -`getRecord()` requires a single table as input. -Use [`tableFind()`](/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/tablefind/) -to extract a single table from a stream of tables. -{{% /note %}} - -## Parameters - -### idx -Index of the record to extract. - -_**Data type:** Integer_ - -## Example -```js -r0 = from(bucket:"example-bucket") - |> range(start: -5m) - |> filter(fn:(r) => r._measurement == "cpu") - |> tableFind(fn: (key) => key._field == "usage_idle") - |> getRecord(idx: 0) - -// Use record values -x = r0._field + "--" + r0._measurement -``` +{{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/tablefind.md b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/tablefind.md index 56eb08a7e..dbeaa2b71 100644 --- a/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/tablefind.md +++ b/content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/tablefind.md @@ -14,49 +14,4 @@ related: - /influxdb/cloud/query-data/flux/scalar-values/ --- -The `tableFind()` function extracts the first table in a stream of tables whose -group key values match a predicate. If no table is found, the function errors. - -_**Function type:** Stream and table_ - -```js -tableFind(fn: (key) => key._field == "fieldName") -``` - -## Parameters - -{{% note %}} -Make sure `fn` parameter names match each specified parameter. -To learn why, see [Match parameter names](/influxdb/cloud/reference/flux/language/data-model/#match-parameter-names). -{{% /note %}} - -### fn - -A predicate function for matching keys in a table's group key. -`tableFind` returns the first table that resolves as `true`. -Expects a `key` argument that represents a group key in the input stream. - -_**Data type:** Function_ - -##### Example fn function - -```js -(key) => key._field == "fieldName" -``` - -## Example - -```js -t = from(bucket:"example-bucket") - |> range(start: -5m) - |> filter(fn:(r) => r._measurement == "cpu") - |> tableFind(fn: (key) => key._field == "usage_idle") - -// t represents the first table in a stream whose group key -// contains "_field" with a value of "usage_idle". -``` - -{{% note %}} -You can use `t` from the example above as input for [`getColumn()`](/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getcolumn/) -and [`getRecord()`](/influxdb/cloud/reference/flux/stdlib/built-in/transformations/stream-table/getrecord/). -{{% /note %}} +{{< duplicate-oss >}} diff --git a/content/influxdb/cloud/tools/grafana.md b/content/influxdb/cloud/tools/grafana.md index 3c64e1f42..00e7465c2 100644 --- a/content/influxdb/cloud/tools/grafana.md +++ b/content/influxdb/cloud/tools/grafana.md @@ -86,15 +86,15 @@ configure your InfluxDB connection: 2. Under **Auth**, enable **Basic Auth**. 3. Under **Basic Auth Details**, provide your InfluxDB authentication credentials: - - **username**: InfluxDB username - - **password**: InfluxDB [authentication token](/influxdb/cloud/security/tokens/) + - **User**: InfluxDB username + - **Password**: InfluxDB [authentication token](/influxdb/cloud/security/tokens/) -4. Under **InfluxDB details**, set the following: +4. Under **InfluxDB Details**, do the following: - - **Database**: The database to use when querying InfluxDB. - _See [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)._ + - **Database**: Enter the ID of the bucket to query in InfluxDB Cloud. To retrieve your bucket ID, see how to [view buckets](/influxdb/cloud/organizations/buckets/view-buckets/). + - **User**: Enter the username to sign into InfluxDB. + - **Password**: Enter the token used to query the bucket above. To retrieve your token, see how to [view tokens](/influxdb/cloud/security/tokens/view-tokens/). - **HTTP Method**: Select **GET**. - - **Min time interval**: The [Grafana minimum time interval](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/#min-time-interval). {{< img-hd src="/img/influxdb/2-0-visualize-grafana-influxql.png" />}} diff --git a/content/influxdb/v1.8/concepts/key_concepts.md b/content/influxdb/v1.8/concepts/key_concepts.md index ede7648b2..c75ab4640 100644 --- a/content/influxdb/v1.8/concepts/key_concepts.md +++ b/content/influxdb/v1.8/concepts/key_concepts.md @@ -9,34 +9,21 @@ menu: v2: /influxdb/v2.0/reference/key-concepts/ --- -Before diving into InfluxDB it's good to get acquainted with some of the key concepts of the database. -This document provides a gentle introduction to those concepts and common InfluxDB terminology. -We've provided a list below of all the terms we'll cover, but we recommend reading this document from start to finish to gain a more general understanding of our favorite time series database. +Before diving into InfluxDB, it's good to get acquainted with some key concepts of the database. This document introduces key InfluxDB concepts and elements. To introduce the key concepts, we’ll cover how the following elements work together in InfluxDB: - - - - - - - - - - - - - - - - - - - - - -
databasefield keyfield set
field valuemeasurementpoint
retention policyseriestag key
tag settag valuetimestamp
+- [database](/influxdb/v1.8/concepts/glossary/#database) +- [field key](/influxdb/v1.8/concepts/glossary/#field-key) +- [field set](/influxdb/v1.8/concepts/glossary/#field-set) +- [field value](/influxdb/v1.8/concepts/glossary/#field-value) +- [measurement](/influxdb/v1.8/concepts/glossary/#measurement) +- [point](/influxdb/v1.8/concepts/glossary/#point) +- [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) +- [series](/influxdb/v1.8/concepts/glossary/#series) +- [tag key](/influxdb/v1.8/concepts/glossary/#tag-key) +- [tag set](/influxdb/v1.8/concepts/glossary/#tag-set) +- [tag value](/influxdb/v1.8/concepts/glossary/#tag-value) +- [timestamp](/influxdb/v1.8/concepts/glossary/#timestamp) -Check out the [glossary](/influxdb/v1.8/concepts/glossary/) if you prefer the cold, hard facts. ### Sample data diff --git a/content/influxdb/v2.0/get-started.md b/content/influxdb/v2.0/get-started.md index ccfa032f5..a9ff42541 100644 --- a/content/influxdb/v2.0/get-started.md +++ b/content/influxdb/v2.0/get-started.md @@ -32,7 +32,7 @@ _See [Differences between InfluxDB Cloud and InfluxDB OSS](#differences-between- Download InfluxDB v2.0 for macOS. -InfluxDB v2.0 (macOS) +InfluxDB v2.0 (macOS) ### (Optional) Verify the authenticity of downloaded binary @@ -50,7 +50,7 @@ If `gpg` is not available, see the [GnuPG homepage](https://gnupg.org/download/) For example: ``` - wget https://dl.influxdata.com/influxdb/releases/influxdb-2.0.3_darwin_amd64.tar.gz.asc + wget https://dl.influxdata.com/influxdb/releases/influxdb2-2.0.3_darwin_amd64.tar.gz.asc ``` 3. Verify the signature with `gpg --verify`: @@ -177,7 +177,7 @@ If `gpg` is not available, see the [GnuPG homepage](https://gnupg.org/download/) 3. Verify the signature with `gpg --verify`: ``` - gpg --verify influxdb-2.0.3_linux_amd64.tar.gz.asc influxdb-2.0.3_linux_amd64.tar.gz + gpg --verify influxdb2-2.0.3_linux_amd64.tar.gz.asc influxdb2-2.0.3_linux_amd64.tar.gz ``` The output from this command should include the following: @@ -194,10 +194,10 @@ _**Note:** The following commands are examples. Adjust the file names, paths, an ```sh # Unpackage contents to the current working directory -tar xvzf path/to/influxdb-2.0.3_linux_amd64.tar.gz +tar xvzf path/to/influxdb2-2.0.3_linux_amd64.tar.gz # Copy the influx and influxd binary to your $PATH -sudo cp influxdb-2.0.3_linux_amd64/{influx,influxd} /usr/local/bin/ +sudo cp influxdb2-2.0.3_linux_amd64/{influx,influxd} /usr/local/bin/ ``` {{% note %}} diff --git a/content/influxdb/v2.0/query-data/influxql.md b/content/influxdb/v2.0/query-data/influxql.md index 69498ab0b..9aa7dcf83 100644 --- a/content/influxdb/v2.0/query-data/influxql.md +++ b/content/influxdb/v2.0/query-data/influxql.md @@ -218,6 +218,7 @@ To learn more about InfluxQL, see [Influx Query Language (InfluxQL)](/{{< latest - `DELETE`* - `DROP MEASUREMENT`* +- `EXPLAIN ANALYZE` - `SELECT` _(read-only)_ - `SHOW DATABASES` - `SHOW MEASUREMENTS` diff --git a/content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/stream-table/findcolumn.md b/content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/stream-table/findcolumn.md index 7999a56f0..f2273c371 100644 --- a/content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/stream-table/findcolumn.md +++ b/content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/stream-table/findcolumn.md @@ -21,7 +21,7 @@ _**Function type:** Stream and table_ ```js findColumn( - fn: (key) => key._field == "fieldName") + fn: (key) => key._field == "fieldName", column: "_value" ) ``` diff --git a/content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/stream-table/findrecord.md b/content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/stream-table/findrecord.md index ac1d045c2..bb83517a8 100644 --- a/content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/stream-table/findrecord.md +++ b/content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/stream-table/findrecord.md @@ -20,7 +20,7 @@ _**Function type:** Stream and table_ ```js findRecord( - fn: (key) => key._field == "fieldName", + fn: (key) => key._field == "fieldName"), idx: 0 ) ``` diff --git a/content/influxdb/v2.0/tools/client-libraries/go.md b/content/influxdb/v2.0/tools/client-libraries/go.md index 17107e1cd..c06200711 100644 --- a/content/influxdb/v2.0/tools/client-libraries/go.md +++ b/content/influxdb/v2.0/tools/client-libraries/go.md @@ -26,7 +26,7 @@ If just getting started, see [Get started with InfluxDB](/influxdb/v2.0/get-star ```sh # Add InfluxDB Go client package to your project go.mod - go get github.com/influxdata/influxdb-client-go/v2 + go get github.com/influxdata/influxdb-client-go ``` 3. Ensure that InfluxDB is running and you can connect to it. For information about what URL to use to connect to InfluxDB OSS or InfluxDB Cloud, see [InfluxDB URLs](/influxdb/v2.0/reference/urls/). diff --git a/content/influxdb/v2.0/tools/grafana.md b/content/influxdb/v2.0/tools/grafana.md index 4cf2b282d..4abcc9195 100644 --- a/content/influxdb/v2.0/tools/grafana.md +++ b/content/influxdb/v2.0/tools/grafana.md @@ -84,15 +84,15 @@ configure your InfluxDB connection: 2. Under **Auth**, enable **Basic Auth**. 3. Under **Basic Auth Details**, provide your InfluxDB authentication credentials: - - **username**: InfluxDB username - - **password**: InfluxDB [authentication token](/influxdb/v2.0/security/tokens/) + - **User**: InfluxDB username + - **Password**: InfluxDB [authentication token](/influxdb/v2.0/security/tokens/) -4. Under **InfluxDB details**, set the following: +4. Under **InfluxDB Details**, do the following: - - **Database**: The database to use when querying InfluxDB 2.0. - _See [Database and retention policy mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/)._ + - **Database**: Enter the ID of the bucket to query in InfluxDB 2.0. To retrieve your bucket ID, see how to [view buckets](/influxdb/v2.0/organizations/buckets/view-buckets/). + - **User**: Enter the username to sign into InfluxDB. + - **Password**: Enter the token used to query the bucket above. To retrieve your token, see how to [view tokens](/influxdb/v2.0/security/tokens/view-tokens/). - **HTTP Method**: Select **GET**. - - **Min time interval**: The [Grafana minimum time interval](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/#min-time-interval). {{< img-hd src="/img/influxdb/2-0-visualize-grafana-influxql.png" />}} diff --git a/content/kapacitor/v1.5/introduction/getting-started.md b/content/kapacitor/v1.5/introduction/getting-started.md index bc7b055e3..f66aacc5e 100644 --- a/content/kapacitor/v1.5/introduction/getting-started.md +++ b/content/kapacitor/v1.5/introduction/getting-started.md @@ -1,5 +1,6 @@ --- title: Get started with Kapacitor +description: Get started with Kapacitor to process your time series data. weight: 20 menu: kapacitor_1_5: @@ -12,14 +13,14 @@ Use Kapacitor to import (stream or batch) time series data, and then transform, - [Start InfluxDB and collect Telegraf data](#start-influxdb-and-collect-telegraf-data) - [Start Kapacitor](#start-kapacitor) - Kapacitor tasks - - [Execute a task](#execute-a-task) - - [Trigger an alert from stream data](#trigger-alerts-from-stream-data) - - [Example alert on CPU usage](#example-alert-on-cpu-usage) - - [Gotcha - single versus double quotes](#gotcha-single-versus-double-quotes) - - [Extending TICKscripts](#extending-tickscripts) - - [A real world example](#a-real-world-example) - - [Trigger an alert from batch data](#trigger-alerts-from-batch-data) - - [Load tasks](#load-tasks-with-kapacitor) + - [Execute a task](#execute-a-task) + - [Trigger an alert from stream data](#trigger-alerts-from-stream-data) + - [Example alert on CPU usage](#example-alert-on-cpu-usage) + - [Gotcha - single versus double quotes](#gotcha-single-versus-double-quotes) + - [Extending TICKscripts](#extending-tickscripts) + - [A real world example](#a-real-world-example) + - [Trigger an alert from batch data](#trigger-alerts-from-batch-data) + - [Load tasks](#load-tasks-with-kapacitor) ## Overview diff --git a/content/kapacitor/v1.5/introduction/installation.md b/content/kapacitor/v1.5/introduction/installation.md index d05dbd4f4..3360df251 100644 --- a/content/kapacitor/v1.5/introduction/installation.md +++ b/content/kapacitor/v1.5/introduction/installation.md @@ -1,6 +1,6 @@ --- title: Install Kapacitor -Description: Download, install, and configure Kapacitor on your operating system of choice. +Description: Install, start, and configure Kapacitor on your operating system of choice. weight: 10 menu: kapacitor_1_5: diff --git a/content/telegraf/v1.10/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.10/concepts/aggregator_processor_plugins.md index dac341858..62917d73e 100644 --- a/content/telegraf/v1.10/concepts/aggregator_processor_plugins.md +++ b/content/telegraf/v1.10/concepts/aggregator_processor_plugins.md @@ -10,37 +10,24 @@ menu: Besides the input plugins and output plugins, Telegraf includes aggregator and processor plugins, which are used to aggregate and process metrics as they pass through Telegraf. -``` -┌───────────┐ -│ │ -│ CPU │───┐ -│ │ │ -└───────────┘ │ - │ -┌───────────┐ │ ┌───────────┐ -│ │ │ │ │ -│ Memory │───┤ ┌──▶│ InfluxDB │ -│ │ │ │ │ │ -└───────────┘ │ ┌─────────────┐ ┌─────────────┐ │ └───────────┘ - │ │ │ │Aggregate │ │ -┌───────────┐ │ │Process │ │ - mean │ │ ┌───────────┐ -│ │ │ │ - transform │ │ - quantiles │ │ │ │ -│ MySQL │───┼──▶ │ - decorate │────▶│ - min/max │───┼──▶│ File │ -│ │ │ │ - filter │ │ - count │ │ │ │ -└───────────┘ │ │ │ │ │ │ └───────────┘ - │ └─────────────┘ └─────────────┘ │ -┌───────────┐ │ │ ┌───────────┐ -│ │ │ │ │ │ -│ SNMP │───┤ └──▶│ Kafka │ -│ │ │ │ │ -└───────────┘ │ └───────────┘ - │ -┌───────────┐ │ -│ │ │ -│ Docker │───┘ -│ │ -└───────────┘ -``` +{{< diagram >}} + graph TD + Process[Process
- transform
- decorate
- filter] + Aggregate[Aggregate
- transform
- decorate
- filter] + + CPU --> Process + Memory --> Process + MySQL --> Process + SNMP --> Process + Docker --> Process + Process --> Aggregate + Aggregate --> InfluxDB + Aggregate --> File + Aggregate --> Kafka + +style Process text-align:left +style Aggregate text-align:left +{{< /diagram >}} **Processor plugins** process metrics as they pass through and immediately emit results based on the values they process. For example, this could be printing diff --git a/content/telegraf/v1.11/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.11/concepts/aggregator_processor_plugins.md index ed130858c..a043c6788 100644 --- a/content/telegraf/v1.11/concepts/aggregator_processor_plugins.md +++ b/content/telegraf/v1.11/concepts/aggregator_processor_plugins.md @@ -10,37 +10,24 @@ menu: Besides the input plugins and output plugins, Telegraf includes aggregator and processor plugins, which are used to aggregate and process metrics as they pass through Telegraf. -``` -┌───────────┐ -│ │ -│ CPU │───┐ -│ │ │ -└───────────┘ │ - │ -┌───────────┐ │ ┌───────────┐ -│ │ │ │ │ -│ Memory │───┤ ┌──▶│ InfluxDB │ -│ │ │ │ │ │ -└───────────┘ │ ┌─────────────┐ ┌─────────────┐ │ └───────────┘ - │ │ │ │Aggregate │ │ -┌───────────┐ │ │Process │ │ - mean │ │ ┌───────────┐ -│ │ │ │ - transform │ │ - quantiles │ │ │ │ -│ MySQL │───┼──▶ │ - decorate │────▶│ - min/max │───┼──▶│ File │ -│ │ │ │ - filter │ │ - count │ │ │ │ -└───────────┘ │ │ │ │ │ │ └───────────┘ - │ └─────────────┘ └─────────────┘ │ -┌───────────┐ │ │ ┌───────────┐ -│ │ │ │ │ │ -│ SNMP │───┤ └──▶│ Kafka │ -│ │ │ │ │ -└───────────┘ │ └───────────┘ - │ -┌───────────┐ │ -│ │ │ -│ Docker │───┘ -│ │ -└───────────┘ -``` +{{< diagram >}} + graph TD + Process[Process
- transform
- decorate
- filter] + Aggregate[Aggregate
- transform
- decorate
- filter] + + CPU --> Process + Memory --> Process + MySQL --> Process + SNMP --> Process + Docker --> Process + Process --> Aggregate + Aggregate --> InfluxDB + Aggregate --> File + Aggregate --> Kafka + +style Process text-align:left +style Aggregate text-align:left +{{< /diagram >}} **Processor plugins** process metrics as they pass through and immediately emit results based on the values they process. For example, this could be printing diff --git a/content/telegraf/v1.12/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.12/concepts/aggregator_processor_plugins.md index 86b33dd62..3b2aae7f8 100644 --- a/content/telegraf/v1.12/concepts/aggregator_processor_plugins.md +++ b/content/telegraf/v1.12/concepts/aggregator_processor_plugins.md @@ -10,37 +10,24 @@ menu: Besides the input plugins and output plugins, Telegraf includes aggregator and processor plugins, which are used to aggregate and process metrics as they pass through Telegraf. -``` -┌───────────┐ -│ │ -│ CPU │───┐ -│ │ │ -└───────────┘ │ - │ -┌───────────┐ │ ┌───────────┐ -│ │ │ │ │ -│ Memory │───┤ ┌──▶│ InfluxDB │ -│ │ │ │ │ │ -└───────────┘ │ ┌─────────────┐ ┌─────────────┐ │ └───────────┘ - │ │ │ │Aggregate │ │ -┌───────────┐ │ │Process │ │ - mean │ │ ┌───────────┐ -│ │ │ │ - transform │ │ - quantiles │ │ │ │ -│ MySQL │───┼──▶ │ - decorate │────▶│ - min/max │───┼──▶│ File │ -│ │ │ │ - filter │ │ - count │ │ │ │ -└───────────┘ │ │ │ │ │ │ └───────────┘ - │ └─────────────┘ └─────────────┘ │ -┌───────────┐ │ │ ┌───────────┐ -│ │ │ │ │ │ -│ SNMP │───┤ └──▶│ Kafka │ -│ │ │ │ │ -└───────────┘ │ └───────────┘ - │ -┌───────────┐ │ -│ │ │ -│ Docker │───┘ -│ │ -└───────────┘ -``` +{{< diagram >}} + graph TD + Process[Process
- transform
- decorate
- filter] + Aggregate[Aggregate
- transform
- decorate
- filter] + + CPU --> Process + Memory --> Process + MySQL --> Process + SNMP --> Process + Docker --> Process + Process --> Aggregate + Aggregate --> InfluxDB + Aggregate --> File + Aggregate --> Kafka + +style Process text-align:left +style Aggregate text-align:left +{{< /diagram >}} **Processor plugins** process metrics as they pass through and immediately emit results based on the values they process. For example, this could be printing diff --git a/content/telegraf/v1.13/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.13/concepts/aggregator_processor_plugins.md index 5191b22ad..01ef1505e 100644 --- a/content/telegraf/v1.13/concepts/aggregator_processor_plugins.md +++ b/content/telegraf/v1.13/concepts/aggregator_processor_plugins.md @@ -10,37 +10,24 @@ menu: Besides the input plugins and output plugins, Telegraf includes aggregator and processor plugins, which are used to aggregate and process metrics as they pass through Telegraf. -``` -┌───────────┐ -│ │ -│ CPU │───┐ -│ │ │ -└───────────┘ │ - │ -┌───────────┐ │ ┌───────────┐ -│ │ │ │ │ -│ Memory │───┤ ┌──▶│ InfluxDB │ -│ │ │ │ │ │ -└───────────┘ │ ┌─────────────┐ ┌─────────────┐ │ └───────────┘ - │ │ │ │Aggregate │ │ -┌───────────┐ │ │Process │ │ - mean │ │ ┌───────────┐ -│ │ │ │ - transform │ │ - quantiles │ │ │ │ -│ MySQL │───┼──▶ │ - decorate │────▶│ - min/max │───┼──▶│ File │ -│ │ │ │ - filter │ │ - count │ │ │ │ -└───────────┘ │ │ │ │ │ │ └───────────┘ - │ └─────────────┘ └─────────────┘ │ -┌───────────┐ │ │ ┌───────────┐ -│ │ │ │ │ │ -│ SNMP │───┤ └──▶│ Kafka │ -│ │ │ │ │ -└───────────┘ │ └───────────┘ - │ -┌───────────┐ │ -│ │ │ -│ Docker │───┘ -│ │ -└───────────┘ -``` +{{< diagram >}} + graph TD + Process[Process
- transform
- decorate
- filter] + Aggregate[Aggregate
- transform
- decorate
- filter] + + CPU --> Process + Memory --> Process + MySQL --> Process + SNMP --> Process + Docker --> Process + Process --> Aggregate + Aggregate --> InfluxDB + Aggregate --> File + Aggregate --> Kafka + +style Process text-align:left +style Aggregate text-align:left +{{< /diagram >}} **Processor plugins** process metrics as they pass through and immediately emit results based on the values they process. For example, this could be printing diff --git a/content/telegraf/v1.14/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.14/concepts/aggregator_processor_plugins.md index 7c4936cc3..36dddf9f1 100644 --- a/content/telegraf/v1.14/concepts/aggregator_processor_plugins.md +++ b/content/telegraf/v1.14/concepts/aggregator_processor_plugins.md @@ -10,37 +10,24 @@ menu: Besides the input plugins and output plugins, Telegraf includes aggregator and processor plugins, which are used to aggregate and process metrics as they pass through Telegraf. -``` -┌───────────┐ -│ │ -│ CPU │───┐ -│ │ │ -└───────────┘ │ - │ -┌───────────┐ │ ┌───────────┐ -│ │ │ │ │ -│ Memory │───┤ ┌──▶│ InfluxDB │ -│ │ │ │ │ │ -└───────────┘ │ ┌─────────────┐ ┌─────────────┐ │ └───────────┘ - │ │ │ │Aggregate │ │ -┌───────────┐ │ │Process │ │ - mean │ │ ┌───────────┐ -│ │ │ │ - transform │ │ - quantiles │ │ │ │ -│ MySQL │───┼──▶ │ - decorate │────▶│ - min/max │───┼──▶│ File │ -│ │ │ │ - filter │ │ - count │ │ │ │ -└───────────┘ │ │ │ │ │ │ └───────────┘ - │ └─────────────┘ └─────────────┘ │ -┌───────────┐ │ │ ┌───────────┐ -│ │ │ │ │ │ -│ SNMP │───┤ └──▶│ Kafka │ -│ │ │ │ │ -└───────────┘ │ └───────────┘ - │ -┌───────────┐ │ -│ │ │ -│ Docker │───┘ -│ │ -└───────────┘ -``` +{{< diagram >}} + graph TD + Process[Process
- transform
- decorate
- filter] + Aggregate[Aggregate
- transform
- decorate
- filter] + + CPU --> Process + Memory --> Process + MySQL --> Process + SNMP --> Process + Docker --> Process + Process --> Aggregate + Aggregate --> InfluxDB + Aggregate --> File + Aggregate --> Kafka + +style Process text-align:left +style Aggregate text-align:left +{{< /diagram >}} **Processor plugins** process metrics as they pass through and immediately emit results based on the values they process. For example, this could be printing diff --git a/content/telegraf/v1.15/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.15/concepts/aggregator_processor_plugins.md index 3ab8ff0a4..e5072b111 100644 --- a/content/telegraf/v1.15/concepts/aggregator_processor_plugins.md +++ b/content/telegraf/v1.15/concepts/aggregator_processor_plugins.md @@ -10,37 +10,24 @@ menu: Besides the input plugins and output plugins, Telegraf includes aggregator and processor plugins, which are used to aggregate and process metrics as they pass through Telegraf. -``` -┌───────────┐ -│ │ -│ CPU │───┐ -│ │ │ -└───────────┘ │ - │ -┌───────────┐ │ ┌───────────┐ -│ │ │ │ │ -│ Memory │───┤ ┌──▶│ InfluxDB │ -│ │ │ │ │ │ -└───────────┘ │ ┌─────────────┐ ┌─────────────┐ │ └───────────┘ - │ │ │ │Aggregate │ │ -┌───────────┐ │ │Process │ │ - mean │ │ ┌───────────┐ -│ │ │ │ - transform │ │ - quantiles │ │ │ │ -│ MySQL │───┼──▶ │ - decorate │────▶│ - min/max │───┼──▶│ File │ -│ │ │ │ - filter │ │ - count │ │ │ │ -└───────────┘ │ │ │ │ │ │ └───────────┘ - │ └─────────────┘ └─────────────┘ │ -┌───────────┐ │ │ ┌───────────┐ -│ │ │ │ │ │ -│ SNMP │───┤ └──▶│ Kafka │ -│ │ │ │ │ -└───────────┘ │ └───────────┘ - │ -┌───────────┐ │ -│ │ │ -│ Docker │───┘ -│ │ -└───────────┘ -``` +{{< diagram >}} + graph TD + Process[Process
- transform
- decorate
- filter] + Aggregate[Aggregate
- transform
- decorate
- filter] + + CPU --> Process + Memory --> Process + MySQL --> Process + SNMP --> Process + Docker --> Process + Process --> Aggregate + Aggregate --> InfluxDB + Aggregate --> File + Aggregate --> Kafka + +style Process text-align:left +style Aggregate text-align:left +{{< /diagram >}} **Processor plugins** process metrics as they pass through and immediately emit results based on the values they process. For example, this could be printing diff --git a/content/telegraf/v1.16/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.16/concepts/aggregator_processor_plugins.md index bdbb02dd8..4bbcbdc21 100644 --- a/content/telegraf/v1.16/concepts/aggregator_processor_plugins.md +++ b/content/telegraf/v1.16/concepts/aggregator_processor_plugins.md @@ -10,37 +10,24 @@ menu: Besides the input plugins and output plugins, Telegraf includes aggregator and processor plugins, which are used to aggregate and process metrics as they pass through Telegraf. -``` -┌───────────┐ -│ │ -│ CPU │───┐ -│ │ │ -└───────────┘ │ - │ -┌───────────┐ │ ┌───────────┐ -│ │ │ │ │ -│ Memory │───┤ ┌──▶│ InfluxDB │ -│ │ │ │ │ │ -└───────────┘ │ ┌─────────────┐ ┌─────────────┐ │ └───────────┘ - │ │ │ │Aggregate │ │ -┌───────────┐ │ │Process │ │ - mean │ │ ┌───────────┐ -│ │ │ │ - transform │ │ - quantiles │ │ │ │ -│ MySQL │───┼──▶ │ - decorate │────▶│ - min/max │───┼──▶│ File │ -│ │ │ │ - filter │ │ - count │ │ │ │ -└───────────┘ │ │ │ │ │ │ └───────────┘ - │ └─────────────┘ └─────────────┘ │ -┌───────────┐ │ │ ┌───────────┐ -│ │ │ │ │ │ -│ SNMP │───┤ └──▶│ Kafka │ -│ │ │ │ │ -└───────────┘ │ └───────────┘ - │ -┌───────────┐ │ -│ │ │ -│ Docker │───┘ -│ │ -└───────────┘ -``` +{{< diagram >}} + graph TD + Process[Process
- transform
- decorate
- filter] + Aggregate[Aggregate
- transform
- decorate
- filter] + + CPU --> Process + Memory --> Process + MySQL --> Process + SNMP --> Process + Docker --> Process + Process --> Aggregate + Aggregate --> InfluxDB + Aggregate --> File + Aggregate --> Kafka + +style Process text-align:left +style Aggregate text-align:left +{{< /diagram >}} **Processor plugins** process metrics as they pass through and immediately emit results based on the values they process. For example, this could be printing diff --git a/content/telegraf/v1.17/_index.md b/content/telegraf/v1.17/_index.md new file mode 100644 index 000000000..e33bcbb68 --- /dev/null +++ b/content/telegraf/v1.17/_index.md @@ -0,0 +1,25 @@ +--- +title: Telegraf 1.17 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_17: + name: Telegraf v1.17 +weight: 1 +--- + +Telegraf is a plugin-driven server agent for collecting & reporting metrics, +and is the first piece of the [TICK stack](https://influxdata.com/time-series-platform/). +Telegraf has plugins to source a variety of metrics directly from the system it's running on, pull metrics from third party APIs, or even listen for metrics via a statsd and Kafka consumer services. +It also has output plugins to send metrics to a variety of other datastores, services, and message queues, including InfluxDB, Graphite, OpenTSDB, Datadog, Librato, Kafka, MQTT, NSQ, and many others. + +## Key features + +Here are some of the features that Telegraf currently supports that make it a great choice for metrics collection. + +* Written entirely in Go. +It compiles into a single binary with no external dependencies. +* Minimal memory footprint. +* Plugin system allows new inputs and outputs to be easily added. +* A wide number of plugins for many popular services already exist for well known services and APIs. diff --git a/content/telegraf/v1.17/about_the_project/_index.md b/content/telegraf/v1.17/about_the_project/_index.md new file mode 100644 index 000000000..648228a0b --- /dev/null +++ b/content/telegraf/v1.17/about_the_project/_index.md @@ -0,0 +1,27 @@ +--- + title: About the Telegraf project +description: Release notes, contribution guidelines, CLA, and license for the Telegraf project. +menu: + telegraf_1_17: + name: About the project + weight: 10 +--- + +## Telegraf release notes +View the [Telegraf release notes](/telegraf/v1.17/about_the_project/release-notes-changelog/) +for important information about new versions of Telegraf. + +## Contributions and licenses +- [Contribute to Telegraf](https://github.com/influxdata/telegraf/blob/master/CONTRIBUTING.md) +- [Contributor License Agreement (CLA)](https://influxdata.com/community/cla/) +- [License](https://github.com/influxdata/telegraf/blob/master/LICENSE) + +## Third party software +InfluxData products contain third party software, which means the copyrighted, patented, or otherwise legally protected +software of third parties that is incorporated in InfluxData products. + +Third party suppliers make no representation nor warranty with respect to such third party software or any portion thereof. +Third party suppliers assume no liability for any claim that might arise with respect to such third party software, nor for a +customer’s use of or inability to use the third party software. + +The [list of third party software components, including references to associated licenses and other materials](https://github.com/influxdata/telegraf/blob/release-1.15/docs/LICENSE_OF_DEPENDENCIES.md), is maintained on a version by version basis. diff --git a/content/telegraf/v1.17/about_the_project/cla.md b/content/telegraf/v1.17/about_the_project/cla.md new file mode 100644 index 000000000..99c6c0898 --- /dev/null +++ b/content/telegraf/v1.17/about_the_project/cla.md @@ -0,0 +1,10 @@ +--- +title: InfluxData Contributor License Agreement (CLA) + +menu: + telegraf_1_17: + name: Contributor License Agreement (CLA) + parent: About the project + weight: 30 + url: https://influxdata.com/community/cla/ +--- diff --git a/content/telegraf/v1.17/about_the_project/contributing.md b/content/telegraf/v1.17/about_the_project/contributing.md new file mode 100644 index 000000000..60ac15e80 --- /dev/null +++ b/content/telegraf/v1.17/about_the_project/contributing.md @@ -0,0 +1,10 @@ +--- + title: Contributing to Telegraf + + menu: + telegraf_1_17: + name: Contributing + parent: About the project + weight: 20 + url: https://github.com/influxdata/telegraf/blob/master/CONTRIBUTING.md +--- diff --git a/content/telegraf/v1.17/about_the_project/license.md b/content/telegraf/v1.17/about_the_project/license.md new file mode 100644 index 000000000..a700db1c1 --- /dev/null +++ b/content/telegraf/v1.17/about_the_project/license.md @@ -0,0 +1,10 @@ +--- + title: License + + menu: + telegraf_1_17: + name: License + parent: About the project + weight: 40 + url: https://github.com/influxdata/telegraf/blob/master/LICENSE +--- diff --git a/content/telegraf/v1.17/about_the_project/release-notes-changelog.md b/content/telegraf/v1.17/about_the_project/release-notes-changelog.md new file mode 100644 index 000000000..db16bcf94 --- /dev/null +++ b/content/telegraf/v1.17/about_the_project/release-notes-changelog.md @@ -0,0 +1,2729 @@ +--- +title: Telegraf 1.17 release notes +description: Important features and changes in the latest version of Telegraf. +menu: + telegraf_1_17: + name: Release notes + weight: 10 + parent: About the project +--- +## v1.17.0 [2020-12-17] + +### Features +- Update Go to 1.15.5. +- Added support for Linux/ppc64le. + +### New plugins + +#### Inputs + +- [Intel Powerstat](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/intel_powerstat/README.md)(`intel_powerstat`) +- [Riemann Listener](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/riemann_listener/README.md)(`riemann`) + +#### Outputs + +- [Logz.io](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/logzio/README.md)(`logzio`) +- [Yandex Cloud Monitoring](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/yandex_cloud_monitoring/README.md)(`yandex_cloud_monitoring`) + +#### Output data formats (serializers) + +- [Prometheus Remote Write](https://github.com/influxdata/telegraf/blob/master/plugins/serializers/prometheusremotewrite/README.md)(`prometheusremotewrite`) + +#### Parsers + +- [Prometheus](https://github.com/influxdata/telegraf/blob/master/plugins/parsers/prometheus/README.md)(`prometheus`) + +### Input plugin updates + +- `aerospike`: Fix edge case where unexpected hex string was converted to integer if all digits. +- `bcache`: Fix tests for Windows. +- `bind`: Add configurable timeout. +- `carbon2`: Fix tests. +- `ecs`: Remove duplicated field from `ecs_task`. +- `execd`: Add support for new lines in line protocol fields. +- `github`: Add query of pull request statistics. +- `graphite`: Parse tags. +- `http`: Add proxy support. +- `http_response`: Fix network test. +- `jenkins`: Add build number field to `jenkins_job` measurement. +- `kafka_consumer`: Enable `ztsd` compression and idempotent writes. +- `kube_inventory`: + - Fix issue with missing metrics when pod has only pending containers. + - Update string parsing of allocatable cpu cores. +- `modbus`: Add FLOAT64-IEEE support. +- `monit`: Add `response_time`. +- `mysql`: Add per user metrics. +- `mqtt_consumer`: Fix issue with concurrent map write. +- `opcua`Add node groups. +- `ping`: + - Add percentiles. + - Fix potential issue with race condition. +- `snmp`: + - Add support for converting hex strings to integers. + - Translate field values. +- `socket_listener`: Fix crash when receiving invalid data. +- `sqlserver`: + - Add tags for monitoring readable secondaries for Azure SQL MI. + - Add SQL Server HA/DR Availability Group queries. + - Remove duplicate column (`session_db_name`). + - Add column `measurement_db_type` to output of all queries if not empty. +- `statsd`: Add configurable Max TTL duration. +- `vsphere`: Fix spelling of datacenter check. +- `win_services`: Add Glob pattern matching. +- `zfs`: Add dataset metrics. + +### Output plugin updates + +- `kafka`: Enable `ztsd` compression and idempotent writes. +- `nats`: Add `name` parameter. + +### Processor plugin updates + +- `starlark`: Can now store state between runs using a global state variable. + +## v1.16.3 [2020-12-01] + +### Features +- Update `godirwalk` to 1.16.1 for Dragonfly BSD support. + +### Input plugin updates +- APCUPSD (`apcupsd`): Add driver and CUDA version. +- CSV Parser (`csv`): Fix issue where CSV timestamp was being read as Unix instead of Go reference time. +- gNMI (`gnmi`): Add logging of `SubscribeResponse_Error` response types. + +- NVIDIA SMI (`nvidia_smi`): Add driver and CUDA version. +- PHP-FPM (`phpfpm`): Fix issue with "index out of range" error. +- SQL Server (`sqlserver`): Fix typo in `database_name` column. + +### Output plugin updates +- Wavefront (`wavefront`): + - Distinguish between retryable and non-retryable errors . + - Add debug-level logging for metric data that is not retryable. + +### Parser plugin updates +- Starlark (`starlark`): + - Allow the processor to manage errors that occur in the `apply` function. + - Add support for logging. + - Add capability to return multiple metrics. + +## v1.16.2 [2020-11-13] + +### Input plugin updates + +- CSV Parser (`csv`): Fix parsing multiple CSV files with different headers. +- DC/OS (`dcos`): Fix high-severity vulnerability in previous version of the `jwt-go` library. +- gNMI (`gnmi`): Add support for bytes encoding for gNMI messages. +- Proxmox ( `proxmox`): + - Fix a few issues with error reporting. + - Now ignores QEMU templates. +- RAS (`ras`): Fix tests failing on some systems. +- Redfish (`redfish`): Fix a parsing issue. +- SMART (`smart`): Fix an issue to recognize all devices from the configuration. +- SQL Server (`sqlserver`): Fix an issue with errors in on-premise instance queries. +- Systemd Units (`systemd_units`): Add `--plain` to the command invocation to fix an issue for reporting errors for units not found. +- vSphere (`vsphere`) + - Fix to how metrics were counted. + - Fix to metrics being skipped under in certain specific circumstances. + +### Output plugin updates + +- Dynatrace (`dynatrace`): Fix pushing metrics to separate Dynatrace environments. +- Wavefront (`wavefront`): Add `immediate_flush` tag. + +## v1.16.1 [2020-10-28] + +### Input plugin updates + +- Apache Kafka Consumer (`kafka_consumer`): Add Kafka SASL-mechanism authentication support for SCRAM-SHA-256, SCRAM-SHA-512, and GSSAPI. +- Microsoft SQL Server (`sqlserver`): + - Fix a syntax error in Azure queries. + - Remove synthetic performance counters that no longer exist from the `sqlserver_performance_counters` measurement. + - Add a new tag (`sql_version_desc`) to identify the readable SQL Server version. +- RAS (`ras`): + - Disable on specific Linux architectures (MIPS64, mips64le, ppc64le, riscv64). + - Fix an issue to properly close file handlers. +- Processes (`processes`): Fix an issue with receiving `no such file or directory` stat error. +- Windows Performance Counters (`win_perf_counters`): Fix an issue with the counter where a negative denominator error would cause gathering operations to fail. + +### Output plugin updates + +- Apache Kafka (`kafka`): Add Kafka SASL-mechanism authentication support for SCRAM-SHA-256, SCRAM-SHA-512, GSSAPI. + +## v1.16.0 [2020-10-21] + +### New plugins + +#### Inputs + +- [InfluxDB v2 Listener Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/influxdb_v2_listener/README.md)(`influxdb_v2_listener`) - Contributed by [@magichair](https://github.com/magichair) +- [Intel RDT Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/intel_rdt/README.md)(`intel_rdt`) - Contributed by [@p-zak](https://github.com/p-zak) +- [NSD Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/nsd/README.md)(`nsd`) - Contributed by [@gearnode](https://github.com/gearnode) +- [OPC UA Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/opcua/README.md)(`opcua`) - Contributed by [@influxdata](https://github.com/influxdata) +- [Proxmox Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/proxmox/README.md)(`proxmox`) - Contributed by [@effitient](https://github.com/effitient) +- [RAS Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/ras/README.md)(`ras`)- Contributed by [@p-zak](https://github.com/p-zak) +- [Windows Eventlog Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/win_eventlog/README.md)(`win_eventlog`) - Contributed by [@simnv](https://github.com/simnv) + +#### Outputs + +- [Dynatrace Output Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/dynatrace/README.md)(`dynatrace`) - Contributed by [@thschue](https://github.com/theschue) +- [Sumo Logic Output Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/sumologic/README.md) (`sumologic`) - Contributed by [@pmalek-sumo](https://github.com/pmalek-sumo) +- [Timestream Output Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/timestream) (`timestream`) - Contributed by [@piotrwest](https://github.com/piotrwest) + + +#### External + +- [Amazon Cloudwatch Alarms Input Plugin](https://github.com/vipinvkmenon/awsalarms)(`awsalarms`) - Contributed by [@vipinvkmenon](https://github.com/vipinvkmenon) +- [YouTube Input Plugin](https://github.com/inabagumi/youtube-telegraf-plugin)(`youtube`) - Contrbuted by [@inabagumi](https://github.com/inabagumi) +- [Octoprint Input Plugin](https://github.com/BattleBas/octoprint-telegraf-plugin)[`octoprint`] - Contributed by [@BattleBas](https://github.com/battlebas) +- [Systemd Timings Input Plugin](https://github.com/pdmorrow/telegraf-execd-systemd-timings)(`systemd-timings`) - Contributed by [@pdmorrow](https://github.com/pdmorrow) + + +### Input plugin updates + +- `aerospike`: Add set and histogram reporting. +- `agent`: + - Send metrics in FIFO order. + - Fix issue with `execd restart_delay` being ignored. + - Sort plugin name lists for output. +- `clickhouse`: Add additional metrics. +- `cloudwatch`: Implement AWS CloudWatch Input Plugin ListMetrics API calls to use Active Metric Filter. +- `consul`: Add `metric_version` flag. +- `docker`: Fix vulnerabilities found in BDBA scan. +- `execd`: Fix issue with `restart_delay` being ignored. +- `gnmi`: Next message after send returns EOF. +- `http_listener_v2`: Make header tags case-insensitive. +- `http_response`: Match on status code. +- `jenkins`: Multiple escaping occurs on at certain folder depth. +- `kubernetes`: Add missing error check for HTTP requirement failure. +- `modbus`: Extend support of fixed point values on input. +- `mongodb`: Add pages written from cache metric. +- `net`: Fix broken link to `proc.c`. +- `snmp` Add agent host tag configuration option. +- `smart`: Add missing NVMe attributes. +- `sqlserver`: + - Database_type config to Split up sql queries by engine type + - Fixed query mapping + - New refactoring and formatting queries. + - Add more performance counters. +- `tail`: + - Close file to ensure it has been flushed. + - Fix following on EOF. + +### Output plugin updates + +- `elasticsearch`: Added `force_document_id` option to ES output enable resend data and avoid duplicated ES documents. +- `opentsdb`: Skips NaN and Inf JSON values. + +### Processor plugin updates + +- `execd`: Increased the maximum serialized metric size in line protocol +- `ifname`: Add `addTag` debugging. +- `starlark`: Add JSON parsing support. + +### Bug fixes + +- Fix `darwin` package build flags. +- `shim`: + - Fix bug with loading plugins with no config. + - Logger improvements. + - Fix issue with loading processor config from `execd`. +- Initialize aggregation processors. +- Fix arch name in `deb/rpm` builds. +- Fix issue with `rpm /var/log/telegraf` permissions +- Fix `docker-image make` target. +- Remove Event field from `serializers.splunkmetric`. +- Fix panic on streaming processors using logging +- `ParseError.Error` panic in `parsers.influx` +- Fix `procstat` performance regression +- Fix serialization when using `carbon2`. +- Fix bugs found by LGTM analysis platform. +- Update to Go 1.15.2 + +## v.1.15.3 [2020-09-11] + +### Features +- `processors.starlark`: + - Improve the quality of docs by executing them as tests. + - Add pivot example. +- `outputs.application_insights`: Added ability to set endpoint url. +- `inputs.sqlserver`: Added new counter - Lock Timeouts (timeout > 0)/sec. + +### Bug fixes + +- `agent`: Fix minor error message race condition. +- `build`: Update dockerfiles to Go 1.14. +- `shim`: + - Fix bug in logger affecting `AddError`. + - Fix issue with `config.Duration`. +- `inputs.eventhub_consumer`: Fix string to int conversion. +- `inputs.http_listener_v2`: Make http header tags case-insensitive. +- `inputs.modbus`: Extend support of fixed point values. +- `inputs.ping`: Fix issue for FreeBSD's ping6. +- `inputs.vsphere`: Fixed missing cluster name. +- `outputs.opentsdb` Fix JSON handling of values `NaN` and `Inf`. + +## v1.15.2 [2020-07-31] + +### Bug Fixes +- Fix RPM `/var/log/telegraf` permissions. +- Fix tail following on EOF. + +## v1.15.1 [2020-07-22] + +### Bug fixes + +- Fix architecture in non-amd64 deb and rpm packages. + +## v1.15.0 [2020-07-22] + +{{% warn %}} +Critical bug that impacted non-amd64 packages was introduced in 1.15.0. **Do not install this release.** Instead, install 1.15.1, which includes the features, new plugins, and bug fixes below. +{{% /warn %}} + +### Breaking changes + +Breaking changes are updates that may cause Telegraf plugins to fail or function incorrectly. If you have one of the following plugins installed, make sure to update your plugin as needed: + +- **Logparser** (`logparser`) input plugin: Deprecated. Use the `tail` input with `data_format = "grok"` as a replacement. +- **Cisco GNMI Telemetry** (`cisco_telemetry_gnmi`) input plugin: Renamed to `gnmi` to better reflect its general support for gNMI devices. +- **Splunkmetric** (`splunkmetric`) serializer: Several fields used primarily for debugging have been removed. If you are making use of these fields, they can be added back with the `tag` option. + +### New plugins + +#### Inputs + +- [NGINX Stream STS Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/nginx_sts/README.md)(`nginx_sts`) - Contributed by [@zdmytriv](https://github.com/zdmytriv) +- [Redfish Input Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/redfish/README.md)(`redfish`) - Contributed by [@sarvanikonda](https://github.com/sarvanikonda) + +#### Outputs + +- [Execd Output Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/execd/README.md)(`execd`) - Contributed by [@influxdata](https://github.com/influxdata) +- [New Relic Output Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/newrelic/README.md)(`newrelic`) - Contributed by [@hsingkalsi](https://github.com/hsingkalsi) + +#### Processors + +- [Defaults Processor Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/processors/defaults/README.md)(`defaults`) - Contributed by [@jregistr](https://github.com/jregistr) +- [Execd Processor Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/processors/execd/README.md)(`execd`) - Contributed by [@influxdata](https://github.com/influxdata) +- [Filepath Processor Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/processors/filepath/README.md)(`filepath`) - Contributed by [@kir4h](https://github.com/kir4h) +- [Network Interface Name Processor Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/processors/ifname/README.md)(`ifname`) - Contributed by [@influxdata](https://github.com/influxdata) +- [Port Name Processor Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/processors/port_name/README.md)(`port_name`) - Contributed by [@influxdata](https://github.com/influxdata) +- [Reverse DNS Processor Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/processors/reverse_DNS/README.md)(`reverse_dns`) - Contributed by [@influxdata](https://github.com/influxdata) +- [Starlark Processor Plugin](https://github.com/influxdata/telegraf/blob/master/plugins/processors/starlark/README.md)(`starlark`) - Contributed by [@influxdata](https://github.com/influxdata) + +### Features + +- Telegraf's `--test` mode runs processors and aggregators before printing metrics. +- Official packages built with Go 1.14.5. +- When updating the Debian package, you will no longer be prompted to merge the `telegraf.conf` file. Instead, the new version will be installed to `/etc/telegraf/telegraf.conf.sample`. The `tar` and `zip` packages now include the version in the top-level directory. +- Allow per input overriding of `collection_jitter` and `precision`. +- Deploy Telegraf configuration as `telegraf.conf.sample`. +- Use Docker log timestamp as metric time. +- Apply ping deadline to DNS lookup. +- Support multiple templates for graphite serializers. +- Add configurable separator graphite serializer and output. +- Add support for SIGUSR1 to trigger flush. +- Add support for once mode that writes to outputs and exits. +- Run processors and aggregators during test mode. +- Add timezone configuration to CSV parser. + + +#### Input plugin updates + +- **Ceph Storage** (`ceph`): Add support for MDS and RGW sockets. +- **ECS** (`ecs`): Add v3 metadata support. +- **Fibaro** (`fibaro`): Add support for battery-level monitoring. +- **File** (`file`): + - Support UTF-16. + - Exclude `csv_timestamp_column` and `csv_measurement_column` from fields. +- **HTTP** (`http`): Add reading bearer token. +- **HTTP Listener v2** (`http_listener_v2`): Add ability to specify HTTP headers as tags. +- **HTTP Response** (`http_response`): + - Add authentication support. + - Allow collection of HTTP headers. + - Add ability to collect response body as field. +- **Icinga 2** (`icinga2`): + - Fix source field. + - Add tag for server hostname. +- **InfluxDB Listener** (`influxdb_listener`): Add option to save retention policy as tag. +- **IPtables** (`iptables`): Extract target as a tag for each rule. +- **Kibana** (`kibana`): Fix `json unmarshal` error. +- **Kubernetes Inventory** (`kube_inventory`): Add ability to add selectors as tags. +- **Mem** (`mem`): Add laundry on FreeBSD. +- **Microsoft SQL Server** (`sqlserver`): + - Add `VolumeSpace` query. + - Add `cpu` query. + - Add counter type to `perfmon` collector. + - Improve compatibility with older server versions. + - Fix typo in `total_elapsed_time_ms` field. +- **Modbus** (`modbus`): + - Add support for 64-bit integer types. + - Add retry when replica is busy. + - Add ability to specify measurement per register. +- **MongoDB** (`monogdb`): + - Add commands stats. + - Add additional fields. + - Add cluster state integer. + - Add option to disable cluster status. + - Add additional conccurrent transaction information. +- **NVIDIA SMI** (`nvidia_smi`): Add video codec stats. +- **Procstat** (`procstat`): + - Improve performance. + - Fix memory leak. +- **S.M.A.R.T.** (`smart`): Add missing `nvme` attributes. +- **SNMP Trap** (`snmp_trap`): Add SNMPv3 trap support. +- **System** (`system`): Fix incorrect uptime when clock is adjusted. +- **Tail** (`tail`): Support UTF-16. + +#### Output plugin updates + +- **Enum** (`enum`): Add integer mapping support. + +#### Processor plugin updates + +- **Date** (`date`): + - Add field creation. + - Add integer unix time support. +- **Wavefront** (`wavefront`): Add `truncate_tags` setting. + + +### Bug fixes +- Fix ability to write metrics to CloudWatch with IMDSv1 disabled. +- Fix vSphere 6.7 missing data issue. +- Fix gzip support in `socket_listener` with tcp sockets. +- Fix interval drift when `round_interval` is set in agent. +- Fix incorrect uptime when clock is adjusted. +- Remove trailing backslash from tag keys/values in `influx` serializer. +- Fix incorrect Azure SQL DB server properties. +- Send metrics in FIFO order. + +## v1.14.5 [2020-06-30] + +### Bug fixes + +- Improve the performance of the `procstat` input. +- Fix ping exit code handling on non-Linux operating systems. +- Fix errors in output of the `sensors` command. +- Prevent startup when tags have incorrect type in configuration file. +- Fix panic with GJSON multiselect query in JSON parser. +- Allow any key usage type on x509 certificate. +- Allow histograms and summary types without buckets or quantiles in `prometheus_client` output. + +## v1.14.4 [2020-06-09] + +### Bug fixes + +- Fix the `cannot insert the value NULL` error with the `PerformanceCounters` query in the `sqlServer` input plugin. +- Fix a typo in the naming of `the gc_cpu_fraction` field in the `influxdb` input plugin. +- Fix a numeric to bool conversion in the `converter` processor. +- Fix an issue with the `influx` stream parser blocking when the data is in buffer. + +## v1.14.3 [2020-05-19] + +### Bug fixes + +- Use same timestamp for all objects in arrays in the `json` parser. +- Handle multiple metrics with the same timestamp in `dedup` processor. +- Fix reconnection of timed out HTTP2 connections `influxdb` outputs. +- Fix negative value parsing in `impi_sensor` input. + +## v1.14.2 [2020-04-28] + +### Bug fixes + +- Trim white space from instance tag in `sqlserver` input . +- Use increased AWS Cloudwatch GetMetricData limit of 500 metrics per call. +- Fix limit on dimensions in `azure_monitor` output. +- Fix 64-bit integer to string conversion in `snmp` input. +- Fix shard indices reporting in `elasticsearch` input plugin. +- Ignore fields with Not a Number or Infinity floats in the JSON serializer. +- Fix typo in name of `gc_cpu_fraction` field of the `kapacitor` input. +- Don't retry create database when using database_tag if forbidden by the server in `influxdb` output. +- Allow CR and FF inside of string fields in InfluxDB line protocol parser. + +## v1.14.1 [2020-04-14] + +### Bug fixes + +- Fix `PerformanceCounter` query performance degradation in `sqlserver` input. +- Fix error when using the `Name` field in template processor. +- Fix export timestamp not working for Prometheus on v2. +- Fix exclude database and retention policy tags. +- Fix status path when using globs in `phpfpm`. + +## v1.14 [2020-03-26] + +### Breaking changes + +Breaking changes are updates that may cause Telegraf plugins to fail or function incorrectly. If you have one of the following plugins installed, make sure to update your plugin as needed: + +- **Microsoft SQL Server** (`sqlserver`) input plugin: Renamed the `sqlserver_azurestats` measurement to `sqlserver_azure_db_resource_stats` to resolve an issue where numeric metrics were previously being reported incorrectly as strings. +- **Date** (`date`) processor plugin: Now uses the UTC timezone when creating its tag. Previously, the local time was used. + +{{% note %}} +Support for SSL v3.0 is deprecated in this release. +Telegraf now uses the [Go TLS library](https://golang.org/pkg/crypto/tls/). +{{% /note %}} + +### New plugins + +#### Inputs + +- [Arista LANZ Consumer](https://github.com/influxdata/telegraf/blob/release-1.14/plugins/inputs/lanz/README.md) - Contributed by [@timhughes](https://github.com/timhughes) +- [ClickHouse](https://github.com/influxdata/telegraf/blob/release-1.14/plugins/inputs/clickhouse/README.md)(`clickhouse`) - Contributed by [@kshvakov](https://github.com/kshvakov) +- [Execd](https://github.com/influxdata/telegraf/blob/release-1.14/plugins/inputs/execd/README.md)(`execd`) - Contributed by [@jgraichen](https://github.com/jgraichen) +- [Event Hub Consumer](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/eventhub_consumer/README.md)(`eventhub_consumer`) - Contributed by [@R290](https://github.com/R290) +- [InfiniBand](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/infiniband/README.md)(`infiniband`) - Contributed by [@willfurnell](https://github.com/willfurnell) +- [Modbus](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/modbus/README.md)(`modbus`) - Contributed by [@garciaolais](https://github.com/garciaolais) +- [Monit](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/monit/README.md)(`monit`) - Contributed by [@SirishaGopigiri](https://github.com/SirishaGopigiri) +- [SFlow](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/sflow/README.md)(`sflow`) - Contributed by [@influxdata](https://github.com/influxdata) +- [Wireguard](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/wireguard/README.md)(`wireguard`) - Contributed by [@LINKIWI](https://github.com/LINKIWI) + +#### Processors + +- [Dedup](https://github.com/influxdata/telegraf/blob/master/plugins/processors/dedup/README.md)(`dedup`) - Contributed by [@igomura](https://github.com/igomura) +- [S2 Geo](https://github.com/influxdata/telegraf/blob/master/plugins/processors/s2geo/README.md)(`s2geo`) - Contributed by [@alespour](https://github.com/alespour) +- [Template](https://github.com/influxdata/telegraf/blob/master/plugins/processors/template/README.md) (`template`) - Contributed by [@RobMalvern](https://github.com/RobMalvern) + +#### Outputs + +- [Warp10](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/warp10/README.md)(`warp10`) - Contributed by [@aurrelhebert](https://github.com/aurrelhebert) + +### Features + +#### Input plugin updates + +- **Apache Kafka Consumer** (`kafka_consumer`): Add SASL version control to support Microsoft Azure Event Hub. +- **Apcupsd** (`apcupsd`): Add new tag `model` and new metrics: `battery_date`, `nominal_input_voltage`, `nominal_battery_voltage`, `nominal_power`, `firmware`. +- **Cisco Model-driven Telemetry (MDT)** (`cisco_telemetry_gnmi`) input plugin: + - Add support for GNMI DecimalVal type. + - Replace dash (`-`) with underscore (`_`) when handling embedded tags. +- **DiskIO** (`diskio`): Add counters for merged reads and writes. +- **IPMI Sensor** (`ipmi_sensor`): Add `use_sudo` option. +- **Jenkins** (`jenkins`): + - Add `source` and `port` tags to `jenkins_job` metrics. + - Add new fields `total_executors` and `busy_executors`. +- **Kubernetes** (`kubernetes`): Add ability to collect pod labels. +- **Microsoft SQL Server** (`sqlserver`): + - Add RBPEX IO statistics to DatabaseIO query. + - Add space on disk for each file to DatabaseIO query. + - Calculate DB Name instead of GUID in `physical_db_name`. + - Add `DatabaseIO` TempDB per Azure DB. + - Add `query_include` option for explicitly including queries. + - Add `volume_mount_point` to DatabaseIO query. +- **MongoDB** (`mongodb`): + - Add `page_faults` for WiredTiger storage engine. + - Add latency statistics. + - Add replica set tag (`rs_name`). +- **NATS Consumer** (`nats_consumer`): Add support for credentials file. +- **NGINX Plus API** (`nginx_plus_api`): Add support for new endpoints. +- **OpenLDAP** (`openldap`): Add support for MDB database information. +- **PHP-FPM** (`phpfpm`): Allow globs in FPM unix socket paths (`unixsocket`). +- **Procstat** (`procstat`): Add process `created_at` time. +- **Prometheus** (`prometheus`) input plugin: Add `label` and `field` selectors for Kubernetes service discovery. +- **RabbitMQ** (`rabbitmq`): Add `slave_nodes` and `synchronized_slave_nodes` metrics. +- **StatsD** (`statsd`): Add UDP internal metrics. +- **Unbound** (`unbound`): Expose [`-c cfgfile` option of `unbound-control`](https://linux.die.net/man/8/unbound-control) and set the default unbound configuration (`config_file= "/etc/unbound/unbound.conf`) in the Telegraf configuration file. +- **VMware vSphere** (`vsphere`): Add option to exclude resources by inventory path, including `vm_exclude`, `host_exclude`, `cluster_exclude` (for both clusters and datastores), and `datacenter_exclude`. +- **X.509 Certificate** (`x509_cert`): Add `server_name` override. + +#### Output plugin updates + +- **Apache Kafka** (`kafka`): Add `topic_tag` and `exclude_topic_tag` options. +- **Graylog** (`graylog`): Allow a user defined field (`short_message_field`) to be used as the `GELF short_message`. +- **InfluxDB v1.x** (`influxdb`): Add support for setting the retention policy using a tag (`retention_policy_tag`). +- **NATS Output** (`nats`): Add support for credentials file. + +#### Aggregator plugin updates + +- **Histogram** (`histogram`): Add non-cumulative histogram. + +#### Processor plugin updates + +- **Converter** (`converter`): Add support for converting `tag` or `field` to `measurement`. +- **Date** (`date`): Add date offset and timezone options. +- **Strings** (`strings`): Add support for titlecase transformation. + +### Bug fixes + +- Fix Telegraf log rotation to use actual file size instead of bytes written. +- Fix internal Telegraf metrics to prevent output split into multiple lines. +- **Chrony** (`chrony`) input plugin: When plugin is enabled, search for `chronyc` only. +- **Microsoft SQL Server** (`sqlserver`) input plugin: + - Fix conversion to floats in AzureDBResourceStats query. + - Fix case sensitive collation. + - Fix several issues with DatabaseIO query. + - Fix schedulers query compatibility with pre SQL-2016. +- **InfluxDB Listener** (`influxdb_listener`): + - Fix request failing with EOF. + - Continue parsing after error. + - Set headers on ping URL. + +## v1.13.4 [2020-02-25] + +### Release Notes +Official packages now built with Go 1.13.8. + +### Bug fixes +- Parse NaN values from summary types in Prometheus (`prometheus`) input plugin. +- Fix PgBouncer (`pgbouncer`) input plugin when used with newer PgBouncer versions. +- Support up to 8192 stats in the Ethtool (`ethtool`) input plugin. +- Fix performance counters collection on named instances in Microsoft SQL Server (`sqlserver`) input plugin. +- Use add time for Prometheus expiration calculation. +- Fix inconsistency with input error counting in Telegraf v1.x (`internal`) input plugin. +- Use the same timestamp per call if no time is provided in Prometheus (`prometheus`) input plugin. + +## v1.13.3 [2020-02-04] + +### Bug fixes + +- Update Kibana (`kibana`) input plugin to support Kibana 6.4 and later. +- Prevent duplicate `TrackingIDs` from being returned in the following queue consumer input plugins: + - Amazon Kineses Consumer (`kinesis_consumer`) + - AMQP Consumer (`amqp_consumer`) + - Apache Consumer (`apache_consumer`) + - MQTT Consumer (`mqtt_consumer`) + - NATS Consumer (`nats_consumer`) + - NSQ Consumer (`nsq_consumer`) +- Increase support for up to 4096 statistics in the Ethtool (`ethtool`) input plugin. +- Remove expired metrics from the Prometheus Client (`prometheus_client`) output plugin. Previously, expired metrics were only removed when new metrics were added. + +## v1.13.2 [2020-01-21] + +### Bug fixes + +- Warn without error when Processes (`processes`) input is started on Windows. +- Only parse certificate blocks in X.509 Certificate (`x509_cert`) input plugin. +- Add custom attributes for all resource types in VMware vSphere (`vsphere`) input plugin. +- Support URL agent address form with UDP in SNMP (`snmp`) input plugin. +- Record device fields in the SMART (`smart`) input plugin when attributes is `false`. +- Remove invalid timestamps from Kafka messages. +- Update `json` parser to fix `json_strict` option and set `default` to `true`. + +## v1.13.1 [2020-01-08] + +### Bug fixes +- Fix ServerProperty query stops working on Azure after failover. +- Add leading period to OID in SNMP v1 generic traps. +- Fix missing config fields in prometheus serializer. +- Fix panic on connection loss with undelivered messages in MQTT Consumer + (`mqtt_consumer`) input plugin. +- Encode query hash fields as hex strings in SQL Server (`sqlserver`) input plugin. +- Invalidate diskio cache if the metadata mtime has changed. +- Show platform not supported warning only on plugin creation. +- Fix rabbitmq cannot complete gather after request error. +- Fix `/sbin/init --version` executed on Telegraf startup. +- Use last path element as field key if path fully specified in Cisco GNMI Telemetry + (`cisco_telemetry_gnmi`) input plugin. + +## v1.13 [2019-12-12] + +### Release Notes +Official packages built with Go 1.13.5. +The Prometheus Format (`prometheus`) input plugin and Prometheus Client (`prometheus_client`) +output have a new mapping to and from Telegraf metrics, which can be enabled by setting `metric_version = 2`. +The original mapping is deprecated. When both plugins have the same setting, +passthrough metrics are unchanged. +Refer to the [Prometheus input plugin](https://github.com/influxdata/telegraf/blob/release-1.13/plugins/inputs/prometheus/README.md) +for details about the mapping. + +### New Inputs +- [Azure Storage Queue](https://github.com/influxdata/telegraf/blob/release-1.13/plugins/inputs/azure_storage_queue/README.md) + (`azure_storage_queue`) - Contributed by [@mjiderhamn](https://github.com/mjiderhamn) +- [Ethtool](https://github.com/influxdata/telegraf/blob/release-1.13/plugins/inputs/ethtool/README.md) + (`ethtool`) - Contributed by [@philippreston](https://github.com/philippreston) +- [SNMP Trap](https://github.com/influxdata/telegraf/blob/release-1.13/plugins/inputs/snmp_trap/README.md) + (`snmp_trap`) - Contributed by [@influxdata](https://github.com/influxdata) +- [Suricata](https://github.com/influxdata/telegraf/blob/release-1.13/plugins/inputs/suricata/README.md) + (`suricata`) - Contributed by [@satta](https://github.com/satta) +- [Synproxy](https://github.com/influxdata/telegraf/blob/release-1.13/plugins/inputs/synproxy/README.md) + (`synproxy`) - Contributed by [@rfrenayworldstream](https://github.com/rfrenayworldstream) +- [Systemd Units](https://github.com/influxdata/telegraf/blob/release-1.13/plugins/inputs/systemd_units/README.md) + (`systemd_units`) - Contributed by [@benschweizer](https://github.com/benschweizer) + +### New Processors +- [Clone](https://github.com/influxdata/telegraf/blob/release-1.13/plugins/processors/clone/README.md) + (`clone`) - Contributed by [@adrianlzt](https://github.com/adrianlzt) + +### New Aggregators +- [Merge](https://github.com/influxdata/telegraf/blob/release-1.13/plugins/aggregators/merge/README.md) + (`merge`) - Contributed by [@influxdata](https://github.com/influxdata) + +### Features +- Add per node memory stats to RabbitMQ (`rabbitmq`) input plugin. +- Add ability to read query from file to PostgreSQL (`postgresql_extensible`) input plugin. +- Add replication metrics to the Redis (`redis`) input plugin. +- Support NX-OS telemetry extensions in Cisco Model-driven Telemetry (`cisco_telemetry_mdt`) + input plugin. +- Allow `graphite` parser to create `Inf` and `NaN` values. +- Use prefix base detection for ints in `grok` parser. +- Add more performance counter metrics to Microsoft SQL Server (`sqlserver`) input plugin. +- Add millisecond unix time support to `grok` parser. +- Add container ID as optional source tag to Docker (`docker`) and Docker Log + (`docker_log`) input plugins. +- Add `lang` parameter to OpenWeatherMap (`openweathermap`) input plugin. +- Log file open errors at debug level in Tail (`tail`) input plugin. +- Add timeout option to Amazon CloudWatch (`cloudwatch`) input plugin. +- Support custom success codes in HTTP (`http`) input plugin. +- Improve IPVS (`ipvs`) input plugin error strings and logging. +- Add strict mode to JSON parser that can be disabled to ignore invalid items. +- Add support for Kubernetes 1.16 and remove deprecated API usage. +- Add gathering of RabbitMQ federation link metrics. +- Add bearer token defaults for Kubernetes plugins. +- Add support for SNMP over TCP. +- Add support for per output flush jitter. +- Add a nameable file tag to File (`file`) input plugin. +- Add Splunk MultiMetric support. +- Add support for sending HTTP Basic Auth in InfluxDB (`influxdb`) input plugin. +- Add ability to configure the url tag in the Prometheus Format (`prometheus`) input plugin. +- Add Prometheus `metric_version=2` mapping to internal metrics/line protocol. +- Add Prometheus `metric_version=2` support to Prometheus Client (`prometheus_client`) output plugin. +- Add content_encoding compression support to Socket Listener (`socket_listener`) input plugin. +- Add high resolution metrics support to Amazon CloudWatch (`cloudwatch`) output plugin. +- Add `SReclaimable` and `SUnreclaim ` to Memory (`mem`) input plugin. +- Allow multiple certificates per file in X.509 Certificate (`x509_cert`) input plugin. +- Add additional tags to the X.509 Certificate (`x509_cert`) input plugin. +- Add batch data format support to File (`file`) output plugin. +- Support partition assignment strategy configuration in Apache Kafka Consumer + (`kafka_consumer`) input plugin. +- Add node type tag to MongoDB (`mongodb`) input plugin. +- Add `uptime_ns` field to MongoDB (`mongodb`) input plugin. +- Support resolution of symlinks in Filecount (`filecount`) input plugin. +- Set message timestamp to the metric time in Apache Kafka (`kafka`) output plugin. +- Add base64decode operation to String (`string`) processor. +- Add option to control collecting global variables to MySQL (`mysql`) input plugin. + +### Bug fixes +- Show correct default settings in MySQL (`mysql`) sample configuration. +- Use `1h` or `3h` rain values as appropriate in OpenWeatherMap (`openweathermap`) input plugin. +- Fix `not a valid field` error in Windows with Nvidia SMI (`nvidia_smi`) input plugin. +- Fix InfluxDB (`influxdb`) output serialization on connection closed. +- Fix ping skips remaining hosts after DNS lookup error. +- Log MongoDB oplog auth errors at debug level. +- Remove trailing underscore trimming from json flattener. +- Revert change causing CPU usage to be capped at 100 percent. +- Accept any media type in the Prometheus Format (`prometheus`) input plugin. +- Fix unix socket dial arguments in uWSGI (`uwsgi`) input plugin. +- Replace colon characters in Prometheus (`prometheus_client`) output labels with `metric_version=1`. +- Set TrimLeadingSpace when TrimSpace is on in CSV (`csv`) parser. + +## v1.12.6 [2019-11-19] + +### Bug fixes +- Fix many plugin errors logged at debug logging level. +- Use nanosecond precision in Docker Log (`docker_log`) input plugin. +- Fix interface option with `method = native` in Ping (`ping`) input plugin. +- Fix panic in MongoDB (`mongodb`) input plugin if shard connection pool stats are unreadable. + +## v1.12.5 [2019-11-12] + +### Bug fixes +- Fix incorrect results in Ping (`ping`) input plugin. +- Add missing character replacement to `sql_instance` tag. +- Change `no metric` error message to `debug` level in CloudWatch (`cloudwatch`) input plugin. +- Add missing `ServerProperties` query to SQLServer (`sqlserver`) input plugin documentation. +- Fix MongoDB `connections_total_created` field loading. +- Fix metric creation when node is offline in Jenkins (`jenkins`) input plugin. +- Fix Docker `uptime_ns` calculation when container has been restarted. +- Fix MySQL field type conflict in conversion of `gtid_mode` to an integer. +- Fix MySQL field type conflict with `ssl_verify_depth` and `ssl_ctx_verify_depth`. + +## v1.12.4 [2019-10-23] + +- Build official packages with Go 1.12.12. + +### Bug fixes +- Fix metric generation with Ping (`ping`) input plugin `native` method. +- Exclude alias tag if unset from plugin internal stats. +- Fix `socket_mode` option in PowerDNS Recursor (`powerdns_recursor`) input plugin. + +## v1.12.3 [2019-10-07] + +- Build official packages with Go 1.12.10. + +### Bug fixes +- Use batch serialization format in Exec (`exec`) output plugin. +- Use case-insensitive serial number match in S.M.A.R.T. (`smart`) input plugin. +- Add authorization header only when environment variable is set. +- Fix issue when running multiple MySQL and SQL Server plugin instances. +- Fix database routing on retry with `exclude_database_tag`. +- Fix logging panic in Exec (`exec`) input plugin with Nagios data format. + +## v1.12.2 [2019-09-24] + +### Bug fixes +- Fix timestamp format detection in `csv` and `json` parsers. +- Apcupsd input (`apcupsd`) + - Fix parsing of `BATTDATE`. +- Keep boolean values listed in `json_string_fields`. +- Disable Go plugin support in official builds. +- Cisco GNMI Telemetry input (`cisco_telemetry_gnmi`) + - Fix path handling issues. + +## v1.12.1 [2019-09-10] + +### Bug fixes +- Fix dependenciess on GLIBC_2.14 symbol version. +- Filecount input (`filecount`) + - Fix filecount for paths with trailing slash. +- Icinga2 input (`icinga2`) + - Convert check state to an integer. +- Apache Kafka Consumer input (`kafka_consumer`) + - Fix could not mark message delivered error. +- MongoDB input (`mongodb`) + - Skip collection stats when disabled. +- HTTP Response input (`http_response`) + - Fix error reading closed response body. +- Apcupsd input (`apcupsd`) + - Fix documentation to reflect plugin. +- InfluxDB v2 output (`influxdb_v2`) + - Display retry log message only when retry after is received. + + +## v1.12 [2019-09-03] + +### Release Notes +- The cluster health related fields in the Elasticsearch input have been split out + from the `elasticsearch_indices` measurement into the new `elasticsearch_cluster_health_indices` + measurement as they were originally combined by error. + +### New Inputs +- [Apcupsd](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/apcupsd/README.md) (`apcupsd`) - Contributed by @jonaz +- [Docker Log](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/docker_log/README.md) (`docker_log`) - Contributed by @prashanthjbabu +- [Fireboard](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/fireboard/README.md) (`fireboard`) - Contributed by @ronnocol +- [Logstash](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/logstash/README.md) (`logstash`) - Contributed by @lkmcs @dmitryilyin @arkady-emelyanov +- [MarkLogic](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/marklogic/README.md) (`marklogic`) - Contributed by @influxdata +- [OpenNTPD](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/openntpd/README.md) (`openntpd`) - Contributed by @aromeyer +- [uWSGI](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/uwsgi) (`uwsgi`) - Contributed by @blaggacao + +### New Parsers +- [From Urlencoded](https://github.com/influxdata/telegraf/blob/master/plugins/parsers/form_urlencoded) (`form_urlencoded`) - Contributed by @byonchev + +### New Processors +- [Date](https://github.com/influxdata/telegraf/blob/master/plugins/processors/date/README.md) (`date`) - Contributed by @influxdata +- [Pivot](https://github.com/influxdata/telegraf/blob/master/plugins/processors/pivot/README.md) (`pivot`) - Contributed by @influxdata +- [Tag Limit](https://github.com/influxdata/telegraf/blob/master/plugins/processors/tag_limit/README.md) (`tag_limit`) - Contributed by @memory +- [Unpivot](https://github.com/influxdata/telegraf/blob/master/plugins/processors/unpivot/README.md) (`unpivot`) - Contributed by @influxdata + +### New Outputs +- [Exec](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/exec/README.md) (`exec`) - Contributed by @Jaeyo + +### Features +- Improve performance of `wavefront` serializer. +- Allow `regex` processor to append tag values. +- Add `starttime` field to `phpfpm` input. +- Add cluster name tag to elasticsearch indices. +- Add support for interface field in `http_response` input plugin. +- Add container uptime_ns in `docker` input plugin. +- Add better user-facing errors for API timeouts in docker input. +- Add TLS mutual auth support to `jti_openconfig_telemetry` input. +- Add support for ES 7.x to `elasticsearch` output. +- Add basic auth to `prometheus` input plugin. +- Add node roles tag to `elasticsearch` input. +- Support floats in `statsd` percentiles. +- Add native Go ping method to `ping` input plugin. +- Resume from last known offset in `tail` input when reloading Telegraf. +- Add improved support for Azure SQL Database to `sqlserver` input. +- Add extra attributes for NVMe devices to `smart` input. +- Add `docker_devicemapper` measurement to `docker` input plugin. +- Add basic auth support to `elasticsearch` input. +- Support string field glob matching in `json` parser. +- Update gjson to allow multipath syntax in `json` parser. +- Add support for collecting SQL Requests to identify waits and blocking to `sqlserver` input. +- Collect k8s endpoints, ingress, and services in `kube_inventory` plugin. +- Add support for field/tag keys to `strings` processor. +- Add certificate verification status to `x509_cert` input. +- Support percentage value parsing in `redis` input. +- Load external Go plugins from `--plugin-directory`. +- Add ability to exclude db/bucket tag from `influxdb` outputs. +- Gather per collections stats in `mongodb` input plugin. +- Add TLS & credentials configuration for `nats_consumer` input plugin. +- Add support for enterprise repos to `github` plugin. +- Add Indices stats to `elasticsearch` input. +- Add left function to `string` processor. +- Add grace period for metrics late for aggregation. +- Add `diff` and `non_negative_diff` to `basicstats` aggregator. +- Add device tags to `smart_attributes`. +- Collect `framework_offers` and `allocator` metrics in `mesos` input. +- Add Telegraf and Go version to the `internal` input plugin. +- Update the number of logical CPUs dynamically in `system` plugin. +- Add darwin (macOS) builds to the release. +- Add configurable timeout setting to `smart` input. +- Add `memory_usage` field to `procstat` input plugin. +- Add support for custom attributes to `vsphere` input. +- Add `cmdstat` metrics to `redis` input. +- Add `content_length` metric to `http_response` input plugin. +- Add `database_tag` option to `influxdb_listener` to add database from query string. +- Add capability to limit TLS versions and cipher suites. +- Add `topic_tag` option to `mqtt_consumer`. +- Add ability to label inputs for logging. +- Add TLS support to `nginx_plus`, `nginx_plus_api` and `nginx_vts`. + +### Bug fixes +- Fix sensor read error stops reporting of all sensors in `temp` input. +- Fix double pct replacement in `sysstat` input. +- Fix race in master node detection in `elasticsearch` input. +- Fix SSPI authentication not working in `sqlserver` input. +- Fix memory error panic in `mqtt` input. +- Support Kafka 2.3.0 consumer groups. +- Fix persistent session in `mqtt_consumer`. +- Fix finder inconsistencies in `vsphere` input. +- Fix parsing multiple metrics on the first line of tailed file. +- Send TERM to `exec` processes before sending KILL signal. +- Query oplog only when connected to a replica set. +- Use environment variables to locate Program Files on Windows. + +## v1.11.5 [2019-08-27] + +### Bug fixes +- Update `go-sql-driver/mysql` driver to 1.4.1 to address auth issues. +- Return error status from `--test` if input plugins produce an error. +- Fix with multiple instances only last configuration is used in smart input. +- Build official packages with Go 1.12.9. +- Split out `-w` argument in `iptables` input plugin. +- Add support for parked process state on Linux. +- Remove leading slash from rcon command. +- Allow jobs with dashes in the name in `lustre2` input plugin. + +## v1.11.4 [2019-08-06] + +### Bug fixes + +#### Plugins +- Kubernetes input (`kubernetes`) + - Correct typo in `logsfs_available_bytes` field. +- Datadog output (`datadog`) + - Skip floats that are `NaN` or `Inf`. +- Socket Listener input (`socket_listener`) + - Fix reload panic. + +## v1.11.3 [2019-07-23] + +### Bug fixes + +#### Agent + +- Treat empty array as successful parse in JSON parser. +- Fix template pattern partial wildcard matching. + +#### Plugins + +- Bind input (`bind`) + - Add missing `rcode` and `zonestat`. +- GitHub input + - - Fix panic. +- Lustre2 input (`lustre2`) + - Fix config parse regression. +- NVIDIA-SMI output (`nvidia-smi`) + - Handle unknown error. +- StatD input (`statd`) + - Fix panic when processing Datadog events. +- VMware vSphere input (`vsphere`) + - Fix unable to reconnect after vCenter reboot. + +## v1.11.2 [2019-07-09] + +### Bug fixes + +#### Plugins + +- Bind input (`bind`) + - Fix `value out of range` error on 32-bit systems. +- Burrow input (`burrow`) + - Apply topic filter to partition metrics. +- Filecount input (`filecount`) + - Fix path separator handling in Windows. +- Logparser input (`logparser`) + - Fix stop working after reload. +- Ping input (`ping`) + - Fix source address ping flag on BSD. +- StatsD input (`statsd`) + - Fix panic with empty Datadog tag string. +- Tail input (`tail`) + - Fix stop working after reload. + +## v1.11.1 [2019-06-25] + +### Bug fixes + +#### Agent + +- Fix panic if `pool_mode` column does not exist. +- Add missing `container_id` field to `docker_container_status` metrics. +- Add `device`, `serial_no`, and `wwn` tags to synthetic attributes. + +#### Plugins + +- Cisco GNMI Telemetry input (`cisco_telemetry_gnmi`) + - Omit keys when creating measurement names for GNMI telemetry. +- Disk input (`disk`) + - Cannot set `mount_points` option. +- NGINX Plus API input (`nginx_plus_api`) + - Skip 404 error reporting. +- Procstat input (`procstat`) + - Don't consider `pid` of `0` when using systemd lookup. +- StatsD input (`statsd`) + - Fix parsing of remote TCP address. +- System input (`system`) + - Ignore error when `utmp` is missing. + +## v1.11.0 [2019-06-11] + +- System (`system`) input plugin + - The `uptime_format` field has been deprecated — use the `uptime` field instead. +- Amazon Cloudwatch Statistics (`cloudwatch`) input plugin + - Updated to use a more efficient API and now requires `GetMetricData` permissions + instead of `GetMetricStatistics`. The `units` tag is not + available from this API and is no longer collected. + +### New input plugins + +- [BIND 9 Nameserver Statistics (`bind`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/inputs/bind/README.md) - Contributed by @dswarbrick & @danielllek +- [Cisco GNMI Telemetry (`cisco_telemetry_gnmi`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/inputs/cisco_telemetry_gnmi/README.md) - Contributed by @sbyx +- [Cisco Model-driven Telemetry (`cisco_telemetry_mdt`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/inputs/cisco_telemetry_mdt/README.md) - Contributed by @sbyx +- [ECS (`ecs`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/inputs/ecs/README.md) - Contributed by @rbtr +- [GitHub (`github`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/inputs/github/README.md) - Contributed by @influxdata +- [OpenWeatherMap (`openweathermap`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/inputs/openweathermap/README.md) - Contributed by @regel +- [PowerDNS Recursor (`powerdns_recursor`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/inputs/powerdns_recursor/README.md) - Contributed by @dupondje + +### New aggregator plugins + +- [Final (`final`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/aggregators/final/README.md) - Contributed by @oplehto + +### New output plugins + +- [Syslog (`syslog`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/outputs/syslog/README.md) - Contributed by @javicrespo +- [Health (`health`)](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/outputs/health/README.md) - Contributed by @influxdata + +### New output data formats (serializers) + +- [wavefront](https://github.com/influxdata/telegraf/blob/release-1.11/plugins/serializers/wavefront/README.md) - Contributed by @puckpuck + +### Features + +#### Agent + +- Add CLI support for outputting sections of the configuration. +- Add `service-display-name` option for use with Windows service. +- Add support for log rotation. +- Allow env vars `${}` expansion syntax in configuration file. +- Allow devices option to match against devlinks. + +### Input data formats + +- Nagios + - Add support for multiple line text and perfdata. + +#### Input plugins + +- AMQP Consumer (`amqp_consumer`) + - Support passive queue declaration. + - Add support for gzip compression. +- Amazon Cloudwatch Statistics (`cloudwatch`) + - Use more efficient GetMetricData API to collect Cloudwatch metrics. + - Allow selection of collected statistic types in cloudwatch input. +- Apache Solr (`solr`) + - Add support for HTTP basic auth. +- Hddtemp (`hddtemp`) + - Add source tag. +- InfluxDB Listener (`influxdb_listener`) + - Support verbose query parameter in ping endpoint. +- NVIDIA SMI (`nvidia-smi`) + - Extend metrics collected from Nvidia GPUs. +- Net (`net`) + - Speed up interface stat collection. +- PHP FM (`phpfm`) + - Enhance HTTP connection options. +- Ping (`ping`) + - Add TTL field. +- Procstat (`procstat`) + - Add `cmdline` tag. + - Add pagefault data. +- Prometheus (`prometheus`) + - Add namespace restriction. +- SMART (`smart`) + - Support more drive types. +- Socket Listener (`socket_listener`) + - Add option to set permissions for UNIX domain sockets. +- StatsD (`statsd`) + - Add support for Datadog events. + +### Output plugins + +- AMQP (`amqp`) + - Add support for gzip compression. +- File (`file`) + - Add file rotation support. +- Stackdriver (`stackdriver`) + - Set user agent. +-- VMware Wavefront (`wavefront`) + - Add option to use strict sanitization rules. + +### Aggregator plugins + +- Histogram aggregator + - Add option to reset buckets on flush. + +#### Processor plugins + +- Converter (`converter`) + - Add hexadecimal string to integer conversion. +- Enum (`enum`) + - Support tags. + +### Bug fixes + +#### Agent + +- Create Windows service only when specified or in service manager. +- Don't start Telegraf when stale pid file found. +- Fix inline table support in configuration file. +- Fix multi-line basic strings support in configuration file. +- Fix multiple SIGHUP causes Telegraf to shutdown. +- Fix batch fails when single metric is unserializable. +- Log a warning on write if the metric buffer has overflowed. + +#### Plugins + +- AMQP (`amqp`) output + - Fix direct exchange routing key. +- Apex Neptune (`apex_neptune`) inpur + - Skip invalid power times. +- Docker (`docker`) input + - Fix docker input does not parse image name correctly. +- Fibaro (`fibaro`) input + - Set default timeout of `5s`. +- InfluxDB v1.x (`influxdb`) output + - Fix connection leak on reload. +- InfluxDB v2 output + - Fix connection leak on reload. +- Lustre 2 (`lustre2`) input + - Fix only one job per storage target reported. +- Microsoft Azure Monitor (`azure_monitor`) output + - Fix scale set resource id. +- Microsoft SQL Server (`sqlserver`) input + Fix connection closing on error. +- Minecraft (`minecraft`) input + - Support Minecraft server 1.13 and newer. +- NGINX Upstream Check (`nginx_upstream_check`) input + - Fix TOML option name. +- PgBounder (`pgbouncer`) input + - Fix unsupported pkt type error. +- Procstat (`procstat`) input + - Verify a process passed by `pid_file` exists. +- VMware vSphere (`vsphere`) input + - Fixed datastore name mapping. + +## v1.10.4 [2019-05-14] + +### Bug fixes + +#### Agent + +- Create telegraf user in pre-install RPM scriptlet. +- Fix parse of unix timestamp with more than ns precision. +- Fix race condition in the Wavefront parser. + +#### Plugins + +- HTTP output plugin (`http`) + - Fix http output cannot set Host header. +- IPMI Sensor input (`ipmi_sensor`) + - Add support for hex values. +- InfluxDB v2 output (`influxdb_v2`) + - Don't discard metrics on forbidden error. +- Interrupts input (`interrupts`) + - Restore field name case. +- NTPQ input (`ntpq`) + - Skip lines with missing `refid`. +- VMware vSphere input (`vsphere`) + - Fix interval estimation. + +## v1.10.3 [2019-04-16] + +### Bug fixes + +#### Agent + +- Set log directory attributes in RPM specification. + +#### Plugins + +- Prometheus Client (`prometheus_client`) output plugin. + - Allow colons in metric names. + +## v1.10.2 [2019-04-02] + +### Breaking changes + + Grok input data format (parser): string fields no longer have leading and trailing quotation marks removed. + If you are capturing quoted strings, the patterns might need to be updated. + +### Bug fixes + +#### Agent + +- Fix deadlock when Telegraf is aligning aggregators. +- Add owned directories to RPM package specification. +- Fix drop tracking of metrics removed with aggregator `drop_original`. +- Fix aggregator window alignment. +- Fix panic during shutdown of multiple aggregators. +- Fix tags applied to wrong metric on parse error. + +#### Plugins + +- Ceph (`ceph`) input + - Fix missing cluster stats. +- DiskIO (`diskio`) input + - Fix reading major and minor block devices identifiers. +- File (`file`) output + - Fix open file error handling. +- Filecount (`filecount`) input + - Fix basedir check and parent dir extraction. +- Grok (`grok`) parser + - Fix last character removed from string field. +- InfluxDB v2 (`influxdb_v2`) output + - Fix plugin name in output logging. +- Prometheus (`prometheus`) input + - Fix parsing of kube config `certificate-authority-data`. +- Prometheus (`prometheus`) output + - Remove tags that would create invalid label names. +- StatsD (`statsd`) input + - Listen before leaving start. + +## v1.10.1 [2019-03-19] + +#### Bug fixes + +- Show error when TLS configuration cannot be loaded. +- Add base64-encoding/decoding for Google Cloud PubSub (`pubsub`) plugins. +- Fix type compatibility in VMware vSphere (`vsphere`) input plugin with `use_int_samples` option. +- Fix VMware vSphere (`vsphere`) input plugin shows failed task in vCenter. +- Fix invalid measurement name and skip column in the CSV input data format parser. +- Fix System (`system`) input plugin causing high CPU usage on Raspbian. + +## v1.10 [2019-03-05] + +#### New input plugins + +- [Google Cloud PubSub (`cloud_pubsub`)](https://github.com/influxdata/telegraf/blob/release-1.10/plugins/inputs/cloud_pubsub/README.md) - Contributed by @emilymye +- [Kubernetes Inventory (`kube_inventory`)](https://github.com/influxdata/telegraf/blob/release-1.10/plugins/inputs/cloud_pubsub_push/README.md) - Contributed by @influxdata +- [Neptune Apex (`neptune_apex`)](https://github.com/influxdata/telegraf/blob/release-1.10/plugins/inputs/neptune_apex/README.md) - Contributed by @MaxRenaud +- [NGINX Upstream Check (`nginx_upstream_check`)](https://github.com/influxdata/telegraf/blob/release-1.10/plugins/inputs/nginx_upstream_check/README.md) - Contributed by @dmitryilyin +- [Multifile (`multifile`)](https://github.com/influxdata/telegraf/blob/release-1.10/plugins/inputs/multifile/README.md) - Contributed by @martin2250 + +#### New output plugins + +- [Google Cloud PubSub (`cloud_pubsub`)](https://github.com/influxdata/telegraf/blob/release-1.10/plugins/outputs/cloud_pubsub/README.md) - Contributed by @emilymye + +#### New output data formats (serializers) + +- [ServiceNow Metrics](/telegraf/v1.12/data_formats/output/nowmetric) - Contributed by @JefMuller +- [Carbon2](/telegraf/v1.12/data_formats/output/carbon2) - Contributed by @frankreno + +#### Features + +- **General** + - Allow for force gathering ES cluster stats. + - Add Linux `mipsle` packages. +- **Input plugins** + - Ceph (`ceph`) + - Add read and write op per second fields. + - CouchDB (`couchdb`) + - Add support for basic auth. + - DNS Query (`dns_query`) + - Add `rcode` tag and field. + - DiskIO (`diskio`) + - Include `DEVLINKS` in available `udev` properties. + - HTTP (`http`) + - Add support for sending a request body to `http` input. + - InfluxDB Listener (`influxdb_listener`) + - Add internal metric for line too long. + - Interrupts (`interrupts`) + - Add option to store `cpu` as a tag. + - Kafka Consumer (`kafka_consumer`) + - Add ability to tag metrics with topic. + - Kubernetes (`k8s`) + - Support passing bearer token directly. + - Microsoft SQL Server (`sqlserver`) + - Add log send and redo queue fields. + - MongoDB (`mongodb`) + - Add `flush_total_time_ns` and additional wired tiger fields. + - Procstat (`procstat_lookup`) + - Add running field. + - Prometheus (`prometheus`) + - Support passing bearer token directly. + - Add option to report input timestamp. + - VMware vSphere (`vsphere`) + - Improve scalability. + - Add resource path-based filtering. + - Varnish (`varnish`) + - Add configurable timeout. +- **Output plugins** + - MQTT (`mqtt`) + - Add option to set retain flag on messages. + - Stackdriver (`stackdriver`) + - Add resource type and resource label support + - VMware Wavefront (`wavefront`) + - Add support for the Wavefront Direct Ingestion API. +- **Aggregator plugins** + - Value Counter (`valuecounter`) + - Allow counting float values. +- **Data formats** + - **Input data formats** + - CSV + - Support `unix_us` and `unix_ns` timestamp format. + - Add support for `unix` and `unix_ms` timestamps. + - Grok (`grok`) + - Allow parser to produce metrics with no fields. + - JSON + - Add micro and nanosecond unix timestamp support. + - **Output data formats** + - ServiceNow Metrics + +#### Bug fixes + +- **General** + - Use `systemd` in Amazon Linux 2 rpm. + - Fix `initscript` removes `pidfile` of restarted Telegraf process. +- **Input plugins** + - Consul (`consul`) + - Use datacenter option spelling. + - InfluxDB Listener (`influxdb_listener`) + - Remove auth from `/ping` route. + - Microsoft SQL Server (`sqlserver`) + - Set deadlock priority. + - Nstat (`nstat`) + - Remove error log when `snmp6` directory does not exist. + - Ping (`ping`) + - Host not added when using custom arguments. + - X.509 Certificate + - Fix input stops checking certificates after first error. +- **Output plugins** + - Prometheus (`prometheus`) + - Sort metrics by timestamp. + - Stackdriver (`stackdriver`) + - Skip string fields when writing. + - Send metrics in ascending time order. + +## v1.9.5 [2019-02-26] + +### Bug fixes + +* General + * Use `systemd` in Amazon Linux 2 rpm. +* Ceph Storage (`ceph`) input plugin + * Add backwards compatibility fields in usage and pool statistics. +* InfluxDB (`influxdb`) output plugin + * Fix UDP line splitting. +* Microsoft SQL Server (`sqlserver`) input plugin + * Set deadlock priority to low. + * Disable results by row in AzureDB query. +* Nstat (`nstat`) input plugin + * Remove error log when `snmp6` directory does not exist. +* Ping (`ping`) input plugin + * Host not added when using custom arguments. +* Stackdriver (`stackdriver`) output plugin + * Skip string fields when writing to stackdriver output. + * Send metrics in ascending time order. + +## v1.9.4 [2019-02-05] + +### Bug fixes + +* General + * Fix `skip_rows` and `skip_columns` options in csv parser. + * Build official packages with Go 1.11.5. +* Jenkins input plugin + * Always send basic auth in jenkins input. +* Syslog (`syslog`) input plugin + * Fix definition of multiple syslog plugins. + +## v1.9.3 [2019-01-22] + +#### Bug fixes + +* General + * Fix latest metrics not sent first when output fails. + * Fix `internal_write buffer_size` not reset on timed writes. +* AMQP Consumer (`amqp_consumer`) input plugin + - Fix `amqp_consumer` input stops consuming when it receives + unparsable messages. +* Couchbase (`couchbase`) input plugin + * Remove `userinfo` from cluster tag in `couchbase` input. +* Microsoft SQL Server (`sqlserver`) input plugin + * Fix arithmetic overflow in `sqlserver`) input. +* Prometheus (`prometheus`) input plugin + * Fix `prometheus` input not detecting added and removed pods. + +## v1.9.2 [2019-01-08] + +### Bug fixes + +- Increase `varnishstat` timeout. +- Remove storage calculation for non-Azure-managed instances and add server version. +- Fix error sending empty tag value in `azure_monitor` output. +- Fix panic with Prometheus input plugin on shutdown. +- Support non-transparent framing of syslog messages. +- Apply global- and plugin-level metric modifications before filtering. +- Fix `num_remapped_pgs` field in `ceph` plugin. +- Add `PDH_NO_DATA` to known counter error codes in `win_perf_counters`. +- Fix `amqp_consumer` stops consuming on empty message. +- Fix multiple replace tables not working in strings processor. +- Allow non-local UDP connections in `net_response`. +- Fix TOML option names in parser processor. +- Fix panic in Docker input with bad endpoint. +- Fix original metric modified by aggregator filters. + +## v1.9.1 [2018-12-11] + +### Bug fixes + +- Fix boolean handling in splunkmetric serializer. +- Set default config values in Jenkins input. +- Fix server connection and document stats in MongoDB input. +- Add X-Requested-By header to Graylog input. +- Fix metric memory not freed from the metric buffer on write. +- Add support for client TLS certificates in PostgreSQL inputs. +- Prevent panic when marking the offset in `kafka_consumer`. +- Add early metrics to aggregator and honor `drop_original` setting. +- Use `-W` flag on BSD variants in ping input. +- Allow delta metrics in Wavefront parser. + +## v1.9.0 [2018-11-20] + +#### Release Notes + +- The HTTP Listener (`http_listener`) input plugin has been renamed to + InfluxDB Listener (`influxdb_listener`) input plugin and + use of the original name is deprecated. The new name better describes the + intended use of the plugin as an InfluxDB relay. For general purpose + transfer of metrics in any format using HTTP, InfluxData recommends using + HTTP Listener v2 (`http_listener_v2`) input plugin. + +- Input plugins are no longer limited from adding metrics when the output is + writing and new metrics will move into the metric buffer as needed. This + will provide more robust degradation and recovery when writing to a slow + output at high throughput. + + To avoid overconsumption when reading from queue consumers, the following + input plugins use the new option `max_undelivered_messages` to limit the number + of outstanding unwritten metrics: + + * Apache Kafka Consumer (`kafka_consumer`) + * AMQP Consumer (`amqp_consumer`) + * MQTT Consumer (`mqtt_consumer`) + * NATS Consumer (`nats_consumer`) + * NSQ Consumer (`nsq_consumer`) + +#### New input plugins + +- [HTTP Listener v2 (`http_listener_v2`)](https://github.com/influxdata/telegraf/blob/release-1.9/plugins/inputs/http_listener_v2/README.md) - Contributed by @jul1u5 +- [IPVS (`ipvs`)](https://github.com/influxdata/telegraf/blob/release-1.9/plugins/inputs/ipvs/README.md) - Contributed by @amoghe +- [Jenkins (`jenkins`)](https://github.com/influxdata/telegraf/blob/release-1.9/plugins/inputs/jenkins/README.md) - Contributed by @influxdata & @lpic10 +- [NGINX Plus API (`nginx_plus_api`)](https://github.com/influxdata/telegraf/blob/release-1.9/plugins/inputs/nginx_plus_api/README.md) - Contributed by @Bugagazavr +- [NGINX VTS (`nginx_vts`)](https://github.com/influxdata/telegraf/blob/release-1.9/plugins/inputs/nginx_vts/README.md) - Contributed by @monder +- [Wireless (`wireless`)](https://github.com/influxdata/telegraf/blob/release-1.9/plugins/inputs/wireless/README.md) - Contributed by @jamesmaidment + +#### New output plugins + +- [Stackdriver (stackdriver)](https://github.com/influxdata/telegraf/blob/release-1.9/plugins/outputs/stackdriver/README.md) - Contributed by @jamesmaidment + +#### Features + +- General + - Add ability to define a custom service name when installing as a Windows service. + - Add new configuration for CSV column explicit type conversion. + - Add Telegraf version to `User-Agent` header. + - Add ability to specify bytes options as strings with units. + - Add per output `flush_interval`, `metric_buffer_limit`, and `metric_batch_size`. +- Amazon Kinesis (`kinesis`) output plugin + - Use `DescribeStreamSummary` in place of `ListStreams`. +- DNS Query (`dns_query`) input plugin + - Query servers in parallel. +- Datadog (`datadog`) output plugin + - Add an option to specify a custom URL. + - Use non-allocating field and tag accessors. +- Filecount (`filecount`) input plugin + - Add per-directory file count. +- HTTP Output (`http output`) plugin + - Add entity-body compression. +- Memcached (`memcached`) input plugin + - Collect additional statistics. +- NSQ (`nsq`) input plugin + - Add TLS configuration support. +- Ping (`ping`) input plugin + - Add support for IPv6. +- Procstat (`procstat`) input plugin + - Add Windows service name lookup. +- Prometheus (`prometheus`) input plugin + - Add scraping for Prometheus annotation in Kubernetes. + - Allow connecting to Prometheus using UNIX socket. +- Strings (`strings`) processor plugin + - Add `replace` function. +- VMware vSphere (`vsphere`) input plugin + - Add LUN to data source translation. + +#### Bug fixes + +- Remove `time_key` from the field values in JSON parser. +- Fix input time rounding when using a custom interval. +- Fix potential deadlock or leaked resources on restart or reload. +- Fix outputs block inputs when batch size is reached. +- Fix potential missing datastore metrics in VMware vSphere (`vsphere`) input plugin. + +## v1.8.3 [2018-10-30] + +### Bug fixes + +- Add DN attributes as tags in X.509 Certificate (`x509_cert`) input plugin to avoid series overwrite. +- Prevent connection leak by closing unused connections in AMQP (`amqp`) output plugin. +- Use default partition key when tag does not exist in Amazon Kinesis (`kinesis`) output plugin. +- Log the correct error in JTI OpenConfig Telemetry (`jti_openconfig_telemetry`) input plugin. +- Handle panic when IMPI Sensor (`ipmi_sensor`) input plugin gets bad input. +- Don't add unserializable fields to Jolokia2 (`jolokia2`) input plugin. +- Fix version check in PostgreSQL Exstensible (`postgresql_extensible`) plugin. + +## v1.8.2 [2018-10-17] + +### Bug fixes + +* Aerospike (`aerospike`) input plugin + * Support uint fields. +* Docker (`docker`) input plugin + * Use container name from list if no name in container stats. +* Filecount (`filecount`) input plugin + * Prevent panic on error in file stat. +* InfluxDB v2 (`influxdb_v2`) input plugin + * Update write path to match updated v2 API. +* Logparser (`logparser`) input plugin + * Fix panic. +* MongoDB (`mongodb`) input plugin + * Lower authorization errors to debug level. +* MQTT Consumer (`mqtt_consumer`) input plugin + * Fix connect and reconnect. +* Ping (`ping`) input plugin + * Return correct response code. +* VMware vSphere (`vsphere`) input plugin + * Fix missing timeouts. +* X.509 Certificate (`x509_cert`) input plugin + * Fix segfault. + +## v1.8.1 [2018-10-03] + +### Bug fixes + +- Fix `hardware_type` may be truncated in Microsoft SQL Server (`sqlserver`) input plugin. +- Improve performance in Basicstats (`basicstats`) aggregator plugin. +- Add `hostname` to TLS config for SNI support in X.509 Certicate (`x509_cert`) input plugin. +- Don't add tags with empty values to OpenTSDB (`opentsdb`) output plugin. +- Fix panic during network error in VMware vSphere (`vsphere`) input plugin. +- Unify error response in HTTP Listener (`http_listener`) input plugin with InfluxDB (`influxdb`) output plugin. +- Add `UUID` to VMs in VMware vSphere (`vsphere`) input plugin. +- Skip tags with empty values in Amazon Cloudwatch (`cloudwatch`) output plugin. +- Fix missing non-realtime samples in VMware vSphere (`vsphere`) input plugin. +- Fix case of `timezone`/`grok_timezone` options in grok parser and logparser input plugin. + +## v1.8 [2018-09-21] + +### New input plugins + +- [ActiveMQ (`activemq`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/activemq/README.md) - Contributed by @mlabouardy +- [Beanstalkd (`beanstalkd`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/beanstalkd/README.md) - Contributed by @44px +- [File (`file`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/file/README.md) - Contributed by @maxunt +- [Filecount (`filecount`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/filecount/README.md) - Contributed by @sometimesfood +- [Icinga2 (`icinga2`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/icinga2/README.md) - Contributed by @mlabouardy +- [Kibana (`kibana`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/kibana/README.md) - Contributed by @lpic10 +- [PgBouncer (`pgbouncer`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/pgbouncer/README.md) - Contributed by @nerzhul +- [Temp (`temp`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/temp/README.md) - Contributed by @pytimer +- [Tengine (`tengine`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/tengine/README.md) - Contributed by @ertaoxu +- [VMware vSphere (`vsphere`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/vsphere/README.md) - Contributed by @prydin +- [X.509 Certificate (`x509_cert`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/x509_cert/README.md) - Contributed by @jtyr + +### New processor plugins + +- [Enum (`enum`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/processors/enum/README.md) - Contributed by @KarstenSchnitter +- [Parser (`parser`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/processors/parser/README.md) - Contributed by @Ayrdrie & @maxunt +- [Rename (`rename`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/processors/rename/README.md) - Contributed by @goldibex +- [Strings (`strings`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/processors/strings/README.md) - Contributed by @bsmaldon + +### New aggregator plugins + +- [ValueCounter (`valuecounter`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/aggregators/valuecounter/README.md) - Contributed by @piotr1212 + +### New output plugins + +- [Azure Monitor (`azure_monitor`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/outputs/azure_monitor/README.md) - Contributed by @influxdata +- [InfluxDB v2 (`influxdb_v2`)](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/outputs/influxdb_v2/README.md) - Contributed by @influxdata + +### New input data formats (parsers) + +- [csv](/telegraf/v1.8/data_formats/input/csv) - Contributed by @maxunt +- [grok](/telegraf/v1.8/data_formats/input/grok/) - Contributed by @maxunt +- [logfmt](/telegraf/v1.8/data_formats/input/logfmt/) - Contributed by @Ayrdrie & @maxunt +- [wavefront](/telegraf/v1.8/data_formats/input/wavefront/) - Contributed by @puckpuck + +### New output data formats (serializers) + +- [splunkmetric](/telegraf/v1.8/data_formats/output/splunkmetric/) - Contributed by @ronnocol + +### Features + +- Add SSL/TLS support to Redis (`redis`) input plugin. +- Add tengine input plugin. +- Add power draw field to the NVIDIA SMI (`nvidia_smi`) input plugin. +- Add support for Solr 7 to the Solr (`solr`) input plugin. +- Add owner tag on partitions in Burrow (`burrow`) input plugin. +- Add container status tag to Docker (`docker`) input plugin. +- Add ValueCounter (`valuecounter`) aggregator plugin. +- Add new measurement with results of `pgrep` lookup to Procstat (`procstat`) input plugin. +- Add support for comma in logparser timestamp format. +- Add path tag to Tail (`tail`) input plugin. +- Add log message when tail is added or removed from a file. +- Add option to use of counter time in win perf counters. +- Add energy and power field and device id tag to Fibaro (`fibaro`) input plugin. +- Add HTTP path configuration for OpenTSDB output. +- Gather IPMI metrics concurrently. +- Add mongo document and connection metrics. +- Add enum processor plugin. +- Add user tag to procstat input. +- Add support for multivalue metrics to collectd parser. +- Add support for setting kafka client id. +- Add file input plugin and grok parser. +- Improve cloudwatch output performance. +- Add x509_cert input plugin. +- Add IPSIpAddress syntax to ipaddr conversion in snmp plugin. +- Add Filecount filecount input plugin. +- Add support for configuring an AWS `endpoint_url`. +- Send all messages before waiting for results in Kafka output plugin. +- Add support for lz4 compression to Kafka output plugin. +- Split multiple sensor keys in ipmi input. +- Support StatisticValues in cloudwatch output plugin. +- Add ip restriction for the prometheus_client output. +- Add PgBouncer (`pgbouncer`) input plugin. +- Add ActiveMQ input plugin. +- Add wavefront parser plugin. +- Add rename processor plugin. +- Add message 'max_bytes' configuration to kafka input. +- Add gopsutil meminfo fields to Mem (`mem`) input plugin. +- Document how to parse Telegraf logs. +- Use dep v0.5.0. +- Add ability to set measurement from matched text in grok parser. +- Drop message batches in Kafka (`kafka`) output plugin if too large. +- Add support for static and random routing keys in Kafka (`kafka`) output plugin. +- Add logfmt parser plugin. +- Add parser processor plugin. +- Add Icinga2 input plugin. +- Add name, time, path and string field options to JSON parser. +- Add forwarded records to sqlserver input. +- Add Kibana input plugin. +- Add csv parser plugin. +- Add read_buffer_size option to statsd input. +- Add azure_monitor output plugin. +- Add queue_durability parameter to amqp_consumer input. +- Add strings processor. +- Add OAuth 2.0 support to HTTP output plugin. +- Add Unix epoch timestamp support for JSON parser. +- Add options for basic auth to haproxy input. +- Add temp input plugin. +- Add Beanstalkd input plugin. +- Add means to specify server password for redis input. +- Add Splunk Metrics serializer. +- Add input plugin for VMware vSphere. +- Align metrics window to interval in cloudwatch input. +- Improve Azure Managed Instance support + more in sqlserver input. +- Allow alternate binaries for iptables input plugin. +- Add influxdb_v2 output plugin. + +### Bug fixes + +- Fix divide by zero in logparser input. +- Fix instance and object name in performance counters with backslashes. +- Reset/flush saved contents from bad metric. +- Document all supported cli arguments. +- Log access denied opening a service at debug level in win_services. +- Add support for Kafka 2.0. +- Fix nagios parser does not support ranges in performance data. +- Fix nagios parser does not strip quotes from performance data. +- Fix null value crash in postgresql_extensible input. +- Remove the startup authentication check from the cloudwatch output. +- Support tailing files created after startup in tail input. +- Fix CSV format configuration loading. + + +## v1.7.4 [2018-08-29] + +### Bug fixes + +* Continue sending write batch in UDP if a metric is unserializable in InfluxDB (`influxdb`) output plugin. +* Fix PowerDNS (`powerdns`) input plugin tests. +* Fix `burrow_group` offset calculation for Burrow (`burrow`) input plugin. +* Add `result_code` value for errors running ping command. +* Remove timeout deadline for UDP in Syslog (`syslog`) input plugin. +* Ensure channel is closed if an error occurs in CGroup (`cgroup`) input plugin. +* Fix sending of basic authentication credentials in HTTP `(output)` output plugin. +* Use the correct `GOARM` value in the Linux armel package. + +## v1.7.3 [2018-08-07] + +### Bug fixes + +* Reduce required Docker API version. +* Keep leading whitespace for messages in syslog input. +* Skip bad entries on interrupt input. +* Preserve metric type when using filters in output plugins. +* Fix error message if URL is unparseable in InfluxDB output. +* Use explicit `zpool` properties to fix parse error on FreeBSD 11.2. +* Lock buffer when adding metrics. + +## v1.7.2 [2018-07-18] + +### Bug fixes + +* Use localhost as default server tag in Zookeeper (`zookeeper`) input plugin. +* Don't set values when pattern doesn't match in Regex (`regex`) processor plugin. +* Fix output format of Printer (`printer`) processor plugin. +* Fix metric can have duplicate field. +* Return error if NewRequest fails in HTTP (`http`) output plugin. +* Reset read deadline for Syslog (`syslog`) input plugin. +* Exclude cached memory on Docker (`docker`) input plugin. + +## v1.7.1 [2018-07-03] + +### Bug fixes + +* Treat `sigterm` as a clean shutdown signal. +* Fix selection of tags under nested objects in the JSON parser. +* Fix Postfix (`postfix`) input plugin handling of multilevel queues. +* Fix Syslog (`syslog` input plugin timestamp parsing with single digit day of month. +* Handle MySQL (`mysql`) input plugin variations in the `user_statistics` collecting. +* Fix Minmax (`minmax`) and Basicstats (`basicstats`) aggregator plugins to use `uint64`. +* Document Swap (`swap`) input plugin. +* Fix incorrect precision being applied to metric in HTTP Listener (`http_listener`) input plugin. + +## v1.7 [2018-06-12] + +### Release notes + +- The Cassandra (`cassandra`) input plugin has been deprecated in favor of the Jolokia2 (`jolokia2`) + input plugin which is much more configurable and more performant. There is + an [example configuration](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/jolokia2/examples) to help you + get started. + +- For plugins supporting TLS, you can now specify the certificate and keys + using `tls_ca`, `tls_cert`, `tls_key`. These options behave the same as + the, now deprecated, `ssl` forms. + +### New input plugins + +- [Aurora (`aurora`)](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/aurora/README.md) - Contributed by @influxdata +- [Burrow (`burrow`) input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/burrow/README.md) - Contributed by @arkady-emelyanov +- [`fibaro`](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/fibaro/README.md) - Contributed by @dynek +- [`jti_openconfig_telemetry`](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/jti_openconfig_telemetry/README.md) - Contributed by @ajhai +- [`mcrouter`](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/mcrouter/README.md) - Contributed by @cthayer +- [NVIDIA SMI (`nvidia_smi`)](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/nvidia_smi/README.md) - Contributed by @jackzampolin +- [Syslog (`syslog`)](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/syslog/README.md) - Contributed by @influxdata + +### New processor plugins + +- [converter](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/processors/converter/README.md) - Contributed by @influxdata +- [regex](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/processors/regex/README.md) - Contributed by @44px +- [topk](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/processors/topk/README.md) - Contributed by @mirath + +### New output plugins + +- [HTTP (`http`)](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/http/README.md) - Contributed by @Dark0096 +- [Application Insights (`application_insights`) output plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/application_insights/README.md): Contribute by @karolz-ms + +### Features + +- Add `repl_oplog_window_sec` metric to MongoDB (`mongodb`) input plugin. +- Add per-host shard metrics in MongoDB (`mongodb`) input plugin. +- Skip files with leading `..` in config directory. +- Add TLS support to `socket_writer` and `socket_listener` plugins. +- Add `snmp` input option to strip non-fixed length index suffixes. +- Add server version tag to the Docker (`docker`) input plugin. +- Add support for LeoFS 1.4 to `leofs` input. +- Add parameter to force the interval of gather for Sysstat (`sysstat`). +- Support BusyBox ping in the Ping (`ping`) input plugin. +- Add Mcrouter (`mcrouter`) input plugin. +- Add TopK (`topk`) processor plugin. +- Add cursor metrics to MongoDB (`mongodb`) input plugin. +- Add tag/integer pair for result to Network Response (`net_response`) input plugin. +- Add Application Insights (`application_insights`) output plugin. +- Added several important Elasticsearch cluster health metrics. +- Add batch mode to `mqtt` output. +- Add Aurora (`aurora`) input plugin. +- Add Regex (`regex`) processor plugin. +- Add support for Graphite 1.1 tags. +- Add timeout option to Sensors (`sensors)` input plugin. +- Add Burrow (`burrow`) input plugin. +- Add option to Unbound (`unbound`) input plugin to use threads as tags. +- Add support for TLS and username/password auth to Aerospike (`aerospike`) input plugin. +- Add special syslog timestamp parser to grok parser that uses current year. +- Add Syslog (`syslog`) input plugin. +- Print the enabled aggregator and processor plugins on startup. +- Add static `routing_key` option to `amqp` output. +- Add passive mode exchange declaration option to AMQP Consumer (`amqp_consumer`) input plugin. +- Add counter fields to PF (`pf`) input plugin. + +### Bug fixes + +- Write to working file outputs if any files are not writeable. +- Add all win_perf_counters fields for a series in a single metric. +- Report results of `dns_query` instead of `0ms` on timeout. +- Add consul service tags to metric. +- Fix wildcards and multi instance processes in win_perf_counters. +- Fix crash on 32-bit Windows in `win_perf_counters`. +- Fix `win_perf_counters` not collecting at every interval. +- Use same flags for all BSD family ping variants. + + +## v1.6.4 [2018-06-05] + +### Bug fixes + +* Fix SNMP overriding of auto-configured table fields. +* Fix uint support in CloudWatch output. +* Fix documentation of `instance_name` option in Varnish input. +* Revert to previous Aerospike library version due to memory leak. + +## v1.6.3 [2018-05-21] + +### Bug fixes + +* Fix intermittent panic in Aerospike input plugin. +* Fix connection leak in the Jolokia agent (`Jolokia2_agent`) input plugin. +* Fix Jolokia agent (`Jolokia2_agent`) input plugin timeout parsing. +* Fix error parsing Dropwizard metrics. +* Fix Librato (`librato`) output plugin support for unsigned integer (`uint`) and Boolean (`bool`). +* Fix WaitGroup deadlock, if URL is incorrect, in Apache input plugin. + +## v1.6.2 [2018-05-08] + +### Bug fixes + +* Use same timestamp for fields in system input. +* Fix handling of uint64 in Datadog (`datadog`) output. +* Ignore UTF8 BOM in JSON parser. +* Fix case for slave metrics in MySQL (`mysql`) input. +* Fix uint support in CrateDB (`cratedb`) output. + + +## v1.6.1 [2018-04-23] + +### Bug fixes + +* Report mem input fields as gauges instead of counters. +* Fix Graphite outputs unsigned integers in wrong format. +* Report available fields if `utmp` is unreadable. +* Fix potential `no fields` error writing to outputs. +* Fix uptime reporting in system input when ran inside docker. +* Fix mem input `cannot allocate memory` error on FreeBSD-based systems. +* Fix duplicate tags when overriding an existing tag. +* Add server argument as first argument in the Unbound (`unbound`) input plugin. +* Fix handling of floats with multiple leading zeroes. +* Return errors in SSL/TLS configuration of MongoDB (`mongodb`) input plugin. + + +## v1.6 [2018-04-16] + +### Release notes + +- The MySQL (`mysql`) input plugin has been updated fix a number of type conversion + issues. This may cause a `field type error` when inserting into InfluxDB due + the change of types. + + To address this, we have introduced a new `metric_version` option to control + enabling the new format. + For in depth recommendations on upgrading, see [Metric version](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/mysql#metric-version) in the MySQL input plugin documentation. + + You are encouraged to migrate to the new model when possible as the old version + is deprecated and will be removed in a future version. + +- The PostgreSQL (`postgresql`) input plugin now defaults to using a persistent connection to the database. + In environments where TCP connections are terminated, the `max_lifetime` + setting should be set less than the collection `interval` to prevent errors. + +- The SQL Server (`sqlserver`) input plugin has a new query and data model that can be enabled + by setting `query_version = 2`. + Migrate to the new model, if possible, since the old version is deprecated and will be removed in a future version. + +- The OpenLDAP (`openldap`) input plugin has a new option, `reverse_metric_names = true`, that reverses metric + names to improve grouping. + Enable this option, when possible, as the old ordering is deprecated. + +- The new HTTP (`http`) input plugin, when configured with `data_format = "json"`, can perform the + same task as the, now deprecated, HTTP JSON (`httpjson`) input plugin. + + +### New input plugins + +- [HTTP (`http`) input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/http/README.md) - Thanks to @grange74 +- [Ipset (`ipset`) input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/ipset/README.md) - Thanks to @sajoupa +- [NATS Server Monitoring (`nats`) input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/nats/README.md) - Thanks to @mjs and @levex + +### New processor plugins + +- [Override (`override`) processor plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/processors/override/README.md) - Thanks to @KarstenSchnitter + +### New parsers + +- [Dropwizard input data format](https://github.com/influxdata/telegraf/blob/release-1.8/docs/DATA_FORMATS_INPUT.md#dropwizard) - Thanks to @atzoum + +### Features + +* Add health status mapping from `string` to `int` in Elasticsearch (`elasticsearch`) input plugin. +* Add control over which stats to gather in BasicStats (`basicstats`) aggregator plugin. +* Add `messages_delivered_get` to RabbitMQ (`rabbitmq`) input plugin. +* Add `wired` field to mem input plugin. +* Add support for gathering exchange metrics to the RabbitMQ (`rabbitmq`) input plugin. +* Add support for additional metrics on Linux in Zfs (`zfs`) input plugin. +* Add `available_entropy` field to Kernel (`kernel`) input plugin. +* Add user privilege level setting to IPMI sensors. +* Use persistent connection to PostgreSQL database. +* Add support for dropwizard input data format. +* Add container health metrics to Docker (`docker`) input plugin. +* Add support for using globs in devices list of DiskIO (`diskio`) input plugin. +* Allow running as console application on Windows. +* Add listener counts and node running status to RabbitMQ (`rabbitmq`) input plugin. +* Add NATS Server Monitoring (`nats`) input plugin. +* Add ability to select which queues will be gathered in RabbitMQ (`rabbitmq`) input plugin. +* Add support for setting BSD source address to the ping (`ping`) input plugin. +* Add Ipset (`ipset`) input plugin. +* Add TLS and HTTP basic auth to Prometheus Client (`prometheus_client`) output plugin. +* Add new sqlserver output data model. +* Add native Go method for finding `pid` to the Procstat (`procstat`) input plugin. +* Add additional metrics and reverse metric names option to OpenLDAP (`openldap`) input plugin. +* Add TLS support to the Mesos (`mesos`) input plugin. +* Add HTTP (`http`) input plugin. +* Add keep alive support to the TCP mode of StatsD (`statsd`) input plugin . +* Support deadline in Ping (`ping`) input plugin. +* Add option to disable labels in the Prometheus Client (`prometheus`) output plugin for string fields. +* Add shard server stats to the MongoDB (`mongodb`) input plugin. +* Add server option to Unbound (`unbound`) input plugin. +* Convert boolean metric values to float in Datadog (`datadog`) output plugin. +* Add Solr 3 compatibility. +* Add sum stat to BasicStats (`basicstats`) aggregator plugin. +* Add ability to override proxy from environment in HTTP Response (`http_response`) input plugin. +* Add host to ping timeout log message. +* Add override processor plugin. +* Add `status_code` and result tags and `result_type` field to HTTP Response (`http_response`) input plugin. +* Added config flag to skip collection of network protocol metrics. +* Add TLS support to Kapacitor (`kapacitor`) input plugin. +* Add HTTP basic auth support to the HTTP Listener (`http_listener`) input plugin. +* Tags in output InfluxDB Line Protocol are now sorted. +* InfluxDB Line Protocol parser now accepts DOS line endings. +* An option has been added to skip database creation in the InfluxDB (`influxdb`) output plugin. +* Add support for connecting to InfluxDB over a UNIX domain socket. +* Add optional unsigned integer support to the influx data format. +* Add TLS support to Zookeeper (`zookeeper`) input plugin. +* Add filters for container state to Docker (`docker`) input plugin. + +### Bug fixes + +* Fix various MySQL data type conversions. +* Fix metric buffer limit in internal plugin after reload. +* Fix panic in HTTP Response (`http_response`) input plugin on invalid regex. +* Fix socket_listener setting ReadBufferSize on TCP sockets. +* Add tag for target URL to `phpfpm` input plugin. +* Fix cannot unmarshal object error in Mesosphere DC/OS (`dcos`) input plugin. +* Fix InfluxDB output not able to reconnect when server address changes. +* Fix parsing of DOS line endings in the SMART (`smart`) input plugin. +* Fix precision truncation when no timestamp included. +* Fix SNMPv3 connection with Cisco ASA 5515 in SNMP (`snmp`) input plugin. + + +## v1.5.3 [2018-03-14] + +### Bug fixes + +* Set path to `/` if `HOST_MOUNT_PREFIX` matches full path. +* Remove `userinfo` from `url` tag in Prometheus input plugin. +* Fix Ping input plugin not reporting zero durations. +* Disable `keepalive` in MQTT output plugin to prevent deadlock. +* Fix collation difference in SQL Server (`sqlserver`) input plugin. +* Fix uptime metric in Passenger (`passenger`) input plugin. +* Add output of stderr in case of error to exec log message. + +## v1.5.2 [2018-01-30] + +### Bug fixes + +- Ignore empty lines in Graphite plaintext. +- Fix `index out of bounds` error in Solr input plugin. +- Reconnect before sending Graphite metrics if disconnected. +- Align aggregator period with internal ticker to avoid skipping metrics. +- Fix a potential deadlock when using aggregators. +- Limit wait time for writes in MQTT (`mqtt`) output plugin. +- Revert change in Graphite (`graphite`) output plugin where dot(`.`) in field key was replaced by underscore (`_`). +- Add `timeout` to Wavefront output write. +- Exclude `master_replid` fields from Redis input. + +## v1.5.1 [2017-01-10] + +### Bug fixes + +- Fix name error in jolokia2_agent sample config. +- Fix DC/OS input - login expiration time. +- Set Content-Type charset parameter in InfluxDB (`influxdb`) output plugin and allow it to be overridden. +- Document permissions setup for Postfix (`postfix`) input plugin. +- Fix `deliver_get` field in RabbitMQ (`rabbitmq`) input plugin. +- Escape environment variables during config TOML parsing. + +## v1.5 [2017-12-14] + +### New plugins + +#### Input plugins +- [Bond (bond)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/bond/README.md) - Thanks to @ildarsv +- [DC/OS (dcos)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/dcos/README.md) - Thanks to @influxdata +- [Jolokia2 (jolokia2)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/jolokia2/README.md) - Thanks to @dylanmei +- [NGINX Plus (nginx_plus)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/nginx_plus/README.md) - Thanks to @mplonka & @poblahblahblah +- [OpenSMTPD (opensmtpd)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/opensmtpd/README.md) - Thanks to @aromeyer +- [Particle.io Webhooks (particle)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/webhooks/particle/README.md) - Thanks to @davidgs +- [PF (pf)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/pf/README.md) - Thanks to @nferch +- [Postfix (postfix)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/postfix/README.md) - Thanks to @phemmer +- [SMART (smart)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/smart/README.md) - Thanks to @rickard-von-essen +- [Solr (solr)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/solr/README.md) - Thanks to @ljagiello +- [Teamspeak (teamspeak)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/teamspeak/README.md) - Thanks to @p4ddy1 +- [Unbound (unbound)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/inputs/unbound/README.md) - Thanks to @aromeyer + +#### Aggregator plugins +- [BasicStats (basicstats)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/aggregators/basicstats/README.md) - Thanks to @toni-moreno + +#### Output plugins +- [CrateDB (cratedb)](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/cratedb) - Thanks to @felixge +- [Wavefront (wavefront)](https://github.com/influxdata/telegraf/tree/release-1.5/plugins/outputs/wavefront/README.md) - Thanks to @puckpuck + + +### Release notes + +- In the Kinesis (`kinesis`) output plugin, use of the `partition_key` and + `use_random_partitionkey` options has been deprecated in favor of the + `partition` subtable. This allows for more flexible methods to set the + partition key such as by metric name or by tag. + +- With the release of the new improved Jolokia2 (`jolokia2`) input plugin, the legacy `jolokia` + plugin is deprecated and will be removed in a future release. Users of this + plugin are encouraged to update to the new `jolokia2` plugin. + +### Features + +- Add support for sharding based on metric name. +- Add Kafka output plugin `topic_suffix` option. +- Include mount mode option in disk metrics. +- TLS and MTLS enhancements to HTTP Listener input plugin. +- Add polling method to logparser and tail inputs. +- Add timeout option for Kubernetes (`kubernetes`) input plugin. +- Add support for timing sums in statsd input plugin. +- Add resource limit monitoring to Procstat (`procstat`) input plugin. +- Add support for k8s service DNS discovery to Prometheus Client (`prometheus`) input plugin. +- Add configurable metrics endpoint to (`prometheus`) output plugin. +- Add support for NSQLookupd to `nsq_consumer`. +- Add configurable separator for metrics and fields in OpenTSDB (`opentsdb`) output plugin. +- Add support for the rollbar occurrence webhook event. +- Add extra wired tiger cache metrics to `mongodb` input. +- Collect Docker Swarm service metrics in Docker (`docker`) input plugin. +- Add cluster health level configuration to Elasticsearch (`elasticsearch`) input plugin. +- Add ability to limit node stats in Elasticsearch (`elasticsearch`) input plugin. +- Add UDP IPv6 support to StatsD (`statsd`) input plugin. +- Use labels in Prometheus Client (`prometheus`) output plugin for string fields. +- Add support for decimal timestamps to ts-epoch modifier. +- Add histogram and summary types and use in Prometheus (`prometheus`) plugins. +- Gather concurrently from snmp agents. +- Perform DNS lookup before ping and report result. +- Add instance name option to Varnish (`varnish`) plugin. +- Add support for SSL settings to ElasticSearch (`elasticsearch`) output plugin. +- Add modification_time field to Filestat (`filestat`) input plugin. +- Add systemd unit pid and cgroup matching to Procstat (`procstat`) . +- Use MAX() instead of SUM() for latency measurements in SQL Server (`sqlserver`) input plugin. +- Add index by week number to Elasticsearch (`elasticsearch`) output plugin. +- Add support for tags in the index name in Elasticsearch (`elasticsearch`) output plugin. +- Add slab to mem plugin. +- Add support for glob patterns in net input plugin. +- Add option to AMQP (`amqp`) output plugin to publish persistent messages. +- Support I (idle) process state on procfs+Linux. + +### Bug fixes + +- Fix webhooks input address in use during reload. +- Unlock Statsd when stopping to prevent deadlock. +- Fix cloudwatch output requires unneeded permissions. +- Fix prometheus passthrough for existing value types. +- Always ignore autofs filesystems in disk input. +- Fail metrics parsing on unescaped quotes. +- Whitelist allowed char classes for graphite output. +- Use hexadecimal ids and lowercase names in zipkin input. +- Fix snmp-tools output parsing with Windows EOLs. +- Add shadow-utils dependency to rpm package. +- Use deb-systemd-invoke to restart service. +- Fix kafka_consumer outside range of offsets error. +- Fix separation of multiple prometheus_client outputs. +- Don't add system input uptime_format as a counter. + +## v1.4.5 [2017-12-01] + +### Bug fixes + +- Fix global variable collection when using interval_slow option in MySQL input. +- Fix error getting net connections info in netstat input. +- Fix HOST_MOUNT_PREFIX in Docker with disk input. + +## v1.4.4 [2017-11-08] + +### Bug fixes +- Use schema specified in mqtt_consumer input. +- Redact Datadog API key in log output. +- Fix error getting PIDs in netstat input. +- Support HOST_VAR envvar to locate /var in system input. +- Use current time if Docker container read time is zero value. + +## v1.4.3 [2017-10-25] + +### Bug fixes + +- Fix container name filters in Docker input. +- Fix snmpwalk address format in leofs input. +- Fix case sensitivity issue in SQL Server query. +- Fix CPU input plugin stuck after suspend on Linux. +- Fix MongoDB input panic when restarting MongoDB. +- Preserve URL path prefix in InfluxDB output. +- Fix TELEGRAF_OPTS expansion in systemd service unit. +- Remove warning when JSON contains null value. +- Fix ACL token usage in consul input plugin. +- Fix unquoting error with Tomcat 6. +- Fix syscall panic in diskio on some Linux systems. + +## v1.4.2 [2017-10-10] + +### Bug fixes + +- Fix error if int larger than 32-bit in `/proc/vmstat`. +- Fix parsing of JSON with a UTF8 BOM in `httpjson`. +- Allow JSON data format to contain zero metrics. +- Fix format of connection_timeout in `mqtt_consumer`. +- Fix case sensitivity error in SQL Server input. +- Add support for proxy environment variables to `http_response`. +- Add support for standard proxy env vars in outputs. +- Fix panic in CPU input if number of CPUs changes. +- Use chunked transfer encoding in InfluxDB output. + +## v1.4.1 [2017-09-26] + +### Bug fixes + +- Fix MQTT input exits if Broker is not available on startup. +- Fix optional field value conversions in fluentd input. +- Whitelist allowed char classes for opentsdb output. +- Fix counter and gauge metric types. +- Fix skipped line with empty target in iptables. +- Fix duplicate keys in perf counters sqlserver query. +- Fix panic in statsd p100 calculation. +- Fix arm64 packages contain 32-bit executable. + +## v1.4.0 [2017-09-05] + +### Release Notes + +- The `kafka_consumer` input has been updated to support Kafka 0.9 and + above style consumer offset handling. The previous version of this plugin + supporting Kafka 0.8 and below is available as the `kafka_consumer_legacy` + plugin. +- In the `aerospike` input the `node_name` field has been changed to be a tag + for both the `aerospike_node` and `aerospike_namespace` measurements. +- The default prometheus_client port has been changed to 9273. + +### New plugins + +- fail2ban +- fluentd +- histogram +- minecraft +- openldap +- salesforce +- tomcat +- win_services +- zipkin + +### Features + +- Add Kafka 0.9+ consumer support. +- Add support for self-signed certs to InfluxDB input plugin. +- Add TCP listener for statsd input. +- Add Docker container environment variables as tags. Only whitelisted. +- Add timeout option to IPMI sensor plugin. +- Add support for an optional SSL/TLS configuration to Nginx input plugin. +- Add timezone support for logparser timestamps. +- Add result_type field for http_response input. +- Add include/exclude filters for docker containers. +- Add secure connection support to graphite output. +- Add min/max response time on linux/darwin to ping. +- Add HTTP Proxy support to influxdb output. +- Add standard SSL options to mysql input. +- Add input plugin for fail2ban. +- Support HOST_PROC in processes and linux_sysctl_fs inputs. +- Add Minecraft input plugin. +- Add support for RethinkDB 1.0 handshake protocol. +- Add optional usage_active and time_active CPU metrics. +- Change default prometheus_client port. +- Add fluentd input plugin. +- Add result_type field to net_response input plugin. +- Add read timeout to socket_listener. +- Add input plugin for OpenLDAP. +- Add network option to dns_query. +- Add redis_version field to redis input. +- Add tls options to docker input. +- Add histogram aggregator plugin. +- Add Zipkin input plugin. +- Add Windows Services input plugin. +- Add path tag to logparser containing path of logfile. +- Add Salesforce input plugin. +- Add option to run varnish under sudo. +- Add weighted_io_time to diskio input. +- Add gzip content-encoding support to influxdb output. +- Allow using system plugin in Windows. +- Add Tomcat input plugin. +- HTTP headers can be added to InfluxDB output. + +### Bug fixes + +- Improve logging of errors in Cassandra input. +- [enh] set db_version at 0 if query version fails. +- Fixed SQL Server input to work with case sensitive server collation. +- Systemd does not see all shutdowns as failures. +- Reuse transports in input plugins. +- Inputs processes fails with "no such process". +- Fix multiple plugin loading in win_perf_counters. +- MySQL input: log and continue on field parse error. +- Fix timeout option in Windows ping input sample configuration. +- Fix Kinesis output plugin in govcloud. +- Fix Aerospike input adds all nodes to a single series. +- Improve Prometheus Client output documentation. +- Display error message if prometheus output fails to listen. +- Fix elasticsearch output content type detection warning. +- Prevent possible deadlock when using aggregators. +- Fix combined tagdrop/tagpass filtering. +- Fix filtering when both pass and drop match an item. +- Only report cpu usage for online cpus in docker input. +- Start first aggregator period at startup time. +- Fix panic in logparser if file cannot be opened. +- Default to localhost if zookeeper has no servers set. +- Fix docker memory and cpu reporting in Windows. +- Allow iptable entries with trailing text. +- Sanitize password from couchbase metric. +- Converge to typed value in prometheus output. +- Skip compilcation of logparser and tail on solaris. +- Discard logging from tail library. +- Remove log message on ping timeout. +- Don't retry points beyond retention policy. +- Don't start Telegraf on install in Amazon Linux. +- Enable hddtemp input on all platforms. +- Escape backslash within string fields. +- Fix parsing of SHM remotes in ntpq input +- Don't fail parsing zpool stats if pool health is UNAVAIL on FreeBSD. +- Fix NSQ input plugin when used with version 1.0.0-compat. +- Added CloudWatch metric constraint validation. +- Skip non-numerical values in graphite format. +- Fix panic when handling string fields with escapes. + +## v1.3.5 [2017-07-26] + +### Bug fixes + +- Fix prometheus output cannot be reloaded. +- Fix filestat reporting exists when cannot list directory. +- Fix ntpq parse issue when using dns_lookup. +- Fix panic when agent.interval = "0s". + +## v1.3.4 [2017-07-12] + +### Bug fixes + +- Fix handling of escape characters within fields. +- Fix chrony plugin does not track system time offset. +- Do not allow metrics with trailing slashes. +- Prevent Write from being called concurrently. + +## v1.3.3 [2017-06-28] + +### Bug fixes + +- Allow dos line endings in tail and logparser. +- Remove label value sanitization in prometheus output. +- Fix bug parsing default timestamps with modified precision. +- Fix panic in elasticsearch input if cannot determine master. + +## v1.3.2 [2017-06-14] + +### Bug fixes + +- Fix InfluxDB UDP metric splitting. +- Fix mongodb/leofs urls without scheme. +- Fix inconsistent label dimensions in prometheus output. + +## v1.3.1 [2017-05-31] + +### Bug fixes + +- Fixed sqlserver input to work with case-sensitive server collation. +- Reuse transports in input plugins. +- Process input fails with `no such process`. +- Fix InfluxDB output database quoting. +- Fix net input on older Linux kernels. +- Fix panic in mongo input. +- Fix length calculation of split metric buffer. + +## v1.3.0 [2017-05-09] + +#### Changes to the Windows ping plugin + +Users of the windows [ping plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/ping) will need to drop or migrate their measurements to continue using the plugin. +The reason for this is that the windows plugin was outputting a different type than the linux plugin. +This made it impossible to use the `ping` plugin for both windows and linux machines. + +#### Changes to the Ceph plugin + +For the [Ceph plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/ceph), the `ceph_pgmap_state` metric content has been modified to use a unique field `count`, with each state expressed as a `state` tag. + +Telegraf < 1.3: + +``` +# field_name value +active+clean 123 +active+clean+scrubbing 3 +``` + +Telegraf >= 1.3: + +``` +# field_name value tag +count 123 state=active+clean +count 3 state=active+clean+scrubbing +``` + +#### Rewritten Riemann plugin + +The [Riemann output plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/riemann) has been rewritten +and the [previous riemann plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/riemann_legacy) is _incompatible_ with the new one. +The reasons for this are outlined in issue [#1878](https://github.com/influxdata/telegraf/issues/1878). +The previous Riemann output will still be available using `outputs.riemann_legacy` if needed, but that will eventually be deprecated. +It is highly recommended that all users migrate to the new Riemann output plugin. + +#### New Socket Listener and Socket Writer plugins + +Generic [Socket Listener](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/socket_listener) and [Socket Writer](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/socket_writer) plugins have been implemented for receiving and sending UDP, TCP, unix, & unix-datagram data. +These plugins will replace [udp_listener](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/udp_listener) and [tcp_listener](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/tcp_listener), which are still available but will be deprecated eventually. + +### Features + +- Add SASL options for the [Kafka output plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/kafka). +- Add SSL configuration for [HAproxy input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/haproxy). +- Add the [Interrupts input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/interrupts). +- Add generic [Socket Listener input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/socket_listener) and [socket writer output plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/socket_writer). +- Extend the [HTTP Response input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/http_response) to support searching for a substring in response. Return 1 if found, else 0. +- Add userstats to the [MySQL input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/mysql). +- Add more InnoDB metric to the [MySQL input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/mysql). +- For the [Ceph input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/ceph), `ceph_pgmap_state` metric now uses a single field `count`, with PG state published as `state` tag. +- Use own client for improved through-put and less allocations in the [InfluxDB output plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/influxdb). +- Keep -config-directory when running as Windows service. +- Rewrite the [Riemann output plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/riemann). +- Add support for name templates and udev tags to the [DiskIO input plugin](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/system/DISK_README.md#diskio-input-plugin). +- Add integer metrics for [Consul](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/consul) check health state. +- Add lock option to the [IPtables input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/iptables). +- Support [ipmi_sensor input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/ipmi_sensor) querying local ipmi sensors. +- Increment gather_errors for all errors emitted by inputs. +- Use the official docker SDK. +- Add [AMQP consumer input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/amqp_consumer). +- Add pprof tool. +- Support DEAD(X) state in the [system input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/system). +- Add support for [MongoDB](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/mongodb) client certificates. +- Support adding [SNMP](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/snmp) table indexes as tags. +- Add [Elasticsearch 5.x output plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/elasticsearch). +- Add json timestamp units configurability. +- Add support for Linux sysctl-fs metrics. +- Support to include/exclude docker container labels as tags. +- Add [DMCache input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/dmcache). +- Add support for precision in [HTTP Listener input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/http_listener). +- Add `message_len_max` option to the [Kafka consumer input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/kafka_consumer). +- Add [collectd parser](/telegraf/v1.3/concepts/data_formats_input/#collectd). +- Simplify plugin testing without outputs. +- Check signature in the [GitHub webhook input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/webhooks/github). +- Add [papertrail](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/webhooks/papertrail) support to webhooks. +- Change [jolokia input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/jolokia) to use bulk requests. +- Add [DiskIO input plugin](https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/system/DISK_README.md#diskio-input-plugin) for Darwin. +- Add use_random_partitionkey option to the [Kinesis output plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/kinesis). +- Add tcp keep-alive to [Socket Listener input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/socket_listener) and [Socket Writer output plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/outputs/socket_writer). +- Add [Kapacitor input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/kapacitor). +- Use Go (golang) 1.8.1. +- Add documentation for the [RabbitMQ input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/rabbitmq). +- Make the [Logparser input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/logparser) check for newly-created files. + +### Bug fixes + +- Allow `@` symbol in password for the ipmi_sensor plugin. +- Fix arithmetic overflow error converting numeric to data type int in SQL Server input. +- Flush jitter can inhibit metric collection. +- Add missing fields for HAproxy input. +- Handle null startTime for stopped pods for the Kubernetes input. +- Fix cpu input panic when /proc/stat is empty. +- Fix telegraf swallowing panics in --test mode. +- Create pidfile with 644 permissions & defer file deletion. +- Fix install/remove of telegraf on non-systemd Debian/Ubuntu systems. +- Fix for reloading telegraf freezes prometheus output. +- Fix when empty tag value causes error on InfluxDB output. +- buffer_size field value is negative number from "internal" plugin. +- Missing error handling in the MySQL plugin leads to segmentation violation. +- Fix type conflict in windows ping plugin. +- logparser: regexp with lookahead. +- Telegraf can crash in LoadDirectory on 0600 files. +- Iptables input: document better that rules without a comment are ignored. +- Fix win_perf_counters capping values at 100. +- Exporting Ipmi.Path to be set by config. +- Remove warning if parse empty content. +- Update default value for Cloudwatch rate limit. +- create /etc/telegraf/telegraf.d directory in tarball. +- Return error on unsupported serializer data format. +- Fix Windows Performance Counters multi instance identifier. +- Add write timeout to Riemann output. +- fix timestamp parsing on prometheus plugin. +- Fix deadlock when output cannot write. +- Fix connection leak in postgresql. +- Set default measurement name for snmp input. +- Improve performance of diskio with many disks. +- The internal input plugin uses the wrong units for `heap_objects`. +- Fix ipmi_sensor config is shared between all plugin instances. +- Network statistics not collected when system has alias interfaces. +- Sysstat plugin needs LANG=C or similar locale. +- File output closes standard streams on reload. +- AMQP output disconnect blocks all outputs. +- Improve documentation for redis input plugin. + +## v1.2.1 [2017-02-01] + +### Bug fixes + +- Fix segfault on nil metrics with InfluxDB output. +- Fix negative number handling. + +### Features + +- Go (golang) version update 1.7.4 -> 1.7.5 + +## v1.2 [2017-01-24] + +### Release Notes + +- The StatsD plugin will now default all "delete_" config options to "true". This +will change te default behavior for users who were not specifying these parameters +in their config file. + +- The StatsD plugin will also no longer save it's state on a service reload. +Essentially we have reverted PR [#887](https://github.com/influxdata/telegraf/pull/887). +The reason for this is that saving the state in a global variable is not +thread-safe (see [#1975](https://github.com/influxdata/telegraf/issues/1975) & [#2102](https://github.com/influxdata/telegraf/issues/2102)), +and this creates issues if users want to define multiple instances +of the statsd plugin. Saving state on reload may be considered in the future, +but this would need to be implemented at a higher level and applied to all +plugins, not just statsd. + +### Features + +- Fix improper calculation of CPU percentages +- Use RFC3339 timestamps in log output. +- Non-default HTTP timeouts for RabbitMQ plugin. +- "Discard" output plugin added, primarily for testing purposes. +- The JSON parser can now parse an array of objects using the same configuration. +- Option to use device name rather than path for reporting disk stats. +- Telegraf "internal" plugin for collecting stats on itself. +- Update GoLang version to 1.7.4. +- Support a metric.Split function. +- Elasticsearch "shield" (basic auth) support doc. +- Fix over-querying of cloudwatch metrics +- OpenTSDB basic auth support. +- RabbitMQ Connection metrics. +- HAProxy session limit metric. +- Accept strings for StatsD sets. +- Change StatsD default "reset" behavior. +- Enable setting ClientID in MQTT output. +- MongoDB input plugin: Improve state data. +- Ping input: add standard deviation field. +- Add GC pause metric to InfluxDB input plugin. +- Added response_timeout property to prometheus input plugin. +- Pulling github.com/lxn/win's pdh wrapper into Telegraf. +- Support negative statsd counters. +- Elasticsearch cluster stats support. +- Change Amazon Kinesis output plugin to use the built-in serializer plugins. +- Hide username/password from elasticsearch error log messages. +- Configurable HTTP timeouts in Jolokia plugin. +- Allow changing jolokia attribute delimiter. + +### Bug fixes + +- Fix the Value data format not trimming null characters from input. +- Fix windows `.net` plugin. +- Cache & expire metrics for delivery to prometheus +- Fix potential panic in aggregator plugin metric maker. +- Add optional ability to define PID as a tag. +- Fix win_perf_counters not gathering non-English counters. +- Fix panic when file stat info cannot be collected due to permissions or other issue(s). +- Graylog output should set short_message field. +- Hddtemp always put the value in the field temperature. +- Properly collect nested jolokia struct data. +- Fix puppetagent inputs plugin to support string for config variable. +- Fix docker input plugin tags when registry has port. +- Fix tail input when reading from a pipe. +- MongoDB plugin always shows 0 replication lag. +- Consul plugin: add check_id as a tag in metrics to avoid overwrites. +- Partial fix: logparser CLF pattern with IPv6 addresses. +- Fix thread-safety when using multiple instances of the statsd input plugin. +- Docker input: interface conversion panic fix. +- SNMP: ensure proper context is present on error messages. +- OpenTSDB: add tcp:// prefix if no scheme provided. +- Influx parser: parse line-protocol without newlines. +- InfluxDB output: fix field type conflict blocking output buffer. + +## v1.1.2 [2016-12-12] + +### Bug fixes + +- Make snmptranslate not required when using numeric OID. +- Add a global snmp translation cache. + +## v1.1.1 [2016-11-14] + +### Bug fixes + +- Fix issue parsing toml durations with single quotes. + +## v1.1.0 [2016-11-07] + +### Release Notes + +- Telegraf now supports two new types of plugins: processors & aggregators. + +- On systemd Telegraf will no longer redirect it's stdout to /var/log/telegraf/telegraf.log. +On most systems, the logs will be directed to the systemd journal and can be +accessed by `journalctl -u telegraf.service`. Consult the systemd journal +documentation for configuring journald. There is also a [`logfile` config option](https://github.com/influxdata/telegraf/blob/release-1.8/etc/telegraf.conf#L70) +available in 1.1, which will allow users to easily configure telegraf to +continue sending logs to /var/log/telegraf/telegraf.log. + +### Features + +- Processor & Aggregator plugin support. +- Adding the tags in the graylog output plugin. +- Telegraf systemd service, log to journal. +- Allow numeric and non-string values for tag_keys. +- Adding Gauge and Counter metric types. +- Remove carraige returns from exec plugin output on Windows +- Elasticsearch input: configurable timeout. +- Massage metric names in Instrumental output plugin +- Apache Mesos improvements. +- Add Ceph Cluster Performance Statistics +- Ability to configure response_timeout in httpjson input. +- Add additional redis metrics. +- Added capability to send metrics through HTTP API for OpenTSDB. +- iptables input plugin. +- Add filestack webhook plugin. +- Add server hostname for each Docker measurements. +- Add NATS output plugin. +- HTTP service listener input plugin. +- Add database blacklist option for Postgresql +- Add Docker container state metrics to Docker input plugin output +- Add support to SNMP for IP & MAC address conversion. +- Add support to SNMP for OID index suffixes. +- Change default arguments for SNMP plugin. +- Apach Mesos input plugin: very high-cardinality mesos-task metrics removed. +- Logging overhaul to centralize the logger & log levels, & provide a logfile config option. +- HAProxy plugin socket glob matching. +- Add Kubernetes plugin for retrieving pod metrics. + +### Bug fixes + +- Fix NATS plug-ins reconnection logic. +- Set required default values in udp_listener & tcp_listener. +- Fix toml unmarshal panic in Duration objects. +- Fix handling of non-string values for JSON keys listed in tag_keys. +- Fix mongodb input panic on version 2.2. +- Fix statsd scientific notation parsing. +- Sensors plugin strconv.ParseFloat: parsing "": invalid syntax. +- Fix prometheus_client reload panic. +- Fix Apache Kafka consumer panic when nil error is returned down errs channel. +- Speed up statsd parsing. +- Fix powerdns integer parse error handling. +- Fix varnish plugin defaults not being used. +- Fix Windows glob paths. +- Fix issue loading config directory on Windows. +- Windows remote management interactive service fix. +- SQLServer, fix issue when case sensitive collation is activated. +- Fix huge allocations in http_listener when dealing with huge payloads. +- Fix translating SNMP fields not in MIB. +- Fix SNMP emitting empty fields. +- SQL Server waitstats truncation bug. +- Fix logparser common log format: numbers in ident. +- Fix JSON Serialization in OpenTSDB output. +- Fix Graphite template ordering, use most specific. +- Fix snmp table field initialization for non-automatic table. +- cgroups path being parsed as metric. +- Fix phpfpm fcgi client panic when URL does not exist. +- Fix config file parse error logging. +- Delete nil fields in the metric maker. +- Fix MySQL special characters in DSN parsing. +- Ping input odd timeout behavior. +- Switch to github.com/kballard/go-shellquote. + +## v1.0.1 [2016-09-26] + +### Bug fixes + +- Prometheus output: Fix bug with multi-batch writes. +- Fix unmarshal of influxdb metrics with null tags. +- Add configurable timeout to influxdb input plugin. +- Fix statsd no default value panic. + +## v1.0 [2016-09-08] + +### Release Notes + +**Breaking Change** The SNMP plugin is being deprecated in it's current form. +There is a [new SNMP plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/snmp) +which fixes many of the issues and confusions +of its predecessor. For users wanting to continue to use the deprecated SNMP +plugin, you will need to change your config file from `[[inputs.snmp]]` to +`[[inputs.snmp_legacy]]`. The configuration of the new SNMP plugin is _not_ +backwards-compatible. + +**Breaking Change**: Aerospike main server node measurements have been renamed +aerospike_node. Aerospike namespace measurements have been renamed to +aerospike_namespace. They will also now be tagged with the node_name +that they correspond to. This has been done to differentiate measurements +that pertain to node vs. namespace statistics. + +**Breaking Change**: users of github_webhooks must change to the new +`[[inputs.webhooks]]` plugin. + +This means that the default github_webhooks config: + +``` +# A Github Webhook Event collector +[[inputs.github_webhooks]] + ## Address and port to host Webhook listener on + service_address = ":1618" +``` + +should now look like: + +``` +# A Webhooks Event collector +[[inputs.webhooks]] + ## Address and port to host Webhook listener on + service_address = ":1618" + + [inputs.webhooks.github] + path = "/" +``` + +- Telegraf now supports being installed as an official windows service, +which can be installed via +`> C:\Program Files\Telegraf\telegraf.exe --service install` + +- `flush_jitter` behavior has been changed. The random jitter will now be +evaluated at every flush interval, rather than once at startup. This makes it +consistent with the behavior of `collection_jitter`. + +- PostgresSQL plugins now handle oid and name typed columns seamlessly, previously they were ignored/skipped. + +### Features + +- postgresql_extensible now handles name and oid types correctly. +- Separate container_version from container_image tag. +- Support setting per-device and total metrics for Docker network and blockio. +- MongoDB input plugin: adding per DB stats from db.stats() +- Add tls support for certs to RabbitMQ input plugin. +- Webhooks input plugin. +- Rollbar webhook plugin. +- Mandrill webhook plugin. +- docker-machine/boot2docker no longer required for unit tests. +- cgroup input plugin. +- Add input plugin for consuming metrics from NSQD. +- Add ability to read Redis from a socket. +- **Breaking Change** - Redis `role` tag renamed to `replication_role` to avoid global_tags override. +- Fetching Galera status metrics in MySQL +- Aerospike plugin refactored to use official client library. +- Add measurement name arg to logparser plugin. +- logparser: change resp_code from a field to a tag. +- Implement support for fetching hddtemp data +- statsd: do not log every dropped metric. +- Add precision rounding to all metrics on collection. +- Add support for Tengine. +- Logparser input plugin for parsing grok-style log patterns. +- ElasticSearch: now supports connecting to ElasticSearch via SSL. +- Add graylog input pluging. +- Consul input plugin. +- conntrack input plugin. +- vmstat input plugin. +- Standardized AWS credentials evaluation & wildcard CloudWatch dimensions. +- Add SSL config options to http_response plugin. +- Graphite parser: add ability to specify multiple tag keys, for consistency with influxdb parser. +- Make DNS lookups for chrony configurable. +- Allow wildcard filtering of varnish stats. +- Support for glob patterns in exec plugin commands configuration. +- RabbitMQ input: made url parameter optional by using DefaultURL (`http://localhost:15672`) if not specified. +- Limit AWS GetMetricStatistics requests to 10 per second. +- RabbitMQ/Apache/InfluxDB inputs: made url(s) parameter optional by using reasonable input defaults if not specified. +- Refactor of flush_jitter argument. +- Add inactive & active memory to mem plugin. +- Official Windows service. +- Forking sensors command to remove C package dependency. +- Add a new SNMP plugin. + +### Bug fixes + +- Fix `make windows` build target. +- Fix error race conditions and partial failures. +- nstat: fix inaccurate config panic. +- jolokia: fix handling multiple multi-dimensional attributes. +- Fix prometheus character sanitizing. Sanitize more win_perf_counters characters. +- Add diskio io_time to FreeBSD & report timing metrics as ms (as linux does). +- Fix covering Amazon Linux for post remove flow. +- procstat missing fields: read/write bytes & count. +- diskio input plugin: set 'skip_serial_number = true' by default to avoid high cardinality. +- nil metrics panic fix. +- Fix datarace in apache input plugin. +- Add `read_repairs` statistics to riak plugin. +- Fix memory/connection leak in Prometheus input plugin. +- Trim BOM from config file for Windows support. +- Prometheus client output panic on service reload. +- Prometheus parser, protobuf format header fix. +- Prometheus output, metric refresh and caching fixes. +- Panic fix for multiple graphite outputs under very high load. +- Instrumental output has better reconnect behavior. +- Remove PID from procstat plugin to fix cardinality issues. +- Cassandra input: version 2.x "column family" fix. +- Shared WaitGroup in Exec plugin. +- logparser: honor modifiers in "pattern" config. +- logparser: error and exit on file permissions/missing errors. +- Make the user able to specify full path for HAproxy stats. +- Fix Redis url, an extra "tcp://" was added. +- Fix exec plugin panic when using single binary. +- Fixed incorrect prometheus metrics source selection. +- Set default Zookeeper chroot to empty string. +- Fix overall ping timeout to be calculated based on per-ping timeout. +- Change "default" retention policy to "". +- Graphite output mangling '%' character. +- Prometheus input plugin now supports x509 certs authentication. +- Fix systemd service. +- Fix influxdb n_shards counter. +- Fix potential kernel plugin integer parse error. +- Fix potential influxdb input type assertion panic. +- Still send processes metrics if a process exited during metric collection. +- disk plugin panic when usage grab fails. +- Removed leaked "database" tag on redis metrics. +- Processes plugin: fix potential error with /proc/net/stat directory. +- Fix rare RHEL 5.2 panic in gopsutil diskio gathering function. +- Remove IF NOT EXISTS from influxdb output database creation. +- Fix quoting with text values in postgresql_extensible plugin. +- Fix win_perf_counter "index out of range" panic. +- Fix ntpq panic when field is missing. +- Sanitize graphite output field names. +- Fix MySQL plugin not sending 0 value fields. diff --git a/content/telegraf/v1.17/administration/_index.md b/content/telegraf/v1.17/administration/_index.md new file mode 100644 index 000000000..7cd389ce7 --- /dev/null +++ b/content/telegraf/v1.17/administration/_index.md @@ -0,0 +1,11 @@ +--- + title: Administering Telegraf + + menu: + telegraf_1_17: + name: Administration + weight: 60 + +--- + +{{< children >}} diff --git a/content/telegraf/v1.17/administration/configuration.md b/content/telegraf/v1.17/administration/configuration.md new file mode 100644 index 000000000..37f0ddf56 --- /dev/null +++ b/content/telegraf/v1.17/administration/configuration.md @@ -0,0 +1,423 @@ +--- +title: Configuring Telegraf +description: Overview of the Telegraf configuration file, enabling plugins, and setting environment variables. +menu: + telegraf_1_17: + name: Configuring + weight: 20 + parent: Administration +--- + +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). + +## Generate a configuration file + +A default Telegraf configuration file can be auto-generated by Telegraf: + +``` +telegraf config > telegraf.conf +``` + +To generate a configuration file with specific inputs and outputs, you can use the +`--input-filter` and `--output-filter` flags: + +``` +telegraf --input-filter cpu:mem:net:swap --output-filter influxdb:kafka config +``` + +## Configuration file locations + +Use the `--config` flag to specify the configuration file location: + +- Filename and path, for example: `--config /etc/default/telegraf` +- Remote URL endpoint, for example: `--config "http://remote-URL-endpoint"` + +Use the `--config-directory` flag to include files ending with `.conf` in the specified directory in the Telegraf +configuration. + +On most systems, the default locations are `/etc/telegraf/telegraf.conf` for +the main configuration file and `/etc/telegraf/telegraf.d` for the directory of +configuration files. + +## Set environment variables + +Add environment variables anywhere in the configuration file by prepending them with `$`. +For strings, variables must be in quotes (for example, `"$STR_VAR"`). +For numbers and Booleans, variables must be unquoted (for example, `$INT_VAR`, `$BOOL_VAR`). + +You can also set environment variables using the Linux `export` command: `export password=mypassword` + +> **Note:** We recommend using environment variables for sensitive information. + +### Example: Telegraf environment variables + +In the Telegraf environment variables file (`/etc/default/telegraf`): + +```sh +USER="alice" +INFLUX_URL="http://localhost:8086" +INFLUX_SKIP_DATABASE_CREATION="true" +INFLUX_PASSWORD="monkey123" +``` + +In the Telegraf configuration file (`/etc/telegraf.conf`): + +```sh +[global_tags] + user = "${USER}" + +[[inputs.mem]] + +[[outputs.influxdb]] + urls = ["${INFLUX_URL}"] + skip_database_creation = ${INFLUX_SKIP_DATABASE_CREATION} + password = "${INFLUX_PASSWORD}" +``` + +The environment variables above add the following configuration settings to Telegraf: + +```sh +[global_tags] + user = "alice" + +[[outputs.influxdb]] + urls = "http://localhost:8086" + skip_database_creation = true + password = "monkey123" + +``` + +# Global tags + +Global tags can be specified in the `[global_tags]` section of the config file +in `key="value"` format. All metrics being gathered on this host will be tagged +with the tags specified here. + +## Agent configuration + +Telegraf has a few options you can configure under the `[agent]` section of the +config. + +* **interval**: Default data collection interval for all inputs +* **round_interval**: Rounds collection interval to `interval`. +For example, if `interval` is set to 10s then always collect on :00, :10, :20, etc. +* **metric_batch_size**: Telegraf will send metrics to output in batch of at +most `metric_batch_size` metrics. +* **metric_buffer_limit**: Telegraf will cache `metric_buffer_limit` metrics +for each output, and will flush this buffer on a successful write. +This should be a multiple of `metric_batch_size` and could not be less +than 2 times `metric_batch_size`. +* **collection_jitter**: Collection jitter is used to jitter +the collection by a random amount. +Each plugin will sleep for a random time within jitter before collecting. +This can be used to avoid many plugins querying things like sysfs at the +same time, which can have a measurable effect on the system. +* **flush_interval**: Default data flushing interval for all outputs. +You should not set this below `interval`. +Maximum `flush_interval` will be `flush_interval` + `flush_jitter` +* **flush_jitter**: Jitter the flush interval by a random amount. +This is primarily to avoid +large write spikes for users running a large number of Telegraf instances. +For example, a `flush_jitter` of 5s and `flush_interval` of 10s means flushes will happen every 10-15s. +* **precision**: By default, precision will be set to the same timestamp order +as the collection interval, with the maximum being 1s. Precision will NOT +be used for service inputs, such as `logparser` and `statsd`. Valid values are +`ns`, `us` (or `µs`), `ms`, and `s`. +* **logfile**: Specify the log file name. The empty string means to log to `stderr`. +* **debug**: Run Telegraf in debug mode. +* **quiet**: Run Telegraf in quiet mode (error messages only). +* **hostname**: Override default hostname, if empty use `os.Hostname()`. +* **omit_hostname**: If true, do no set the `host` tag in the Telegraf agent. + +## Input configuration + +The following config parameters are available for all inputs: + +* **interval**: How often to gather this metric. Normal plugins use a single +global interval, but if one particular input should be run less or more often, +you can configure that here. +* **name_override**: Override the base name of the measurement. +(Default is the name of the input). +* **name_prefix**: Specifies a prefix to attach to the measurement name. +* **name_suffix**: Specifies a suffix to attach to the measurement name. +* **tags**: A map of tags to apply to a specific input's measurements. + +## Output configuration + +There are no generic configuration options available for all outputs. + +## Aggregator configuration + +The following config parameters are available for all aggregators: + +* **period**: The period on which to flush & clear each aggregator. All metrics +that are sent with timestamps outside of this period will be ignored by the +aggregator. +* **delay**: The delay before each aggregator is flushed. This is to control +how long for aggregators to wait before receiving metrics from input plugins, +in the case that aggregators are flushing and inputs are gathering on the +same interval. +* **drop_original**: If true, the original metric will be dropped by the +aggregator and will not get sent to the output plugins. +* **name_override**: Override the base name of the measurement. +(Default is the name of the input). +* **name_prefix**: Specifies a prefix to attach to the measurement name. +* **name_suffix**: Specifies a suffix to attach to the measurement name. +* **tags**: A map of tags to apply to a specific input's measurements. + +## Processor configuration + +The following config parameters are available for all processors: + +* **order**: This is the order in which processors are executed. If this +is not specified, then processor execution order will be random. + +#### Measurement filtering + +Filters can be configured per input, output, processor, or aggregator, +see below for examples. + +* **namepass**: +An array of glob pattern strings. Only points whose measurement name matches +a pattern in this list are emitted. +* **namedrop**: +The inverse of `namepass`. If a match is found the point is discarded. This +is tested on points after they have passed the `namepass` test. +* **fieldpass**: +An array of glob pattern strings. Only fields whose field key matches a +pattern in this list are emitted. +* **fielddrop**: +The inverse of `fieldpass`. Fields with a field key matching one of the +patterns will be discarded from the point. +* **tagpass**: +A table mapping tag keys to arrays of glob pattern strings. Only points +that contain a tag key in the table and a tag value matching one of its +patterns is emitted. +* **tagdrop**: +The inverse of `tagpass`. If a match is found the point is discarded. This +is tested on points after they have passed the `tagpass` test. +* **taginclude**: +An array of glob pattern strings. Only tags with a tag key matching one of +the patterns are emitted. In contrast to `tagpass`, which will pass an entire +point based on its tag, `taginclude` removes all non matching tags from the +point. This filter can be used on both inputs & outputs, but it is +_recommended_ to be used on inputs, as it is more efficient to filter out tags +at the ingestion point. +* **tagexclude**: +The inverse of `taginclude`. Tags with a tag key matching one of the patterns +will be discarded from the point. + +**NOTE** Due to the way TOML is parsed, `tagpass` and `tagdrop` parameters +must be defined at the _end_ of the plugin definition, otherwise subsequent +plugin config options will be interpreted as part of the tagpass/tagdrop +tables. + +#### Input configuration examples + +This is a full working config that will output CPU data to an InfluxDB instance +at `192.168.59.103:8086`, tagging measurements with `dc="denver-1"`. It will output +measurements at a 10s interval and will collect per-cpu data, dropping any +fields which begin with `time_`. + +```toml +[global_tags] + dc = "denver-1" + +[agent] + interval = "10s" + +# OUTPUTS +[[outputs.influxdb]] + url = "http://192.168.59.103:8086" # required. + database = "telegraf" # required. + precision = "s" + +# INPUTS +[[inputs.cpu]] + percpu = true + totalcpu = false + # filter all fields beginning with 'time_' + fielddrop = ["time_*"] +``` + +#### Input Config: `tagpass` and `tagdrop` + +**NOTE** `tagpass` and `tagdrop` parameters must be defined at the _end_ of +the plugin definition, otherwise subsequent plugin config options will be +interpreted as part of the tagpass/tagdrop map. + +```toml +[[inputs.cpu]] + percpu = true + totalcpu = false + fielddrop = ["cpu_time"] + # Don't collect CPU data for cpu6 & cpu7 + [inputs.cpu.tagdrop] + cpu = [ "cpu6", "cpu7" ] + +[[inputs.disk]] + [inputs.disk.tagpass] + # tagpass conditions are OR, not AND. + # If the (filesystem is ext4 or xfs) OR (the path is /opt or /home) + # then the metric passes + fstype = [ "ext4", "xfs" ] + # Globs can also be used on the tag values + path = [ "/opt", "/home*" ] +``` + +#### Input Config: `fieldpass` and `fielddrop` + +```toml +# Drop all metrics for guest & steal CPU usage +[[inputs.cpu]] + percpu = false + totalcpu = true + fielddrop = ["usage_guest", "usage_steal"] + +# Only store inode related metrics for disks +[[inputs.disk]] + fieldpass = ["inodes*"] +``` + +#### Input Config: `namepass` and `namedrop` + +```toml +# Drop all metrics about containers for kubelet +[[inputs.prometheus]] + urls = ["http://kube-node-1:4194/metrics"] + namedrop = ["container_*"] + +# Only store rest client related metrics for kubelet +[[inputs.prometheus]] + urls = ["http://kube-node-1:4194/metrics"] + namepass = ["rest_client_*"] +``` + +#### Input Config: `taginclude` and `tagexclude` + +```toml +# Only include the "cpu" tag in the measurements for the cpu plugin. +[[inputs.cpu]] + percpu = true + totalcpu = true + taginclude = ["cpu"] + +# Exclude the `fstype` tag from the measurements for the disk plugin. +[[inputs.disk]] + tagexclude = ["fstype"] +``` + +#### Input config: `prefix`, `suffix`, and `override` + +This plugin will emit measurements with the name `cpu_total`. + +```toml +[[inputs.cpu]] + name_suffix = "_total" + percpu = false + totalcpu = true +``` + +This will emit measurements with the name `foobar`. + +```toml +[[inputs.cpu]] + name_override = "foobar" + percpu = false + totalcpu = true +``` + +#### Input config: tags + +This plugin will emit measurements with two additional tags: `tag1=foo` and +`tag2=bar`. + +NOTE: Order matters, the `[inputs.cpu.tags]` table must be at the _end_ of the +plugin definition. + +```toml +[[inputs.cpu]] + percpu = false + totalcpu = true + [inputs.cpu.tags] + tag1 = "foo" + tag2 = "bar" +``` + +#### Multiple inputs of the same type + +Additional inputs (or outputs) of the same type can be specified by defining these instances in the configuration file. To avoid measurement collisions, use the `name_override`, `name_prefix`, or `name_suffix` config options: + +```toml +[[inputs.cpu]] + percpu = false + totalcpu = true + +[[inputs.cpu]] + percpu = true + totalcpu = false + name_override = "percpu_usage" + fielddrop = ["cpu_time*"] +``` + +#### Output configuration examples: + +```toml +[[outputs.influxdb]] + urls = [ "http://localhost:8086" ] + database = "telegraf" + precision = "s" + # Drop all measurements that start with "aerospike" + namedrop = ["aerospike*"] + +[[outputs.influxdb]] + urls = [ "http://localhost:8086" ] + database = "telegraf-aerospike-data" + precision = "s" + # Only accept aerospike data: + namepass = ["aerospike*"] + +[[outputs.influxdb]] + urls = [ "http://localhost:8086" ] + database = "telegraf-cpu0-data" + precision = "s" + # Only store measurements where the tag "cpu" matches the value "cpu0" + [outputs.influxdb.tagpass] + cpu = ["cpu0"] +``` + +#### Aggregator Configuration Examples: + +This will collect and emit the min/max of the system load1 metric every +30s, dropping the originals. + +```toml +[[inputs.system]] + fieldpass = ["load1"] # collects system load1 metric. + +[[aggregators.minmax]] + period = "30s" # send & clear the aggregate every 30s. + drop_original = true # drop the original metrics. + +[[outputs.file]] + files = ["stdout"] +``` + +This will collect and emit the min/max of the swap metrics every +30s, dropping the originals. The aggregator will not be applied +to the system load metrics due to the `namepass` parameter. + +```toml +[[inputs.swap]] + +[[inputs.system]] + fieldpass = ["load1"] # collects system load1 metric. + +[[aggregators.minmax]] + period = "30s" # send & clear the aggregate every 30s. + drop_original = true # drop the original metrics. + namepass = ["swap"] # only "pass" swap metrics through the aggregator. + +[[outputs.file]] + files = ["stdout"] +``` diff --git a/content/telegraf/v1.17/administration/enterprise-plugins.md b/content/telegraf/v1.17/administration/enterprise-plugins.md new file mode 100644 index 000000000..68018ed9a --- /dev/null +++ b/content/telegraf/v1.17/administration/enterprise-plugins.md @@ -0,0 +1,18 @@ +--- +title: Recommended Telegraf plugins for Enterprise users + +menu: + telegraf_1_17: + name: Recommended plugins for Enterprise users + weight: 20 + parent: Administration +draft: true +--- + +The Telegraf configuration file (`telegraf.conf`) lists all of the available plugins. The current version is available here: +[telegraf.conf](https://github.com/influxdata/telegraf/blob/master/etc/telegraf.conf) + +## Core Telegraf plugins for Enterprise users + + +## Optional Telegraf plugins for Enterprise users diff --git a/content/telegraf/v1.17/administration/troubleshooting.md b/content/telegraf/v1.17/administration/troubleshooting.md new file mode 100644 index 000000000..6c756258a --- /dev/null +++ b/content/telegraf/v1.17/administration/troubleshooting.md @@ -0,0 +1,89 @@ +--- +title: Troubleshoot Telegraf +description: Capture Telegraf output, submit sample metrics, and see how Telegraf formats and emits points to its output plugins. +menu: + telegraf_1_17: + name: Troubleshoot + weight: 30 + parent: Administration +--- + +This guide will show you how to capture Telegraf output, submit sample metrics, and see how Telegraf formats and emits points to its output plugins. + +## Capture output + +A quick way to view Telegraf output is by enabling a new UDP output plugin to run in parallel with the existing output plugins. Since each output plugin creates its own stream, the already existing outputs will not be affected. Traffic will be replicated to all active outputs. + +> **NOTE:** This approach requires Telegraf to be restarted, which will cause a brief interruption to your metrics collection. + +The minimal Telegraf configuration required to enable a UDP output is: + +``` +[[outputs.influxdb]] + urls = ["udp://localhost:8089"] +``` + +This setup utilizes the UDP format of the [InfluxDB output plugin](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb) and emits points formatted in InfluxDB's [line protocol](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#line-protocol). +You will need to append this section to the Telegraf configuration file and restart Telegraf for the change to take effect. + +Now you are ready to start listening on the destination port (`8089` in this example) using a simple tool like `netcat`: + +``` +nc -lup 8089 +``` + +`nc` will print the exact Telegraf output on stdout. +You can also direct the output to a file for further inspection: + +``` +nc -lup 8089 > telegraf_dump.txt +``` + +## Submit test inputs + +Once you have Telegraf's output arriving to your `nc` socket, you can enable the [inputs.socket_listener](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener) plugins to submit some sample metrics. + +Append the TCP or UDP input section to Telegraf's config file and restart Telegraf for the change to take effect. + +``` + [[inputs.socket_listener]] + service_address = "tcp://:8094" + data_format = "influx" +``` + +Submit sample data to the Telegraf socket listener: + +``` +echo 'mymeasurement,my_tag_key=mytagvalue my_field="my field value"' | nc localhost 8094 +``` + +The output from your `netcat` listener will look like the following: + +``` +mymeasurement,host=kubuntu,my_tag_key=mytagvalue my_field="my field value" 1478106104713745634 +``` + +## Testing other plugins + +The same approach can be used to test other plugins, like the [inputs.statsd](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/statsd) plugin. + +Here is a basic configuration example of how to set up the Telegraf statsd input plugin: + +``` + [[inputs.statsd]] + service_address = ":8125" + metric_separator = "_" + allowed_pending_messages = 10000 +``` + +Sending a sample metric to the Telegraf statsd port: + +``` +echo "a.b.c:1|g" | nc -u localhost 8125 +``` + +The output from `nc` will look like the following: + +``` +a_b_c,host=myserver,metric_type=gauge value=1 1478106500000000000 +``` diff --git a/content/telegraf/v1.17/administration/windows_service.md b/content/telegraf/v1.17/administration/windows_service.md new file mode 100644 index 000000000..32bbfedd9 --- /dev/null +++ b/content/telegraf/v1.17/administration/windows_service.md @@ -0,0 +1,66 @@ +--- +title: Running Telegraf as a Windows service +description: How to configure Telegraf as a Windows service using PowerShell. +menu: + telegraf_1_17: + name: Running as Windows service + weight: 20 + parent: Administration +--- + +Telegraf natively supports running as a Windows service. + +The following commands are available: + +| Command | Effect | +|------------------------------------|-------------------------------| +| `telegraf.exe --service install` | Install telegraf as a service | +| `telegraf.exe --service uninstall` | Remove the telegraf service | +| `telegraf.exe --service start` | Start the telegraf service | +| `telegraf.exe --service stop` | Stop the telegraf service | + +Outlined below are the general steps to install Telegraf as a Service. + +{{% note %}} +Installing a Windows service requires administrative permissions. +Be sure to [launch Powershell as administrator]( +https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell?view=powershell-7#with-administrative-privileges-run-as-administrator). +{{% /note %}} + +1. Download the Telegraf binary and unzip its contents to `C:\Program Files\InfluxData\Telegraf`. +2. In PowerShell, run the following as an administrator: + ```powershell + > cd "C:\Program Files\InfluxData\Telegraf" + > .\telegraf.exe --service install --config "C:\Program Files\InfluxData\Telegraf\telegraf.conf" + ``` + When installing Telegraf as a Windows service, provide the absolute path of the Telegraf configuration file. + Otherwise the Windows service may fail to start. +3. To test that the installation works, run: + + ```powershell + > C:\"Program Files"\InfluxData\Telegraf\telegraf.exe --config C:\"Program Files"\InfluxData\Telegraf\telegraf.conf --test + ``` + +4. To start collecting data, run: + + ```powershell + telegraf.exe --service start + ``` + + + +{{% note %}} +## Logging and troubleshooting +When Telegraf runs as a Windows service, Telegraf logs messages to Windows event logs. +If the Telegraf service fails to start, view error logs by selecting **Event Viewer**→**Windows Logs**→**Application**. +{{% /note %}} diff --git a/content/telegraf/v1.17/concepts/_index.md b/content/telegraf/v1.17/concepts/_index.md new file mode 100644 index 000000000..faced6e5e --- /dev/null +++ b/content/telegraf/v1.17/concepts/_index.md @@ -0,0 +1,11 @@ +--- +title: Key Telegraf concepts +description: Includes information on supported input data formats, output data formats, aggregator and processor plugins, and includes a glossary of important terms. +menu: + telegraf_1_17: + name: Concepts + weight: 30 +--- +This section discusses key concepts about Telegraf, the plug-in driven server agent component of the InfluxData time series platform. Topics covered include metrics, aggregator and processor plugins, and a glossary of important terms. + +{{< children >}} diff --git a/content/telegraf/v1.17/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.17/concepts/aggregator_processor_plugins.md new file mode 100644 index 000000000..7e5bc29ad --- /dev/null +++ b/content/telegraf/v1.17/concepts/aggregator_processor_plugins.md @@ -0,0 +1,49 @@ +--- +title: Telegraf aggregator and processor plugins +description: Aggregator and processor plugins work between the input plugins and output plugins to aggregate and process metrics in Telegraf. +menu: + telegraf_1_17: + name: Aggregator and processor plugins + weight: 20 + parent: Concepts +--- + +Besides the input plugins and output plugins, Telegraf includes aggregator and processor plugins, which are used to aggregate and process metrics as they pass through Telegraf. + +{{< diagram >}} + graph TD + Process[Process
- transform
- decorate
- filter] + Aggregate[Aggregate
- transform
- decorate
- filter] + + CPU --> Process + Memory --> Process + MySQL --> Process + SNMP --> Process + Docker --> Process + Process --> Aggregate + Aggregate --> InfluxDB + Aggregate --> File + Aggregate --> Kafka + +style Process text-align:left +style Aggregate text-align:left +{{< /diagram >}} + +**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. + +**Aggregator plugins**, on the other hand, are a bit more complicated. Aggregators +are typically for emitting new _aggregate_ metrics, such as a running mean, +minimum, maximum, quantiles, or standard deviation. For this reason, all _aggregator_ +plugins are configured with a `period`. The `period` is the size of the window +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. + +**NOTE** Since aggregator plugins only aggregate metrics within their periods, +historical data is not supported. In other words, if your metric timestamp is more +than `now() - period` in the past, it will not be aggregated. If this is a feature +that you need, please comment on this [GitHub issue](https://github.com/influxdata/telegraf/issues/1992). diff --git a/content/telegraf/v1.17/concepts/glossary.md b/content/telegraf/v1.17/concepts/glossary.md new file mode 100644 index 000000000..ab6da1781 --- /dev/null +++ b/content/telegraf/v1.17/concepts/glossary.md @@ -0,0 +1,103 @@ +--- +title: Telegraf glossary of terms +description: This section includes definitions of important terms for related to Telegraf. +menu: + telegraf_1_17: + name: Glossary of terms + weight: 30 + parent: Concepts +--- + +## agent + +An agent is the core part of Telegraf that gathers metrics from the declared input plugins and sends metrics to the declared output plugins, based on the plugins enabled by the given configuration. + +Related entries: [input plugin](/telegraf/v1.15/concepts/glossary/#input-plugin), [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin) + +## aggregator plugin + +Aggregator plugins receive raw metrics from input plugins and create aggregate metrics from them. +The aggregate metrics are then passed to the configured output plugins. + +Related entries: [input plugin](/telegraf/v1.15/concepts/glossary/#input-plugin), [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin), [processor plugin](/telegraf/v1.15/concepts/glossary/#processor-plugin) + +## batch size + +The Telegraf agent sends metrics to output plugins in batches, not individually. +The batch size controls the size of each write batch that Telegraf sends to the output plugins. + +Related entries: [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin) + +## collection interval + +The default global interval for collecting data from each input plugin. +The collection interval can be overridden by each individual input plugin's configuration. + +Related entries: [input plugin](/telegraf/v1.15/concepts/glossary/#input-plugin) + +## collection jitter + +Collection jitter is used to prevent every input plugin from collecting metrics simultaneously, which can have a measurable effect on the system. +Each collection interval, every input plugin will sleep for a random time between zero and the collection jitter before collecting the metrics. + +Related entries: [collection interval](/telegraf/v1.15/concepts/glossary/#collection-interval), [input plugin](/telegraf/v1.15/concepts/glossary/#input-plugin) + +## flush interval + +The global interval for flushing data from each output plugin to its destination. +This value should not be set lower than the collection interval. + +Related entries: [collection interval](/telegraf/v1.15/concepts/glossary/#collection-interval), [flush jitter](/telegraf/v1.15/concepts/glossary/#flush-jitter), [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin) + +## flush jitter + +Flush jitter is used to prevent every output plugin from sending writes simultaneously, which can overwhelm some data sinks. +Each flush interval, every output plugin will sleep for a random time between zero and the flush jitter before emitting metrics. +This helps smooth out write spikes when running a large number of Telegraf instances. + +Related entries: [flush interval](/telegraf/v1.15/concepts/glossary/#flush-interval), [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin) + +## input plugin + +Input plugins actively gather metrics and deliver them to the core agent, where aggregator, processor, and output plugins can operate on the metrics. +In order to activate an input plugin, it needs to be enabled and configured in Telegraf's configuration file. + +Related entries: [aggregator plugin](/telegraf/v1.15/concepts/glossary/#aggregator-plugin), [collection interval](/telegraf/v1.15/concepts/glossary/#collection-interval), [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin), [processor plugin](/telegraf/v1.15/concepts/glossary/#processor-plugin) + +## metric buffer + +The metric buffer caches individual metrics when writes are failing for an output plugin. +Telegraf will attempt to flush the buffer upon a successful write to the output. +The oldest metrics are dropped first when this buffer fills. + +Related entries: [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin) + +## output plugin + +Output plugins deliver metrics to their configured destination. In order to activate an output plugin, it needs to be enabled and configured in Telegraf's configuration file. + +Related entries: [aggregator plugin](/telegraf/v1.15/concepts/glossary/#aggregator-plugin), [flush interval](/telegraf/v1.15/concepts/glossary/#flush-interval), [input plugin](/telegraf/v1.15/concepts/glossary/#input-plugin), [processor plugin](/telegraf/v1.15/concepts/glossary/#processor-plugin) + +## precision + +The precision configuration setting determines how much timestamp precision is retained in the points received from input plugins. All incoming timestamps are truncated to the given precision. +Telegraf then pads the truncated timestamps with zeros to create a nanosecond timestamp; output plugins will emit timestamps in nanoseconds. +Valid precisions are `ns`, `us` or `µs`, `ms`, and `s`. + +For example, if the precision is set to `ms`, the nanosecond epoch timestamp `1480000000123456789` would be truncated to `1480000000123` in millisecond precision and then padded with zeroes to make a new, less precise nanosecond timestamp of `1480000000123000000`. +Output plugins do not alter the timestamp further. The precision setting is ignored for service input plugins. + +Related entries: [aggregator plugin](/telegraf/v1.15/concepts/glossary/#aggregator-plugin), [input plugin](/telegraf/v1.15/concepts/glossary/#input-plugin), [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin), [processor plugin](/telegraf/v1.15/concepts/glossary/#processor-plugin), [service input plugin](/telegraf/v1.15/concepts/glossary/#service-input-plugin) + +## processor plugin + +Processor plugins transform, decorate, and/or filter metrics collected by input plugins, passing the transformed metrics to the output plugins. + +Related entries: [aggregator plugin](/telegraf/v1.15/concepts/glossary/#aggregator-plugin), [input plugin](/telegraf/v1.15/concepts/glossary/#input-plugin), [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin) + +## service input plugin + +Service input plugins are input plugins that run in a passive collection mode while the Telegraf agent is running. +They listen on a socket for known protocol inputs, or apply their own logic to ingested metrics before delivering them to the Telegraf agent. + +Related entries: [aggregator plugin](/telegraf/v1.15/concepts/glossary/#aggregator-plugin), [input plugin](/telegraf/v1.15/concepts/glossary/#input-plugin), [output plugin](/telegraf/v1.15/concepts/glossary/#output-plugin), [processor plugin](/telegraf/v1.15/concepts/glossary/#processor-plugin) diff --git a/content/telegraf/v1.17/concepts/metrics.md b/content/telegraf/v1.17/concepts/metrics.md new file mode 100644 index 000000000..59ffb5d6e --- /dev/null +++ b/content/telegraf/v1.17/concepts/metrics.md @@ -0,0 +1,28 @@ +--- +title: Telegraf metrics +description: Telegraf metrics are internal representations used to model data during processing and are based on InfluxDB's data model. Each metric component includes the measurement name, tags, fields, and timestamp. +menu: + telegraf_1_17: + name: Metrics + weight: 10 + parent: Concepts +--- + +Telegraf metrics are the internal representation used to model data during +processing. These metrics are closely based on InfluxDB's data model and contain +four main components: + +- **Measurement name**: Description and namespace for the metric. +- **Tags**: Key/Value string pairs and usually used to identify the + metric. +- **Fields**: Key/Value pairs that are typed and usually contain the + metric data. +- **Timestamp**: Date and time associated with the fields. + +This metric type exists only in memory and must be converted to a concrete +representation in order to be transmitted or viewed. Telegraf provides [output data formats][output data formats] (also known as *serializers*) for these conversions. Telegraf's default serializer converts to [InfluxDB Line +Protocol][line protocol], which provides a high performance and one-to-one +direct mapping from Telegraf metrics. + +[output data formats]: /telegraf/v1.15/data_formats/output/ +[line protocol]: /telegraf/v1.15/data_formats/output/influx/ diff --git a/content/telegraf/v1.17/data_formats/_index.md b/content/telegraf/v1.17/data_formats/_index.md new file mode 100644 index 000000000..d249b4879 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/_index.md @@ -0,0 +1,12 @@ +--- +title: Telegraf data formats +description: Telegraf supports input data formats and output data formats for converting input and output data. +menu: + telegraf_1_17: + name: Data formats + weight: 50 +--- + +This section covers the input data formats and output data formats used in the Telegraf plugin-driven server agent component of the InfluxData time series platform. + +{{< children hlevel="h2" >}} diff --git a/content/telegraf/v1.17/data_formats/input/_index.md b/content/telegraf/v1.17/data_formats/input/_index.md new file mode 100644 index 000000000..94a01cfb6 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/_index.md @@ -0,0 +1,46 @@ +--- +title: Telegraf input data formats +description: Telegraf supports parsing input data formats into Telegraf metrics for InfluxDB Line Protocol, CollectD, CSV, Dropwizard, Graphite, Grok, JSON, Logfmt, Nagios, Value, and Wavefront. +menu: + telegraf_1_17: + name: Input data formats + weight: 1 + parent: Data formats +--- + +Telegraf contains many general purpose plugins that support parsing input data +using a configurable parser into [metrics][]. This allows, for example, the +`kafka_consumer` input plugin to process messages in either InfluxDB Line +Protocol or in JSON format. Telegraf supports the following input data formats: + +- [InfluxDB Line Protocol](/telegraf/v1.15/data_formats/input/influx/) +- [collectd](/telegraf/v1.15/data_formats/input/collectd/) +- [CSV](/telegraf/v1.15/data_formats/input/csv/) +- [Dropwizard](/telegraf/v1.15/data_formats/input/dropwizard/) +- [Graphite](/telegraf/v1.15/data_formats/input/graphite/) +- [Grok](/telegraf/v1.15/data_formats/input/grok/) +- [JSON](/telegraf/v1.15/data_formats/input/json/) +- [logfmt](/telegraf/v1.15/data_formats/input/logfmt/) +- [Nagios](/telegraf/v1.15/data_formats/input/nagios/) +- [Value](/telegraf/v1.15/data_formats/input/value/), ie: 45 or "booyah" +- [Wavefront](/telegraf/v1.15/data_formats/input/wavefront/) + +Any input plugin containing the `data_format` option can use it to select the +desired parser: + +```toml +[[inputs.exec]] + ## Commands array + commands = ["/tmp/test.sh", "/usr/bin/mycollector --foo=bar"] + + ## measurement name suffix (for separating different commands) + name_suffix = "_mycollector" + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "json" +``` + +[metrics]: /telegraf/v1.15/concepts/metrics/ diff --git a/content/telegraf/v1.17/data_formats/input/collectd.md b/content/telegraf/v1.17/data_formats/input/collectd.md new file mode 100644 index 000000000..4cadf1277 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/collectd.md @@ -0,0 +1,48 @@ +--- +title: Collectd input data format +description: Use the `collectd` input data format to parse the collectd network binary protocol to create tags for host, instance, type, and type instance. +menu: + telegraf_1_17: + name: collectd + weight: 10 + parent: Input data formats +--- + +The collectd input data format parses the collectd network binary protocol to create tags for host, instance, type, and type instance. All collectd values are added as float64 fields. + +For more information, see [binary protocol](https://collectd.org/wiki/index.php/Binary_protocol) in the collectd Wiki. + +You can control the cryptographic settings with parser options. +Create an authentication file and set `collectd_auth_file` to the path of the file, then set the desired security level in `collectd_security_level`. + +For more information, including client setup, see +[Cryptographic setup](https://collectd.org/wiki/index.php/Networking_introduction#Cryptographic_setup) in the collectd Wiki. + +You can also change the path to the typesdb or add additional typesdb using +`collectd_typesdb`. + +## Configuration + +```toml +[[inputs.file]] + files = ["example"] + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "collectd" + + ## Authentication file for cryptographic security levels + collectd_auth_file = "/etc/collectd/auth_file" + ## One of none (default), sign, or encrypt + collectd_security_level = "encrypt" + ## Path of to TypesDB specifications + collectd_typesdb = ["/usr/share/collectd/types.db"] + + ## Multi-value plugins can be handled two ways. + ## "split" will parse and store the multi-value plugin data into separate measurements + ## "join" will parse and store the multi-value plugin as a single multi-value measurement. + ## "split" is the default behavior for backward compatability with previous versions of influxdb. + collectd_parse_multivalue = "split" +``` diff --git a/content/telegraf/v1.17/data_formats/input/csv.md b/content/telegraf/v1.17/data_formats/input/csv.md new file mode 100644 index 000000000..75ade371c --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/csv.md @@ -0,0 +1,111 @@ +--- +title: CSV input data format +description: Use the `csv` input data format to parse a document containing comma-separated values into Telegraf metrics. +menu: + telegraf_1_17: + name: CSV + weight: 20 + parent: Input data formats +--- + +The CSV input data format parses documents containing comma-separated values into Telegraf metrics. + +## Configuration + +```toml +[[inputs.file]] + files = ["example"] + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "csv" + + ## Indicates how many rows to treat as a header. By default, the parser assumes + ## there is no header and will parse the first row as data. If set to anything more + ## than 1, column names will be concatenated with the name listed in the next header row. + ## If `csv_column_names` is specified, the column names in header will be overridden. + csv_header_row_count = 0 + + ## For assigning custom names to columns + ## If this is specified, all columns should have a name + ## Unnamed columns will be ignored by the parser. + ## If `csv_header_row_count` is set to 0, this config must be used + csv_column_names = [] + + ## Indicates the number of rows to skip before looking for header information. + csv_skip_rows = 0 + + ## Indicates the number of columns to skip before looking for data to parse. + ## These columns will be skipped in the header as well. + csv_skip_columns = 0 + + ## The seperator between csv fields + ## By default, the parser assumes a comma (",") + csv_delimiter = "," + + ## The character reserved for marking a row as a comment row + ## Commented rows are skipped and not parsed + csv_comment = "" + + ## If set to true, the parser will remove leading whitespace from fields + ## By default, this is false + csv_trim_space = false + + ## Columns listed here will be added as tags. Any other columns + ## will be added as fields. + csv_tag_columns = [] + + ## The column to extract the name of the metric from + csv_measurement_column = "" + + ## The column to extract time information for the metric + ## `csv_timestamp_format` must be specified if this is used + csv_timestamp_column = "" + + ## The format of time data extracted from `csv_timestamp_column` + ## this must be specified if `csv_timestamp_column` is specified + csv_timestamp_format = "" + ``` +### csv_timestamp_column, csv_timestamp_format + +By default the current time will be used for all created metrics, to set the +time using the JSON document you can use the `csv_timestamp_column` and +`csv_timestamp_format` options together to set the time to a value in the parsed +document. + +The `csv_timestamp_column` option specifies the column name containing the +time value and `csv_timestamp_format` must be set to a Go "reference time" +which is defined to be the specific time: `Mon Jan 2 15:04:05 MST 2006`. + +Consult the Go [time][time parse] package for details and additional examples +on how to set the time format. + +## Metrics + +One metric is created for each row with the columns added as fields. The type +of the field is automatically determined based on the contents of the value. + +## Examples + +Config: +``` +[[inputs.file]] + files = ["example"] + data_format = "csv" + csv_header_row_count = 1 + csv_timestamp_column = "time" + csv_timestamp_format = "2006-01-02T15:04:05Z07:00" +``` + +Input: +``` +measurement,cpu,time_user,time_system,time_idle,time +cpu,cpu0,42,42,42,2018-09-13T13:03:28Z +``` + +Output: +``` +cpu cpu=cpu0,time_user=42,time_system=42,time_idle=42 1536869008000000000 +``` diff --git a/content/telegraf/v1.17/data_formats/input/dropwizard.md b/content/telegraf/v1.17/data_formats/input/dropwizard.md new file mode 100644 index 000000000..4adb8d898 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/dropwizard.md @@ -0,0 +1,179 @@ +--- +title: Dropwizard input data format +description: Use the `dropwizard` input data format to parse Dropwizard JSON representations into Telegraf metrics. +menu: + telegraf_1_17: + name: Dropwizard + weight: 30 + parent: Input data formats +--- + +The `dropwizard` data format can parse a [Dropwizard JSON representation][dropwizard] 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`. + +[templates]: /telegraf/v1.15/data_formats/template-patterns/ +[dropwizard]: http://metrics.dropwizard.io/3.1.0/manual/json/ + +## Configuration + +```toml +[[inputs.file]] + files = ["example"] + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "dropwizard" + + ## Used by the templating engine to join matched values when cardinality is > 1 + separator = "_" + + ## Each template line requires a template pattern. It can have an optional + ## filter before the template and separated by spaces. It can also have optional extra + ## tags following the template. Multiple tags should be separated by commas and no spaces + ## similar to the line protocol format. There can be only one default template. + ## Templates support below format: + ## 1. filter + template + ## 2. filter + template + extra tag(s) + ## 3. filter + template with field key + ## 4. default template + ## By providing an empty template array, templating is disabled and measurements are parsed as influxdb line protocol keys (measurement<,tag_set>) + templates = [] + + ## You may use an appropriate [gjson path](https://github.com/tidwall/gjson#path-syntax) + ## to locate the metric registry within the JSON document + # dropwizard_metric_registry_path = "metrics" + + ## You may use an appropriate [gjson path](https://github.com/tidwall/gjson#path-syntax) + ## to locate the default time of the measurements within the JSON document + # dropwizard_time_path = "time" + # dropwizard_time_format = "2006-01-02T15:04:05Z07:00" + + ## You may use an appropriate [gjson path](https://github.com/tidwall/gjson#path-syntax) + ## to locate the tags map within the JSON document + # dropwizard_tags_path = "tags" + + ## You may even use tag paths per tag + # [inputs.exec.dropwizard_tag_paths] + # tag1 = "tags.tag1" + # tag2 = "tags.tag2" +``` + + +## Examples + +A typical JSON of a dropwizard metric registry: + +```json +{ + "version": "3.0.0", + "counters" : { + "measurement,tag1=green" : { + "count" : 1 + } + }, + "meters" : { + "measurement" : { + "count" : 1, + "m15_rate" : 1.0, + "m1_rate" : 1.0, + "m5_rate" : 1.0, + "mean_rate" : 1.0, + "units" : "events/second" + } + }, + "gauges" : { + "measurement" : { + "value" : 1 + } + }, + "histograms" : { + "measurement" : { + "count" : 1, + "max" : 1.0, + "mean" : 1.0, + "min" : 1.0, + "p50" : 1.0, + "p75" : 1.0, + "p95" : 1.0, + "p98" : 1.0, + "p99" : 1.0, + "p999" : 1.0, + "stddev" : 1.0 + } + }, + "timers" : { + "measurement" : { + "count" : 1, + "max" : 1.0, + "mean" : 1.0, + "min" : 1.0, + "p50" : 1.0, + "p75" : 1.0, + "p95" : 1.0, + "p98" : 1.0, + "p99" : 1.0, + "p999" : 1.0, + "stddev" : 1.0, + "m15_rate" : 1.0, + "m1_rate" : 1.0, + "m5_rate" : 1.0, + "mean_rate" : 1.0, + "duration_units" : "seconds", + "rate_units" : "calls/second" + } + } +} +``` + +Would get translated into 4 different measurements: + +``` +measurement,metric_type=counter,tag1=green count=1 +measurement,metric_type=meter count=1,m15_rate=1.0,m1_rate=1.0,m5_rate=1.0,mean_rate=1.0 +measurement,metric_type=gauge value=1 +measurement,metric_type=histogram count=1,max=1.0,mean=1.0,min=1.0,p50=1.0,p75=1.0,p95=1.0,p98=1.0,p99=1.0,p999=1.0 +measurement,metric_type=timer count=1,max=1.0,mean=1.0,min=1.0,p50=1.0,p75=1.0,p95=1.0,p98=1.0,p99=1.0,p999=1.0,stddev=1.0,m15_rate=1.0,m1_rate=1.0,m5_rate=1.0,mean_rate=1.0 +``` + +You may also parse a dropwizard registry from any JSON document which contains a dropwizard registry in some inner field. +Eg. to parse the following JSON document: + +```json +{ + "time" : "2017-02-22T14:33:03.662+02:00", + "tags" : { + "tag1" : "green", + "tag2" : "yellow" + }, + "metrics" : { + "counters" : { + "measurement" : { + "count" : 1 + } + }, + "meters" : {}, + "gauges" : {}, + "histograms" : {}, + "timers" : {} + } +} +``` +and translate it into: + +``` +measurement,metric_type=counter,tag1=green,tag2=yellow count=1 1487766783662000000 +``` + +you simply need to use the following additional configuration properties: + +```toml +dropwizard_metric_registry_path = "metrics" +dropwizard_time_path = "time" +dropwizard_time_format = "2006-01-02T15:04:05Z07:00" +dropwizard_tags_path = "tags" +## tag paths per tag are supported too, eg. +#[inputs.yourinput.dropwizard_tag_paths] +# tag1 = "tags.tag1" +# tag2 = "tags.tag2" +``` diff --git a/content/telegraf/v1.17/data_formats/input/graphite.md b/content/telegraf/v1.17/data_formats/input/graphite.md new file mode 100644 index 000000000..0fabdcf74 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/graphite.md @@ -0,0 +1,55 @@ +--- +title: Graphite input data format +description: Us the Graphite data format to translate Graphite dot buckets directly into Telegraf measurement names, with a single value field, and without any tags. +menu: + telegraf_1_17: + name: Graphite + weight: 40 + parent: Input data formats +--- + +The Graphite data format translates Graphite *dot* buckets directly into +Telegraf measurement names, with a single value field, and without any tags. +By default, the separator is left as `.`, but this can be changed using the +`separator` argument. For more advanced options, Telegraf supports specifying +[templates](#templates) to translate graphite buckets into Telegraf metrics. + +## Configuration + +```toml +[[inputs.exec]] + ## Commands array + commands = ["/tmp/test.sh", "/usr/bin/mycollector --foo=bar"] + + ## measurement name suffix (for separating different commands) + name_suffix = "_mycollector" + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "graphite" + + ## This string will be used to join the matched values. + separator = "_" + + ## Each template line requires a template pattern. It can have an optional + ## filter before the template and separated by spaces. It can also have optional extra + ## tags following the template. Multiple tags should be separated by commas and no spaces + ## similar to the line protocol format. There can be only one default template. + ## Templates support below format: + ## 1. filter + template + ## 2. filter + template + extra tag(s) + ## 3. filter + template with field key + ## 4. default template + templates = [ + "*.app env.service.resource.measurement", + "stats.* .host.measurement* region=eu-east,agent=sensu", + "stats2.* .host.measurement.field", + "measurement*" + ] +``` + +### templates + +For information on creating templates, see [Template patterns](/telegraf/v1.15/data_formats/template-patterns/). diff --git a/content/telegraf/v1.17/data_formats/input/grok.md b/content/telegraf/v1.17/data_formats/input/grok.md new file mode 100644 index 000000000..cfb03eba0 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/grok.md @@ -0,0 +1,226 @@ +--- +title: Grok input data format +description: Use the grok data format to parse line-delimited data using a regular expression-like language. +menu: + telegraf_1_17: + name: Grok + weight: 40 + parent: Input data formats +--- + +The grok data format parses line delimited data using a regular expression-like +language. + +If you need to become familiar with grok patterns, see [Grok Basics](https://www.elastic.co/guide/en/logstash/current/plugins-filters-grok.html#_grok_basics) +in the Logstash documentation. The grok parser uses a slightly modified version of logstash "grok" +patterns, using the format: + +``` +%{[:][:]} +``` + +The `capture_syntax` defines the grok pattern that is used to parse the input +line and the `semantic_name` is used to name the field or tag. The extension +`modifier` controls the data type that the parsed item is converted to or +other special handling. + +By default, all named captures are converted into string fields. +Timestamp modifiers can be used to convert captures to the timestamp of the +parsed metric. If no timestamp is parsed the metric will be created using the +current time. + +You must capture at least one field per line. + +- Available modifiers: + - string (default if nothing is specified) + - int + - float + - duration (ie, 5.23ms gets converted to int nanoseconds) + - tag (converts the field into a tag) + - drop (drops the field completely) + - measurement (use the matched text as the measurement name) +- Timestamp modifiers: + - ts (This will auto-learn the timestamp format) + - ts-ansic ("Mon Jan _2 15:04:05 2006") + - ts-unix ("Mon Jan _2 15:04:05 MST 2006") + - ts-ruby ("Mon Jan 02 15:04:05 -0700 2006") + - ts-rfc822 ("02 Jan 06 15:04 MST") + - ts-rfc822z ("02 Jan 06 15:04 -0700") + - ts-rfc850 ("Monday, 02-Jan-06 15:04:05 MST") + - ts-rfc1123 ("Mon, 02 Jan 2006 15:04:05 MST") + - ts-rfc1123z ("Mon, 02 Jan 2006 15:04:05 -0700") + - ts-rfc3339 ("2006-01-02T15:04:05Z07:00") + - ts-rfc3339nano ("2006-01-02T15:04:05.999999999Z07:00") + - ts-httpd ("02/Jan/2006:15:04:05 -0700") + - ts-epoch (seconds since unix epoch, may contain decimal) + - ts-epochnano (nanoseconds since unix epoch) + - ts-syslog ("Jan 02 15:04:05", parsed time is set to the current year) + - ts-"CUSTOM" + +CUSTOM time layouts must be within quotes and be the representation of the +"reference time", which is `Mon Jan 2 15:04:05 -0700 MST 2006`. +To match a comma decimal point you can use a period. For example `%{TIMESTAMP:timestamp:ts-"2006-01-02 15:04:05.000"}` can be used to match `"2018-01-02 15:04:05,000"` +To match a comma decimal point you can use a period in the pattern string. +See https://golang.org/pkg/time/#Parse for more details. + +Telegraf has many of its own [built-in patterns](https://github.com/influxdata/telegraf/blob/master/plugins/parsers/grok/influx_patterns.go), +as well as support for most of +[logstash's builtin patterns](https://github.com/logstash-plugins/logstash-patterns-core/blob/master/patterns/grok-patterns). +_Golang regular expressions do not support lookahead or lookbehind. +logstash patterns that depend on these are not supported._ + +If you need help building patterns to match your logs, the +[Grok Debugger application](https://grokdebug.herokuapp.com) might be helpful. + +## Configuration + +```toml +[[inputs.file]] + ## Files to parse each interval. + ## These accept standard unix glob matching rules, but with the addition of + ## ** as a "super asterisk". ie: + ## /var/log/**.log -> recursively find all .log files in /var/log + ## /var/log/*/*.log -> find all .log files with a parent dir in /var/log + ## /var/log/apache.log -> only tail the apache log file + files = ["/var/log/apache/access.log"] + + ## The dataformat to be read from files + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "grok" + + ## This is a list of patterns to check the given log file(s) for. + ## Note that adding patterns here increases processing time. The most + ## efficient configuration is to have one pattern. + ## Other common built-in patterns are: + ## %{COMMON_LOG_FORMAT} (plain apache & nginx access logs) + ## %{COMBINED_LOG_FORMAT} (access logs + referrer & agent) + grok_patterns = ["%{COMBINED_LOG_FORMAT}"] + + ## Full path(s) to custom pattern files. + grok_custom_pattern_files = [] + + ## Custom patterns can also be defined here. Put one pattern per line. + grok_custom_patterns = ''' + ''' + + ## Timezone allows you to provide an override for timestamps that + ## don't already include an offset + ## e.g. 04/06/2016 12:41:45 data one two 5.43µs + ## + ## Default: "" which renders UTC + ## Options are as follows: + ## 1. Local -- interpret based on machine localtime + ## 2. "Canada/Eastern" -- Unix TZ values like those found in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + ## 3. UTC -- or blank/unspecified, will return timestamp in UTC + grok_timezone = "Canada/Eastern" +``` + +### Timestamp examples + +This example input and config parses a file using a custom timestamp conversion: + +``` +2017-02-21 13:10:34 value=42 +``` + +```toml +[[inputs.file]] + grok_patterns = ['%{TIMESTAMP_ISO8601:timestamp:ts-"2006-01-02 15:04:05"} value=%{NUMBER:value:int}'] +``` + +This example input and config parses a file using a timestamp in unix time: + +``` +1466004605 value=42 +1466004605.123456789 value=42 +``` + +```toml +[[inputs.file]] + grok_patterns = ['%{NUMBER:timestamp:ts-epoch} value=%{NUMBER:value:int}'] +``` + +This example parses a file using a built-in conversion and a custom pattern: + +``` +Wed Apr 12 13:10:34 PST 2017 value=42 +``` + +```toml +[[inputs.file]] + grok_patterns = ["%{TS_UNIX:timestamp:ts-unix} value=%{NUMBER:value:int}"] + grok_custom_patterns = ''' + TS_UNIX %{DAY} %{MONTH} %{MONTHDAY} %{HOUR}:%{MINUTE}:%{SECOND} %{TZ} %{YEAR} + ''' +``` + +For cases where the timestamp itself is without offset, the `timezone` config var is available +to denote an offset. By default (with `timezone` either omit, blank or set to `"UTC"`), the times +are processed as if in the UTC timezone. If specified as `timezone = "Local"`, the timestamp +will be processed based on the current machine timezone configuration. Lastly, if using a +timezone from the list of Unix [timezones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), +grok will offset the timestamp accordingly. + +### TOML escaping + +When saving patterns to the configuration file, keep in mind the different TOML +[string](https://github.com/toml-lang/toml#string) types and the escaping +rules for each. These escaping rules must be applied in addition to the +escaping required by the grok syntax. Using the Multi-line line literal +syntax with `'''` may be useful. + +The following config examples will parse this input file: + +``` +|42|\uD83D\uDC2F|'telegraf'| +``` + +Since `|` is a special character in the grok language, we must escape it to +get a literal `|`. With a basic TOML string, special characters such as +backslash must be escaped, requiring us to escape the backslash a second time. + +```toml +[[inputs.file]] + grok_patterns = ["\\|%{NUMBER:value:int}\\|%{UNICODE_ESCAPE:escape}\\|'%{WORD:name}'\\|"] + grok_custom_patterns = "UNICODE_ESCAPE (?:\\\\u[0-9A-F]{4})+" +``` + +We cannot use a literal TOML string for the pattern, because we cannot match a +`'` within it. However, it works well for the custom pattern. +```toml +[[inputs.file]] + grok_patterns = ["\\|%{NUMBER:value:int}\\|%{UNICODE_ESCAPE:escape}\\|'%{WORD:name}'\\|"] + grok_custom_patterns = 'UNICODE_ESCAPE (?:\\u[0-9A-F]{4})+' +``` + +A multi-line literal string allows us to encode the pattern: +```toml +[[inputs.file]] + grok_patterns = [''' + \|%{NUMBER:value:int}\|%{UNICODE_ESCAPE:escape}\|'%{WORD:name}'\| + '''] + grok_custom_patterns = 'UNICODE_ESCAPE (?:\\u[0-9A-F]{4})+' +``` + +### Tips for creating patterns + +Writing complex patterns can be difficult, here is some advice for writing a +new pattern or testing a pattern developed [online](https://grokdebug.herokuapp.com). + +Create a file output that writes to stdout, and disable other outputs while +testing. This will allow you to see the captured metrics. Keep in mind that +the file output will only print once per `flush_interval`. + +```toml +[[outputs.file]] + files = ["stdout"] +``` + +- Start with a file containing only a single line of your input. +- Remove all but the first token or piece of the line. +- Add the section of your pattern to match this piece to your configuration file. +- Verify that the metric is parsed successfully by running Telegraf. +- If successful, add the next token, update the pattern and retest. +- Continue one token at a time until the entire line is successfully parsed. diff --git a/content/telegraf/v1.17/data_formats/input/influx.md b/content/telegraf/v1.17/data_formats/input/influx.md new file mode 100644 index 000000000..691c9facd --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/influx.md @@ -0,0 +1,27 @@ +--- +title: InfluxDB Line Protocol input data format +description: Use the InfluxDB Line Protocol input data format to parse InfluxDB metrics directly into Telegraf metrics. +menu: + telegraf_1_17: + name: InfluxDB Line Protocol input + weight: 60 + parent: Input data formats +--- + +There are no additional configuration options for InfluxDB [line protocol][]. The +InfluxDB metrics are parsed directly into Telegraf metrics. + +[line protocol]: /{{< latest "influxdb" "v1" >}}/write_protocols/line/ + +### Configuration + +```toml +[[inputs.file]] + files = ["example"] + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "influx" +``` diff --git a/content/telegraf/v1.17/data_formats/input/json.md b/content/telegraf/v1.17/data_formats/input/json.md new file mode 100644 index 000000000..9e5ed388b --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/json.md @@ -0,0 +1,224 @@ +--- +title: JSON input data format +description: Use the JSON input data format to parse [JSON][json] objects, or an array of objects, into Telegraf metric fields. +menu: + telegraf_1_17: + name: JSON input + weight: 70 + parent: Input data formats +--- + + +The JSON input data format parses a [JSON][json] object or an array of objects +into Telegraf metric fields. + +**NOTE:** All JSON numbers are converted to float fields. JSON String are +ignored unless specified in the `tag_key` or `json_string_fields` options. + +## Configuration + +```toml +[[inputs.file]] + files = ["example"] + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "json" + + ## Query is a GJSON path that specifies a specific chunk of JSON to be + ## parsed, if not specified the whole document will be parsed. + ## + ## GJSON query paths are described here: + ## https://github.com/tidwall/gjson#path-syntax + json_query = "" + + ## Tag keys is an array of keys that should be added as tags. + tag_keys = [ + "my_tag_1", + "my_tag_2" + ] + + ## String fields is an array of keys that should be added as string fields. + json_string_fields = [] + + ## Name key is the key to use as the measurement name. + json_name_key = "" + + ## Time key is the key containing the time that should be used to create the + ## metric. + json_time_key = "" + + ## Time format is the time layout that should be used to interprete the + ## json_time_key. The time must be `unix`, `unix_ms` or a time in the + ## "reference time". + ## ex: json_time_format = "Mon Jan 2 15:04:05 -0700 MST 2006" + ## json_time_format = "2006-01-02T15:04:05Z07:00" + ## json_time_format = "unix" + ## json_time_format = "unix_ms" + json_time_format = "" +``` + +### `json_query` + +The `json_query` is a [GJSON][gjson] path that can be used to limit the +portion of the overall JSON document that should be parsed. The result of the +query should contain a JSON object or an array of objects. + +Consult the GJSON [path syntax][gjson syntax] for details and examples. + +### json_time_key, json_time_format + +By default the current time will be used for all created metrics, to set the +time using the JSON document you can use the `json_time_key` and +`json_time_format` options together to set the time to a value in the parsed +document. + +The `json_time_key` option specifies the key containing the time value and +`json_time_format` must be set to `unix`, `unix_ms`, or the Go "reference +time" which is defined to be the specific time: `Mon Jan 2 15:04:05 MST 2006`. + +Consult the Go [time][time parse] package for details and additional examples +on how to set the time format. + +## Examples + +### Basic parsing + +Config: +```toml +[[inputs.file]] + files = ["example"] + name_override = "myjsonmetric" + data_format = "json" +``` + +Input: +```json +{ + "a": 5, + "b": { + "c": 6 + }, + "ignored": "I'm a string" +} +``` + +Output: +``` +myjsonmetric a=5,b_c=6 +``` + +### Name, tags, and string fields + +Config: +```toml +[[inputs.file]] + files = ["example"] + json_name_key = "name" + tag_keys = ["my_tag_1"] + json_string_fields = ["my_field"] + data_format = "json" +``` + +Input: +```json +{ + "a": 5, + "b": { + "c": 6, + "my_field": "description" + }, + "my_tag_1": "foo", + "name": "my_json" +} +``` + +Output: +``` +my_json,my_tag_1=foo a=5,b_c=6,my_field="description" +``` + +### Arrays + +If the JSON data is an array, then each object within the array is parsed with +the configured settings. + +Config: +```toml +[[inputs.file]] + files = ["example"] + data_format = "json" + json_time_key = "b_time" + json_time_format = "02 Jan 06 15:04 MST" +``` + +Input: +```json +[ + { + "a": 5, + "b": { + "c": 6, + "time":"04 Jan 06 15:04 MST" + }, + }, + { + "a": 7, + "b": { + "c": 8, + "time":"11 Jan 07 15:04 MST" + }, + } +] +``` + +Output: +``` +file a=5,b_c=6 1136387040000000000 +file a=7,b_c=8 1168527840000000000 +``` + +### Query + +The `json_query` option can be used to parse a subset of the document. + +Config: +```toml +[[inputs.file]] + files = ["example"] + data_format = "json" + tag_keys = ["first"] + json_string_fields = ["last"] + json_query = "obj.friends" +``` + +Input: +```json +{ + "obj": { + "name": {"first": "Tom", "last": "Anderson"}, + "age":37, + "children": ["Sara","Alex","Jack"], + "fav.movie": "Deer Hunter", + "friends": [ + {"first": "Dale", "last": "Murphy", "age": 44}, + {"first": "Roger", "last": "Craig", "age": 68}, + {"first": "Jane", "last": "Murphy", "age": 47} + ] + } +} +``` + +Output: +``` +file,first=Dale last="Murphy",age=44 +file,first=Roger last="Craig",age=68 +file,first=Jane last="Murphy",age=47 +``` + +[gjson]: https://github.com/tidwall/gjson +[gjson syntax]: https://github.com/tidwall/gjson#path-syntax +[json]: https://www.json.org/ +[time parse]: https://golang.org/pkg/time/#Parse diff --git a/content/telegraf/v1.17/data_formats/input/logfmt.md b/content/telegraf/v1.17/data_formats/input/logfmt.md new file mode 100644 index 000000000..89c14f1cf --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/logfmt.md @@ -0,0 +1,42 @@ +--- +title: Logfmt input data format +description: Use the `logfmt` input data format to parse logfmt data into Telegraf metrics. +menu: + telegraf_1_17: + name: logfmt + weight: 80 + parent: Input data formats +--- + +The `logfmt` data format parses [logfmt] data into Telegraf metrics. + +[logfmt]: https://brandur.org/logfmt + +## Configuration + +```toml +[[inputs.file]] + files = ["example"] + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "logfmt" + + ## Set the name of the created metric, if unset the name of the plugin will + ## be used. + metric_name = "logfmt" +``` + +## Metrics + +Each key/value pair in the line is added to a new metric as a field. The type +of the field is automatically determined based on the contents of the value. + +## Examples + +``` +- method=GET host=example.org ts=2018-07-24T19:43:40.275Z connect=4ms service=8ms status=200 bytes=1653 ++ logfmt method="GET",host="example.org",ts="2018-07-24T19:43:40.275Z",connect="4ms",service="8ms",status=200i,bytes=1653i +``` diff --git a/content/telegraf/v1.17/data_formats/input/nagios.md b/content/telegraf/v1.17/data_formats/input/nagios.md new file mode 100644 index 000000000..82b9819e9 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/nagios.md @@ -0,0 +1,29 @@ +--- +title: Nagios input data format +description: Use the Nagios input data format to parse the output of Nagios plugins into Telegraf metrics. +menu: + telegraf_1_17: + name: Nagios + weight: 90 + parent: Input data formats +--- + +# Nagios + +The Nagios input data format parses the output of +[Nagios plugins](https://www.nagios.org/downloads/nagios-plugins/) into +Telegraf metrics. + +## Configuration + +```toml +[[inputs.exec]] + ## Commands array + commands = ["/usr/lib/nagios/plugins/check_load -w 5,6,7 -c 7,8,9"] + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "nagios" +``` diff --git a/content/telegraf/v1.17/data_formats/input/value.md b/content/telegraf/v1.17/data_formats/input/value.md new file mode 100644 index 000000000..b38758cde --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/value.md @@ -0,0 +1,44 @@ +--- +title: Value input data format +description: Use the `value` input data format to parse single values into Telegraf metrics. +menu: + telegraf_1_17: + name: Value + weight: 100 + parent: Input data formats +--- + + +The "value" input data format translates single values into Telegraf metrics. This +is done by assigning a measurement name and setting a single field ("value") +as the parsed metric. + +## Configuration + +You **must** tell Telegraf what type of metric to collect by using the +`data_type` configuration option. Available data type options are: + +1. integer +2. float or long +3. string +4. boolean + +> **Note:** It is also recommended that you set `name_override` to a measurement +name that makes sense for your metric; otherwise, it will just be set to the +name of the plugin. + +```toml +[[inputs.exec]] + ## Commands array + commands = ["cat /proc/sys/kernel/random/entropy_avail"] + + ## override the default metric name of "exec" + name_override = "entropy_available" + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "value" + data_type = "integer" # required +``` diff --git a/content/telegraf/v1.17/data_formats/input/wavefront.md b/content/telegraf/v1.17/data_formats/input/wavefront.md new file mode 100644 index 000000000..bef307951 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/input/wavefront.md @@ -0,0 +1,28 @@ +--- +title: Wavefront input data format +description: Use the Wavefront input data format to parse Wavefront data into Telegraf metrics. +menu: + telegraf_1_17: + name: Wavefront + weight: 110 + parent: Input data formats +--- + +The Wavefront input data format parse Wavefront data into Telegraf metrics. +For more information on the Wavefront native data format, see +[Wavefront Data Format](https://docs.wavefront.com/wavefront_data_format.html) in the Wavefront documentation. + +## Configuration + +There are no additional configuration options for Wavefront Data Format line-protocol. + +```toml +[[inputs.file]] + files = ["example"] + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "wavefront" +``` diff --git a/content/telegraf/v1.17/data_formats/output/_index.md b/content/telegraf/v1.17/data_formats/output/_index.md new file mode 100644 index 000000000..60a6da955 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/output/_index.md @@ -0,0 +1,35 @@ +--- +title: Telegraf output data formats +description: Telegraf serializes metrics into output data formats for InfluxDB Line Protocol, JSON, Graphite, and Splunk metrics. +menu: + telegraf_1_17: + name: Output data formats + weight: 1 + parent: Data formats +--- + +In addition to output-specific data formats, Telegraf supports the following set +of common data formats that may be selected when configuring many of the Telegraf +output plugins. + +* [Carbon2](/telegraf/v1.15/data_formats/output/carbon2) +* [Graphite](/telegraf/v1.15/data_formats/output/graphite) +* [InfluxDB Line Protocol](/telegraf/v1.15/data_formats/output/influx) +* [JSON](/telegraf/v1.15/data_formats/output/json) +* [ServiceNow Metrics](/telegraf/v1.15/data_formats/output/nowmetric) +* [SplunkMetric](/telegraf/v1.15/data_formats/output/splunkmetric) + +You will be able to identify the plugins with support by the presence of a +`data_format` configuration option, for example, in the File (`file`) output plugin: + +```toml +[[outputs.file]] + ## Files to write to, "stdout" is a specially handled file. + files = ["stdout"] + + ## Data format to output. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "influx" +``` diff --git a/content/telegraf/v1.17/data_formats/output/carbon2.md b/content/telegraf/v1.17/data_formats/output/carbon2.md new file mode 100644 index 000000000..a487176e3 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/output/carbon2.md @@ -0,0 +1,60 @@ +--- +title: Carbon2 output data format +description: Use the Carbon2 output data format (serializer) converts Telegraf metrics into the Carbon2 format. +menu: + telegraf_1_17: + name: Carbon2 + weight: 10 + parent: Output data formats +--- + +The `carbon2` output data format (serializer) translates the Telegraf metric format to the [Carbon2 format](http://metrics20.org/implementations/). + +### Configuration + +```toml +[[outputs.file]] + ## Files to write to, "stdout" is a specially handled file. + files = ["stdout", "/tmp/metrics.out"] + + ## Data format to output. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "carbon2" +``` + +Standard form: + +``` +metric=name field=field_1 host=foo 30 1234567890 +metric=name field=field_2 host=foo 4 1234567890 +metric=name field=field_N host=foo 59 1234567890 +``` + +### Metrics + +The serializer converts the metrics by creating `intrinsic_tags` using the combination of metric name and fields. So, if one Telegraf metric has 4 fields, the `carbon2` output will be 4 separate metrics. There will be a `metric` tag that represents the name of the metric and a `field` tag to represent the field. + +### Example + +If we take the following InfluxDB Line Protocol: + +``` +weather,location=us-midwest,season=summer temperature=82,wind=100 1234567890 +``` + +After serializing in Carbon2, the result would be: + +``` +metric=weather field=temperature location=us-midwest season=summer 82 1234567890 +metric=weather field=wind location=us-midwest season=summer 100 1234567890 +``` + +### Fields and tags with spaces + +When a field key or tag key/value have spaces, spaces will be replaced with `_`. + +### Tags with empty values + +When a tag's value is empty, it will be replaced with `null`. diff --git a/content/telegraf/v1.17/data_formats/output/graphite.md b/content/telegraf/v1.17/data_formats/output/graphite.md new file mode 100644 index 000000000..b22c33a38 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/output/graphite.md @@ -0,0 +1,58 @@ +--- +title: Graphite output data format +description: Use the Graphite output data format to serialize data from Telegraf metrics. +menu: + telegraf_1_17: + name: Graphite output + weight: 20 + parent: Output data formats +--- + +The Graphite data format is serialized from Telegraf metrics using either the +template pattern or tag support method. You can select between the two +methods using the [`graphite_tag_support`](#graphite-tag-support) option. When set, the tag support method is used, +otherwise the [template pattern][templates]) option is used. + +## Configuration + +```toml +[[outputs.file]] + ## Files to write to, "stdout" is a specially handled file. + files = ["stdout", "/tmp/metrics.out"] + + ## Data format to output. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "graphite" + + ## Prefix added to each graphite bucket + prefix = "telegraf" + ## Graphite template pattern + template = "host.tags.measurement.field" + + ## Support Graphite tags, recommended to enable when using Graphite 1.1 or later. + # graphite_tag_support = false +``` + +### graphite_tag_support + +When the `graphite_tag_support` option is enabled, the template pattern is not +used. Instead, tags are encoded using +[Graphite tag support](http://graphite.readthedocs.io/en/latest/tags.html), +added in Graphite 1.1. The `metric_path` is a combination of the optional +`prefix` option, measurement name, and field name. + +The tag `name` is reserved by Graphite, any conflicting tags and will be encoded as `_name`. + +**Example conversion**: +``` +cpu,cpu=cpu-total,dc=us-east-1,host=tars usage_idle=98.09,usage_user=0.89 1455320660004257758 +=> +cpu.usage_user;cpu=cpu-total;dc=us-east-1;host=tars 0.89 1455320690 +cpu.usage_idle;cpu=cpu-total;dc=us-east-1;host=tars 98.09 1455320690 +``` + +### templates + +For more information on templates and template patterns, see [Template patterns](/telegraf/v1.15/data_formats/template-patterns/). diff --git a/content/telegraf/v1.17/data_formats/output/influx.md b/content/telegraf/v1.17/data_formats/output/influx.md new file mode 100644 index 000000000..c7e44d093 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/output/influx.md @@ -0,0 +1,41 @@ +--- +title: InfluxDB Line Protocol output data format +description: The `influx` data format outputs metrics into the InfluxDB Line Protocol format. +menu: + telegraf_1_17: + name: InfluxDB Line Protocol + weight: 30 + parent: Output data formats +--- + +The `influx` output data format outputs metrics into [InfluxDB Line Protocol][line protocol]. InfluxData recommends this data format unless another format is required for interoperability. + +## Configuration + +```toml +[[outputs.file]] + ## Files to write to, "stdout" is a specially handled file. + files = ["stdout", "/tmp/metrics.out"] + + ## Data format to output. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "influx" + + ## Maximum line length in bytes. Useful only for debugging. + influx_max_line_bytes = 0 + + ## When true, fields will be output in ascending lexical order. Enabling + ## this option will result in decreased performance and is only recommended + ## when you need predictable ordering while debugging. + influx_sort_fields = false + + ## When true, Telegraf will output unsigned integers as unsigned values, + ## i.e.: `42u`. You will need a version of InfluxDB supporting unsigned + ## integer values. Enabling this option will result in field type errors if + ## existing data has been written. + influx_uint_support = false +``` + +[line protocol]: /{{< latest "influxdb" "v1" >}}/write_protocols/line_protocol_tutorial/ diff --git a/content/telegraf/v1.17/data_formats/output/json.md b/content/telegraf/v1.17/data_formats/output/json.md new file mode 100644 index 000000000..5cd4ea633 --- /dev/null +++ b/content/telegraf/v1.17/data_formats/output/json.md @@ -0,0 +1,89 @@ +--- +title: JSON output data format +description: Telegraf's `json` output data format converts metrics into JSON documents. +menu: + telegraf_1_17: + name: JSON + weight: 40 + parent: Output data formats +--- + +The `json` output data format serializes Telegraf metrics into JSON documents. + +## Configuration + +```toml +[[outputs.file]] + ## Files to write to, "stdout" is a specially handled file. + files = ["stdout", "/tmp/metrics.out"] + + ## Data format to output. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "json" + + ## The resolution to use for the metric timestamp. Must be a duration string + ## such as "1ns", "1us", "1ms", "10ms", "1s". Durations are truncated to + ## the power of 10 less than the specified units. + json_timestamp_units = "1s" +``` + +## Examples + +### Standard format + +```json +{ + "fields": { + "field_1": 30, + "field_2": 4, + "field_N": 59, + "n_images": 660 + }, + "name": "docker", + "tags": { + "host": "raynor" + }, + "timestamp": 1458229140 +} +``` + +### Batch format + +When an output plugin needs to emit multiple metrics at one time, it may use the +batch format. The use of batch format is determined by the plugin -- reference +the documentation for the specific plugin. + +```json +{ + "metrics": [ + { + "fields": { + "field_1": 30, + "field_2": 4, + "field_N": 59, + "n_images": 660 + }, + "name": "docker", + "tags": { + "host": "raynor" + }, + "timestamp": 1458229140 + }, + { + "fields": { + "field_1": 30, + "field_2": 4, + "field_N": 59, + "n_images": 660 + }, + "name": "docker", + "tags": { + "host": "raynor" + }, + "timestamp": 1458229140 + } + ] +} +``` diff --git a/content/telegraf/v1.17/data_formats/output/nowmetric.md b/content/telegraf/v1.17/data_formats/output/nowmetric.md new file mode 100644 index 000000000..666c77b8d --- /dev/null +++ b/content/telegraf/v1.17/data_formats/output/nowmetric.md @@ -0,0 +1,90 @@ +--- +title: ServiceNow Metrics output data format +description: Use the ServiceNow Metrics output data format (serializer) to output metrics in the ServiceNow Operational Intelligence format. +menu: + telegraf_1_17: + name: ServiceNow Metrics + weight: 50 + parent: Output data formats +--- + +The ServiceNow Metrics output data format (serializer) outputs metrics in the [ServiceNow Operational Intelligence format](https://docs.servicenow.com/bundle/london-it-operations-management/page/product/event-management/reference/mid-POST-metrics.html). + +It can be used to write to a file using the File output plugin, or for sending metrics to a MID Server with Enable REST endpoint activated using the standard telegraf HTTP output. +If you're using the HTTP output plugin, this serializer knows how to batch the metrics so you don't end up with an HTTP POST per metric. + +An example event looks like: + +```javascript +[{ + "metric_type": "Disk C: % Free Space", + "resource": "C:\\", + "node": "lnux100", + "value": 50, + "timestamp": 1473183012000, + "ci2metric_id": { + "node": "lnux100" + }, + "source": “Telegraf” +}] +``` + +## Using with the HTTP output plugin + +To send this data to a ServiceNow MID Server with Web Server extension activated, you can use the HTTP output plugin, there are some custom headers that you need to add to manage the MID Web Server authorization, here's a sample config for an HTTP output: + +```toml +[[outputs.http]] + ## URL is the address to send metrics to + url = "http://:9082/api/mid/sa/metrics" + + ## Timeout for HTTP message + # timeout = "5s" + + ## HTTP method, one of: "POST" or "PUT" + method = "POST" + + ## HTTP Basic Auth credentials + username = 'evt.integration' + password = 'P@$$w0rd!' + + ## Optional TLS Config + # tls_ca = "/etc/telegraf/ca.pem" + # tls_cert = "/etc/telegraf/cert.pem" + # tls_key = "/etc/telegraf/key.pem" + ## Use TLS but skip chain & host verification + # insecure_skip_verify = false + + ## Data format to output. + ## Each data format has it's own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "nowmetric" + + ## Additional HTTP headers + [outputs.http.headers] + # # Should be set manually to "application/json" for json data_format + Content-Type = "application/json" + Accept = "application/json" +``` + +Starting with the London release, you also need to explicitly create event rule to allow binding of metric events to host CIs. + +https://docs.servicenow.com/bundle/london-it-operations-management/page/product/event-management/task/event-rule-bind-metrics-to-host.html + +## Using with the File output plugin + +You can use the File output plugin to output the payload in a file. +In this case, just add the following section to your telegraf configuration file. + +```toml +[[outputs.file]] + ## Files to write to, "stdout" is a specially handled file. + files = ["C:/Telegraf/metrics.out"] + + ## Data format to output. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "nowmetric" +``` diff --git a/content/telegraf/v1.17/data_formats/output/splunkmetric.md b/content/telegraf/v1.17/data_formats/output/splunkmetric.md new file mode 100644 index 000000000..50820871d --- /dev/null +++ b/content/telegraf/v1.17/data_formats/output/splunkmetric.md @@ -0,0 +1,147 @@ +--- +title: SplunkMetric output data format +description: The SplunkMetric serializer formats and outputs data in a format that can be consumed by a Splunk metrics index. +menu: + telegraf_1_17: + name: SplunkMetric + weight: 60 + parent: Output data formats +--- + +The SplunkMetric serializer formats and outputs the metric data in a format that can be consumed by a Splunk metrics index. +It can be used to write to a file using the file output, or for sending metrics to a HEC using the standard Telegraf HTTP output. + +If you're using the HTTP output, this serializer knows how to batch the metrics so you don't end up with an HTTP POST per metric. + +Th data is output in a format that conforms to the specified Splunk HEC JSON format as found here: +[Send metrics in JSON format](http://dev.splunk.com/view/event-collector/SP-CAAAFDN). + +An example event looks like: +```javascript +{ + "time": 1529708430, + "event": "metric", + "host": "patas-mbp", + "fields": { + "_value": 0.6, + "cpu": "cpu0", + "dc": "mobile", + "metric_name": "cpu.usage_user", + "user": "ronnocol" + } +} +``` +In the above snippet, the following keys are dimensions: +* cpu +* dc +* user + +## Using with the HTTP output + +To send this data to a Splunk HEC, you can use the HTTP output, there are some custom headers that you need to add +to manage the HEC authorization, here's a sample config for an HTTP output: + +```toml +[[outputs.http]] + ## URL is the address to send metrics to + url = "https://localhost:8088/services/collector" + + ## Timeout for HTTP message + # timeout = "5s" + + ## HTTP method, one of: "POST" or "PUT" + # method = "POST" + + ## HTTP Basic Auth credentials + # username = "username" + # password = "pa$$word" + + ## Optional TLS Config + # tls_ca = "/etc/telegraf/ca.pem" + # tls_cert = "/etc/telegraf/cert.pem" + # tls_key = "/etc/telegraf/key.pem" + ## Use TLS but skip chain & host verification + # insecure_skip_verify = false + + ## Data format to output. + ## Each data format has it's own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "splunkmetric" + ## Provides time, index, source overrides for the HEC + splunkmetric_hec_routing = true + + ## Additional HTTP headers + [outputs.http.headers] + # Should be set manually to "application/json" for json data_format + Content-Type = "application/json" + Authorization = "Splunk xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + X-Splunk-Request-Channel = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" +``` + +## Overrides +You can override the default values for the HEC token you are using by adding additional tags to the config file. + +The following aspects of the token can be overriden with tags: +* index +* source + +You can either use `[global_tags]` or using a more advanced configuration as documented [here](https://github.com/influxdata/telegraf/blob/master/docs/CONFIGURATION.md). + +Such as this example which overrides the index just on the cpu metric: +```toml +[[inputs.cpu]] + percpu = false + totalcpu = true + [inputs.cpu.tags] + index = "cpu_metrics" +``` + +## Using with the File output + +You can use the file output when running telegraf on a machine with a Splunk forwarder. + +A sample event when `hec_routing` is false (or unset) looks like: +```javascript +{ + "_value": 0.6, + "cpu": "cpu0", + "dc": "mobile", + "metric_name": "cpu.usage_user", + "user": "ronnocol", + "time": 1529708430 +} +``` +Data formatted in this manner can be ingested with a simple `props.conf` file that +looks like this: + +```ini +[telegraf] +category = Metrics +description = Telegraf Metrics +pulldown_type = 1 +DATETIME_CONFIG = +NO_BINARY_CHECK = true +SHOULD_LINEMERGE = true +disabled = false +INDEXED_EXTRACTIONS = json +KV_MODE = none +TIMESTAMP_FIELDS = time +TIME_FORMAT = %s.%3N +``` + +An example configuration of a file based output is: + +```toml + # Send telegraf metrics to file(s) +[[outputs.file]] + ## Files to write to, "stdout" is a specially handled file. + files = ["/tmp/metrics.out"] + + ## Data format to output. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "splunkmetric" + hec_routing = false +``` diff --git a/content/telegraf/v1.17/data_formats/template-patterns.md b/content/telegraf/v1.17/data_formats/template-patterns.md new file mode 100644 index 000000000..083994cec --- /dev/null +++ b/content/telegraf/v1.17/data_formats/template-patterns.md @@ -0,0 +1,143 @@ +--- +title: Telegraf template patterns +description: Use template patterns to describe how dot-delimited strings should map to and from Telegraf metrics. +menu: + telegraf_1_17: + name: Template patterns + weight: 30 + parent: Data formats +--- + +Template patterns are a mini language that describes how a dot delimited +string should be mapped to and from [metrics][]. + +A template has the form: +``` +"host.mytag.mytag.measurement.measurement.field*" +``` + +Where the following keywords can be set: + +1. `measurement`: specifies that this section of the graphite bucket corresponds +to the measurement name. This can be specified multiple times. +2. `field`: specifies that this section of the graphite bucket corresponds +to the field name. This can be specified multiple times. +3. `measurement*`: specifies that all remaining elements of the graphite bucket +correspond to the measurement name. +4. `field*`: specifies that all remaining elements of the graphite bucket +correspond to the field name. + +Any part of the template that is not a keyword is treated as a tag key. This +can also be specified multiple times. + +**NOTE:** `field*` cannot be used in conjunction with `measurement*`. + +## Examples + +### Measurement and tag templates + +The most basic template is to specify a single transformation to apply to all +incoming metrics. So the following template: + +```toml +templates = [ + "region.region.measurement*" +] +``` + +would result in the following Graphite -> Telegraf transformation. + +``` +us.west.cpu.load 100 +=> cpu.load,region=us.west value=100 +``` + +Multiple templates can also be specified, but these should be differentiated +using _filters_ (see below for more details) + +```toml +templates = [ + "*.*.* region.region.measurement", # <- all 3-part measurements will match this one. + "*.*.*.* region.region.host.measurement", # <- all 4-part measurements will match this one. +] +``` + +### Field templates + +The field keyword tells Telegraf to give the metric that field name. +So the following template: + +```toml +separator = "_" +templates = [ + "measurement.measurement.field.field.region" +] +``` + +would result in the following Graphite -> Telegraf transformation. + +``` +cpu.usage.idle.percent.eu-east 100 +=> cpu_usage,region=eu-east idle_percent=100 +``` + +The field key can also be derived from all remaining elements of the graphite +bucket by specifying `field*`: + +```toml +separator = "_" +templates = [ + "measurement.measurement.region.field*" +] +``` + +which would result in the following Graphite -> Telegraf transformation. + +``` +cpu.usage.eu-east.idle.percentage 100 +=> cpu_usage,region=eu-east idle_percentage=100 +``` + +### Filter templates + +Users can also filter the template(s) to use based on the name of the bucket, +using glob matching, like so: + +```toml +templates = [ + "cpu.* measurement.measurement.region", + "mem.* measurement.measurement.host" +] +``` + +which would result in the following transformation: + +``` +cpu.load.eu-east 100 +=> cpu_load,region=eu-east value=100 + +mem.cached.localhost 256 +=> mem_cached,host=localhost value=256 +``` + +### Adding Tags + +Additional tags can be added to a metric that don't exist on the received metric. +You can add additional tags by specifying them after the pattern. +Tags have the same format as the line protocol. +Multiple tags are separated by commas. + +```toml +templates = [ + "measurement.measurement.field.region datacenter=1a" +] +``` + +would result in the following Graphite -> Telegraf transformation. + +``` +cpu.usage.idle.eu-east 100 +=> cpu_usage,region=eu-east,datacenter=1a idle=100 +``` + +[metrics]: /telegraf/v1.15/concepts/metrics/ diff --git a/content/telegraf/v1.17/guides/_index.md b/content/telegraf/v1.17/guides/_index.md new file mode 100644 index 000000000..dfb74fab8 --- /dev/null +++ b/content/telegraf/v1.17/guides/_index.md @@ -0,0 +1,12 @@ +--- +title: Telegraf Guides +description: Step-by-step tutorials for Telegraf. +menu: + telegraf_1_17: + name: Guides + weight: 20 +--- + +The following articles guide you through step-by-step Telegraf configuration examples. + +{{< children >}} diff --git a/content/telegraf/v1.17/guides/using_http.md b/content/telegraf/v1.17/guides/using_http.md new file mode 100644 index 000000000..61beb7258 --- /dev/null +++ b/content/telegraf/v1.17/guides/using_http.md @@ -0,0 +1,116 @@ +--- +title: Using the HTTP input plugin with Citi Bike data +description: Collect live metrics on Citi Bike stations in New York City with the HTTP input plugin. +menu: + telegraf_1_17: + name: Using the HTTP plugin + weight: 30 + parent: Guides +--- + +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 from [NYC OpenData](https://data.cityofnewyork.us/NYC-BigApps/Citi-Bike-Live-Station-Feed-JSON-/p94q-8hxh). + +For the following example to work, configure [`influxdb` output plugin](/telegraf/v1.15/plugins/#influxdb). This plugin is what allows Telegraf to write the metrics to your InfluxDB. + +## Configure the HTTP Input plugin in your Telegraf configuration file + +To retrieve data from the Citi Bike URL endpoint, enable the `inputs.http` input plugin in your Telegraf configuration file. + +Specify the following options: + +### `urls` +One or more URLs to read metrics from. For this example, use `https://feeds.citibikenyc.com/stations/stations.json`. + +### `data_format` +The format of the data in the HTTP endpoints that Telegraf will ingest. For this example, use JSON. + + +## Add parser information to your Telegraf configuration + +Specify the following JSON-specific options. + +### JSON + +#### `json_query` +To parse only the relevant portion of JSON data, set the `json_query` option with a [GJSON](https://github.com/tidwall/gjson) path. The result of the query should contain a JSON object or an array of objects. +In this case, we don't want to parse the JSON query's `executionTime` at the beginning of the data, so we'll limit this to include only the data in the `stationBeanList` array. + +#### `tag_keys` +List of one or more JSON keys that should be added as tags. For this example, we'll use the tag keys `id`, `stationName`, `city`, and `postalCode`. + +#### `json_string_fields` +List the keys of fields that are in string format so that they can be parsed as strings. Here, the string fields are `statusValue`, `stAddress1`, `stAddress2`, `location`, and `landMark`. + +#### `json_time_key` +Key from the JSON file that creates the timestamp metric. In this case, we want to use the time that station data was last reported, or the `lastCommunicationTime`. If you don't specify a key, the time that Telegraf reads the data becomes the timestamp. + +#### `json_time_format` +The format used to interpret the designated `json_time_key`. This example uses [Go reference time format](https://golang.org/pkg/time/#Time.Format). For example, `Mon Jan 2 15:04:05 MST 2006`. + +#### `json_timezone` +The timezone We'll set this to the Unix TZ value where our bike data takes place, `America/New_York`. + + +#### Example configuration + + ```toml + [[inputs.http]] + #URL for NYC's Citi Bike station data in JSON format + urls = ["https://feeds.citibikenyc.com/stations/stations.json"] + + #Overwrite measurement name from default `http` to `citibikenyc` + name_override = "citibikenyc" + + #Exclude url and host items from tags + tagexclude = ["url", "host"] + + #Data from HTTP in JSON format + data_format = "json" + + #Parse `stationBeanList` array only + json_query = "stationBeanList" + + #Set station metadata as tags + tag_keys = ["id", "stationName", "city", "postalCode"] + + #Do not include station landmark data as fields + fielddrop = ["landMark"] + + #JSON values to set as string fields + json_string_fields = ["statusValue", "stAddress1", "stAddress2", "location", "landMark"] + + #Latest station information reported at `lastCommunicationTime` + json_time_key = "lastCommunicationTime" + + #Time is reported in Golang "reference time" format + json_time_format = "2006-01-02 03:04:05 PM" + + #Time is reported in Eastern Standard Time (EST) + json_timezone = "America/New_York" + ``` + + + +## Start Telegraf and verify data appears + +[Start the Telegraf service](/telegraf/v1.15/introduction/getting-started/#start-telegraf-service). + +To test that the data is being sent to InfluxDB, run the following (replacing `telegraf.conf` with the path to your configuration file): + +``` +telegraf -config ~/telegraf.conf -test +``` + +This command should return line protocol that looks similar to the following: + + +``` +citibikenyc,id=3443,stationName=W\ 52\ St\ &\ 6\ Ave statusKey=1,location="",totalDocks=41,availableDocks=32,latitude=40.76132983124814,longitude=-73.97982001304626,availableBikes=8,stAddress2="",stAddress1="W 52 St & 6 Ave",statusValue="In Service" 1581533519000000000 +citibikenyc,id=367,stationName=E\ 53\ St\ &\ Lexington\ Ave availableBikes=8,stAddress1="E 53 St & Lexington Ave",longitude=-73.97069431,latitude=40.75828065,stAddress2="",statusKey=1,location="",statusValue="In Service",totalDocks=34,availableDocks=24 1581533492000000000 +citibikenyc,id=359,stationName=E\ 47\ St\ &\ Park\ Ave totalDocks=64,availableBikes=15,statusValue="In Service",location="",latitude=40.75510267,availableDocks=49,stAddress1="E 47 St & Park Ave",longitude=-73.97498696,statusKey=1,stAddress2="" 1581533535000000000 +citibikenyc,id=304,stationName=Broadway\ &\ Battery\ Pl statusValue="In Service",availableDocks=11,stAddress1="Broadway & Battery Pl",statusKey=1,stAddress2="",location="",totalDocks=33,latitude=40.70463334,longitude=-74.01361706,availableBikes=22 1581533499000000000 +``` + +Now, you can explore and query the Citi Bike data in InfluxDB. The example below is an InfluxQL query and visualization showing the number of available bikes over the past 15 minutes at the Broadway and West 29th Street station. + +![Citi Bike visualization](/img/telegraf/1-13-citibike_query.png) diff --git a/content/telegraf/v1.17/introduction/_index.md b/content/telegraf/v1.17/introduction/_index.md new file mode 100644 index 000000000..b8e25b88a --- /dev/null +++ b/content/telegraf/v1.17/introduction/_index.md @@ -0,0 +1,12 @@ +--- +title: Introducing Telegraf +description: Get up and running with Telegraf. +menu: + telegraf_1_17: + name: Introduction + weight: 20 +--- + +To get up and running with Telegraf, complete the following tasks: + +{{< children >}} diff --git a/content/telegraf/v1.17/introduction/downloading.md b/content/telegraf/v1.17/introduction/downloading.md new file mode 100644 index 000000000..1a107597e --- /dev/null +++ b/content/telegraf/v1.17/introduction/downloading.md @@ -0,0 +1,13 @@ +--- +title: Download Telegraf +description: Download the latest version of Telegraf. +menu: + telegraf_1_17: + name: Download + weight: 10 + parent: Introduction +--- + + + +Download the latest Telegraf release at the [InfluxData download page](https://portal.influxdata.com/downloads). diff --git a/content/telegraf/v1.17/introduction/getting-started.md b/content/telegraf/v1.17/introduction/getting-started.md new file mode 100644 index 000000000..8393749dc --- /dev/null +++ b/content/telegraf/v1.17/introduction/getting-started.md @@ -0,0 +1,135 @@ +--- +title: Get started with Telegraf +description: Configure and start the Telegraf service. +aliases: + - /telegraf/v1.15/introduction/getting_started/ +menu: + telegraf_1_17: + name: Get started + weight: 30 + parent: Introduction +--- + +Use Telegraf to collect and write metrics into InfluxDB and other supported outputs. + +To get up and running, do the following: + +1. [Download and install Telegraf](#download-and-install-telegraf) +2. [Configure Telegraf](#configure-telegraf) +3. [Start Telegraf service](#start-telegraf-service) + +## Download and install Telegraf + +Follow the instructions in the Telegraf section on the [Downloads page](https://influxdata.com/downloads/). + +> **Note:** Telegraf will start automatically using the default configuration when installed from a deb package. + +## Configure Telegraf + +### Configuration file location by installation type + +* macOS [Homebrew](http://brew.sh/): `/usr/local/etc/telegraf.conf` +* 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.15/administration/configuration/#configuration-file-locations). + +### Create and edit the configuration file + +Before starting the Telegraf server, create or edit the initial configuration to specify your [inputs](/telegraf/v1.15/plugins/inputs/) (where the metrics come from) and [outputs](/telegraf/v1.15/plugins/outputs/) (where the metrics go). You can do this [several ways](/telegraf/v1.15/administration/configuration/). + +The following example shows how to create a configuration file called `telegraf.conf` and specify two inputs (`cpu` and `mem`) with the `--input-filter` flag and specify InfluxDB as the output with the `--output-filter` flag. + +```bash +telegraf -sample-config --input-filter cpu:mem --output-filter influxdb > telegraf.conf +``` + +`cpu` and `mem` reads metrics about the system's cpu usage and memory usage, and then output this data to InfluxDB. + +## Start Telegraf service + +Start the Telegraf service and direct it to the relevant configuration file or URL to pull a configuration file from a remote endpoint: + +### macOS [Homebrew](http://brew.sh/) +```bash +telegraf --config telegraf.conf +``` + +### Linux (sysvinit and upstart installations) +```bash +sudo service telegraf start +``` + +### Linux (systemd installations) +```bash +systemctl start telegraf +``` + +## Results + +Telegraf starts collecting and writing data to the specified output. + +Returning to our sample configuration, we show what the `cpu` and `mem` data looks like in InfluxDB below. +Note that we used the default input and output configuration settings to get this data. + +* List all [measurements](/influxdb/v1.4/concepts/glossary/#measurement) in the `telegraf` [database](/influxdb/v1.4/concepts/glossary/#database): + +``` +> SHOW MEASUREMENTS +name: measurements +------------------ +name +cpu +mem +``` + +* List all [field keys](/influxdb/v1.4/concepts/glossary/#field-key) by measurement: + +``` +> SHOW FIELD KEYS +name: cpu +--------- +fieldKey fieldType +usage_guest float +usage_guest_nice float +usage_idle float +usage_iowait float +usage_irq float +usage_nice float +usage_softirq float +usage_steal float +usage_system float +usage_user float + +name: mem +--------- +fieldKey fieldType +active integer +available integer +available_percent float +buffered integer +cached integer +free integer +inactive integer +total integer +used integer +used_percent float +``` + +* Select a sample of the data in the [field](/influxdb/v1.4/concepts/glossary/#field) `usage_idle` in the measurement `cpu_usage_idle`: + +```bash +> SELECT usage_idle FROM cpu WHERE cpu = 'cpu-total' LIMIT 5 +name: cpu +--------- +time usage_idle +2016-01-16T00:03:00Z 97.56189047261816 +2016-01-16T00:03:10Z 97.76305923519121 +2016-01-16T00:03:20Z 97.32533433320835 +2016-01-16T00:03:30Z 95.68857785553611 +2016-01-16T00:03:40Z 98.63715928982245 +``` + +Notice that the timestamps occur at rounded ten second intervals (that is, `:00`, `:10`, `:20`, and so on) - this is a configurable setting. + +That's it! You ready to use Telegraf to collect metrics and write them to your output of choice. diff --git a/content/telegraf/v1.17/introduction/installation.md b/content/telegraf/v1.17/introduction/installation.md new file mode 100644 index 000000000..073a9c9d0 --- /dev/null +++ b/content/telegraf/v1.17/introduction/installation.md @@ -0,0 +1,389 @@ +--- +title: Install Telegraf +description: Install Telegraf on your operating system. +menu: + telegraf_1_17: + name: Install + weight: 20 + parent: Introduction +--- + +This page provides directions for installing, starting, and configuring Telegraf. + +## Requirements + +Installation of the Telegraf package may require `root` or administrator privileges in order to complete successfully. + +### Networking + +Telegraf offers multiple service [input plugins](/telegraf/v1.17/plugins/inputs/) that may +require custom ports. +Modify port mappings through the configuration file (`telegraf.conf`). + +For Linux distributions, this file is located at `/etc/telegraf` for default installations. + +For Windows distributions, the configuration file is located in the directory where you unzipped the Telegraf ZIP archive. +The default location is `C:\InfluxData\telegraf`. + +### NTP + +Telegraf uses a host's local time in UTC to assign timestamps to data. +Use the Network Time Protocol (NTP) to synchronize time between hosts; if hosts' clocks +aren't synchronized with NTP, the timestamps on the data can be inaccurate. + +## Installation + +{{< tabs-wrapper >}} +{{% tabs %}} + [Ubuntu & Debian](#) + [RedHat & CentOS](#) + [SLES & openSUSE](#) + [FreeBSD/PC-BSD](#) + [macOS](#) + [Windows](#) +{{% /tabs %}} + +{{% tab-content %}} +Debian and Ubuntu users can install the latest stable version of Telegraf using the `apt-get` package manager. + +**Ubuntu:** Add the InfluxData repository with the following commands: + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[wget](#) +[curl](#) +{{% /code-tabs %}} + +{{% code-tab-content %}} +```bash +wget -qO- https://repos.influxdata.com/influxdb.key | sudo apt-key add - +source /etc/lsb-release +echo "deb https://repos.influxdata.com/${DISTRIB_ID,,} ${DISTRIB_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/influxdb.list +``` +{{% /code-tab-content %}} + +{{% code-tab-content %}} +```bash +curl -s https://repos.influxdata.com/influxdb.key | sudo apt-key add - +source /etc/lsb-release +echo "deb https://repos.influxdata.com/${DISTRIB_ID,,} ${DISTRIB_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/influxdb.list +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +**Debian:** Add the InfluxData repository with the following commands: + +{{< code-tabs-wrapper >}} +{{% code-tabs %}} +[wget](#) +[curl](#) +{{% /code-tabs %}} + +{{% code-tab-content %}} +```bash +# Before adding Influx repository, run this so that apt will be able to read the repository. + +sudo apt-get update && sudo apt-get install apt-transport-https + +# Add the InfluxData key + +wget -qO- https://repos.influxdata.com/influxdb.key | sudo apt-key add - +source /etc/os-release +test $VERSION_ID = "7" && echo "deb https://repos.influxdata.com/debian wheezy stable" | sudo tee /etc/apt/sources.list.d/influxdb.list +test $VERSION_ID = "8" && echo "deb https://repos.influxdata.com/debian jessie stable" | sudo tee /etc/apt/sources.list.d/influxdb.list +test $VERSION_ID = "9" && echo "deb https://repos.influxdata.com/debian stretch stable" | sudo tee /etc/apt/sources.list.d/influxdb.list +test $VERSION_ID = "10" && echo "deb https://repos.influxdata.com/debian buster stable" | sudo tee /etc/apt/sources.list.d/influxdb.list +``` +{{% /code-tab-content %}} + +{{% code-tab-content %}} +```bash +# Before adding Influx repository, run this so that apt will be able to read the repository. + +sudo apt-get update && sudo apt-get install apt-transport-https + +# Add the InfluxData key + +curl -s https://repos.influxdata.com/influxdb.key | sudo apt-key add - +source /etc/os-release +test $VERSION_ID = "7" && echo "deb https://repos.influxdata.com/debian wheezy stable" | sudo tee /etc/apt/sources.list.d/influxdb.list +test $VERSION_ID = "8" && echo "deb https://repos.influxdata.com/debian jessie stable" | sudo tee /etc/apt/sources.list.d/influxdb.list +test $VERSION_ID = "9" && echo "deb https://repos.influxdata.com/debian stretch stable" | sudo tee /etc/apt/sources.list.d/influxdb.list +``` +{{% /code-tab-content %}} +{{< /code-tabs-wrapper >}} + +Then, install and start the Telegraf service: + +```bash +sudo apt-get update && sudo apt-get install telegraf +sudo service telegraf start +``` + +Or if your operating system is using systemd (Ubuntu 15.04+, Debian 8+): +``` +sudo apt-get update && sudo apt-get install telegraf +sudo systemctl start telegraf +``` + +**Install from a `.deb` file**: + +To manually install the Debian package from a `.deb` file: + +1. Download the latest Telegraf `.deb` release + from the Telegraf section of the [downloads page](https://influxdata.com/downloads/). +2. Run the following command (making sure to supply the correct version number for the downloaded file): + + ```sh + sudo sudo dpkg -i telegraf_1.17_amd64.deb + ``` + +{{% telegraf/verify %}} + +## Configuration + +### Create a configuration file with default input and output plugins. + +Every plugin will be in the file, but most will be commented out. + +``` +telegraf config > telegraf.conf +``` + +### Create a configuration file with specific inputs and outputs +``` +telegraf --input-filter [:] --output-filter [:] config > telegraf.conf +``` + +For more advanced configuration details, see the +[configuration documentation](/telegraf/v1.17/administration/configuration/). +{{% /tab-content %}} + +{{% tab-content %}} +For instructions on how to manually install the RPM package from a file, please see the [downloads page](https://influxdata.com/downloads/). + +**RedHat and CentOS:** Install the latest stable version of Telegraf using the `yum` package manager: + +```bash +cat < telegraf.conf +``` + +### Create a configuration file with specific inputs and outputs +``` +telegraf --input-filter [:] --output-filter [:] config > telegraf.conf +``` + +For more advanced configuration details, see the +[configuration documentation](/telegraf/v1.17/administration/configuration/). +{{% /tab-content %}} + +{{% tab-content %}} +There are RPM packages provided by openSUSE Build Service for SUSE Linux users: + +```bash +# add go repository +zypper ar -f obs://devel:languages:go/ go +# install latest telegraf +zypper in telegraf +``` + +{{% telegraf/verify %}} + +## Configuration + +### Create a configuration file with default input and output plugins. + +Every plugin will be in the file, but most will be commented out. + +``` +telegraf config > telegraf.conf +``` + +### Create a configuration file with specific inputs and outputs +``` +telegraf --input-filter [:] --output-filter [:] config > telegraf.conf +``` + +For more advanced configuration details, see the +[configuration documentation](/telegraf/v1.17/administration/configuration/). +{{% /tab-content %}} + +{{% tab-content %}} +Telegraf is part of the FreeBSD package system. +It can be installed by running: + +```bash +sudo pkg install telegraf +``` + +The configuration file is located at `/usr/local/etc/telegraf.conf` with examples in `/usr/local/etc/telegraf.conf.sample`. + +{{% telegraf/verify %}} + +## Configuration + +### Create a configuration file with default input and output plugins. + +Every plugin will be in the file, but most will be commented out. + +``` +telegraf config > telegraf.conf +``` + +### Create a configuration file with specific inputs and outputs +``` +telegraf --input-filter [:] --output-filter [:] config > telegraf.conf +``` + +For more advanced configuration details, see the +[configuration documentation](/telegraf/v1.17/administration/configuration/). +{{% /tab-content %}} + +{{% tab-content %}} +Users of macOS 10.8 and higher can install Telegraf using the [Homebrew](http://brew.sh/) package manager. +Once `brew` is installed, you can install Telegraf by running: + +```bash +brew update +brew install telegraf +``` + +To have launchd start telegraf at next login: +``` +ln -sfv /usr/local/opt/telegraf/*.plist ~/Library/LaunchAgents +``` +To load telegraf now: +``` +launchctl load ~/Library/LaunchAgents/homebrew.mxcl.telegraf.plist +``` + +Or, if you don't want/need launchctl, you can just run: +``` +telegraf -config /usr/local/etc/telegraf.conf +``` + +{{% telegraf/verify %}} + +## Configuration + +### Create a configuration file with default input and output plugins. + +Every plugin will be in the file, but most will be commented out. + +``` +telegraf config > telegraf.conf +``` + +### Create a configuration file with specific inputs and outputs +``` +telegraf --input-filter [:] --output-filter [:] config > telegraf.conf +``` + +For more advanced configuration details, see the +[configuration documentation](/telegraf/v1.17/administration/configuration/). +{{% /tab-content %}} + +{{% tab-content %}} + +## Installation + +Download the Telegraf ZIP archive for Windows from the [InfluxData downloads page](https://portal.influxdata.com/downloads). + +Extract the contents of the ZIP archive to `C:\Program Files\InfluxData\Telegraf`. + +##### Verify the integrity of the downloaded Telegraf binary (optional) + +To obtain the SHA256 hash for the Windows Telegraf download, use the following PowerShell command: + +```powershell +CertUtil -hashfile /telegraf-1.17_windows_amd64.zip SHA256 +``` + +Compare the output from this command to the hash listed on the downloads page to ensure the integrity of the download. + +### Configure an input plugin + +The Telegraf ZIP archive contains a default configuration file (`telegraf.conf`). +In this file, the input plugin for capturing basic [Windows system metrics](/telegraf/v1.17/plugins/#win_perf_counters) is already activated. +With this plugin, Telegraf monitors the following defined Windows Operating System objects: + +- Processor +- LogicalDisk +- PhysicalDisk +- Network Interface +- System +- Memory +- Paging File + +Telegraf can capture metrics and log information from a wide variety of sources. +For more advanced configuration details, see the [configuration documentation](/telegraf/v1.17/administration/configuration/). + +### Configure an output plugin + +Before you start the Telegraf agent, configure an output plugin to send data to InfluxDB. +Choose the appropriate plugin based on the version of InfluxDB you are using. + +The `telegraf.conf` file included in the ZIP archive contains sections for configuring +both the [InfluxDB v1](/telegraf/v1.17/plugins/#influxdb) and +[InfluxDB v2](/telegraf/v1.17/plugins/#influxdb_v2) output plugins. + +#### Writing data to InfluxDB 1.x + +Open `telegraf.conf` in a text editor and fill in the `database` field under `[[outputs.influxdb]]`. + +#### Writing data to InfluxDB 2.0 + +Open `telegraf.conf` in a text editor and comment out the InfluxDB v1 plugin +by placing a `#` in front of `[[outputs.influxdb]]`. +Then remove the `#` in front of `[[outputs.influxdb_v2]]`. + +For detailed instructions on configuring Telegraf to write to InfluxDB 2.0, see +[Enable and configure the InfluxDB v2 output plugin](/{{< latest "influxdb" "v2" >}}/write-data/use-telegraf/manual-config/#enable-and-configure-the-influxdb-v2-output-plugin). + +### Start the agent + +Once configured, run the following commands in PowerShell to begin sending metrics with Telegraf: + +```powershell +> cd C:\Program Files\InfluxData\Telegraf # path to extracted Telegraf directory +> .\telegraf.exe -config +``` +## Install Telegraf as a Windows Service + +See [Running Telegraf as a Windows service](/telegraf/v1.17/administration/windows_service). + +{{< /tab-content >}} +{{< /tabs-wrapper >}} diff --git a/content/telegraf/v1.17/plugins.md b/content/telegraf/v1.17/plugins.md new file mode 100644 index 000000000..2dfd28b85 --- /dev/null +++ b/content/telegraf/v1.17/plugins.md @@ -0,0 +1,50 @@ +--- +title: Telegraf plugins +description: > + Telegraf is a plugin-driven agent that collects, processes, aggregates, and writes metrics. + It supports four categories of plugins including input, output, aggregator, and processor. + View and search all available Telegraf plugins. +menu: + telegraf_1_17: + weight: 40 +weight: 6 +aliases: + - /telegraf/v1.16/plugins/plugins-list/ + - /telegraf/v1.16/plugins/aggregators/ + - /telegraf/v1.16/plugins/inputs/ + - /telegraf/v1.16/plugins/outputs/ + - /telegraf/v1.16/plugins/processors/ +--- + +Telegraf is a plugin-driven agent that collects, processes, aggregates, and writes metrics. +It supports four categories of plugins including input, output, aggregator, and processor. + +{{< telegraf/filters >}} + +**Jump to:** + +- [Input plugins](#input-plugins) +- [Output plugins](#output-plugins) +- [Aggregator plugins](#aggregator-plugins) +- [Processor plugins](#processor-plugins) + +## Input plugins +Telegraf input plugins are used with the InfluxData time series platform to collect +metrics from the system, services, or third party APIs. + +{{< telegraf/plugins type="input" >}} + +## Output plugins +Telegraf processor plugins write metrics to various destinations. + +{{< telegraf/plugins type="output" >}} + +## Aggregator plugins +Telegraf aggregator plugins create aggregate metrics (for example, mean, min, max, quantiles, etc.) + +{{< telegraf/plugins type="aggregator" >}} + +## Processor plugins +Telegraf output plugins transform, decorate, and filter metrics. + +{{< telegraf/plugins type="processor" >}} diff --git a/content/telegraf/v1.9/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.9/concepts/aggregator_processor_plugins.md index 518a5a4f8..828b6012e 100644 --- a/content/telegraf/v1.9/concepts/aggregator_processor_plugins.md +++ b/content/telegraf/v1.9/concepts/aggregator_processor_plugins.md @@ -10,37 +10,24 @@ menu: Besides the input plugins and output plugins, Telegraf includes aggregator and processor plugins, which are used to aggregate and process metrics as they pass through Telegraf. -``` -┌───────────┐ -│ │ -│ CPU │───┐ -│ │ │ -└───────────┘ │ - │ -┌───────────┐ │ ┌───────────┐ -│ │ │ │ │ -│ Memory │───┤ ┌──▶│ InfluxDB │ -│ │ │ │ │ │ -└───────────┘ │ ┌─────────────┐ ┌─────────────┐ │ └───────────┘ - │ │ │ │Aggregate │ │ -┌───────────┐ │ │Process │ │ - mean │ │ ┌───────────┐ -│ │ │ │ - transform │ │ - quantiles │ │ │ │ -│ MySQL │───┼──▶│ - decorate │────▶│ - min/max │───┼──▶│ File │ -│ │ │ │ - filter │ │ - count │ │ │ │ -└───────────┘ │ │ │ │ │ │ └───────────┘ - │ └─────────────┘ └─────────────┘ │ -┌───────────┐ │ │ ┌───────────┐ -│ │ │ │ │ │ -│ SNMP │───┤ └──▶│ Kafka │ -│ │ │ │ │ -└───────────┘ │ └───────────┘ - │ -┌───────────┐ │ -│ │ │ -│ Docker │───┘ -│ │ -└───────────┘ -``` +{{< diagram >}} + graph TD + Process[Process
- transform
- decorate
- filter] + Aggregate[Aggregate
- transform
- decorate
- filter] + + CPU --> Process + Memory --> Process + MySQL --> Process + SNMP --> Process + Docker --> Process + Process --> Aggregate + Aggregate --> InfluxDB + Aggregate --> File + Aggregate --> Kafka + +style Process text-align:left +style Aggregate text-align:left +{{< /diagram >}} **Processor plugins** process metrics as they pass through and immediately emit results based on the values they process. For example, this could be printing diff --git a/data/influxdb_urls.yml b/data/influxdb_urls.yml index f1d21f519..47cec59e4 100644 --- a/data/influxdb_urls.yml +++ b/data/influxdb_urls.yml @@ -38,3 +38,4 @@ cloud: - name: East US (Virginia) location: Virginia, USA url: https://eastus-1.azure.cloud2.influxdata.com + \ No newline at end of file diff --git a/data/products.yml b/data/products.yml index c6ead28d3..36db7597e 100644 --- a/data/products.yml +++ b/data/products.yml @@ -20,8 +20,8 @@ telegraf: name: Telegraf namespace: telegraf list_order: 4 - versions: [v1.9, v1.10, v1.11, v1.12, v1.13, v1.14, v1.15, v1.16] - latest: v1.16 + versions: [v1.9, v1.10, v1.11, v1.12, v1.13, v1.14, v1.15, v1.16, v1.17] + latest: v1.17 chronograf: name: Chronograf diff --git a/data/telegraf_plugins.yml b/data/telegraf_plugins.yml index f18155492..20324b385 100644 --- a/data/telegraf_plugins.yml +++ b/data/telegraf_plugins.yml @@ -687,6 +687,13 @@ input: introduced: 1.16.0 tags: [linux, macos, windows, data-stores] + - name: Intel Powerstat + id: intel_powerstat + description: | + The Intel Powerstat input plugin collects information provided by the monitoring features of Intel Powerstat. + introduced: 1.17.0 + tags: [linux] + - name: Intel RDT id: intel_rdt description: | @@ -1407,6 +1414,13 @@ input: introduced: 0.10.4 tags: [linux, macos, windows, data-stores] + - name: Riemann Listener + id: riemann_listener + description: | + The Riemann Listener input plugin listens for messages Riemann clients using Riemann-Protobuff format. + introduced: 1.17.0 + tags: [linux, macos, windows] + - name: Salesforce id: salesforce description: | @@ -1965,6 +1979,13 @@ output: introduced: 0.2.0 tags: [linux, macos, windows, cloud] + - name: Logz.io + id: logzio + description: | + The Logz.io output plugin sends metrics to Logz.io over HTTPs. + introduced: 1.17.0 + tags: [linux, macos, windows] + - name: Microsoft Azure Application Insights id: application_insights description: | @@ -2038,13 +2059,27 @@ output: introduced: 0.1.9 tags: [linux, macos, windows, data-stores] + - name: Prometheus Text-Based Format + id: prometheus + description: | + The Prometheus parser plugin is used internally in the Prometheus input plugin or the HTTP Listener v2 input plugin to simulate Pushgateway. + introduced: 1.17.0 + tags: [linux, macos, windows, applications] + - name: Prometheus Client id: prometheus_client description: | The Prometheus Client output plugin starts a [Prometheus](https://prometheus.io/) Client, it exposes all metrics on `/metrics` (default) to be polled by a Prometheus server. introduced: 0.2.1 - tags: [linux, macos, windows, applications, data-stores] + tags: [linux, macos, windows, applications] + + - name: Prometheus Remote Write + id: prometheusremotewrite + description: | + The Prometheus Remote Write data format output plugin converts metrics into the Prometheus protobuf exposition format. + introduced: 1.17.0 + tags: [linux, macos, windows, applications] - name: Riemann id: riemann @@ -2063,6 +2098,7 @@ output: deprecated: 1.2.1 tags: [linux, macos, windows, applications] + - name: Socket Writer id: socket_writer description: | @@ -2119,6 +2155,12 @@ output: introduced: 1.5.0 tags: [linux, macos, windows, applications, cloud] + - name: Yandex Cloud Monitoring + id: yandex_cloud_monitoring + description: | + The Yandex Cloud Monitoring output plugin sends custom metrics to Yandex Cloud Monitoring. + introduced: 1.17.0 + tags: [linux, macos, windows] # %%%% %%%% %%%% %%%%% %%%%%% %%%% %%%% %%%%%% %%%% %%%%% %%%% # # %% %% %% %% %% %% %% %% %% %% %% %% %% %% %% %% # diff --git a/deploy/edge.js b/deploy/edge.js index 7e6253eba..7214fcd65 100644 --- a/deploy/edge.js +++ b/deploy/edge.js @@ -5,7 +5,7 @@ const path = require('path'); const latestVersions = { 'influxdb': 'v2.0', 'influxdbv2': 'v2.0', - 'telegraf': 'v1.16', + 'telegraf': 'v1.17', 'chronograf': 'v1.8', 'kapacitor': 'v1.5', 'enterprise': 'v1.8', diff --git a/layouts/partials/footer/javascript.html b/layouts/partials/footer/javascript.html index 1d5fc1659..bc5e4edff 100644 --- a/layouts/partials/footer/javascript.html +++ b/layouts/partials/footer/javascript.html @@ -19,3 +19,22 @@ + +{{ if .Page.HasShortcode "diagram" }} + + + +{{ end }} \ No newline at end of file diff --git a/layouts/shortcodes/diagram.html b/layouts/shortcodes/diagram.html new file mode 100644 index 000000000..9aafee8a6 --- /dev/null +++ b/layouts/shortcodes/diagram.html @@ -0,0 +1,3 @@ +
+ {{.Inner}} +
\ No newline at end of file