Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit e83fcb0

Browse files
Update telegraf.rst
Edits
1 parent 02e55bf commit e83fcb0

File tree

1 file changed

+28
-24
lines changed

1 file changed

+28
-24
lines changed

gdi/monitors-monitoring/telegraf.rst

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
11
.. _telegraf:
22

3-
Telegraf
4-
==================
3+
Telegraf Exec (OpenTelemetry)
4+
==============================
55

66
.. meta::
7-
:description: Use this Splunk Observability Cloud integration for the telegraf monitor. See benefits, install, configuration, and metrics
7+
:description: Use this Splunk Observability Cloud integration for the Telegraf monitor. See benefits, install, configuration, and metrics.
88

9+
To monitor your system with Telegraf Exec using native OpenTelemetry, install the Telegraf plugin independently, then push metrics to the Splunk Opentelemetry Collector
10+
via OTLP.
911

10-
Instead of using The Splunk Distribution of the OpenTelemetry Collector's Smart Agent receiver with the
11-
Telegraf monitor to scrape metrics, it is recommended to install Telegraf plugin independently, then push metrics to the Splunk Opentelemetry collector
12-
via OTLP.
13-
14-
15-
16-
.. note:: All the setup was carried out on a Linux Ubuntu OS based machine but should be replicable on any machines running Linux OS with Debian flavor.
17-
18-
These instruction to install the telegraf plugin to scrape metrics on other OS (for e.g. MacOS/Windows) operating systems, have not been tested
19-
out.
12+
.. note:: This setup is designed for a Linux Ubuntu OS but should be replicable on any machines running Linux OS with Debian flavor. These instructions might not work on other OS (MacOS/Windows).
2013

2114
Benefits
2215
--------
2316

2417
.. include:: /_includes/benefits.rst
2518

26-
Installation of Telegraf Plugin
19+
Configuration
2720
----------------------------------
2821

22+
Follow these steps to scrape Telegraf metrics with the OTel Collector:
23+
24+
1. Install the Telegraf Exec Input plugin
25+
2. Set up the OpenTelemetry Output plugin
26+
3. Configure the OpenTelemetry Collector
27+
28+
1. Install the Telegraf Exec Input Plugin plugin
29+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30+
2931
Run the following commands to install Telegraf from the InfluxData repository:
3032

3133
.. code:: shell
@@ -38,21 +40,24 @@ Run the following commands to install Telegraf from the InfluxData repository:
3840
| sudo tee /etc/apt/sources.list.d/influxdata.list
3941
sudo apt-get update && sudo apt-get install telegraf
4042
43+
2. Set up the OpenTelemetry Output plugin
44+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4145

42-
After successful installation of telegraf above, you can add the following to your telegraf configuration file (usually the config file resides on
43-
./etc/telegraf/telegraf.d directory)
44-
46+
Next, add the OTel Output plugin to your Telegraf configuration file:
4547

48+
.. code::
49+
4650
# Send OpenTelemetry metrics over gRPC
4751
[[outputs.opentelemetry]]
48-
49-
For detailed information on the Telegraf Opentelemetry output plugin configuration, check https://github.com/influxdata/telegraf/blob/master/plugins/outputs/opentelemetry/README.md
5052
51-
Configuration
52-
-------------
53+
The config file usually resides on the ./etc/telegraf/telegraf.d directory.
5354

54-
To retrieve metrics from this telegraf installation running independently, the following Collector
55-
configuration is sufficient:
55+
For detailed information on the Telegraf Opentelemetry output plugin see the :new-page:`Exec Input Plugin <https://github.com/influxdata/telegraf/blob/master/plugins/outputs/opentelemetry/README.md>` documentation in GitHub.
56+
57+
3. Configure the OpenTelemetry Collector
58+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
59+
60+
Add the following configuration to the OTel Collector to retrieve metrics from the Telegraf installation:
5661

5762
.. code:: yaml
5863
@@ -76,7 +81,6 @@ configuration is sufficient:
7681
processors:
7782
exporters: [signalfx]
7883
79-
8084
Troubleshooting
8185
---------------
8286

0 commit comments

Comments
 (0)