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

Commit 01c91a6

Browse files
aurbiztondo-splunkaurbiztondo-splunk
authored
Merge pull request #2306 from splunk/urbiz-OD6350-k8s-obtain-otel
[6350]: Collector how to
2 parents e94a55f + 04036fe commit 01c91a6

File tree

3 files changed

+99
-23
lines changed

3 files changed

+99
-23
lines changed

‎gdi/opentelemetry/collector-how-to.rst‎

Lines changed: 91 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,46 +12,114 @@ Use the Collector: How to perform common tasks
1212
:titlesonly:
1313
:hidden:
1414

15-
Browse the table below to learn how to carry out common tasks with the Splunk Distribution of OpenTelemetry Collector.
15+
Browse the table below to learn how to carry out common tasks with the Splunk Distribution of the OpenTelemetry Collector.
1616

1717
.. list-table::
1818
:width: 100%
19-
:widths: 40 60
19+
:widths: 25 25 25 25
2020
:header-rows: 1
2121

2222
* - I want to...
23+
- Why?
24+
- When?
2325
- See...
2426
* - Control data pre-ingest
27+
- To optimize data ingestion performance, reduce storage costs, allow for customization, and address privacy concerns by controlling the data sent to Splunk Observability Cloud.
28+
- Use this when you encounter redundant or unnecessary telemetry data, need to modify data to meet specific requirements, or must sanitize sensitive information before ingestion using the Collector.
2529
- :ref:`configure-remove`
26-
* - Obfuscate sensitive data
27-
- :ref:`sensitive-data-controls`
28-
* - Uniquely identify an instance
29-
- :ref:`attributes-processor`
30-
* - Use tags or attributes
31-
- :ref:`otel-tags`
32-
* - Remove attributes
33-
- :ref:`attributes-processor`
30+
* - Work with tags or attributes
31+
- To add, modify, or remove tags or attributes on data for better organization and control.
32+
- Use this when learning how to modify tags and attributes on data before ingestion using the Collector.
33+
- :ref:`otel-tags`
34+
* - Obfuscate sensitive data in logs
35+
- To protect privacy by ensuring sensitive log data is not ingested.
36+
- Use this when sensitive information needs to be sanitized before ingestion using the Collector.
37+
- :ref:`attributes-processor-obfuscate-logs`
38+
* - Obfuscate sensitive data in traces
39+
- To protect privacy by ensuring sensitive trace data is not ingested.
40+
- Use this when sensitive information needs to be sanitized before ingestion using the Collector.
41+
- :ref:`sensitive-data-controls`
42+
* - Filter unwanted logs
43+
- To prevent ingestion of unwanted log data by using filtering logic to include or exclude specific logs. This helps to optimize data flow and reduce costs.
44+
- Use this when you need to collect log data only from certain sources or of specific types, or when log ingestion load is too high.
45+
- :ref:`filter-processor-logs`
46+
* - Filter unwanted metrics
47+
- To prevent ingestion of unwanted metric data by using filtering logic to include or exclude specific metrics. This helps to optimize data flow and reduce costs.
48+
- Use this when you need to collect metric data only from certain sources or of specific types, or when metric ingestion load is too high.
49+
- :ref:`filter-processor-metrics`
50+
* - Filter unwanted traces
51+
- To prevent ingestion of unwanted trace data by using filtering logic to include or exclude specific traces. This helps to optimize data flow and reduce costs.
52+
- Use this when you need to collect trace data only from certain sources or of specific types, or when trace ingestion load is too high.
53+
- :ref:`filter-processor-spans`
54+
* - Collect a fraction of logs using sampling
55+
- To reduce log ingestion volume and costs by using probabilistic sampling to collect a percentage of log data.
56+
- Use this when you need to collect only a sample set of log data which can help address ingesting too many logs.
57+
- :ref:`probabilistic-sampler-processor`
58+
* - Collect a fraction of traces using sampling
59+
- To reduce trace ingestion volume and costs by using tail sampling to collect a percentage of trace data.
60+
- Use this when you need to collect only a sample set of trace data which can help address ingesting too many traces.
61+
- :ref:`tail-sampling-processor`
3462
* - Collect custom metrics
35-
- :new-page:`Receive any custom metric with the Collector <https://opentelemetry.io/blog/2023/any-metric-receiver/>`
63+
- To send custom infrastructure and application metrics to Splunk Observability Cloud for deeper custom visibility.
64+
- Use this when instrumenting a service that isn't natively supported or when specific custom metrics are required.
65+
- :new-page:`send-custom-metrics`
3666
* - Collect Prometheus metrics
67+
- To collect widely used Prometheus metrics and send them to Splunk Observability Cloud.
68+
- Use this when instrumenting a Prometheus source for monitoring.
3769
- :ref:`prometheus-receiver`
38-
* - Collect logs
70+
* - Collect host logs
71+
- To collect on-disk logs for analysis and monitoring.
72+
- Use this when you need to collect logs from the local system or host.
3973
- :ref:`filelog-receiver`
40-
* - Collect Kubernetes events
41-
- :ref:`otel-k8s-events`
42-
* - Filter Kubernetes elements
43-
- :ref:`filter-processor-kubernetes`
44-
* - Deactivate Kubernetes metrics
45-
- :ref:`kubernetes-cluster-receiver`
46-
* - Observe specific events
74+
* - Dynamically collect data from new data sources at runtime
75+
- To monitor data sources that may be created, removed, or recreated during runtime.
76+
- Use this when the receiver creator feature is needed to dynamically create receivers at runtime, based on configured rules and observer extensions.
4777
- :ref:`receiver-creator-receiver`
48-
* - Look for support for an environment
78+
* - Look for collector support for a specific environment
79+
- To ensure that your environment is compatible with the Collector.
80+
- Validate support for your target environment before deploying your Collector instance.
4981
- :ref:`requirements`
50-
* - Collector deployment options, such as Amazon Fargate, Ansible, Chef, PCF, or Puppet
82+
* - Evaluate Collector deployment options like Ansible, Chef, PCF, or Puppet
83+
- Different deployment methods have unique requirements and features, allowing you to tailor the deployment to your specific needs.
84+
- Before deploying the Collector choose the most suitable deployment mechanism for your environment and requirements.
5185
- :ref:`otel_deployments`
52-
* - Look for changes between versions
86+
* - Review release changes before collector version upgrades
87+
- New Collector versions include important features, optimizations, and fixes, which are documented in the release notes.
88+
- Always review the release notes before upgrading the collector to understand the changes.
5389
- * :new-page:`Main changelog for the Splunk distribution of the Collector <https://github.com/signalfx/splunk-otel-collector/blob/main/CHANGELOG.md>`
54-
* :new-page:`Changelog for the Helm chart <https://github.com/signalfx/splunk-otel-collector-chart/blob/main/CHANGELOG.md>`
90+
* :new-page:`Collector Contrib repository <https://github.com/open-telemetry/opentelemetry-collector-contrib>`
91+
* :new-page:`Upstream changelog (Contrib) <https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CHANGELOG.md>`
92+
* :new-page:`Upstream changelog (Core) <https://github.com/open-telemetry/opentelemetry-collector/blob/main/CHANGELOG.md>`
93+
94+
.. _collector-how-to-kubernetes:
95+
96+
Tasks specific to Kubernetes environments
97+
==========================================
98+
99+
These tasks are specific to Kubernetes environments:
100+
101+
.. list-table::
102+
:width: 100%
103+
:widths: 25 25 25 25
104+
:header-rows: 1
105+
106+
* - I want to...
107+
- Why?
108+
- When?
109+
- See...
110+
* - Collect Kubernetes events
111+
- To enable the collection of Kubernetes events (events.k8s.io/v1) for enhanced observability.
112+
- Use this when you want Kubernetes events to be available in your observability setup for better insight into cluster activities.
113+
- :ref:`otel-k8s-events`
114+
* - Filter collecting telemetry data at different levels in Kubernetes
115+
- To filter Kubernetes metrics, logs, and traces from specific clusters, namespaces, pods, or containers, reducing unnecessary data collection.
116+
- Use this when you need to minimize telemetry ingestion by excluding data from certain parts of the cluster or when focusing on specific Kubernetes data souces.
117+
- :ref:`filter-processor-kubernetes`
118+
* - Review release changes before collector version upgrades
119+
- New collector versions often include important features, optimizations, and fixes, which are documented in the release notes.
120+
- Always review the release notes before upgrading the collector to understand the changes.
121+
- * :new-page:`Changelog for the Helm chart <https://github.com/signalfx/splunk-otel-collector-chart/blob/main/CHANGELOG.md>`
122+
* :new-page:`Main changelog for the Splunk distribution of the Collector <https://github.com/signalfx/splunk-otel-collector/blob/main/CHANGELOG.md>`
55123
* :new-page:`Collector Contrib repository <https://github.com/open-telemetry/opentelemetry-collector-contrib>`
56124
* :new-page:`Upstream changelog (Contrib) <https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CHANGELOG.md>`
57125
* :new-page:`Upstream changelog (Core) <https://github.com/open-telemetry/opentelemetry-collector/blob/main/CHANGELOG.md>`

‎gdi/opentelemetry/components/attributes-processor.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,8 @@ The following sample configurations show how to perform different actions on att
134134

135135
.. note:: For a complete list of examples, see the configuration snippets in :new-page:`https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/attributesprocessor/testdata/config.yaml`.
136136

137+
.. _attributes-processor-obfuscate-logs:
138+
137139
Remove or obfuscate sensitive information from logs
138140
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
139141

‎gdi/opentelemetry/components/filter-processor.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ The following sample configurations show how to filter spans, metrics, and logs
114114

115115
.. note:: For a complete list of examples, see the configuration snippets in :new-page:`https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/filterprocessor/testdata`.
116116

117+
.. _filter-processor-spans:
118+
117119
Filter spans
118120
^^^^^^^^^^^^^^^^^^^^^^^^^^
119121

@@ -146,6 +148,8 @@ You can exclude or include spans from traces using resource attributes or OTTL c
146148
147149
.. note:: Include filters are always applied before exclude filters for any given filter processor instance.
148150

151+
.. _filter-processor-metrics:
152+
149153
Filter metrics
150154
^^^^^^^^^^^^^^^^^^^^^
151155

@@ -190,6 +194,8 @@ You can exclude or include metrics using metric names, expressions, or OTTL cond
190194
datapoint:
191195
- 'attributes["attributename"] == "value"'
192196
197+
.. _filter-processor-logs:
198+
193199
Filter logs
194200
^^^^^^^^^^^^^^^^^^^^^
195201

0 commit comments

Comments
 (0)