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

Commit 12b1cf1

Browse files
Merge pull request #2629 from splunk/urbiz-DG28306-collector-rx-cx
[DG28306]: Improvements to Receiver Creator
2 parents 69b6335 + abeadcb commit 12b1cf1

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

gdi/opentelemetry/components/receiver-creator-receiver.rst

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Receiver creator receiver
77
.. meta::
88
:description: Use the receiver creator to create receivers at runtime in the OpenTelemetry Collector based on rules. Read on to learn how to configure the component.
99

10-
The receiver creator receiver allows the Splunk Distribution of the OpenTelemetry Collector to create new receivers at runtime based on configured rules and observer extensions. The supported pipeline types are ``metrics``, ``traces``, and ``logs``. See :ref:`otel-data-processing` for more information.
10+
Use the Receiver creator receiver with the Splunk Distribution of the OpenTelemetry Collector to create new receivers at runtime based on configured rules and observer extensions. The supported pipeline types are ``metrics``, ``traces``, and ``logs``. See :ref:`otel-data-processing` for more information.
1111

12-
You can use any of the following observer extensions as listeners for the receiver creator:
12+
You can use any of the following observer extensions as listeners for the Receiver creator:
1313

1414
- ``docker_observer``: Detects and reports running container endpoints through the Docker API.
1515
- ``ecs_task_observer``: Detects and reports container endpoints for running ECS tasks.
@@ -29,17 +29,16 @@ Follow these steps to configure and activate the component:
2929
- :ref:`otel-install-windows`
3030
- :ref:`otel-install-k8s`
3131

32-
2. Configure the receiver creator receiver as described in the next section.
32+
2. Configure the Receiver creator receiver as described in the next section.
3333
3. Restart the Collector.
3434

35-
Sample configurations
35+
Sample configuration
3636
----------------------
3737

38-
To activate the receiver creator receiver, add the desired extensions to the ``extensions`` section of your configuration file, followed by ``receiver_creator`` instances in the ``receivers`` section. For example:
38+
To activate the Receiver creator receiver add the desired extensions to the ``extensions`` section of your configuration file, followed by ``receiver_creator`` instances in the ``receivers`` section. For example:
3939

4040
.. code-block:: yaml
4141
42-
4342
extensions:
4443
# Configures the Kubernetes observer to watch for pod start and stop events.
4544
k8s_observer:
@@ -76,16 +75,10 @@ To activate the receiver creator receiver, add the desired extensions to the ``e
7675
7776
You can nest and configure any supported receiver inside the ``receivers`` section of a ``receiver_creator`` configuration. Which receiver you can nest depends on the type of infrastructure the receiver creator is watching through the extensions defined in ``watch_observers``.
7877

79-
Rules expressions
80-
------------------------------------
81-
82-
New receivers are created dynamically based on rules. Each rule must start with ``type == ("pod"|"port"|"hostport"|"container"|"k8s.node") &&`` such that the rule matches only one endpoint type. For a list of variable available to each endpoint type, see :new-page:`Rules expressions <https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/receivercreator/README.md#rule-expressions>` on GitHub.
83-
84-
85-
Docker observer example
78+
Example: Docker observer
8679
------------------------------------
8780

88-
The following example shows how to configure the receiver creator using the Docker observer:
81+
The following example shows how to configure the Receiver creator receiver using the Docker observer:
8982

9083
.. code-block:: yaml
9184
@@ -113,10 +106,10 @@ The following example shows how to configure the receiver creator using the Dock
113106
114107
.. note:: See :new-page:`https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/observer/dockerobserver/README.md` for a complete list of settings.
115108

116-
Kubernetes observer example
109+
Example: Kubernetes observer
117110
------------------------------------
118111

119-
The following example shows how to configure the receiver creator using the Kubernetes observer:
112+
The following example shows how to configure the receiver creator receiver using the Kubernetes observer:
120113

121114
.. code-block:: yaml
122115
@@ -149,10 +142,18 @@ The following example shows how to configure the receiver creator using the Kube
149142
150143
.. note:: See :new-page:`https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/observer/k8sobserver/README.md` for a complete list of settings.
151144

145+
Rules to create new receivers
146+
============================================
147+
148+
You can use this receiver to dynamically create new receivers based on rules. Each rule must start with ``type == ("pod"|"port"|"hostport"|"container"|"k8s.node") &&`` such that the rule matches only one endpoint type.
149+
150+
For a list of variables available to each endpoint type, see :new-page:`Rules expressions <https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/receivercreator/README.md#rule-expressions>` on GitHub.
151+
152+
152153
Settings
153154
======================
154155

155-
The following table shows the configuration options for the receiver creator receiver:
156+
The following table shows the configuration options for the Receiver creator receiver:
156157

157158
.. raw:: html
158159

@@ -161,8 +162,6 @@ The following table shows the configuration options for the receiver creator rec
161162
Troubleshooting
162163
======================
163164

164-
165-
166165
.. raw:: html
167166

168167
<div class="include-start" id="troubleshooting-components.rst"></div>

0 commit comments

Comments
 (0)