You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: gdi/opentelemetry/components/receiver-creator-receiver.rst
+18-19Lines changed: 18 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,9 @@ Receiver creator receiver
7
7
.. meta::
8
8
: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.
9
9
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.
11
11
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:
13
13
14
14
- ``docker_observer``: Detects and reports running container endpoints through the Docker API.
15
15
- ``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:
29
29
- :ref:`otel-install-windows`
30
30
- :ref:`otel-install-k8s`
31
31
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.
33
33
3. Restart the Collector.
34
34
35
-
Sample configurations
35
+
Sample configuration
36
36
----------------------
37
37
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:
39
39
40
40
.. code-block:: yaml
41
41
42
-
43
42
extensions:
44
43
# Configures the Kubernetes observer to watch for pod start and stop events.
45
44
k8s_observer:
@@ -76,16 +75,10 @@ To activate the receiver creator receiver, add the desired extensions to the ``e
76
75
77
76
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``.
78
77
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
86
79
------------------------------------
87
80
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:
89
82
90
83
.. code-block:: yaml
91
84
@@ -113,10 +106,10 @@ The following example shows how to configure the receiver creator using the Dock
113
106
114
107
.. 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.
115
108
116
-
Kubernetes observer example
109
+
Example: Kubernetes observer
117
110
------------------------------------
118
111
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:
120
113
121
114
.. code-block:: yaml
122
115
@@ -149,10 +142,18 @@ The following example shows how to configure the receiver creator using the Kube
149
142
150
143
.. 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.
151
144
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
+
152
153
Settings
153
154
======================
154
155
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:
156
157
157
158
.. raw:: html
158
159
@@ -161,8 +162,6 @@ The following table shows the configuration options for the receiver creator rec
0 commit comments