Skip to content

Commit 8d1caa8

Browse files
committed
Enhance observability documentation by adding detailed information on OpenTelemetry destinations, including common OTLP endpoint formats for various providers. Update Grafana Cloud setup instructions for clarity and include a new section on known limitations regarding metrics export and OTLP support. Additionally, refine the spans and attributes section to indicate that names may change during the beta period, ensuring users are informed of potential updates.
1 parent e41aea1 commit 8d1caa8

File tree

4 files changed

+31
-6
lines changed

4 files changed

+31
-6
lines changed

src/content/docs/workers/observability/exporting-opentelemetry-data/grafana-cloud.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,15 @@ Before you begin, ensure you have:
2929
4. Select **Quickstart** then select **JavaScript**
3030
6. Click **Create a new token**
3131
7. Enter a name for your token (e.g., `cloudflare-workers-otel`) and click **create token**
32+
8. Click on **Close** without copying the token
33+
9. Copy and Save the value for `OTEL_EXPORTER_OTLP_ENDPOINT` and `OTEL_EXPORTER_OTLP_HEADERS` in the `Environment variables` code block as the OTel endpoint and as the Auth header value respectively
3234

3335

3436
## Step 2: Set up destination
3537
1. Navigate to your Cloudflare account's [Workers Observability](https://dash.cloudflare.com/?to=/:account/workers-and-pages/observability/pipelines) section
3638
2. Click **Add destination** and configure a destination name (e.g. `grafana-tracing`)
3739
3. From Grafana, copy your Otel endpoint, auth header, and auth value
38-
* Your OTEL endpoint will look like `https://otlp-gateway-prod-us-east-2.grafana.net/otlp` (append `/v1/traces for tracing and `/v1/logs` for logs)
40+
* Your OTEL endpoint will look like `https://otlp-gateway-prod-us-east-2.grafana.net/otlp` (append `/v1/traces` for traces and `/v1/logs` for logs)
3941
* Your custom header should include:
4042
* Your auth header name `Authorization`
4143
* Your auth header value `Basic MTMxxx...`

src/content/docs/workers/observability/exporting-opentelemetry-data/index.mdx

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,27 @@ You can export the following types of telemetry data:
1818

1919
**Note**: exporting Worker metrics and custom metrics is not yet supported.
2020

21-
### Supported OpenTelemtry destinations
22-
* [Honeycomb](/workers/observability/exporting-opentelemetry-data/honeycomb/)
23-
* [Grafana Cloud](/workers/observability/exporting-opentelemetry-data/grafana-cloud/)
21+
### Available OpenTelemetry destinations
22+
23+
Below are common OTLP endpoint formats for popular observability providers. Refer to your provider's documentation for specific details and authentication requirements.
24+
25+
| Provider | Traces Endpoint | Logs Endpoint |
26+
|----------|----------------|---------------|
27+
| [**Honeycomb**](/workers/observability/exporting-opentelemetry-data/honeycomb/) | `https://api.honeycomb.io/v1/traces` | `https://api.honeycomb.io/v1/logs` |
28+
| [**Grafana Cloud**](/workers/observability/exporting-opentelemetry-data/grafana-cloud/) | `https://otlp-gateway-{region}.grafana.net/otlp/v1/traces`[^1] | `https://otlp-gateway-{region}.grafana.net/otlp/v1/logs`[^1] |
29+
| **Axiom** | `https://api.axiom.co/v1/traces` | `https://api.axiom.co/v1/logs` |
30+
| **Datadog** | Not yet available. Pending release from Datadog[^2] | Not yet available. Pending release from Datadog[^2] |
31+
| **Sentry** | Not yet available. Pending release from Sentry[^3] | Not yet available. Pending release from Sentry[^3] |
32+
33+
[^1]: Replace `{region}` with your Grafana Cloud stack region (e.g., `prod-us-east-0`)
34+
35+
[^2]: Datadog's OTLP endpoints are currently being rolled out and may not be available for all accounts. Contact Datadog support to enable OTLP ingestion for your account.
36+
37+
[^3]: Sentry's OTLP endpoints are currently being rolled out and may not be available for all accounts. Contact Sentry support to enable OTLP ingestion for your account.
38+
39+
:::note[Authentication]
40+
Most providers require authentication headers. Refer to your provider's documentation for specific authentication requirements.
41+
:::
2442

2543
## Setting up OpenTelemetry-compatible destinations
2644
To start sending data to your destination, you'll need to create a destination in the Cloudflare dashboard.
@@ -91,3 +109,7 @@ This includes the following limits and pricing:
91109
| **Workers Free** | Not available | Not available | - |
92110
| **Workers Paid** | 10 million events per month included | 10 million events per month included | $0.05 per million additional events |
93111

112+
## Known limitations
113+
OpenTelemetry data export is currently in beta. Please be aware of the following limitations:
114+
- **Metrics export not yet supported**: Exporting Worker infrastructure metrics and custom metrics via OpenTelemetry is not currently available. We are actively working to add metrics support in the future.
115+
- **Limited OTLP support from some providers**: Some observability providers are still rolling out OTLP endpoint support. Check the [Available OpenTelemetry destinations](#available-opentelemetry-destinations) table above for current availability.

src/content/docs/workers/observability/traces/known-limitations.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,7 @@ We are adding more automatic instrumentation for every part of the Workers platf
2020
### Support for custom spans and attributes:
2121
While automatic instrumentation covers the platform interactions, we know you need visibility into your own application logic too. We're working to support the [OpenTelemetry API](https://www.npmjs.com/package/@opentelemetry/api) to make it easier for you to instrument custom spans within your application.
2222

23+
### Span and attribute names subject to change
24+
As Workers tracing is currently in beta, span names and attribute names are not yet finalized. We may refine these names during the beta period to improve clarity and align with OpenTelemetry semantic conventions. We recommend reviewing the [spans and attributes documentation](/workers/observability/traces/spans-and-attributes) periodically for updates.
25+
2326
###

src/content/docs/workers/observability/traces/spans-and-attributes.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,6 @@ Cloudflare Workers provides automatic tracing instrumentation **out of the box**
140140

141141
#### [`d1_exec`](/d1/worker-api/d1-database/#exec)
142142

143-
- `N/A`
144-
145143
#### [`d1_first`](/d1/worker-api/prepared-statements/#first)
146144

147145
- `cloudflare.d1.query.bookmark`

0 commit comments

Comments
 (0)