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
updates docs with metrics otel information (#35645)
* updates docs with metrics otel information
* Small updates to documentation
* revert otlp/http -> otlphttp
* Update content/en/observability_pipelines/sources/opentelemetry.md
Co-authored-by: May Lee <may.lee@datadoghq.com>
* Update content/en/observability_pipelines/sources/datadog_agent.md
Co-authored-by: May Lee <may.lee@datadoghq.com>
---------
Co-authored-by: May Lee <may.lee@datadoghq.com>
Copy file name to clipboardExpand all lines: content/en/observability_pipelines/sources/datadog_agent.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ further_reading:
20
20
21
21
Use Observability Pipelines' Datadog Agent source to receive logs or metrics ({{< tooltip glossary="preview" case="title" >}}) from the Datadog Agent.
22
22
23
-
**Note**: If you are using the Datadog Distribution of OpenTelemetry (DDOT) Collector for logs, you must [use the OpenTelemetry source to send logs to Observability Pipelines][4].
23
+
**Note**: If you are using the Datadog Distribution of OpenTelemetry (DDOT) Collector to collect logs or metrics, you must [use the OpenTelemetry source to send that data to Observability Pipelines][4].
Use Observability Pipelines' OpenTelemetry (OTel) source to collect logs from your OTel Collector through HTTP or gRPC. Select and set up this source when you set up a pipeline. The information below is configured in the pipelines UI.
21
+
Use Observability Pipelines' OpenTelemetry (OTel) source to collect logs or metrics ({{< tooltip glossary="preview" case="title" >}}) from your OTel Collector through HTTP or gRPC. Select and set up this source when you set up a pipeline.
19
22
20
23
**Notes**:
21
-
- If you are using the Datadog Distribution of OpenTelemetry (DDOT) Collector, use the OpenTelemetry source to [send logs to Observability Pipelines](#send-logs-from-the-datadog-distribution-of-opentelemetry-collector-to-observability-pipelines).
24
+
- If you are using the Datadog Distribution of OpenTelemetry (DDOT) Collector, use the OpenTelemetry source to [send data to Observability Pipelines](#send-data-from-the-datadog-distribution-of-opentelemetry-collector-to-observability-pipelines).
22
25
- If you are using the Splunk HEC Distribution of the OpenTelemetry Collector, use the [Splunk HEC source][4] to send logs to Observability Pipelines.
23
26
24
27
### When to use this source
@@ -60,10 +63,10 @@ Toggle the switch to enable TLS. The following certificate and key files are req
60
63
{{% tab "Secrets Management" %}}
61
64
62
65
- HTTP address identifier:
63
-
- References the HTTP socket address on which the Observability Pipelines Worker listens for logs from the OTel collector.
66
+
- References the HTTP socket address on which the Observability Pipelines Worker listens for data from the OTel collector.
64
67
- The default identifier is `SOURCE_OTEL_HTTP_ADDRESS`.
65
68
- gRPC address identifier:
66
-
- References the gRPC socket address on which the Observability Pipelines Worker listens for logs from the OTel collector.
69
+
- References the gRPC socket address on which the Observability Pipelines Worker listens for data from the OTel collector.
67
70
- The default identifier is `SOURCE_OTEL_GRPC_ADDRESS`.
68
71
- TLS passphrase identifier (when TLS is enabled):
69
72
- The default identifier is `SOURCE_OTEL_KEY_PASS`.
@@ -77,17 +80,20 @@ Toggle the switch to enable TLS. The following certificate and key files are req
77
80
{{% /tab %}}
78
81
{{< /tabs >}}
79
82
80
-
## Send logs to the Observability Pipelines Worker
83
+
## Send data to the Observability Pipelines Worker
81
84
82
85
Configure your OTel exporters to point to HTTP or gRPC. The Worker exposes configurable listener ports for each protocol.
83
86
84
87
<divclass="alert alert-info">The ports 4318 (HTTP) and 4317 (gRPC) shown below are examples only. You can configure the port value for either protocol in the Worker. Ensure your OTel exporters match the port value you choose.</a></div>
85
88
89
+
{{< tabs >}}
90
+
{{% tab "Logs" %}}
91
+
86
92
### HTTP configuration example
87
93
88
94
The Worker exposes the HTTP endpoint on port 4318, which is the default port. You can configure the port value in the Worker.
89
95
90
-
For example, to configure an OTel exporter over HTTP in Python:
96
+
For example, to configure an OTel log exporter over HTTP in Python:
91
97
92
98
```python
93
99
from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
@@ -100,7 +106,7 @@ For example, to configure an OTel exporter over HTTP in Python:
100
106
101
107
The Worker exposes the gRPC endpoint on port 4317, which is the default port. You can configure the port value in the Worker.
102
108
103
-
For example, to configure an OTel exporter over gRPC in Python:
109
+
For example, to configure an OTel log exporter over gRPC in Python:
104
110
105
111
```python
106
112
from opentelemetry.exporter.otlp.proto.grpc._log_exporter import OTLPLogExporter
@@ -114,7 +120,48 @@ Set the listener address environment variables to the following default values.
114
120
- HTTP listener address: `worker:4318`
115
121
- gRPC listener address: `worker:4317`
116
122
117
-
## Send logs from the Datadog Distribution of OpenTelemetry Collector to Observability Pipelines
123
+
{{% /tab %}}
124
+
125
+
{{% tab "Metrics" %}}
126
+
127
+
### HTTP configuration example
128
+
129
+
The Worker exposes the HTTP endpoint on port 4318, which is the default port. You can configure the port value in the Worker.
130
+
131
+
For example, to configure an OTel metric exporter over HTTP in Python:
132
+
133
+
```python
134
+
from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter
135
+
http_exporter = OTLPMetricExporter(
136
+
endpoint="http://worker:4318/v1/metrics"
137
+
)
138
+
```
139
+
140
+
### gRPC configuration example
141
+
142
+
The Worker exposes the gRPC endpoint on port 4317, which is the default port. You can configure the port value in the Worker.
143
+
144
+
For example, to configure an OTel metric exporter over gRPC in Python:
145
+
146
+
```python
147
+
from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import OTLPMetricExporter
148
+
grpc_exporter = OTLPMetricExporter(
149
+
endpoint="grpc://worker:4317"
150
+
)
151
+
```
152
+
153
+
Set the listener address environment variables to the following default values. If you configured different port values in the Worker, use those instead.
154
+
155
+
- HTTP listener address: `worker:4318`
156
+
- gRPC listener address: `worker:4317`
157
+
158
+
{{% /tab %}}
159
+
{{< /tabs >}}
160
+
161
+
## Send data from the Datadog Distribution of OpenTelemetry Collector to Observability Pipelines
162
+
163
+
{{< tabs >}}
164
+
{{% tab "Logs" %}}
118
165
119
166
To send logs from the Datadog Distribution of the OpenTelemetry (DDOT) Collector:
120
167
1. Deploy the DDOT Collector using Helm. See [Install the DDOT Collector as a Kubernetes DaemonSet][5] for instructions.
@@ -127,13 +174,14 @@ To send logs from the Datadog Distribution of the OpenTelemetry (DDOT) Collector
- Logs sent from DDOT might have nested objects that prevent Datadog from parsing the logs correctly. To resolve this, Datadog recommends using the [Custom Processor][8] to flatten the nested `resource` object.
197
+
- If the DDOT Collector and the Observability Pipelines Worker are running on the same host, their default OTLP receiver ports (4317/4318) may conflict. In a typical Kubernetes deployment, the Collector and the Worker run in separate pods, so this is not an issue.
To send metrics from the Datadog Distribution of the OpenTelemetry (DDOT) Collector:
210
+
1. Deploy the DDOT Collector using Helm. See [Install the DDOT Collector as a Kubernetes DaemonSet][5] for instructions.
211
+
1. [Set up a pipeline][6] on Observability Pipelines using the [OpenTelemetry source](#set-up-the-source-in-the-pipeline-ui).
212
+
1. (Optional) Datadog recommends adding an [Edit Fields processor][7] to the pipeline that appends the field `op_otel_ddot:true`.
213
+
1. When you install the Worker, for the OpenTelemetry source environment variables:
214
+
1. Set your HTTP listener to `0.0.0.0:4318`.
215
+
1. Set your gRPC listener to `0.0.0.0:4317`.
216
+
1. After you install the Worker and deployed the pipeline, update the OpenTelemetry Collector's [`otel-config.yaml`][9] to include an exporter that sends metrics to Observability Pipelines. For example:
- Because DDOT is sending metrics to Observability Pipelines, and not the Datadog Agent, the following settings do not work for sending metrics from DDOT to Observability Pipelines:
- Metrics sent from DDOT might have nested objects that prevent Datadog from parsing the metrics correctly. To resolve this, Datadog recommends using the [Custom Processor][8] to flatten the nested `resource` object.
240
+
- If the DDOT Collector and the Observability Pipelines Worker are running on the same host, their default OTLP receiver ports (4317/4318) may conflict. In a typical Kubernetes deployment, the Collector and the Worker run in separate pods, so this is not an issue.
You must provide both HTTP and gRPC endpoints. Configure your OTLP exporters to point to one of these endpoints. See [Send logs to the Observability Pipelines Worker][10230] for more information.
1
+
You must provide both HTTP and gRPC endpoints. Configure your OTLP exporters to point to one of these endpoints. See [Send data to the Observability Pipelines Worker][10230] for more information.
2
2
3
3
- HTTP listener address
4
-
- The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector.
4
+
- The Observability Pipelines Worker listens to this socket address to receive data from the OTel collector.
5
5
- The default environment variable is `DD_OP_SOURCE_OTEL_HTTP_ADDRESS`.
6
6
7
7
- gRPC listener address
8
-
- The Observability Pipelines Worker listens to this socket address to receive logs from the OTel collector.
8
+
- The Observability Pipelines Worker listens to this socket address to receive data from the OTel collector.
9
9
- The default environment variable is `DD_OP_SOURCE_OTEL_GRPC_ADDRESS`.
10
10
11
11
If TLS is enabled:
12
12
13
13
- OpenTelemetry TLS passphrase
14
14
- The default environment variable is `DD_OP_SOURCE_OTEL_KEY_PASS`.
0 commit comments