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

Commit 029c617

Browse files
aurbiztondo-splunkaurbiztondo-splunk
authored
Merge pull request #1617 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents 885edf2 + bd3762d commit 029c617

File tree

7 files changed

+154
-15
lines changed

7 files changed

+154
-15
lines changed

‎gdi/integrations-list.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ Supported integrations in Splunk Observability Cloud
1919
Infrastructure monitoring <get-data-in/compute/compute>
2020
APM instrumentation <get-data-in/application/application>
2121
RUM instrumentation <get-data-in/rum/rum-instrumentation>
22-
OpenTelemetry receivers <opentelemetry/components/a-components-receivers>
22+
OpenTelemetry: Receivers <opentelemetry/components/a-components-receivers>
23+
OpenTelemetry: Other ingestion methods <opentelemetry/otel-other/otel-other-landing>
2324
Applications: Caches and memory TOGGLE <caches-memory>
2425
Applications: Cloud platforms TOGGLE <cloud>
2526
Applications: Cloudfoundry <monitors-cloudfoundry/cloudfoundry-firehose-nozzle>
@@ -130,6 +131,7 @@ You can monitor your applications and services with the Collector and the follow
130131
You can also send data to Splunk Observability Cloud with OpenTelemetry with the following options:
131132

132133
* :ref:`prometheus-generic`
134+
* :ref:`telegraf-generic`
133135

134136
.. raw:: html
135137

‎gdi/monitoring.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@ Configure application exporters and receivers for monitoring
1313

1414
monitors-monitoring/cadvisor
1515
monitors-monitoring/cgroups
16-
Istio <get-data-in/application/istio/istio>
1716
monitors-monitoring/jaeger-grpc
1817
monitors-monitoring/nagios
1918
monitors-monitoring/signalfx-forwarder
20-
opentelemetry/components/splunk-apm-exporter
2119
monitors-monitoring/win_perf_counters
2220

2321
These application receivers gather metrics from their associated monitoring applications and the hosts the applications are running on.

‎gdi/monitors-databases/exec-input.rst‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,9 @@ 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 more at :new-page:`OpenTelemetry Output Plugin <https://github.com/influxdata/telegraf/blob/master/plugins/outputs/opentelemetry/README.md>` in GitHub.
13+
To monitor your system with Telegraf Exec you can use native OpenTelemetry instead. See :ref:`telegraf-generic` to learn how.
1414

15-
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
16-
Exec Input monitor type, an embedded form of the Telegraf Exec plugin,
17-
to receive metrics or logs from exec files.
15+
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.
1816

1917
Benefits
2018
--------

‎gdi/opentelemetry/otel-other/otel-other-landing.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _otel-other-landing:
2+
3+
******************************************
4+
Other OpenTelemetry ingestion methods
5+
******************************************
6+
7+
.. meta::
8+
:description: Learn about other options to send your data with OpenTelemetry to Splunk Observability Cloud OpenTelemetry Collector.
9+
10+
.. toctree::
11+
:maxdepth: 4
12+
:titlesonly:
13+
:hidden:
14+
15+
prometheus-generic
16+
telegraf
17+
18+
On top of the available native :ref:`OpenTelemetry receivers <otel-components-receivers>`, you can also send data to Splunk Observability Cloud with OpenTelemetry with the following options:
19+
20+
* :ref:`prometheus-generic`
21+
* :ref:`telegraf-generic`

‎gdi/monitors-prometheus/prometheus-generic.rst‎ renamed to ‎gdi/opentelemetry/otel-other/prometheus-generic.rst‎

File renamed without changes.

‎gdi/opentelemetry/otel-other/telegraf.rst‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
.. _telegraf:
2+
.. _telegraf-generic:
3+
4+
Monitor services with Telegraf and OpenTelemetry
5+
========================================================
6+
7+
.. meta::
8+
:description: Use this Splunk Observability Cloud integration for the Telegraf monitor. See benefits, install, configuration, and metrics.
9+
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.
12+
13+
.. 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).
14+
15+
Benefits
16+
--------
17+
18+
.. include:: /_includes/benefits.rst
19+
20+
Configuration
21+
----------------------------------
22+
23+
Follow these steps to scrape Telegraf metrics with the OTel Collector:
24+
25+
1. Install Telegraf
26+
2. Set up your service's Telegraf Input plugin
27+
3. Set up the Telegraf OpenTelemetry Output plugin
28+
4. Configure the OpenTelemetry Collector
29+
30+
1. Install Telegraf
31+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32+
33+
Run the following commands to install Telegraf from the InfluxData repository:
34+
35+
.. code:: shell
36+
37+
curl --silent --location -O \ https://repos.influxdata.com/influxdata-archive.key \ && echo "943666881a1b8d9b849b74caebf02d3465d6beb716510d86a39f6c8e8dac7515 influxdata-archive.key" \
38+
| sha256sum -c - && cat influxdata-archive.key \
39+
| gpg --dearmor \
40+
| sudo tee /etc/apt/trusted.gpg.d/influxdata-archive.gpg > /dev/null \
41+
&& echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive.gpg] https://repos.influxdata.com/debian stable main' \
42+
| sudo tee /etc/apt/sources.list.d/influxdata.list
43+
sudo apt-get update && sudo apt-get install telegraf
44+
45+
2. Set up your service's Telegraf Input plugin
46+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47+
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.
49+
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:
51+
52+
.. code::
53+
54+
# Read metrics from one or more commands that can output to stdout
55+
[[inputs.exec]]
56+
57+
## Commands array
58+
commands = ["sh /testfolder/testscript.sh"]
59+
timeout = "30s"
60+
data_format = "influx"
61+
62+
## Environment variables
63+
## Array of "key=value" pairs to pass as environment variables
64+
## e.g. "KEY=value", "USERNAME=John Doe",
65+
## "LD_LIBRARY_PATH=/opt/custom/lib64:/usr/local/libs"
66+
# environment = []
67+
68+
## Measurement name suffix
69+
## Used for separating different commands
70+
# name_suffix = ""
71+
72+
## Ignore Error Code
73+
## If set to true, a non-zero error code in not considered an error and the
74+
## plugin will continue to parse the output.
75+
# ignore_error = false
76+
77+
3. Set up the Telegraf OpenTelemetry Output plugin
78+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79+
80+
Next, add the OTel Output plugin to your Telegraf configuration file:
81+
82+
.. code::
83+
84+
# Send OpenTelemetry metrics over gRPC
85+
[[outputs.opentelemetry]]
86+
87+
The config file usually resides on the ./etc/telegraf/telegraf.d directory.
88+
89+
For detailed information see Telegraf's :new-page:`OpenTelemetry Output plugin <https://github.com/influxdata/telegraf/blob/master/plugins/outputs/opentelemetry/README.md>` documentation in GitHub.
90+
91+
4. Configure the OpenTelemetry Collector
92+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
93+
94+
Add the following configuration to the OTel Collector to retrieve metrics from the Telegraf installation:
95+
96+
.. code:: yaml
97+
98+
receivers:
99+
otlp:
100+
protocols:
101+
http:
102+
grpc:
103+
signalfx:
104+
105+
exporters:
106+
signalfx:
107+
access_token: "SPLUNK_TOKEN"
108+
realm: "us0"
109+
110+
service:
111+
pipelines:
112+
metrics:
113+
receivers: [otlp]
114+
exporters: [signalfx]
115+
metrics/internal:
116+
receivers: [signalfx]
117+
processors:
118+
exporters: [signalfx]
119+
120+
Troubleshooting
121+
---------------
122+
123+
.. include:: /_includes/troubleshooting-components.rst

‎gdi/prometheus.rst‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,21 @@ Configure application receivers with Prometheus metrics
1111
:maxdepth: 4
1212
:hidden:
1313

14-
monitors-prometheus/prometheus-generic
15-
opentelemetry/components/prometheus-receiver
1614
monitors-prometheus/prometheus-exporter
1715
monitors-prometheus/prometheus-go
1816
monitors-prometheus/prometheus-nginx-ingress
1917
monitors-prometheus/prometheus-nginx-vts
2018
monitors-prometheus/prometheus-node
2119
monitors-prometheus/prometheus-velero
2220

23-
You can use the OpenTelementry native Prometheus receiver to gather metrics from any software, tool or service that exposes metrics in the Prometheus format, such as Ansible Tower (AWX), CockroachDB, Docker Daemon, Doorman, Etcd, Flink, Grafana, PATROL, Traefik, or Zipkin. See more at :ref:`prometheus-receiver`.
21+
Splunk Observability Cloud offers the following OTel solutions to monitor applications and services that expose metrics in the Prometheus format:
2422

25-
Splunk Observability Cloud offers the following solutions:
23+
* :ref:`prometheus-receiver`. You can use the OpenTelementry native Prometheus receiver to gather metrics from any software, tool or service that exposes metrics in the Prometheus format, such as Ansible Tower (AWX), CockroachDB, Docker Daemon, Doorman, Etcd, Flink, Grafana, PATROL, Traefik, or Zipkin.
24+
* :ref:`prometheus-generic`.
2625

27-
* :ref:`prometheus-generic`
28-
* :ref:`prometheus-receiver`
29-
* See a complete list of third-party applications compatible with Prometheus in :new-page:`Prometheus' official documentation <https://prometheus.io/docs/instrumenting/exporters/>`.
26+
You can find the complete list of third-party applications compatible with Prometheus in :new-page:`Prometheus' official documentation <https://prometheus.io/docs/instrumenting/exporters/>`.
3027

31-
See also:
28+
The following Smart Agent monitors are also available:
3229

3330
* :ref:`prometheus-exporter`
3431
* :ref:`prometheus-go`

0 commit comments

Comments
 (0)