Skip to content

Reorganize OTel Documentation #27331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 46 commits into from
Mar 12, 2025
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
900cfbf
Create Send Data section.
brett0000FF Jan 25, 2025
0178881
Roughly apply new structure.
brett0000FF Jan 28, 2025
cd05145
Continue building out structure.
brett0000FF Jan 29, 2025
5801c8a
Start drafting new landing page.
brett0000FF Jan 30, 2025
db9cb9d
Add aliases.
brett0000FF Jan 30, 2025
1d8d1d6
Outline overview content. Fix links.
brett0000FF Jan 31, 2025
0940ad0
Fix aliases.
brett0000FF Jan 31, 2025
438a4aa
Draft overview pages. Clean up organization.
brett0000FF Feb 1, 2025
63dc277
Merge branch 'master' of github.com:DataDog/documentation into brett.…
brett0000FF Feb 1, 2025
5625773
Add getting started to guides left-nav.
brett0000FF Feb 7, 2025
280d945
Fixing links and streamlining text.
brett0000FF Feb 11, 2025
f508f18
Fix links.
brett0000FF Feb 11, 2025
19826a2
Polish new top-level pages.
brett0000FF Feb 11, 2025
259e720
Create new section for migration guides.
brett0000FF Feb 11, 2025
dbe93f9
Fix typos.
brett0000FF Feb 11, 2025
8e3f594
Fix links.
brett0000FF Feb 11, 2025
dfea64c
Fix links.
brett0000FF Feb 13, 2025
2a201d8
Merge branch 'master' of github.com:DataDog/documentation into brett.…
brett0000FF Feb 13, 2025
921e737
Apply feedback from stakeholders.
brett0000FF Feb 21, 2025
0e86db0
Continue applying feedback.
brett0000FF Feb 21, 2025
25ff149
Fix links.
brett0000FF Feb 21, 2025
d161caf
Merge branch 'master' of github.com:DataDog/documentation into brett.…
brett0000FF Feb 21, 2025
65cc050
Fix menu file.
brett0000FF Feb 21, 2025
3b12746
Menu conflicts.
brett0000FF Feb 21, 2025
d709ad3
Cleanup.
brett0000FF Feb 21, 2025
10e9f23
Fix links.
brett0000FF Feb 21, 2025
248314c
Apply more feedback.
brett0000FF Feb 25, 2025
3f0c526
Merge branch 'master' of github.com:DataDog/documentation into brett.…
brett0000FF Feb 26, 2025
7f28119
Add metrics intake endpoint to nav.
brett0000FF Feb 26, 2025
3fd84b3
Apply updated images.
brett0000FF Feb 28, 2025
5e58f17
Add runtime metric languages to nav.
brett0000FF Feb 28, 2025
aed5422
Tweaks and value prop additions.
brett0000FF Feb 28, 2025
b31a905
Apply suggestions from code review
brett0000FF Mar 4, 2025
c0e02b2
Apply suggestions from review.
brett0000FF Mar 4, 2025
af4573c
Fix missing redirects.
brett0000FF Mar 5, 2025
2eb850e
Apply suggestions from code review
brett0000FF Mar 5, 2025
02b7ad5
Apply suggestions from review.
brett0000FF Mar 5, 2025
a0d11e0
Merge branch 'brett.blue/reorg-otel' of github.com:DataDog/documentat…
brett0000FF Mar 5, 2025
8f2a4a4
Merge branch 'master' of github.com:DataDog/documentation into brett.…
brett0000FF Mar 5, 2025
f01a815
Fix redirect.
brett0000FF Mar 5, 2025
f61c16b
Final content review.
brett0000FF Mar 10, 2025
2d8169b
Merge branch 'master' into brett.blue/reorg-otel
brett0000FF Mar 10, 2025
d4010ea
Note number of integrations for Agent-based setup.
brett0000FF Mar 11, 2025
792ac57
Merge branch 'brett.blue/reorg-otel' of github.com:DataDog/documentat…
brett0000FF Mar 11, 2025
2e4f633
Alias to removed page.
brett0000FF Mar 11, 2025
cf26a8b
Rename direct ingest.
brett0000FF Mar 12, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
345 changes: 209 additions & 136 deletions config/_default/menus/main.en.yaml

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions content/en/getting_started/opentelemetry/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ further_reading:
text: 'Forward logs from the OpenTelemetry Collector with the Datadog Exporter'
---

{{< learning-center-callout header="Try 'Introduction to OpenTelemetry with Datadog' in the Learning Center" btn_title="Enroll Now" btn_url="https://learn.datadoghq.com/courses/otel-with-datadog">}}
Learn how to configure OpenTelemetry to export metrics, traces, and logs to Datadog, and explore the collected data within the platform.
{{< learning-center-callout header="Try \"Understanding OpenTelemetry\" in the Learning Center" btn_title="Enroll Now" btn_url="https://learn.datadoghq.com/courses/understanding-opentelemetry" hide_image="false" >}}
Learn the fundamentals of OpenTelemetry, including its capabilities and benefits, key components, and how OTel and Datadog work together.
{{< /learning-center-callout >}}

## Overview
Expand Down
2 changes: 1 addition & 1 deletion content/en/metrics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This is an introduction to Metrics in Datadog and why they're useful. This secti

{{< whatsnext desc="Submit metrics to Datadog" >}}
{{< nextlink href="/metrics/custom_metrics">}}<u>Submit Custom Metrics</u> - Learn what custom metrics are and how to submit them.{{< /nextlink >}}
{{< nextlink href="/opentelemetry/otel_metrics" >}}<u>Send OpenTelemetry Metrics</u> - Configure the Datadog Agent or OpenTelemetry Collector.{{< /nextlink >}}
{{< nextlink href="/opentelemetry/reference/otel_metrics" >}}<u>Send OpenTelemetry Metrics</u> - Configure the Datadog Agent or OpenTelemetry Collector.{{< /nextlink >}}
{{< nextlink href="/metrics/types" >}}<u>Metrics Types</u> - Types of metrics that can be submitted to Datadog.{{< /nextlink >}}
{{< nextlink href="/metrics/distributions" >}}<u>Distribution Metrics</u> - Learn about Distribution Metrics and globally accurate percentiles.{{< /nextlink >}}
{{< nextlink href="/metrics/units" >}}<u>Metrics Units</u> - Learn about the units that can be associated with metrics.{{< /nextlink >}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/metrics/open_telemetry/otlp_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ aliases:
- /metrics/open_telemetry/
---

{{< include-markdown "/opentelemetry/otel_metrics" >}}
{{< include-markdown "/opentelemetry/reference/otel_metrics" >}}
4 changes: 2 additions & 2 deletions content/en/metrics/summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,11 +245,11 @@ This table shows the mapping between the metric origin as seen in the facet and
[14]: /security/cloud_security_management/
[15]: /database_monitoring/
[16]: /data_streams/
[17]: /opentelemetry/collector_exporter/otel_collector_datadog_exporter/?tab=onahost
[17]: /opentelemetry/setup/collector_exporter/
[18]: /opentelemetry/collector_exporter/
[19]: /network_monitoring/cloud_network_monitoring/
[20]: /observability_pipelines/
[21]: /opentelemetry/interoperability/otlp_ingest_in_the_agent/?tab=host
[21]: /opentelemetry/setup/otlp_ingest_in_the_agent/
[22]: /integrations/process/
[23]: /monitors/types/real_user_monitoring/
[24]: /serverless/
Expand Down
84 changes: 71 additions & 13 deletions content/en/opentelemetry/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: OpenTelemetry in Datadog
aliases:
- /tracing/setup_overview/open_standards/
- /opentelemetry/otel_terms
further_reading:
- link: "https://www.datadoghq.com/blog/opentelemetry-instrumentation/"
tag: "Blog"
Expand All @@ -27,28 +28,89 @@ further_reading:
- link: "https://www.datadoghq.com/blog/opentelemetry-runtime-metrics-datadog/"
tag: "Blog"
text: "Monitor runtime metrics from OTel-instrumented apps with Datadog APM"
- link: "https://learn.datadoghq.com/courses/otel-with-datadog"
tag: "Learning Center"
text: "Introduction to OpenTelemetry with Datadog"

algolia:
tags: ['opentelemetry', 'open telemetry', 'otel']
cascade:
algolia:
rank: 70
---

{{< learning-center-callout hide_image="true" header="Try \"Introduction to OTel with Datadog\" in the Learning Center" btn_title="Enroll Now" btn_url="https://learn.datadoghq.com/courses/otel-with-datadog">}}
Learn how to configure OpenTelemetry to export metrics, traces, and logs to Datadog, and explore the collected data in the platform.
{{< /learning-center-callout >}}

## Overview

[OpenTelemetry][1] is an open source observability framework that provides IT teams with standardized protocols and tools for collecting and routing telemetry data. Created as an incubator project by the [Cloud Native Computing Foundation][2] (CNCF), OpenTelemetry provides a consistent format for instrumenting, generating, gathering, and exporting application telemetry data—namely metrics, logs, and traces—to monitoring platforms for analysis and insight.
[OpenTelemetry][1] (OTel) provides standardized protocols for collecting and routing telemetry data. Datadog supports multiple ways to collect and analyze telemetry data from OpenTelemetry-instrumented applications, whether you're using existing Datadog infrastructure or prefer a vendor-neutral setup.

### Why OpenTelemetry with Datadog?

Datadog provides advanced observability for all your application telemetry, regardless of its source. By supporting OpenTelemetry, Datadog offers:

- **Flexibility and Choice**: Use standardized instrumentation while maintaining freedom to adapt as your technology needs evolve
- **Comprehensive Language Support**: Consistently monitor applications across your entire tech stack
- **Unified Instrumentation**: Maintain a single approach to instrumentation across your systems
- **Powerful Analytics**: Combine OpenTelemetry's standardization with Datadog's robust analysis, visualization, and alerting capabilities

Whether you're already using OpenTelemetry or considering adoption, Datadog provides flexible options to meet your specific needs.

### Key decisions

There are two key decisions to make when using OpenTelemetry with Datadog:

- [How to instrument your applications](#instrument-your-applications)
- [How to send your data to Datadog](#send-opentelemetry-data-to-datadog)

The features available to you depend on these choices. For example, using the OpenTelemetry API with the Datadog SDK provides access to more Datadog features than using the OpenTelemetry SDK alone.

## Instrument your applications

There are several ways to instrument your applications with OpenTelemetry and Datadog. Each approach provides different features and levels of vendor neutrality.

If your applications and services are instrumented with OpenTelemetry libraries, you can choose how to get traces, metrics, and logs data to the Datadog backend:
- **OpenTelemetry API**: Use the OpenTelemetry API with Datadog's SDK implementation
- **OpenTelemetry Instrumentation Libraries**: Extend Datadog's observability to additional frameworks and technologies
- **Full OpenTelemetry**: Use the OpenTelemetry SDK and API for a vendor-neutral setup

1. [Send data to the OpenTelemetry collector, and use the Datadog exporter to forward it to Datadog][3], or
For more information, see [Instrument Your Applications][8].

2. [Ingest data with the Datadog Agent, which collects it for Datadog][4].
## Send OpenTelemetry data to Datadog

{{< img src="tracing/setup/open_standards/otel-flow.png" alt="Map options for generating telemetry data and sending it to observability products.">}}
If your applications and services are instrumented with OpenTelemetry libraries, you can choose how to get traces, metrics, and logs data into Datadog.

<div class="alert alert-info"><strong>Custom Instrumentation with the OpenTelemetry API</strong></br>You can configure OpenTelemetry instrumented applications to use the Datadog APM SDK to process spans and traces. For more information, read <a href="/tracing/trace_collection/otel_instrumentation/">Custom Instrumentation with the OpenTelemetry API</a>.</div>
<div class="alert alert-info"><strong>Not sure which setup is right for you?</strong></br> See the <a href="/opentelemetry/compatibility/">Feature Compatibility</a> table to understand which Datadog features are supported.</div>

Datadog supports the [W3C Trace Context standard][6], ensuring complete traces are captured even when a request travels between services that have been instrumented with different tools. Services need only be instrumented with any system, such as an OpenTelemetry library or Datadog tracing library, that follows the W3C Trace Context standard. Read [Propagating Trace Context][5] for more information.
### Option 1: Use the OpenTelemetry Collector

{{< img src="/opentelemetry/setup/otel-collector.png" alt="Diagram: OpenTelemetry SDK in code sends data via OTLP to host running OpenTelemetry Collector with Datadog Exporter, which forwards to Datadog's Observability Platform." style="width:100%;" >}}

**Best for**: New or existing OTel users wanting a completely vendor-neutral setup.

- Complete vendor neutrality for sending OpenTelemetry data to Datadog
- Flexible configuration options like tail-based sampling and data transformations

{{< whatsnext desc=" " >}}
{{< nextlink href="/opentelemetry/setup/collector_exporter/" >}}Learn more about using the OTel Collector{{< /nextlink >}}
{{< /whatsnext >}}

### Option 2: Use the Datadog Agent

{{< img src="/opentelemetry/setup/dd-agent-otlp-ingest.png" alt="Diagram: OpenTelemetry SDK sends data via OTLP protocol directly to the Datadog Agent, which forwards to Datadog's platform." style="width:100%;" >}}

**Best for**: Existing Datadog users or teams requiring Agent-based features.

- Access to Agent-based features like Live Processes and Cloud Network Monitoring

{{< whatsnext desc=" " >}}
{{< nextlink href="/opentelemetry/setup/otlp_ingest_in_the_agent" >}}Learn more about using OTLP ingest in the Agent{{< /nextlink >}}
{{< /whatsnext >}}

### Additional setup options

For other setup options, including direct OTLP intake, see [Send Data to Datadog][7].

## Further reading

Expand All @@ -58,9 +120,5 @@ Datadog supports the [W3C Trace Context standard][6], ensuring complete traces a
[2]: https://www.cncf.io/
[3]: /opentelemetry/collector_exporter/
[4]: /opentelemetry/otlp_ingest_in_the_agent/
[5]: /tracing/trace_collection/trace_context_propagation/
[6]: https://www.w3.org/TR/trace-context/

{{< learning-center-callout header="Try Understanding OpenTelemetry in the Learning Center" btn_title="Enroll Now" btn_url="https://learn.datadoghq.com/courses/understanding-opentelemetry">}}
Discover the fundamentals of OpenTelemetry, an open source standard for telemetry data collection. This course provides an overview of OpenTelemetry's capabilities and benefits, preparing you for integrating observability into your applications.
{{< /learning-center-callout >}}
[7]: /opentelemetry/setup
[8]: /opentelemetry/instrument/
58 changes: 0 additions & 58 deletions content/en/opentelemetry/collector_exporter/_index.md

This file was deleted.

Loading
Loading