From 5c79277b4ca8ec3a54e9577ba2bf24db4931c9e5 Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Mon, 24 Aug 2020 13:59:38 -0700 Subject: [PATCH] Telegraf --- content/telegraf/v1.15/about_the_project/_index.md | 2 +- .../about_the_project/release-notes-changelog.md | 2 +- content/telegraf/v1.15/administration/_index.md | 12 +----------- .../telegraf/v1.15/administration/configuration.md | 4 ++-- .../v1.15/administration/troubleshooting.md | 6 +++--- .../v1.15/administration/windows_service.md | 2 +- content/telegraf/v1.15/concepts/_index.md | 14 ++------------ .../v1.15/concepts/aggregator_processor_plugins.md | 2 +- content/telegraf/v1.15/concepts/glossary.md | 2 +- .../telegraf/v1.15/data_formats/input/collectd.md | 2 +- content/telegraf/v1.15/data_formats/input/csv.md | 2 +- .../v1.15/data_formats/input/dropwizard.md | 2 +- .../telegraf/v1.15/data_formats/input/logfmt.md | 2 +- content/telegraf/v1.15/data_formats/input/value.md | 2 +- .../telegraf/v1.15/data_formats/output/graphite.md | 2 +- .../telegraf/v1.15/data_formats/output/influx.md | 2 +- content/telegraf/v1.15/data_formats/output/json.md | 2 +- .../v1.15/data_formats/template-patterns.md | 2 -- content/telegraf/v1.15/guides/_index.md | 4 ++-- content/telegraf/v1.15/guides/using_http.md | 2 +- content/telegraf/v1.15/introduction/_index.md | 14 ++------------ content/telegraf/v1.15/introduction/downloading.md | 5 +++-- .../telegraf/v1.15/introduction/getting-started.md | 6 +++--- .../telegraf/v1.15/introduction/installation.md | 5 +++-- content/telegraf/v1.15/plugins/aggregators.md | 2 +- content/telegraf/v1.15/plugins/inputs.md | 2 +- content/telegraf/v1.15/plugins/outputs.md | 3 ++- content/telegraf/v1.15/plugins/processors.md | 3 ++- 28 files changed, 41 insertions(+), 69 deletions(-) diff --git a/content/telegraf/v1.15/about_the_project/_index.md b/content/telegraf/v1.15/about_the_project/_index.md index fcd6cf763..495cace35 100644 --- a/content/telegraf/v1.15/about_the_project/_index.md +++ b/content/telegraf/v1.15/about_the_project/_index.md @@ -1,6 +1,6 @@ --- title: About the Telegraf project - +description: Release notes, contribution guidelines, CLA, and license for the Telegraf project. menu: telegraf_1_15: name: About the project diff --git a/content/telegraf/v1.15/about_the_project/release-notes-changelog.md b/content/telegraf/v1.15/about_the_project/release-notes-changelog.md index 13efb9021..bd993425a 100644 --- a/content/telegraf/v1.15/about_the_project/release-notes-changelog.md +++ b/content/telegraf/v1.15/about_the_project/release-notes-changelog.md @@ -1,6 +1,6 @@ --- title: Telegraf 1.15 release notes -description: See the new features, bug fixes, breaking changes, and enhancements in the latest and earlier Telegraf releases. +description: Important features and changes in the latest version of Telegraf. menu: telegraf_1_15: name: Release notes diff --git a/content/telegraf/v1.15/administration/_index.md b/content/telegraf/v1.15/administration/_index.md index 8b821f02f..79e5e8196 100644 --- a/content/telegraf/v1.15/administration/_index.md +++ b/content/telegraf/v1.15/administration/_index.md @@ -8,14 +8,4 @@ --- -## [Configuring Telegraf](/telegraf/v1.15/administration/configuration/) - -[Configuring Telegraf](/telegraf/v1.15/administration/configuration/) discusses the Telegraf configuration file, enabling plugins, and setting environment variables. - -## [Running Telegraf as a Windows service](/telegraf/v1.15/administration/windows_service/) - -[Running Telegraf as a Windows service](/telegraf/v1.15/administration/windows_service/) describes how to use Telegraf as a Windows service. - -## [Troubleshooting Telegraf](/telegraf/v1.15/administration/troubleshooting/) - -[Troubleshooting Telegraf](/telegraf/v1.15/administration/troubleshooting/) shows you how to capture Telegraf output, submit sample metrics, and see how Telegraf formats and emits points to its output plugins. +{{< children >}} diff --git a/content/telegraf/v1.15/administration/configuration.md b/content/telegraf/v1.15/administration/configuration.md index 69b67661d..e814dcdb4 100644 --- a/content/telegraf/v1.15/administration/configuration.md +++ b/content/telegraf/v1.15/administration/configuration.md @@ -1,6 +1,6 @@ --- title: Configuring Telegraf - +description: Overview of the Telegraf configuration file, enabling plugins, and setting environment variables. menu: telegraf_1_15: name: Configuring @@ -42,7 +42,7 @@ 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 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` diff --git a/content/telegraf/v1.15/administration/troubleshooting.md b/content/telegraf/v1.15/administration/troubleshooting.md index f4792a342..1dcaf461f 100644 --- a/content/telegraf/v1.15/administration/troubleshooting.md +++ b/content/telegraf/v1.15/administration/troubleshooting.md @@ -1,9 +1,9 @@ --- -title: Troubleshooting Telegraf - +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_15: - name: Troubleshooting + name: Troubleshoot weight: 30 parent: Administration --- diff --git a/content/telegraf/v1.15/administration/windows_service.md b/content/telegraf/v1.15/administration/windows_service.md index 1b3764f5f..f0ca7e2f4 100644 --- a/content/telegraf/v1.15/administration/windows_service.md +++ b/content/telegraf/v1.15/administration/windows_service.md @@ -1,6 +1,6 @@ --- title: Running Telegraf as a Windows service -description: How to configure Telegraf as a Windows service. +description: How to configure Telegraf as a Windows service using PowerShell. menu: telegraf_1_15: name: Running as Windows service diff --git a/content/telegraf/v1.15/concepts/_index.md b/content/telegraf/v1.15/concepts/_index.md index dc860c471..f4f528242 100644 --- a/content/telegraf/v1.15/concepts/_index.md +++ b/content/telegraf/v1.15/concepts/_index.md @@ -1,6 +1,6 @@ --- title: Key Telegraf concepts -description: This section discusses key concepts about Telegraf, including information on supported input data formats, output data formats, aggregator and processor plugins, and includes a glossary of important terms. +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_15: name: Concepts @@ -8,14 +8,4 @@ menu: --- 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. -## [Telegraf metrics](/telegraf/v1.15/concepts/metrics/) - -[Telegraf metrics](/telegraf/v1.15/concepts/metrics/) are internal representations used to model data during processing. - -## [Telegraf aggregator and processor plugins](/telegraf/v1.15/concepts/aggregator_processor_plugins/) - -[Telegraf aggregator and processor plugins](/telegraf/v1.15/concepts/aggregator_processor_plugins/) work between the input plugins and output plugins to aggregate and process metrics in Telegraf. - -## [Glossary of terms (for Telegraf)](/telegraf/v1.15/concepts/glossary/) - -This section includes definitions of important terms for related to Telegraf. +{{< children >}} diff --git a/content/telegraf/v1.15/concepts/aggregator_processor_plugins.md b/content/telegraf/v1.15/concepts/aggregator_processor_plugins.md index e5a8d6971..3ab8ff0a4 100644 --- a/content/telegraf/v1.15/concepts/aggregator_processor_plugins.md +++ b/content/telegraf/v1.15/concepts/aggregator_processor_plugins.md @@ -1,6 +1,6 @@ --- title: Telegraf aggregator and processor plugins -description: Use Telegraf aggregator and processor plugins to aggregate and process data between the input plugins and output plugins. +description: Aggregator and processor plugins work between the input plugins and output plugins to aggregate and process metrics in Telegraf. menu: telegraf_1_15: name: Aggregator and processor plugins diff --git a/content/telegraf/v1.15/concepts/glossary.md b/content/telegraf/v1.15/concepts/glossary.md index d63bb731f..988c3b96e 100644 --- a/content/telegraf/v1.15/concepts/glossary.md +++ b/content/telegraf/v1.15/concepts/glossary.md @@ -1,6 +1,6 @@ --- title: Telegraf glossary of terms -description: This section includes definitions of important terms for related to Telegraf, the plug-in driven server agent component of the InfluxData time series platform. +description: This section includes definitions of important terms for related to Telegraf. menu: telegraf_1_15: name: Glossary of terms diff --git a/content/telegraf/v1.15/data_formats/input/collectd.md b/content/telegraf/v1.15/data_formats/input/collectd.md index 903d974ea..5fc66ffcd 100644 --- a/content/telegraf/v1.15/data_formats/input/collectd.md +++ b/content/telegraf/v1.15/data_formats/input/collectd.md @@ -1,6 +1,6 @@ --- 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. +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_15: name: collectd diff --git a/content/telegraf/v1.15/data_formats/input/csv.md b/content/telegraf/v1.15/data_formats/input/csv.md index 4935dfbcc..4d72b58c8 100644 --- a/content/telegraf/v1.15/data_formats/input/csv.md +++ b/content/telegraf/v1.15/data_formats/input/csv.md @@ -1,6 +1,6 @@ --- title: CSV input data format -description: Use the "csv" input data format to parse a document containing comma-separated values into Telegraf metrics. +description: Use the `csv` input data format to parse a document containing comma-separated values into Telegraf metrics. menu: telegraf_1_15: name: CSV diff --git a/content/telegraf/v1.15/data_formats/input/dropwizard.md b/content/telegraf/v1.15/data_formats/input/dropwizard.md index 3e7356d14..c2a27d5d1 100644 --- a/content/telegraf/v1.15/data_formats/input/dropwizard.md +++ b/content/telegraf/v1.15/data_formats/input/dropwizard.md @@ -1,6 +1,6 @@ --- title: Dropwizard input data format -description: Use the "dropwizard" input data format to parse Dropwizard JSON representations into Telegraf metrics. +description: Use the `dropwizard` input data format to parse Dropwizard JSON representations into Telegraf metrics. menu: telegraf_1_15: name: Dropwizard diff --git a/content/telegraf/v1.15/data_formats/input/logfmt.md b/content/telegraf/v1.15/data_formats/input/logfmt.md index cb396473d..0d96cbaef 100644 --- a/content/telegraf/v1.15/data_formats/input/logfmt.md +++ b/content/telegraf/v1.15/data_formats/input/logfmt.md @@ -1,6 +1,6 @@ --- title: Logfmt input data format -description: Use the "logfmt" input data format to parse "logfmt" data into Telegraf metrics. +description: Use the `logfmt` input data format to parse logfmt data into Telegraf metrics. menu: telegraf_1_15: name: logfmt diff --git a/content/telegraf/v1.15/data_formats/input/value.md b/content/telegraf/v1.15/data_formats/input/value.md index ea3c76e1d..2fed3c0b5 100644 --- a/content/telegraf/v1.15/data_formats/input/value.md +++ b/content/telegraf/v1.15/data_formats/input/value.md @@ -1,6 +1,6 @@ --- title: Value input data format -description: Use the "value" input data format to parse single values into Telegraf metrics. +description: Use the `value` input data format to parse single values into Telegraf metrics. menu: telegraf_1_15: name: Value diff --git a/content/telegraf/v1.15/data_formats/output/graphite.md b/content/telegraf/v1.15/data_formats/output/graphite.md index 8d5fcbe6b..9d1d7ba21 100644 --- a/content/telegraf/v1.15/data_formats/output/graphite.md +++ b/content/telegraf/v1.15/data_formats/output/graphite.md @@ -1,6 +1,6 @@ --- title: Graphite output data format -description: Use the "Graphite" output data format to serialize data from Telegraf metrics. +description: Use the Graphite output data format to serialize data from Telegraf metrics. menu: telegraf_1_15: name: Graphite output diff --git a/content/telegraf/v1.15/data_formats/output/influx.md b/content/telegraf/v1.15/data_formats/output/influx.md index a0b61ee2e..4fd5ee57c 100644 --- a/content/telegraf/v1.15/data_formats/output/influx.md +++ b/content/telegraf/v1.15/data_formats/output/influx.md @@ -1,6 +1,6 @@ --- title: InfluxDB Line Protocol output data format -description: The "influx" data format outputs metrics into the InfluxDB Line Protocol format. +description: The `influx` data format outputs metrics into the InfluxDB Line Protocol format. menu: telegraf_1_15: name: InfluxDB Line Protocol diff --git a/content/telegraf/v1.15/data_formats/output/json.md b/content/telegraf/v1.15/data_formats/output/json.md index 17ddae837..f947b4af5 100644 --- a/content/telegraf/v1.15/data_formats/output/json.md +++ b/content/telegraf/v1.15/data_formats/output/json.md @@ -1,6 +1,6 @@ --- title: JSON output data format -description: Telegraf's "json" output data format converts metrics into JSON documents. +description: Telegraf's `json` output data format converts metrics into JSON documents. menu: telegraf_1_15: name: JSON diff --git a/content/telegraf/v1.15/data_formats/template-patterns.md b/content/telegraf/v1.15/data_formats/template-patterns.md index 766b01501..9d4541c9b 100644 --- a/content/telegraf/v1.15/data_formats/template-patterns.md +++ b/content/telegraf/v1.15/data_formats/template-patterns.md @@ -8,8 +8,6 @@ menu: parent: Data formats --- - - Template patterns are a mini language that describes how a dot delimited string should be mapped to and from [metrics][]. diff --git a/content/telegraf/v1.15/guides/_index.md b/content/telegraf/v1.15/guides/_index.md index 14ba24e5b..4a6cddaca 100644 --- a/content/telegraf/v1.15/guides/_index.md +++ b/content/telegraf/v1.15/guides/_index.md @@ -1,6 +1,6 @@ --- title: Telegraf Guides - +description: Step-by-step tutorials for Telegraf. menu: telegraf_1_15: name: Guides @@ -9,4 +9,4 @@ menu: The following articles guide you through step-by-step Telegraf configuration examples. -[Using the HTTP plugin with Citi Bike data](/telegraf/v1.15/guides/using_http) +{{< children >}} diff --git a/content/telegraf/v1.15/guides/using_http.md b/content/telegraf/v1.15/guides/using_http.md index 787b2d25e..cd10658f6 100644 --- a/content/telegraf/v1.15/guides/using_http.md +++ b/content/telegraf/v1.15/guides/using_http.md @@ -1,6 +1,6 @@ --- title: Using the HTTP input plugin with Citi Bike data -description: +description: Collect live metrics on Citi Bike stations in New York City with the HTTP input plugin. menu: telegraf_1_15: name: Using the HTTP plugin diff --git a/content/telegraf/v1.15/introduction/_index.md b/content/telegraf/v1.15/introduction/_index.md index aa02375a1..6dca16ba8 100644 --- a/content/telegraf/v1.15/introduction/_index.md +++ b/content/telegraf/v1.15/introduction/_index.md @@ -1,6 +1,6 @@ --- title: Introducing Telegraf - +description: Get up and running with Telegraf. menu: telegraf_1_15: name: Introduction @@ -9,14 +9,4 @@ menu: To get up and running with Telegraf, complete the following tasks: -## [Download Telegraf](https://portal.influxdata.com/downloads) - -Find the latest release of Telegraf. - -## [Install Telegraf](/telegraf/v1.15/introduction/installation/) - -Learn how to install, start, and configure Telegraf. - -## [Get started with Telegraf](/telegraf/v1.15/introduction/getting-started/) - -Learn how to use Telegraf to get data into InfluxDB. +{{< children >}} diff --git a/content/telegraf/v1.15/introduction/downloading.md b/content/telegraf/v1.15/introduction/downloading.md index 5ecaec6d4..afb8e0251 100644 --- a/content/telegraf/v1.15/introduction/downloading.md +++ b/content/telegraf/v1.15/introduction/downloading.md @@ -1,8 +1,9 @@ --- -title: Downloading Telegraf +title: Download Telegraf +description: Download the latest version of Telegraf. menu: telegraf_1_15: - name: Downloading + name: Download weight: 10 parent: Introduction --- diff --git a/content/telegraf/v1.15/introduction/getting-started.md b/content/telegraf/v1.15/introduction/getting-started.md index 17e470b1d..a85d97684 100644 --- a/content/telegraf/v1.15/introduction/getting-started.md +++ b/content/telegraf/v1.15/introduction/getting-started.md @@ -1,11 +1,11 @@ --- -title: Getting started with Telegraf -description: Downloading, installing, configuring and getting started with Telegraf, the plug-in driven server agent of the InfluxData time series platform. +title: Get started with Telegraf +description: Configure and start the Telegraf service. aliases: - /telegraf/v1.15/introduction/getting_started/ menu: telegraf_1_15: - name: Getting started + name: Get started weight: 30 parent: Introduction --- diff --git a/content/telegraf/v1.15/introduction/installation.md b/content/telegraf/v1.15/introduction/installation.md index c57dfd533..ab0bd12dd 100644 --- a/content/telegraf/v1.15/introduction/installation.md +++ b/content/telegraf/v1.15/introduction/installation.md @@ -1,8 +1,9 @@ --- -title: Installing Telegraf +title: Install Telegraf +description: Install Telegraf on your operating system. menu: telegraf_1_15: - name: Installing + name: Install weight: 20 parent: Introduction --- diff --git a/content/telegraf/v1.15/plugins/aggregators.md b/content/telegraf/v1.15/plugins/aggregators.md index 0711f4768..00442a2da 100644 --- a/content/telegraf/v1.15/plugins/aggregators.md +++ b/content/telegraf/v1.15/plugins/aggregators.md @@ -1,6 +1,6 @@ --- title: Telegraf aggregator plugins -description: Use the Telegraf aggregator plugins with the InfluxData time series platfrom to create aggregate metrics (for example, mean, min, max, quantiles, etc.) collected by the input plugins. Aggregator plugins support basic statistics, histograms, and min/max values. +description: Telegraf aggregator plugins create aggregate metrics (for example, mean, min, max, quantiles, etc.) collected by the input plugins. Aggregator plugins support basic statistics, histograms, and min/max values. menu: telegraf_1_15: name: Aggregator diff --git a/content/telegraf/v1.15/plugins/inputs.md b/content/telegraf/v1.15/plugins/inputs.md index 16394e01e..635bdbd56 100644 --- a/content/telegraf/v1.15/plugins/inputs.md +++ b/content/telegraf/v1.15/plugins/inputs.md @@ -1,6 +1,6 @@ --- title: Telegraf input plugins -description: Telegraf input plugins are used with the InfluxData time series platform to collect metrics from the system, services, or third party APIs. +description: Telegraf input plugins collect metrics from the system, services, or third party APIs. menu: telegraf_1_15: name: Input diff --git a/content/telegraf/v1.15/plugins/outputs.md b/content/telegraf/v1.15/plugins/outputs.md index d0341951f..02d9bae88 100644 --- a/content/telegraf/v1.15/plugins/outputs.md +++ b/content/telegraf/v1.15/plugins/outputs.md @@ -1,6 +1,7 @@ --- title: Telegraf output plugins -descriptions: Use Telegraf output plugins to transform, decorate, and filter metrics. Supported output plugins include Datadog, Elasticsearch, Graphite, InfluxDB, Kafka, MQTT, Prometheus Client, Riemann, and Wavefront. +descriptions: > +Use Telegraf output plugins to transform, decorate, and filter metrics. Supported output plugins include Datadog, Elasticsearch, Graphite, InfluxDB, Kafka, MQTT, Prometheus Client, Riemann, and Wavefront. menu: telegraf_1_15: name: Output diff --git a/content/telegraf/v1.15/plugins/processors.md b/content/telegraf/v1.15/plugins/processors.md index cf8e0365c..f196ce8e9 100644 --- a/content/telegraf/v1.15/plugins/processors.md +++ b/content/telegraf/v1.15/plugins/processors.md @@ -1,6 +1,7 @@ --- title: Telegraf processor plugins -description: Use Telegraf processor plugins in the InfluxData time series platform to process metrics and emit results based on the values processed. +description: > +Telegraf processor plugins process metrics and emit results based on the values processed. menu: telegraf_1_15: name: Processor