Skip to content

Add new supported OTel integrations #28253

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 4 commits into from
Apr 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
75 changes: 50 additions & 25 deletions config/_default/menus/main.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -754,51 +754,76 @@ menu:
identifier: otel_integrations
parent: opentelemetry_top_level
weight: 8
- name: Trace Metrics
url: opentelemetry/integrations/trace_metrics/
identifier: otel_trace_metrics
- name: Apache Metrics
url: opentelemetry/integrations/apache_metrics/
identifier: otel_apache_metrics
parent: otel_integrations
weight: 801
- name: Runtime Metrics
url: opentelemetry/integrations/runtime_metrics/
identifier: otel_runtime_metrics
parent: otel_integrations
weight: 802
- name: Java
url: opentelemetry/integrations/runtime_metrics/java
identifier: otel_runtime_metrics_java
parent: otel_runtime_metrics
weight: 8021
- name: .NET
url: opentelemetry/integrations/runtime_metrics/dotnet
identifier: otel_runtime_metrics_dotnet
parent: otel_runtime_metrics
weight: 8022
- name: Go
url: opentelemetry/integrations/runtime_metrics/go
identifier: otel_runtime_metrics_go
parent: otel_runtime_metrics
weight: 8023
- name: Collector Health Metrics
url: opentelemetry/integrations/collector_health_metrics/
identifier: otel_health_metrics
parent: otel_integrations
weight: 803
weight: 802
- name: Docker Metrics
url: opentelemetry/integrations/docker_metrics/
identifier: otel_docker_metrics
parent: otel_integrations
weight: 803
- name: HAProxy Metrics
url: opentelemetry/integrations/haproxy_metrics/
identifier: otel_haproxy_metrics
parent: otel_integrations
weight: 804
- name: Host Metrics
url: opentelemetry/integrations/host_metrics/
identifier: otel_host_metrics
parent: otel_integrations
weight: 805
- name: IIS Metrics
url: opentelemetry/integrations/iis_metrics/
identifier: otel_iis_metrics
parent: otel_integrations
weight: 806
- name: Kafka Metrics
url: opentelemetry/integrations/kafka_metrics/
identifier: otel_kafka_metrics
parent: otel_integrations
weight: 806
weight: 807
- name: MySQL Metrics
url: opentelemetry/integrations/mysql_metrics/
identifier: otel_mysql_metrics
parent: otel_integrations
weight: 808
- name: NGINX Metrics
url: opentelemetry/integrations/nginx_metrics/
identifier: otel_nginx_metrics
parent: otel_integrations
weight: 809
- name: Runtime Metrics
url: opentelemetry/integrations/runtime_metrics/
identifier: otel_runtime_metrics
parent: otel_integrations
weight: 810
- name: Java
url: opentelemetry/integrations/runtime_metrics/java
identifier: otel_runtime_metrics_java
parent: otel_runtime_metrics
weight: 8101
- name: .NET
url: opentelemetry/integrations/runtime_metrics/dotnet
identifier: otel_runtime_metrics_dotnet
parent: otel_runtime_metrics
weight: 8102
- name: Go
url: opentelemetry/integrations/runtime_metrics/go
identifier: otel_runtime_metrics_go
parent: otel_runtime_metrics
weight: 8103
Comment on lines +807 to +821
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These menu items aren't showing up in the staging preview. Is it because the weights are off? (they're 8101/8102/8103 while the siblings are 810, 811)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird! I see them?
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh! my bad, I didn't realize they were nested like that. ignore my comment!!

- name: Trace Metrics
url: opentelemetry/integrations/trace_metrics/
identifier: otel_trace_metrics
parent: otel_integrations
weight: 811
- name: Troubleshooting
url: opentelemetry/troubleshooting/
identifier: otel_troubleshooting
Expand Down
46 changes: 34 additions & 12 deletions content/en/opentelemetry/integrations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,43 @@ Datadog supports the following OpenTelemetry integrations:

Monitor and optimize your application's performance:

- [Trace Metrics][2]
- [Runtime Metrics][3]
- [Trace Metrics][2] - Generate APM stats such as hits, errors, and duration
- [Runtime Metrics][3] - Collect runtime metrics for Java, .NET, and Go applications

### Collector

Monitor the health and performance of your OpenTelemetry Collector:

- [Collector Health Metrics][8]
- [Collector Health Metrics][4] - Track the performance of your OpenTelemetry Collector

### Containers and hosts

Gain insights into your containerized environments and host systems:

- [Docker Metrics][4]
- [Host Metrics][5]
- [Docker Metrics][5] - Monitor Docker container performance
- [Host Metrics][6] - Track system metrics such as CPU, disk, and memory usage

### Vendor technologies
### Web servers and proxies

Extend your observability to popular vendor technologies:
Monitor web servers and proxy technologies:

- [Kafka Metrics][6]
- [Apache Web Server Metrics][7] - Collect metrics from Apache HTTP Server
- [NGINX Metrics][8] - Monitor NGINX web server performance
- [IIS Metrics][9] - Track Internet Information Services (IIS) metrics
- [HAProxy Metrics][10] - Monitor HAProxy load balancer performance

### Databases and messaging

Monitor database and messaging systems:

- [MySQL Metrics][11] - Track MySQL database performance
- [Kafka Metrics][12] - Monitor Apache Kafka messaging platform

### Big data and processing

Monitor big data processing frameworks:

- [Apache Spark Metrics][13] - Track Apache Spark performance metrics

## Further reading

Expand All @@ -51,7 +67,13 @@ Extend your observability to popular vendor technologies:
[1]: https://opentelemetry.io/ecosystem/registry/
[2]: /opentelemetry/integrations/trace_metrics
[3]: /opentelemetry/integrations/runtime_metrics/
[4]: /opentelemetry/integrations/docker_metrics/
[5]: /opentelemetry/integrations/host_metrics/
[6]: /opentelemetry/integrations/kafka_metrics/
[8]: /opentelemetry/integrations/collector_health_metrics/
[4]: /opentelemetry/integrations/collector_health_metrics/
[5]: /opentelemetry/integrations/docker_metrics/
[6]: /opentelemetry/integrations/host_metrics/
[7]: /opentelemetry/integrations/apache_metrics/
[8]: /opentelemetry/integrations/nginx_metrics/
[9]: /opentelemetry/integrations/iis_metrics/
[10]: /opentelemetry/integrations/haproxy_metrics/
[11]: /opentelemetry/integrations/mysql_metrics/
[12]: /opentelemetry/integrations/kafka_metrics/
[13]: /opentelemetry/integrations/spark_metrics/
38 changes: 38 additions & 0 deletions content/en/opentelemetry/integrations/apache_metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Apache Web Server Metrics
further_reading:
- link: "/opentelemetry/collector_exporter/"
tag: "Documentation"
text: "Setting Up the OpenTelemetry Collector"
---

## Overview

{{< img src="/opentelemetry/collector_exporter/apache_metrics.png" alt="OpenTelemetry Apache metrics in an Apache dashboard" style="width:100%;" >}}

The [Apache receiver][1] allows for collection of Apache Web Server metrics. Configure the receiver according to the specifications of the latest version of the `apachereceiver`.

For more information, see the OpenTelemetry project documentation for the [Apache receiver][1].

## Setup

To collect Apache Web Server metrics with OpenTelemetry for use with Datadog:

1. Configure the [Apache receiver][1] in your OpenTelemetry Collector configuration.
2. Ensure the OpenTelemetry Collector is [configured to export to Datadog][4].

See the [Apache receiver documentation][1] for detailed configuration options and requirements.

## Data collected

{{< mapping-table resource="apache.csv">}}

See [OpenTelemetry Metrics Mapping][2] for more information.

## Further reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/apachereceiver
[2]: /opentelemetry/guide/metrics_mapping/
[4]: /opentelemetry/setup/collector_exporter/
39 changes: 39 additions & 0 deletions content/en/opentelemetry/integrations/haproxy_metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: HAProxy Metrics
further_reading:
- link: "/opentelemetry/collector_exporter/"
tag: "Documentation"
text: "Setting Up the OpenTelemetry Collector"
---

## Overview

{{< img src="/opentelemetry/collector_exporter/haproxy_metrics.png" alt="OpenTelemetry HAProxy metrics in an HAProxy dashboard" style="width:100%;" >}}

The [HAProxy receiver][1] allows for collection of HAProxy metrics and access to the [HAProxy Overview][4] dashboard. Configure the receiver according to the specifications of the latest version of the `haproxyreceiver`.

For more information, see the OpenTelemetry project documentation for the [HAProxy receiver][1].

## Setup

To collect HAProxy metrics with OpenTelemetry for use with Datadog:

1. Configure the [HAProxy receiver][1] in your OpenTelemetry Collector configuration.
2. Ensure the OpenTelemetry Collector is [configured to export to Datadog][5].

See the [HAProxy receiver documentation][1] for detailed configuration options and requirements.

## Data collected

{{< mapping-table resource="haproxy.csv">}}

See [OpenTelemetry Metrics Mapping][2] for more information.

## Further reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/haproxyreceiver
[2]: /opentelemetry/guide/metrics_mapping/
[4]: https://app.datadoghq.com/dash/integration/28/haproxy---overview
[5]: /opentelemetry/setup/collector_exporter/
39 changes: 39 additions & 0 deletions content/en/opentelemetry/integrations/iis_metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: IIS Metrics
further_reading:
- link: "/opentelemetry/collector_exporter/"
tag: "Documentation"
text: "Setting Up the OpenTelemetry Collector"
---

## Overview

{{< img src="/opentelemetry/collector_exporter/iis_metrics.png" alt="OpenTelemetry IIS metrics in an IIS dashboard" style="width:100%;" >}}

The [IIS receiver][1] allows for collection of IIS (Internet Information Services) metrics and access to the [IIS Overview][4] dashboard. Configure the receiver according to the specifications of the latest version of the `iisreceiver`.

For more information, see the OpenTelemetry project documentation for the [IIS receiver][1].

## Setup

To collect IIS metrics with OpenTelemetry for use with Datadog:

1. Configure the [IIS receiver][1] in your OpenTelemetry Collector configuration.
2. Ensure the OpenTelemetry Collector is [configured to export to Datadog][5].

See the [IIS receiver documentation][1] for detailed configuration options and requirements.

## Data collected

{{< mapping-table resource="iis.csv">}}

See [OpenTelemetry Metrics Mapping][2] for more information.

## Further reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/iisreceiver
[2]: /opentelemetry/guide/metrics_mapping/
[4]: https://app.datadoghq.com/screen/integration/243/iis---overview
[5]: /opentelemetry/setup/collector_exporter/
4 changes: 2 additions & 2 deletions content/en/opentelemetry/integrations/kafka_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ OTel Kafka Metrics Remapping is in public alpha. It is available in versions >=

The [Kafka metrics receiver][1], [JMX Receiver][2]/ [JMX Metrics Gatherer][3] allow collecting Kafka metrics and access to the out of the box [Kafka Dashboard][7], "Kafka, Zookeeper and Kafka Consumer Overview".

Please note that the [JMX Receiver][2] and [JMX Metrics Gatherer][3] should be considered as replacements. They collect the same set of metrics ([JMX Receiver][2] launches the [JMX Metrics Gatherer][3]).
**Note**: the [JMX Receiver][2] and [JMX Metrics Gatherer][3] should be considered as replacements. They collect the same set of metrics ([JMX Receiver][2] launches the [JMX Metrics Gatherer][3]).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm having some trouble understanding the landscape of the Kafka metrics receiver, JMX Receiver, and JMX Metrics Gatherer. I can sort of guess that JMX Receiver and JMX Metrics Gatherer are always used together, and this pair is an alternative to the Kafka metrics receiver—is that true? When would you use one over the other?

As-is, this first sentence could be interpreted to mean that the JMX Receiver and JMX Metrics Gatherer are replacements for each other, which seems misleading.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! I will update this in a follow-up PR.



## Kafka metrics receiver
Expand Down Expand Up @@ -103,7 +103,7 @@ The JMX Receiver has the following requirements:
- JRE is available on the host in which you are running the collector.
- The JMX Metric Gatherer JAR is available on the host in which you are running the collector. You can download the most recent release of the JMX Metric Gatherer JAR [here][1].

Because the OTel collector default image does not meet the requirements above, a custom image needs to be built. Please refer to the Dockerfile below for an example image that contains the collector binary, JRE, and JMX Metrics Gatherer Jar.
Because the OTel collector default image does not meet the requirements above, a custom image needs to be built. See the Dockerfile below for an example image that contains the collector binary, JRE, and JMX Metrics Gatherer Jar.

Dockerfile:
```Dockerfile
Expand Down
39 changes: 39 additions & 0 deletions content/en/opentelemetry/integrations/mysql_metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: MySQL Metrics
further_reading:
- link: "/opentelemetry/collector_exporter/"
tag: "Documentation"
text: "Setting Up the OpenTelemetry Collector"
---

## Overview

{{< img src="/opentelemetry/collector_exporter/mysql_metrics.png" alt="OpenTelemetry MySQL metrics in a MySQL dashboard" style="width:100%;" >}}

The [MySQL receiver][1] allows for collection of MySQL metrics and access to the [MySQL Overview][4] dashboard. Configure the receiver according to the specifications of the latest version of the `mysqlreceiver`.

For more information, see the OpenTelemetry project documentation for the [MySQL receiver][1].

## Setup

To collect MySQL metrics with OpenTelemetry for use with Datadog:

1. Configure the [MySQL receiver][1] in your OpenTelemetry Collector configuration.
2. Ensure the OpenTelemetry Collector is [configured to export to Datadog][5].

See the [MySQL receiver documentation][1] for detailed configuration options and requirements.

## Data collected

{{< mapping-table resource="mysql.csv">}}

See [OpenTelemetry Metrics Mapping][2] for more information.

## Further reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/mysqlreceiver
[2]: /opentelemetry/guide/metrics_mapping/
[4]: https://app.datadoghq.com/dash/integration/12/mysql---overview
[5]: /opentelemetry/setup/collector_exporter/
39 changes: 39 additions & 0 deletions content/en/opentelemetry/integrations/nginx_metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: NGINX Metrics
further_reading:
- link: "/opentelemetry/collector_exporter/"
tag: "Documentation"
text: "Setting Up the OpenTelemetry Collector"
---

## Overview

{{< img src="/opentelemetry/collector_exporter/nginx_metrics.png" alt="OpenTelemetry NGINX metrics in a NGINX dashboard" style="width:100%;" >}}

The [NGINX receiver][1] allows for collection of NGINX metrics and access to the [NGINX Overview][4] dashboard. Configure the receiver according to the specifications of the latest version of the `nginxreceiver`.

For more information, see the OpenTelemetry project documentation for the [NGINX receiver][1].

## Setup

To collect NGINX metrics with OpenTelemetry for use with Datadog:

1. Configure the [NGINX receiver][1] in your OpenTelemetry Collector configuration.
2. Ensure the OpenTelemetry Collector is [configured to export to Datadog][5].

See the [NGINX receiver documentation][1] for detailed configuration options and requirements.

## Data collected

{{< mapping-table resource="nginx.csv">}}

See [OpenTelemetry Metrics Mapping][2] for more information.

## Further reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/nginxreceiver
[2]: /opentelemetry/guide/metrics_mapping/
[4]: https://app.datadoghq.com/dash/integration/21/nginx---overview
[5]: /opentelemetry/setup/collector_exporter/
Loading
Loading