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

Commit 9b49b34

Browse files
aurbiztondo-splunkaurbiztondo-splunk
authored
Merge pull request #2537 from splunk/urbiz-DG27735-px-matrix
[DG27735]: Processor matrix
2 parents ce9113c + f8ef304 commit 9b49b34

10 files changed

+378
-400
lines changed

‎_includes/gdi/collector-available-exporters.rst‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. list-table::
2+
:widths: 25 55 20
3+
:header-rows: 1
4+
:width: 100%
5+
6+
* - Name
7+
- Description
8+
- Pipeline types
9+
* - :ref:`awss3-exporter` (``awss3``)
10+
- This exporter targets to support proto/json format.
11+
- Metrics, logs, traces
12+
* - :ref:`file-exporter` (``file``)
13+
- Writes pipeline data to a JSON file in Protobuf JSON encoding using the OpenTelemetry protocol.
14+
- Metrics, logs, traces
15+
* - :ref:`kafka-exporter` (``kafka``)
16+
- Exports metrics, logs, and traces to Kafka using a synchronous producer.
17+
- Metrics, logs, traces
18+
* - :ref:`loadbalancing-exporter` (``loadbalancing``)
19+
- Exports metrics, logs, and traces to different back-ends.
20+
- Metrics, logs, traces
21+
* - :ref:`logging-exporter` (``logging``)
22+
- Exports data to the console. By default, ``logging`` doesn't send its output to Windows Event Viewer. Run the Splunk Distribution of OpenTelemetry Collector directly from the PowerShell terminal to send output to the Windows Event Viewer.
23+
- Metrics, logs, traces
24+
* - :ref:`otlp-exporter` (``otlp``)
25+
- Exports data through gRPC using the OTLP format. By default, this exporter requires TLS and provides queued retry capabilities.
26+
- Metrics, logs, traces
27+
* - :ref:`otlphttp-exporter` (``otlphttp``)
28+
- Exports data in OTLP format over the HTTP protocol.
29+
- Metrics, logs, traces
30+
* - :ref:`pulsar-exporter` (``pulsar``)
31+
- Exports logs, metrics, and traces to Pulsar.
32+
- Metrics, logs, traces -
33+
* - :ref:`signalfx-exporter` (``signalfx``)
34+
- Sends metrics, events, and trace correlation to Splunk Observability Cloud.
35+
- Logs (events), metrics, traces (trace to metric correlation only)
36+
* - :ref:`splunk-apm-exporter` (``sapm``)
37+
- Exports traces from multiple nodes or services in a single batch.
38+
- Traces
39+
* - :ref:`splunk-hec-exporter` (``splunk_hec``)
40+
- Sends telemetry to a Splunk HEC endpoint.
41+
- Metrics, logs, traces

‎_includes/gdi/collector-available-extensions.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.. list-table::
2+
:widths: 25 75
3+
:header-rows: 1
4+
:width: 100%
5+
6+
* - Name
7+
- Description
8+
* - :ref:`basic-auth-extension` (``basicauth``)
9+
- Implements both ``configauth.ServerAuthenticator`` and ``configauth.ClientAuthenticator`` to authenticate clients and servers using basic authentication. The authenticator type has to be set to ``basicauth``.
10+
* - :ref:`docker-observer-extension` (``docker_observer``)
11+
- Detects and reports container endpoints discovered through the Docker API. Only containers that are in the state of ``Running`` and not ``Paused`` emit endpoints.
12+
* - :ref:`ecs-observer-extension` (``ecs_observer``)
13+
- Uses the ECS and EC2 API to discover Prometheus scrape targets from all running tasks and filter them based on service names, task definitions, and container labels. Only compatible with the Prometheus receiver.
14+
* - :ref:`ecstask-observer-extension` (``ecs_task_observer``)
15+
- Detects and reports container endpoints for the running ECS task of which your Collector instance is a member.
16+
* - :ref:`file-storage-extension` (``file_storage``)
17+
- Persists state to the local file system. Requires read and write access to a diectory.
18+
* - :ref:`health-check-extension` (``health_check``)
19+
- Activates an HTTP URL that can be probed to check the status of the OpenTelemetry Collector. You can also use this extension as a liveness or readiness probe on Kubernetes.
20+
* - :ref:`http-forwarder-extension` (``http_forwarder``)
21+
- Accepts HTTP requests and optionally adds headers and forwards them. The RequestURIs of the original requests are preserved by the extension.
22+
* - :ref:`host-observer-extension` (``host_observer``)
23+
- Looks at the current host for listening network endpoints. Uses the /proc file system and requires the ``SYS_PTRACE`` and ``DAC_READ_SEARCH`` capabilities so that it can determine what processes own the listening sockets. See :ref:`receiver-creator-receiver` for more information.
24+
* - :ref:`kubernetes-observer-extension` (``k8s_observer``)
25+
- Uses the Kubernetes API to discover pods running on the local node. See :ref:`receiver-creator-receiver` for more information.
26+
* - :ref:`memory-ballast-extension` (``memory_ballast``)
27+
- ``memory_ballast`` is deprecated. If you're using this extension, see :ref:`how to update your configuration <collector-upgrade-memory-ballast>`.
28+
* - :ref:`oauth2client-extension` (``oauth2client``)
29+
- Provides OAuth2 Client Credentials flow authenticator for HTTP and gRPC based exporters.
30+
* - :ref:`pprof-extension` (``pprof``)
31+
- Activates the golang ``net/http/pprof`` endpoint, which is used to collect performance profiles and investigate issues with a service.
32+
* - :ref:`smartagent-extension` (``smartagent``)
33+
- Provides a mechanism to set configuration options that are applicable to all instances of the Smart Agent receiver. Allows to migrate your existing Smart Agent configuration to the Splunk Distribution of OpenTelemetry Collector.
34+
* - :ref:`zpages-extension` (``zpages``)
35+
- Activates an extension that serves zPages, an HTTP endpoint that provides live data for debugging different components.

‎_includes/gdi/collector-available-processors.rst‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. list-table::
2+
:widths: 25 55 20
3+
:header-rows: 1
4+
:width: 100%
5+
6+
* - Name
7+
- Description
8+
- Pipeline types
9+
* - :ref:`attributes-processor` (``attributes``)
10+
- Modifies attributes of a span or log record.
11+
- Logs, traces
12+
* - :ref:`batch-processor` (``batch``)
13+
- Accepts spans, metrics, or logs and places them into batches. Batching helps better compress the data and reduce the number of outgoing connections required to transmit the data. This processor supports both size-based and time-based batching.
14+
- Metrics, logs, traces
15+
* - :ref:`cumulative-to-delta-processor` (``cumulativetodelta``)
16+
- Convert cumulative monotonic metrics to delta aggregation temporality. This enhances the usage of cumulative metrics in Splunk Observability Cloud.
17+
- Metrics
18+
* - :ref:`filter-processor` (``filter``)
19+
- Can be configured to include or exclude metrics based on metric name in the case of the ``strict`` or ``regexp`` match types, or based on other metric attributes in the case of the ``expr`` match type.
20+
- Metrics
21+
* - :ref:`groupbyattrs-processor` (``groupbyattrs``)
22+
- Reassociates spans, log records, and metric data points to a resource that matches with the specified attributes. As a result, all spans, log records, or metric data points with the same values for the specified attributes are grouped under the same resource.
23+
- Metrics, logs, traces
24+
* - :ref:`kubernetes-attributes-processor` (``k8sattributes``)
25+
- Allows automatic tagging of spans, metrics, and logs with Kubernetes metadata. Formerly known as ``k8s_tagger``.
26+
- Metrics, logs, traces
27+
* - :ref:`memory-limiter-processor` (``memory_limiter``)
28+
- Prevents out of memory situations on the Splunk Distribution of OpenTelemetry Collector.
29+
- Metrics, logs, traces
30+
* - :ref:`metrics-transform-processor` (``metricstransform``)
31+
- Renames metrics, and adds, renames, or deletes label keys and values.
32+
- Metrics
33+
* - :ref:`probabilistic-sampler-processor` (``probabilisticsampler``)
34+
- Supports several modes of sampling for spans and log records.
35+
- Traces, logs
36+
* - :ref:`redaction-processor` (``redaction``)
37+
- Deletes span attributes that don't match a list of allowed attributes. It also masks span attribute values that match a blocked value list.
38+
- Traces
39+
* - :ref:`resource-processor` (``resource``)
40+
- Applies changes to resource attributes. Attributes represent actions that can be applied on resources.
41+
- Metrics, logs, traces
42+
* - :ref:`resourcedetection-processor` (``resourcedetection``)
43+
- Detects resource information from the host, in a format that conforms to the OpenTelemetry resource semantic conventions, and appends or overrides the resource value in telemetry data with this information.
44+
- Metrics, logs, traces
45+
* - :ref:`routing-processor` (``routing``)
46+
- Reads a header from the incoming HTTP request or reads a resource attribute, and then directs the trace information to specific exporters based on the value.
47+
- Metrics, logs, traces
48+
* - :ref:`span-processor` (``span``)
49+
- Modifies either the span name or attributes of a span based on the span name.
50+
- Traces
51+
* - :ref:`tail-sampling-processor` (``tail_sampling``)
52+
- Samples traces based on a set of defined policies. All spans for a given trace must be received by the same Collector instance for effective sampling decisions.
53+
- Traces
54+
* - :ref:`transform-processor` (``transform``)
55+
- Modifies telemetry based on OpenTelemetry Transformation Language functions.
56+
- Metrics, logs, traces

‎_includes/gdi/otel-receivers-table.rst‎

Lines changed: 170 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,171 @@
1-
* :ref:`apache-receiver`
2-
* :ref:`apache-spark-receiver`
3-
* :ref:`awsecscontainermetrics-receiver`
4-
* :ref:`azureeventhub-receiver`
5-
* :ref:`carbon-receiver`
6-
* :ref:`chrony-receiver`
7-
* :ref:`cloudfoundry-receiver`
8-
* :ref:`collectd-receiver`
9-
* :ref:`discovery-receiver`
10-
* :ref:`elasticsearch-receiver`
11-
* :ref:`filelog-receiver`
12-
* :ref:`fluentd-receiver`
13-
* :ref:`haproxy-receiver`
14-
* :ref:`host-metrics-receiver`
15-
* :ref:`http-check-receiver`
16-
* :ref:`jaeger-receiver`
17-
* :ref:`jmx-receiver`
18-
* :ref:`journald-receiver`
19-
* :ref:`kafka-receiver`
20-
* :ref:`kafkametrics-receiver`
21-
* :ref:`kubelet-stats-receiver`
22-
* :ref:`kubernetes-cluster-receiver`
23-
* :ref:`kubernetes-events-receiver`
24-
* :ref:`kubernetes-objects-receiver`
25-
* :ref:`mongodb-receiver`
26-
* :ref:`mongodb-atlas-receiver`
27-
* :ref:`mssql-server-receiver`
28-
* :ref:`mysql-receiver`
29-
* :ref:`nginx-receiver`
30-
* :ref:`oracledb-receiver`
31-
* :ref:`otlp-receiver`
32-
* :ref:`postgresql-receiver`
33-
* :ref:`prometheus-receiver`
34-
* :ref:`rabbitmq-receiver`
35-
* :ref:`receiver-creator-receiver`
36-
* :ref:`redis-receiver`
37-
* :ref:`sapm-receiver`
38-
* :ref:`simple-prometheus-receiver`
39-
* :ref:`signalfx-gateway-prometheus-remote-write-receiver`
40-
* :ref:`signalfx-receiver`
41-
* :ref:`smartagent-receiver`
42-
* :ref:`splunk-enterprise-receiver`
43-
* :ref:`splunk-hec-receiver`
44-
* :ref:`sqlquery-receiver`
45-
* :ref:`sshcheck-receiver`
46-
* :ref:`statsd-receiver`
47-
* :ref:`syslog-receiver`
48-
* :ref:`tcp-logs-receiver`
49-
* :ref:`udp-logs-receiver`
50-
* :ref:`vcenter-receiver`
51-
* :ref:`wavefront-receiver`
52-
* :ref:`windowseventlog-receiver`
53-
* :ref:`windowsperfcounters-receiver`
54-
* :ref:`zipkin-receiver`
1+
.. list-table::
2+
:widths: 25 55 20
3+
:header-rows: 1
4+
:width: 100%
5+
6+
* - Name
7+
- Description
8+
- Pipeline types
9+
* - :ref:`apache-receiver` (``apache``)
10+
- Fetches stats from a Apache Web Server.
11+
- Metrics
12+
* - :ref:`apache-spark-receiver` (``apachespark``)
13+
- Fetches metrics for an Apache Spark cluster through the Apache Spark REST API.
14+
- Metrics
15+
* - :ref:`awsecscontainermetrics-receiver` (``awsecscontainermetrics``)
16+
- Reads task metadata and docker stats from Amazon ECS and generates resource usage metrics.
17+
- Metrics
18+
* - :ref:`azureeventhub-receiver` (``azureeventhub``)
19+
- Pulls logs from an Azure event hub.
20+
- Logs
21+
* - :ref:`carbon-receiver` (``carbon``)
22+
- Receives metrics in Carbon plaintext protocol.
23+
- Metrics
24+
* - :ref:`chrony-receiver` (``chrony``)
25+
- Go implementation of the ``chronyc`` command to track portability across systems and platforms.
26+
- Metrics
27+
* - :ref:`cloudfoundry-receiver` (``cloudfoundry``)
28+
- Connects to the Reverse Log Proxy (RLP) gateway of Cloud Foundry to extract metrics.
29+
- Metrics
30+
* - :ref:`collectd-receiver` (``collectd``)
31+
- Receives data exported through the CollectD ``write_http`` plugin. Only supports the JSON format.
32+
- Metrics
33+
* - :ref:`discovery-receiver` (``discovery``) elasticsearch-receiver
34+
- Wraps the receiver creator to facilitate the discovery of metric collection targets. See :ref:`discovery_mode`.
35+
- Logs
36+
* - :ref:`elasticsearch-receiver` (``elasticsearch``)
37+
- Queries the Elasticsearch node stats, cluster health and index stats endpoints to scrape metrics from a running Elasticsearch cluster.
38+
- Metrics
39+
* - :ref:`filelog-receiver` (``filelog``)
40+
- Tails and parses logs from files.
41+
- Logs
42+
* - :ref:`fluentd-receiver` (``fluentforward``)
43+
- Runs a TCP server that accepts events through the Fluentd Forward protocol.
44+
- Logs
45+
* - :ref:`haproxy-receiver` (``haproxy``)
46+
- Generates metrics by polling periodically the HAProxy process through a dedicated socket or HTTP URL.
47+
- Metrics
48+
* - :ref:`host-metrics-receiver` (``hostmetrics``)
49+
- Generates system metrics from various sources. Use this receiver when deploying the Collector as an agent.
50+
- Metrics
51+
* - :ref:`http-check-receiver` (``httpcheck``)
52+
- Performs synthethic checks against HTTP endpoints.
53+
- Metrics
54+
* - :ref:`jaeger-receiver` (``jaeger``)
55+
- Receives trace data in Jaeger format.
56+
- Traces
57+
* - :ref:`jmx-receiver` (``jmx``)
58+
- Works in conjunction with the :new-page:`OpenTelemetry JMX Metric Gatherer <https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/README.md>` to report metrics from an MBean server.
59+
- Metrics
60+
* - :ref:`journald-receiver` (``journald``)
61+
- Parses Journald events from the systemd journal. The ``journalctl`` binary must be in the same ``$PATH`` of the agent.
62+
- Logs
63+
* - :ref:`kafka-receiver` (``kafka``)
64+
- Receives metrics, logs, and traces from Kafka. Metrics and logs only support the OTLP format.
65+
- Metrics, logs, traces
66+
* - :ref:`kafkametrics-receiver` (``kafkametrics``)
67+
- Collects Kafka metrics such as brokers, topics, partitions, and consumer groups from Kafka server, and converts them to OTLP format.
68+
- Metrics
69+
* - :ref:`kubernetes-cluster-receiver` (``k8s_cluster``)
70+
- Collects cluster-level metrics from the Kubernetes API server. It uses the Kubernetes API to listen for updates. You can use a single instance of this receiver to monitor a cluster.
71+
- Metrics
72+
* - :ref:`kubernetes-events-receiver` (``k8s_events``)
73+
- Collects all new and updated events from the Kubernetes API server. Supports authentication through service accounts only.
74+
- Logs
75+
* - :ref:`kubernetes-objects-receiver` (``k8sobjects``)
76+
- Collects objects from the Kubernetes API server. Supports authentication through service accounts only.
77+
- Logs
78+
* - :ref:`kubelet-stats-receiver` (``kubeletstats``)
79+
- Pulls pod metrics from the API server on a kubelet.
80+
- Metrics
81+
* - :ref:`mongodb-receiver` (``mongodb``)
82+
- Fetches stats from a MongoDB instance using the Golang ``mongo`` driver.
83+
- Metrics
84+
* - :ref:`mongodb-atlas-receiver` (``mongodbatlas``)
85+
- Retrieves metrics from MongoDB Atlas using their monitoring APIs.
86+
- Metrics
87+
* - :ref:`mssql-server-receiver` (``sqlserver``)
88+
- Grabs metrics from a Microsoft SQL Server instance.
89+
- Metrics
90+
* - :ref:`mysql-receiver` (``mysql``)
91+
- Queries and retrieves metrics about MySQL's global status and InnoDB tables.
92+
- Metrics
93+
* - :ref:`nginx-receiver` (``nginx``)
94+
- Fetches stats from a NGINX instance using the ``ngx_http_stub_status_module`` module's status endpoint.
95+
- Metrics
96+
* - :ref:`oracledb` (``oracledb``) |br|
97+
- Connects to an Oracle Database instance and obtains metrics such as physical reads, CPU, time, and others.
98+
- Metrics
99+
* - :ref:`otlp-receiver` (``otlp``)
100+
- Receives data through gRPC or HTTP using OTLP format.
101+
- Metrics, logs, traces
102+
* - :ref:`postgresql-receiver` (``postgresql``)
103+
- Queries the PostgreSQL statistics collector. Supports PostgreSQL version 9.6 and higher.
104+
- Metrics
105+
* - :ref:`prometheus-receiver` (``prometheus``)
106+
- Provides a simple configuration interface to scrape metrics from a single target.
107+
- Metrics
108+
* - :ref:`simple-prometheus-receiver` (``prometheus_simple``)
109+
- Wraps the ``prometheus`` receiver to provide simplified settings for single targets.
110+
- Metrics
111+
* - :ref:`rabbitmq-receiver` (``rabbitmq``)
112+
- Fetches stats from a RabbitMQ node using the RabbitMQ Management Plugin.
113+
- Metrics
114+
* - :ref:`receiver-creator-receiver` (``receiver_creator``)
115+
- Instantiates other receivers at runtime based on whether observed endpoints match a configured rule. To use the receiver creator, configure one or more observer extensions to discover networked endpoints.
116+
- N/A
117+
* - :ref:`redis-receiver` (``redis``)
118+
- Retrieves Redis ``INFO`` data from a specific Redis instance and builds metrics from it.
119+
- Metrics
120+
* - :ref:`sapm-receiver` (``sapm``)
121+
- Receives traces from other collectors or from the SignalFx Smart Agent.
122+
- Traces
123+
* - :ref:`signalfx-gateway-prometheus-remote-write-receiver` (``signalfxgatewayprometheusremotewritereceiver``)
124+
- OTel native version of the SignalFx Prometheus remote write gateway.
125+
- Metrics
126+
* - :ref:`signalfx-receiver` (``signalfx``)
127+
- Accepts metrics and logs in the proto format.
128+
- Metrics, logs
129+
* - :ref:`smartagent-receiver` (``smartagent``)
130+
- Uses the existing Smart Agent monitors as Collector metric receivers. Learn more in :ref:`migration-monitors`.
131+
- Metrics
132+
* - :ref:`splunk-enterprise-receiver` (``splunkenterprise``)
133+
- Enables the ingestion of performance metrics describing the operational status of a user's Splunk Enterprise deployment.
134+
- Metrics
135+
* - :ref:`splunk-hec-receiver` (``splunk_hec``)
136+
- Accepts telemetry in the Splunk HEC format.
137+
- Metrics, logs, traces
138+
* - :ref:`sqlquery-receiver` (``sqlquery``)
139+
- Runs custom SQL queries to generate metrics from a database connection.
140+
- Metrics
141+
* - :ref:`sshcheck-receiver` (``sshcheck``)
142+
- Creates stats by connecting to an SSH server, might be an SFTP server.
143+
- Metrics
144+
* - :ref:`statsd-receiver` (``statsd``)
145+
- Collects StatsD messages to generate metrics.
146+
- Metrics
147+
* - :ref:`syslog-receiver` (``syslog``)
148+
- Parses syslog messages received over TCP or UDP.
149+
- Logs
150+
* - :ref:`tcp-logs-receiver` (``tcplog``)
151+
- Receives logs over TCP.
152+
- Logs
153+
* - :ref:`udp-logs-receiver` (``udplog``)
154+
- Receives logs over UDP.
155+
- Logs
156+
* - :ref:`vcenter-receiver` (``vcenter``)
157+
- Supports ESXi and vCenter.
158+
- Metrics
159+
* - :ref:`wavefront-receiver` (``wavefront``)
160+
- Accepts metrics and depends on the ``carbon`` receiver proto and transport.
161+
- Metrics
162+
* - :ref:`windowseventlog-receiver` (``windowseventlog``)
163+
- Tails and parses logs from the Windows Event log API.
164+
- Logs
165+
* - :ref:`windowsperfcounters-receiver` (``windowsperfcounters``) (Windows only)
166+
- Collects the configured system, application, or custom performance counter data from the Windows Registry.
167+
- Metrics
168+
* - :ref:`zipkin-receiver` (``zipkin``)
169+
- Receives spans from Zipkin versions 1 and 2.
170+
- Traces
55171

0 commit comments

Comments
 (0)