Skip to content

Commit 94269fd

Browse files
Merge pull request #2479 from splunk/urbiz-OD6469-telegraf-links
[6469]: Linking Telegraf monitors
2 parents c90aa34 + 41b3d7c commit 94269fd

File tree

11 files changed

+28
-17
lines changed

11 files changed

+28
-17
lines changed

gdi/monitors-databases/exec-input.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Exec Input (deprecated)
1010

1111
The Exec Input monitor is now deprecated and will reach of End of Support on February 3, 2025. During this period only critical security and bug fixes are provided. When End of Support is reached, the monitor will be removed and no longer be supported, and you won't be able to use it to send data to Splunk Observability Cloud.
1212

13-
To monitor your system with Telegraf Exec you can use native OpenTelemetry instead. See :ref:`telegraf-generic` to learn how.
13+
To collect exec file data use the OpenTelemetry Collector and the :new-page:`Telegraf Exec Input plugin <https://github.com/influxdata/telegraf/tree/master/plugins/inputs/exec>`. See how in :ref:`telegraf-generic`.
1414

1515
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the Exec Input monitor type, an embedded form of the Telegraf Exec plugin, to receive metrics or logs from exec files.
1616

gdi/monitors-databases/logparser.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Logparser
77

88
:description: Use this Splunk Observability Cloud integration for the telegraf/logparser plugin monitor. See benefits, install, configuration, and metrics.
99

10+
.. caution:: Smart Agent monitors are being deprecated. To tail log files use the OpenTelemetry Collector and the :new-page:`Telegraf Tail Input plugin <https://github.com/influxdata/telegraf/blob/master/plugins/inputs/tail/README.md>`. See how in :ref:`telegraf-generic`.
11+
1012
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``telegraf/logparser`` monitor type to tail log files.
1113

1214
This integration is based on the Telegraf logparser plugin, and all

gdi/monitors-databases/sql.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SQL
66
.. meta::
77
:description: Use this Splunk Observability Cloud integration for the SQL monitor. See benefits, install, configuration, and metrics
88

9-
.. note:: If you're using the Splunk Distribution of the OpenTelemetry Collector and want to collect SQL metrics, use the native OTel :ref:`sqlquery-receiver` component.
9+
.. caution:: Smart Agent monitors are being deprecated. To collect SQL metrics use the native OpenTelemetry :ref:`sqlquery-receiver` component.
1010

1111
The SQL monitor gathers database usage metrics from SQL queries on your databases. It's available for Kubernetes, Windows, and Linux.
1212

gdi/monitors-hosts/procstat.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ procstat
66
.. meta::
77
:description: Use this Splunk Observability Cloud integration for the procstat monitor. See benefits, install, configuration, and metrics
88

9-
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
9+
.. caution:: Smart Agent monitors are being deprecated. To collect metrics about processes use the OpenTelemetry Collector and the :new-page:`Telegraf Procstat Input plugin <https://github.com/influxdata/telegraf/tree/master/plugins/inputs/procstat>`. See how in :ref:`telegraf-generic`.
10+
11+
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
1012
``procstat`` monitor type to collect metrics about processes.
1113

1214
This integration is available for Kubernetes, Linux, and Windows.

gdi/monitors-hosts/win-services.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ Windows Services
66
.. meta::
77
:description: Use this Splunk Observability Cloud integration for the Telegraf Win_services monitor. See benefits, install, configuration, and metrics
88

9-
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
9+
.. caution:: Smart Agent monitors are being deprecated. To collect Windows service data use the OpenTelemetry Collector and the :new-page:`Telegraf Windows Services Input plugin <https://github.com/influxdata/telegraf/tree/master/plugins/inputs/win_services>`. See how in :ref:`telegraf-generic`.
10+
11+
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
1012
``telegraf/win_services`` monitor type to ingest metrics about Windows
1113
services.
1214

gdi/monitors-languages/asp-dot-net.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ ASP.NET (deprecated)
1212

1313
To forward data from a .NET application to Splunk Observability Cloud use the :ref:`Splunk Distribution of OpenTelemetry .NET <get-started-dotnet-otel>` instead.
1414

15+
To monitor Windows Performance Counters with native OpenTelemetry refer to :ref:`windowsperfcounters-receiver`.
16+
1517
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
1618
``aspdotnet`` monitor type to retrieve metrics for requests, errors,
1719
sessions, and worker processes from ASP.NET applications.

gdi/monitors-languages/microsoft-dotnet.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ Microsoft .NET (deprecated)
66
.. meta::
77
:description: Use this Splunk Observability Cloud integration for the .NET (dotnet) apps monitor. See benefits, install, configuration, and metrics
88

9-
.. note:: This integration is deprecated and will be removed in February 2025. To forward data to Splunk Observability Cloud, use the Splunk Distribution of OpenTelemetry .NET. For a full list of collected metrics, refer to :ref:`dotnet-otel-metrics-attributes`.
9+
.. caution::
10+
11+
This integration is deprecated and will be removed in February 2025. To forward data to Splunk Observability Cloud, use the Splunk Distribution of OpenTelemetry .NET. For a full list of collected metrics, refer to :ref:`dotnet-otel-metrics-attributes`.
1012

11-
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
13+
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
1214
``dotnet`` monitor type to report metrics for .NET applications.
1315

1416
This integration is only available on Windows.

gdi/monitors-network/dns.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ DNS Query Input
66
.. meta::
77
:description: Use this Splunk Observability Cloud integration for the Telegraf DNS monitor. See benefits, install, configuration, and metrics
88

9-
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
10-
DNS Query Input monitor type (an embedded form of the Telegraf DNS Query
11-
plugin) to collect DNS data.
9+
.. caution:: Smart Agent monitors are being deprecated. To collect DNS data use the OpenTelemetry Collector and the :new-page:`Telegraf DNS Query Input plugin <https://github.com/influxdata/telegraf/tree/master/plugins/inputs/dns_query>`. See how in :ref:`telegraf-generic`.
10+
11+
You can use the Splunk Distribution of the OpenTelemetry Collector's Smart Agent receiver with the DNS Query Input monitor type (an embedded form of the Telegraf DNS Query plugin) to collect DNS data.
1212

1313
Benefits
1414
--------

gdi/monitors-network/snmp.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ SNMP agent
66
.. meta::
77
:description: Use this Splunk Observability Cloud integration for the SNMP agent monitor. See benefits, install, configuration, and metrics
88

9-
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
9+
.. caution:: Smart Agent monitors are being deprecated. To collect data from SNMP agents use the OpenTelemetry Collector and the :new-page:`Telegraf SNMP Input plugin <https://github.com/influxdata/telegraf/tree/master/plugins/inputs/snmp>`. See how in :ref:`telegraf-generic`.
10+
11+
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
1012
``snmp`` monitor type to collect metrics from SNMP agents.
1113

1214
This integration is available for Kubernetes, Windows, and Linux.

gdi/opentelemetry/otel-other/telegraf.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
.. _telegraf:
22
.. _telegraf-generic:
33

4-
Monitor services with Telegraf and OpenTelemetry
5-
========================================================
4+
Monitor services with Telegraf Input plugins and OpenTelemetry
5+
=====================================================================
66

77
.. meta::
88
:description: Use this Splunk Observability Cloud integration for the Telegraf monitor. See benefits, install, configuration, and metrics.
99

10-
To monitor your service with Telegraf using native OpenTelemetry in Splunk Observability Cloud, install the service's Telegraf plugin then push metrics to the Splunk Opentelemetry Collector
11-
via OTLP.
10+
To monitor your service with Telegraf using native OpenTelemetry in Splunk Observability Cloud, install the service's Telegraf Input plugin then push metrics to the Splunk Opentelemetry Collector via OTLP.
1211

1312
.. 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).
1413

@@ -45,9 +44,9 @@ Run the following commands to install Telegraf from the InfluxData repository:
4544
2. Set up your service's Telegraf Input plugin
4645
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4746

48-
Next, install the Telegraf Input plugin for the service you want to monitor. Available plugins include Chrony, Consul, Docker, Elasticsearch, Fluentd, GitHub, Jenkins, RabbitMQ or SQL. Find a complete list of Input plugins at :new-page:`Telegraf Input plugins <https://github.com/influxdata/telegraf/tree/master/plugins/inputs/exec>` in GitHub.
47+
Next, install the Telegraf Input plugin for the service you want to monitor. Available plugins include Chrony, Consul, Docker, Elasticsearch, Fluentd, GitHub, Jenkins, RabbitMQ or SQL. Find a complete list of available plugins at :new-page:`Telegraf Input plugins <https://github.com/influxdata/telegraf/tree/master/plugins/inputs>` in GitHub.
4948

50-
For example, if you want to monitor execute commands on every interval and parse metrics from their output with the exec input plugin, use a setup like:
49+
For example, if you want to monitor execute commands on every interval and parse metrics from their output with the Exec Input plugin, use a setup like:
5150

5251
.. code::
5352

0 commit comments

Comments
 (0)