[DRAFT] Workers Tracing / Exporting OTel #24713
Open
+1,162
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nevikashah
requested review from
a team,
irvinebroque,
kodster28,
mikenomitch and
rohinlohe
as code owners
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Merged
6 tasks
nevikashah
requested review from
a team,
Maddy-Cloudflare,
RebeccaTamachiro,
ToriLindsay,
andre-j3sus,
angelampcosta,
haleycode,
kathayl,
marciocloudflare,
migueldemoura,
patriciasantaana,
pedrosousa,
punkeel and
securitypedant
as code owners
IgorMinar
approved these changes
Sep 26, 2025
|
|
||
| Cloudflare has automatically instrumented fetch calls and requests to Cloudflare resources (e.g. Workers KV, D1 Databases, Durable Objects) bound to your Workers application, without requiring you to install and configure an OpenTelemetry SDK. | ||
|
|
||
| **TO-DO:** add defintions to each span and attribute |
There was a problem hiding this comment.
This is very important! Thank you in advance for filling in the docs.
| Workers tracing is currently in open beta. This page documents current limitations and any features on our roadmap. To provide more feedback and feature requests please [reach out to us](link). | ||
|
|
||
| ### Support for more spans and attributes | ||
| We are adding more automatic instrumentation for every part of the Workers platform. While we first want to give you visibility into the duration of every operation w ithin your request, we also want to add more detailed attributes which are crucial to debugging your app. You can find a complete list of what is already instrumented [here](link). Your feedback on what’s missing will be extremely valuable [here](link). |
There was a problem hiding this comment.
Suggested change
| We are adding more automatic instrumentation for every part of the Workers platform. While we first want to give you visibility into the duration of every operation w ithin your request, we also want to add more detailed attributes which are crucial to debugging your app. You can find a complete list of what is already instrumented [here](link). Your feedback on what’s missing will be extremely valuable [here](link). | |
| We are adding more automatic instrumentation for every part of the Workers platform. While we first want to give you visibility into the duration of every operation within your request, we also want to add more detailed attributes which are crucial to debugging your app. You can find a complete list of what is already instrumented [here](link). Your feedback on what’s missing will be extremely valuable [here](link). |
| ``` | ||
|
|
||
| ### Exporting OpenTelemetry traces to a 3rd party destination | ||
| You can also export [OpenTelemetry](https://opentelemetry.io/) (OTel) traces to a 3rd party destination such as Honeycomb by [setting up an external destination](/workers/observability/exporting-opentelemetry-data) in the Cloudflare dashboard and setting that destination in your Wrangler configuration file. |
There was a problem hiding this comment.
Suggested change
| You can also export [OpenTelemetry](https://opentelemetry.io/) (OTel) traces to a 3rd party destination such as Honeycomb by [setting up an external destination](/workers/observability/exporting-opentelemetry-data) in the Cloudflare dashboard and setting that destination in your Wrangler configuration file. | |
| You can also export [OpenTelemetry](https://opentelemetry.io/) (OTel) traces to a 3rd party destination such as Honeycomb by [setting up an external destination](/workers/observability/exporting-opentelemetry-data) in the Cloudflare dashboard and setting that destination in your Wrangler configuration file. |
IgorMinar
reviewed
Oct 3, 2025
| ### Support for more spans and attributes | ||
| We are adding more automatic instrumentation for every part of the Workers platform. While we first want to give you visibility into the duration of every operation w ithin your request, we also want to add more detailed attributes which are crucial to debugging your app. You can find a complete list of what is already instrumented [here](link). Your feedback on what’s missing will be extremely valuable [here](link). | ||
|
|
||
| ### Trace context propagation |
There was a problem hiding this comment.
it's unclear what the limitation is here. can you be more explicit please?
vs-mg
approved these changes
Oct 6, 2025
…ana Cloud and Honeycomb
…I attributes for various handlers, including fetch, cache, D1, R2, and Durable Objects. This update improves clarity on available metrics and attributes for better monitoring and tracing.
…ion by updating section headers and adding links to runtime APIs. This includes restructuring attributes for spans and handlers, improving navigation for users seeking information on metrics and tracing capabilities.
… context propagation and clarify current limitations. Enhance the spans and attributes section with detailed descriptions and examples, ensuring users have comprehensive information on automatic tracing instrumentation and supported attributes.
… including prerequisites, setup steps, and configuration examples for both `wrangler.jsonc` and `wrangler.toml`. This enhances the observability documentation by providing users with clear instructions on integrating Cloudflare Workers with Grafana Cloud for telemetry data visualization and analysis.
…components with `WranglerConfig` for improved clarity and consistency in presenting configuration examples. This update streamlines the guide for exporting OpenTelemetry data to Grafana Cloud, ensuring users have a unified format for configuration across different sections.
…y data delivery status and sampling configurations. This includes refining status descriptions, enhancing troubleshooting guidance, and clarifying the default sampling behavior. Additionally, the known limitations section has been updated to reflect upcoming features and improvements in trace context propagation and automatic instrumentation.
…y data export links and improve the descriptions of spans and attributes. This includes correcting links for exporting OpenTelemetry data, refining the section on missing instrumentation, and updating references to the Durable Object Storage SQL and KV APIs for better user guidance.
…nTelemetry data and refine references to Durable Object Storage APIs. This includes updating the link for the SQL API and the KV API, as well as improving the clarity of the known limitations section by removing unnecessary phrasing. These changes enhance user guidance and ensure accurate navigation within the documentation.
There was a problem hiding this comment.
Is this leaking Issues as a feature?
src/content/docs/workers/observability/traces/known-limitations.md
Outdated
Show resolved
Hide resolved
Ankcorn
reviewed
Oct 7, 2025
| ### Support for custom spans and attributes: | ||
| 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. | ||
|
|
||
| ### No newline at end of file |
There was a problem hiding this comment.
Can you add a section here explaining Missing Root Spans/Trace in progress so I can link to it from the UI?
There was a problem hiding this comment.
Maybe in a different section? That isn't a known limitation so much as "how tracing works"
ishanjainn
reviewed
Oct 8, 2025
src/content/docs/workers/observability/exporting-opentelemetry-data/grafana-cloud.mdx
Outdated
Show resolved
Hide resolved
ishanjainn
reviewed
Oct 8, 2025
src/content/docs/workers/observability/exporting-opentelemetry-data/grafana-cloud.mdx
Show resolved
Hide resolved
ishanjainn
reviewed
Oct 8, 2025
src/content/docs/workers/observability/traces/spans-and-attributes.mdx
Outdated
Show resolved
Hide resolved
… 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.
…, including prerequisites, API key configuration, and step-by-step instructions for setting up trace and logs destinations in the Cloudflare dashboard. Update Worker configuration example using `WranglerConfig` for clarity. Additionally, enhance the known limitations section with a new call-out for user awareness.
…ormats for Grafana Cloud, Axiom, Datadog, and Sentry. Enhance the known limitations section with additional details on metadata applicability across spans and logs, ensuring users are better informed about current bugs and trace visibility.
…traces documentation for improved clarity on KV Namespace and R2 bucket calls.
…sualization of trace data. This enhances user understanding of the observability features available in Cloudflare Workers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
10 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
-draft PR for tracing / exporting OTel docs
Documentation checklist