jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-19 18:14:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

update otel docs to reflect proper configuration steps (#67719)

Browse Source 
## What

The OpenTelemetry docs were unclear on how to actually configure the
Collector and Airbyte to connect, as well as necessary prereqs to do so.
This PR just updates to make those a little clearer.

## How

Docs updates. 

## Review guide

Validate docs makes sense. 

## User Impact

n/a

## Can this PR be safely reverted and rolled back?
<!--
* If unsure, leave it blank.
-->
- [x] YES 💚
- [ ] NO ❌

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Lucas Leadbetter
2025-10-14 16:55:44 -04:00
committed by GitHub
parent 597d6e55af
commit b7f9c5bbea
4 changed files with 72 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/platform/operator-guides/open-telemetry.md
View File

@@ -16,13 +16,23 @@ Airbyte sends specific metrics to provide you with health insight in the followi
## Example dashboard
Here's an example of a dashboard in Datadog using Airbyte's OTEL metrics.
Here's an example of a dashboard in Datadog using Airbyte's OpenTelemetry metrics.
![Airbyte OTEL metrics in a dashboard in Datadog](assets/otel-datadog.png)
![Airbyte OpenTelemetry metrics in a dashboard in Datadog](assets/otel-datadog.png)
## Configure OpenTelemetry metrics
1. Deploy an OpenTelemetry collector if you don't already have one. See the [OpenTelemetry documentation](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) for help doing this. If you use Datadog as your monitoring tool, they have an excellent guide to [set up a collector and exporter](https://docs.datadoghq.com/opentelemetry/collector_exporter/).
1. Deploy an OpenTelemetry Collector if you don't already have one. See the [OpenTelemetry documentation](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) for help doing this. If you use Datadog as your monitoring tool, they have an in-depth guide to [set up a Datadog Collector and Exporter](https://docs.datadoghq.com/opentelemetry/collector_exporter/).
1. For Airbyte to send metrics to your server, your OpenTelemetry service (collector or otherwise) must accept OpenTelemetry Protocol (OTLP) over HTTP. If you use an OpenTelemetry Collector, your configuration would need to include some variation of the below to accept OTLP over HTTP:
```yml
receivers:
otlp:
protocols:
http:
endpoint: 0.0.0.0:4318
```
2. Update Airbyte's `values.yaml` file to enable OpenTelemetry.
@@ -33,7 +43,10 @@ Here's an example of a dashboard in Datadog using Airbyte's OTEL metrics.
enabled: true
otlp:
enabled: true
collectorEndpoint: "YOUR_ENDPOINT" # The OTel collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OTel deployment.
# The OpenTelemetry Collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OpenTelemetry deployment
# This endpoint also needs to end in the metrics ingestion endpoint. For OpenTelemetry Collector users, this is /v1/metrics.
# e.g. http://localhost:4318/v1/metrics
collectorEndpoint: "YOUR_ENDPOINT"
```
3. Redeploy Airbyte with the updated values.

33
docusaurus/platform_versioned_docs/version-1.6/operator-guides/collecting-metrics.md
View File

@@ -30,19 +30,32 @@ Airbyte sends specific metrics to provide you with health insight in the followi
### Configure OpenTelemetry metrics
1. Deploy an OpenTelemetry collector if you don't already have one. See the [OpenTelemetry documentation](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) for help doing this. If you use Datadog as your monitoring tool, they have an excellent guide to [set up a collector and exporter](https://docs.datadoghq.com/opentelemetry/collector_exporter/).
1. Deploy an OpenTelemetry collector if you don't already have one. See the [OpenTelemetry documentation](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) for help doing this. If you use Datadog as your monitoring tool, they have an in-depth guide to [set up a collector and exporter](https://docs.datadoghq.com/opentelemetry/collector_exporter/).
1. For Airbyte to send metrics to your server, your OpenTelemetry service (collector or otherwise) must accept OpenTelemetry Protocol (OTLP) over HTTP. If you use an OpenTelemetry Collector, your configuration would need to include some variation of the below to accept OTLP over HTTP:
```yml
receivers:
otlp:
protocols:
http:
endpoint: 0.0.0.0:4318
```
2. Update Airbyte's `values.yaml` file to enable OpenTelemetry.
```yaml title="values.yaml"
global:
edition: enterprise # This is an enterprise-only feature
metrics:
enabled: true
otlp:
enabled: true
collectorEndpoint: "YOUR_ENDPOINT" # The OTel collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OTel deployment.
```
```yaml title="values.yaml"
global:
edition: enterprise # This is an enterprise-only feature
metrics:
enabled: true
otlp:
enabled: true
# The OpenTelemetry Collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OpenTelemetry deployment
# This endpoint also needs to end in the metrics ingestion endpoint. For OpenTelemetry Collector users, this is /v1/metrics.
# e.g. http://localhost:4318/v1/metrics
collectorEndpoint: "YOUR_ENDPOINT"
```
3. Redeploy Airbyte with the updated values.

17
docusaurus/platform_versioned_docs/version-1.7/operator-guides/collecting-metrics.md
View File

@@ -30,7 +30,17 @@ Airbyte sends specific metrics to provide you with health insight in the followi
### Configure OpenTelemetry metrics
1. Deploy an OpenTelemetry collector if you don't already have one. See the [OpenTelemetry documentation](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) for help doing this. If you use Datadog as your monitoring tool, they have an excellent guide to [set up a collector and exporter](https://docs.datadoghq.com/opentelemetry/collector_exporter/).
1. Deploy an OpenTelemetry Collector if you don't already have one. See the [OpenTelemetry documentation](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) for help doing this. If you use Datadog as your monitoring tool, they have an in-depth guide to [set up a Datadog Collector and Exporter](https://docs.datadoghq.com/opentelemetry/collector_exporter/).
1. For Airbyte to send metrics to your server, your OpenTelemetry service (collector or otherwise) must accept OpenTelemetry protocol (OTLP) over HTTP. If you use an OpenTelemetry Collector, your configuration would need to include some variation of the below to accept OTLP over HTTP:
```yml
receivers:
otlp:
protocols:
http:
endpoint: 0.0.0.0:4318
```
2. Update Airbyte's `values.yaml` file to enable OpenTelemetry.
@@ -41,7 +51,10 @@ Airbyte sends specific metrics to provide you with health insight in the followi
enabled: true
otlp:
enabled: true
collectorEndpoint: "YOUR_ENDPOINT" # The OTel collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OTel deployment.
# The OpenTelemetry Collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OpenTelemetry deployment
# This endpoint also needs to end in the metrics ingestion endpoint. For OpenTelemetry Collector users, this is /v1/metrics.
# e.g. http://localhost:4318/v1/metrics
collectorEndpoint: "YOUR_ENDPOINT"
```
3. Redeploy Airbyte with the updated values.

21
docusaurus/platform_versioned_docs/version-1.8/operator-guides/open-telemetry.md
View File

@@ -16,13 +16,23 @@ Airbyte sends specific metrics to provide you with health insight in the followi
## Example dashboard
Here's an example of a dashboard in Datadog using Airbyte's OTEL metrics.
Here's an example of a dashboard in Datadog using Airbyte's OpenTelemetry metrics.
![Airbyte OTEL metrics in a dashboard in Datadog](assets/otel-datadog.png)
![Airbyte OpenTelemetry metrics in a dashboard in Datadog](assets/otel-datadog.png)
## Configure OpenTelemetry metrics
1. Deploy an OpenTelemetry collector if you don't already have one. See the [OpenTelemetry documentation](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) for help doing this. If you use Datadog as your monitoring tool, they have an excellent guide to [set up a collector and exporter](https://docs.datadoghq.com/opentelemetry/collector_exporter/).
1. Deploy an OpenTelemetry Collector if you don't already have one. See the [OpenTelemetry documentation](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) for help doing this. If you use Datadog as your monitoring tool, they have an in-depth guide to [set up a Datadog Collector and Exporter](https://docs.datadoghq.com/opentelemetry/collector_exporter/).
1. For Airbyte to send metrics to your server, your OpenTelemetry service (collector or otherwise) must accept OpenTelemetry Protocol (OTLP) over HTTP. If you use an OpenTelemetry Collector, your configuration would need to include some variation of the below to accept OTLP over HTTP:
```yml
receivers:
otlp:
protocols:
http:
endpoint: 0.0.0.0:4318
```
2. Update Airbyte's `values.yaml` file to enable OpenTelemetry.
@@ -33,7 +43,10 @@ Here's an example of a dashboard in Datadog using Airbyte's OTEL metrics.
enabled: true
otlp:
enabled: true
collectorEndpoint: "YOUR_ENDPOINT" # The OTel collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OTel deployment.
# The OpenTelemetry Collector endpoint Airbyte sends metrics to. You configure this endpoint outside of Airbyte as part of your OpenTelemetry deployment
# This endpoint also needs to end in the metrics ingestion endpoint. For OpenTelemetry Collector users, this is /v1/metrics.
# e.g. http://localhost:4318/v1/metrics
collectorEndpoint: "YOUR_ENDPOINT"
```
3. Redeploy Airbyte with the updated values.