Skip to content

Conversation

@nevikashah
Copy link
Contributor

Summary

-draft PR for tracing / exporting OTel docs

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions github-actions bot added product:workers Related to Workers product size/l labels Aug 26, 2025
@nevikashah nevikashah changed the title Nevi/tracing [DRAFT] Workers Tracing / Exporting OTel Aug 26, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Aug 26, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/assets/images/ @cloudflare/pm-changelogs, @cloudflare/pcx-technical-writing
/src/content/docs/workers/observability/ @irvinebroque, @mikenomitch, @rohinlohe, @kodster28, @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

github-actions bot commented Aug 26, 2025

Preview URL: https://80f4ad54.preview.developers.cloudflare.com
Preview Branch URL: https://nevi-tracing.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/observability/traces/spans-and-attributes/ https://nevi-tracing.preview.developers.cloudflare.com/workers/observability/traces/spans-and-attributes/
https://developers.cloudflare.com/workers/observability/traces/ https://nevi-tracing.preview.developers.cloudflare.com/workers/observability/traces/
https://developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/ https://nevi-tracing.preview.developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/
https://developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/honeycomb/ https://nevi-tracing.preview.developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/honeycomb/
https://developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/axiom/ https://nevi-tracing.preview.developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/axiom/
https://developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/sentry/ https://nevi-tracing.preview.developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/sentry/
https://developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/grafana-cloud/ https://nevi-tracing.preview.developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/grafana-cloud/
https://developers.cloudflare.com/workers/observability/query-builder/ https://nevi-tracing.preview.developers.cloudflare.com/workers/observability/query-builder/
https://developers.cloudflare.com/workers/observability/third-party-integrations/ https://nevi-tracing.preview.developers.cloudflare.com/workers/observability/third-party-integrations/

Copy link
Contributor

@IgorMinar IgorMinar left a comment

Choose a reason for hiding this comment

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

lgtm once TODOs are resolved. thanks @nevikashah


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
Copy link
Contributor

Choose a reason for hiding this comment

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

This is very important! Thank you in advance for filling in the docs.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this leaking Issues as a feature?

### 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
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a section here explaining Missing Root Spans/Trace in progress so I can link to it from the UI?

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe in a different section? That isn't a known limitation so much as "how tracing works"

Copy link

@ishanjainn ishanjainn left a comment

Choose a reason for hiding this comment

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

Minor updates on the steps to extract Auth headers

- Corrected links in the known limitations section to point to the appropriate security model documentation.
- Updated span and attribute references to reflect changes in the Durable Object Storage API, including renaming and correcting links for various methods.
- Corrected the link for the Durable Object Storage SQL API to point to the correct SQLite storage API documentation.
- Ensured consistency in the references to OpenTelemetry and observability platforms.
AbhiPrasad and others added 4 commits October 22, 2025 18:13
- Added `head_sampling_rate` and `persist` options for traces and logs in the OpenTelemetry configuration example.
- Improved clarity in the tracing documentation regarding default sampling rates and configuration options.
…on documentation

- Updated the Datadog entry to include a direct link to the official documentation.
- Enhanced comments for clarity regarding the optional disabling of traces and logs in the Cloudflare dashboard.
* Update spans-and-attributes.mdx

Add explanation for sequence number and remove attributes for durable_object_subrequest that we do not have yet

* Update spans-and-attributes.mdx

Also remove cold start since we do not have that info yet
nevikashah and others added 3 commits October 27, 2025 14:19
- Clarified the format for the Sentry authentication header in the OpenTelemetry data exporting instructions.
- Updated attribute names in spans-and-attributes documentation to include the correct units for CPU and wall time.
…ation

- Updated the formatting of the Sentry authentication header description to ensure proper usage of curly braces around the public key placeholder in the OpenTelemetry data exporting instructions.
Copy link
Contributor

@irvinebroque irvinebroque left a comment

Choose a reason for hiding this comment

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

🚀 🎸 🐐 🚢

@nevikashah nevikashah merged commit ecbbedf into production Oct 28, 2025
8 checks passed
@nevikashah nevikashah deleted the nevi/tracing branch October 28, 2025 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:workers Related to Workers product size/l

Projects

None yet

Development

Successfully merging this pull request may close these issues.