From 882a2912406c3ec45bc6a646fab76ec10b1a4e31 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 12 Jun 2023 15:36:48 -0500 Subject: [PATCH 1/3] fix(telegraf): v1.27 glossary links --- content/telegraf/v1.27/glossary.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/content/telegraf/v1.27/glossary.md b/content/telegraf/v1.27/glossary.md index 9bee013d4..c1394f862 100644 --- a/content/telegraf/v1.27/glossary.md +++ b/content/telegraf/v1.27/glossary.md @@ -12,35 +12,35 @@ menu: 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) +Related entries: [input plugin](/telegraf/v1.27/glossary/#input-plugin), [output plugin](/telegraf/v1.27/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) +Related entries: [input plugin](/telegraf/v1.27/glossary/#input-plugin), [output plugin](/telegraf/v1.27/glossary/#output-plugin), [processor plugin](/telegraf/v1.27/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) +Related entries: [output plugin](/telegraf/v1.27/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) +Related entries: [input plugin](/telegraf/v1.27/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) +Related entries: [collection interval](/telegraf/v1.27/glossary/#collection-interval), [input plugin](/telegraf/v1.27/glossary/#input-plugin) ## external plugin @@ -50,7 +50,7 @@ Programs built outside of Telegraf that run through the `execd` plugin. Provides 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) +Related entries: [collection interval](/telegraf/v1.27/glossary/#collection-interval), [flush jitter](/telegraf/v1.27/glossary/#flush-jitter), [output plugin](/telegraf/v1.27/glossary/#output-plugin) ## flush jitter @@ -58,14 +58,14 @@ Flush jitter is used to prevent every output plugin from sending writes simultan 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) +Related entries: [flush interval](/telegraf/v1.27/glossary/#flush-interval), [output plugin](/telegraf/v1.27/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) +Related entries: [aggregator plugin](/telegraf/v1.27/glossary/#aggregator-plugin), [collection interval](/telegraf/v1.27/glossary/#collection-interval), [output plugin](/telegraf/v1.27/glossary/#output-plugin), [processor plugin](/telegraf/v1.27/glossary/#processor-plugin) ## metric buffer @@ -73,13 +73,13 @@ The metric buffer caches individual metrics when writes are failing for an outpu 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) +Related entries: [output plugin](/telegraf/v1.27/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) +Related entries: [aggregator plugin](/telegraf/v1.27/glossary/#aggregator-plugin), [flush interval](/telegraf/v1.27/glossary/#flush-interval), [input plugin](/telegraf/v1.27/glossary/#input-plugin), [processor plugin](/telegraf/v1.27/glossary/#processor-plugin) ## precision @@ -90,17 +90,17 @@ 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) +Related entries: [aggregator plugin](/telegraf/v1.27/glossary/#aggregator-plugin), [input plugin](/telegraf/v1.27/glossary/#input-plugin), [output plugin](/telegraf/v1.27/glossary/#output-plugin), [processor plugin](/telegraf/v1.27/glossary/#processor-plugin), [service input plugin](/telegraf/v1.27/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) +Related entries: [aggregator plugin](/telegraf/v1.27/glossary/#aggregator-plugin), [input plugin](/telegraf/v1.27/glossary/#input-plugin), [output plugin](/telegraf/v1.27/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) +Related entries: [aggregator plugin](/telegraf/v1.27/glossary/#aggregator-plugin), [input plugin](/telegraf/v1.27/glossary/#input-plugin), [output plugin](/telegraf/v1.27/glossary/#output-plugin), [processor plugin](/telegraf/v1.27/glossary/#processor-plugin) From 729192ef5039cf532f01b5f891f41205903819ee Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 12 Jun 2023 15:37:28 -0500 Subject: [PATCH 2/3] fix(telegraf): update links for v1.27 --- .../v1.27/configure_plugins/aggregator_processor/_index.md | 2 +- content/telegraf/v1.27/data_formats/output/graphite.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/telegraf/v1.27/configure_plugins/aggregator_processor/_index.md b/content/telegraf/v1.27/configure_plugins/aggregator_processor/_index.md index e9660c090..5d2bce93b 100644 --- a/content/telegraf/v1.27/configure_plugins/aggregator_processor/_index.md +++ b/content/telegraf/v1.27/configure_plugins/aggregator_processor/_index.md @@ -54,5 +54,5 @@ This can have unintended consequences, such as executing mathematical operations _See [influxdata/telegraf#7993](https://github.com/influxdata/telegraf/issues/7993)._ If using custom processor scripts, they must be idempotent (repeatable, without side-effects). -For custom processes that are not idempotent, use [namepass or namedrop](/telegraf/v1.17/administration/configuration/#input-config-namepass-and-namedrop) to avoid issues when aggregated data is processed a second time. +For custom processes that are not idempotent, use [namepass or namedrop](/telegraf/v1.27/configuration/#metric-filtering) to avoid issues when aggregated data is processed a second time. {{% /note %}} diff --git a/content/telegraf/v1.27/data_formats/output/graphite.md b/content/telegraf/v1.27/data_formats/output/graphite.md index 5b5c0d61f..98bc3f9c9 100644 --- a/content/telegraf/v1.27/data_formats/output/graphite.md +++ b/content/telegraf/v1.27/data_formats/output/graphite.md @@ -56,4 +56,4 @@ 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/). +For more information on templates and template patterns, see [Template patterns](/telegraf/v1.27/data_formats/input/graphite/#templates). From 831d4ba6dfbbc7853646530923b1d299f22e1b9d Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 12 Jun 2023 15:38:03 -0500 Subject: [PATCH 3/3] fix(telegraf): revise intro grammar --- content/telegraf/v1.27/data_formats/input/_index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/telegraf/v1.27/data_formats/input/_index.md b/content/telegraf/v1.27/data_formats/input/_index.md index 99344a6f2..7398dae5c 100644 --- a/content/telegraf/v1.27/data_formats/input/_index.md +++ b/content/telegraf/v1.27/data_formats/input/_index.md @@ -9,9 +9,8 @@ menu: 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 +Telegraf contains many general purpose plugins that use a configurable parser for parsing input data into [metrics][]. This allows, for example, the +`kafka_consumer` input plugin to process messages formatted in InfluxDB Line Protocol or in JSON format. Telegraf supports the following input data formats: {{< children >}} @@ -34,4 +33,4 @@ desired parser: data_format = "json_v2" ``` -[metrics]: /telegraf/v1.15/concepts/metrics/ +[metrics]: /telegraf/v1.27/metrics/