Skip to content

feat(otlp): Add basic OTLP beta documentation #14453

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

Conversation

gggritso
Copy link
Member

@gggritso gggritso commented Jul 24, 2025

DESCRIBE YOUR PR

Sentry is working on OTLP ingestion! This'll allow customers to configure their OpenTelemetry SDKs to send traces directly to Sentry. This is a major departure from our current OTLP support, which mostly requires users to configure their SDKs in special ways.

We are gearing up for a Limited Availability Beta with a few select customers. While we expect to hold their hand for a lot of it, it's still a good idea to have some public documentation they can refer to.

I'm looking for feedback from the Docs team on where to best place this kind of generic documentation (I took a shot!) and from the SDKs team for how to make this document play nice with existing SDK documentation about OpenTelemetry.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • None: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Copy link

vercel bot commented Jul 24, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 28, 2025 9:43pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 28, 2025 9:43pm

Copy link

linear bot commented Jul 24, 2025

Copy link

codecov bot commented Jul 24, 2025

Bundle Report

Changes will increase total bundle size by 1.93kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.83MB 187 bytes (0.0%) ⬆️
sentry-docs-server-cjs 12.24MB 1.75kB (0.01%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%
../app/[[...path]]/page.js.nft.json 563 bytes 725.57kB 0.08%
../app/platform-redirect/page.js.nft.json 563 bytes 725.48kB 0.08%
../app/sitemap.xml/route.js.nft.json 563 bytes 722.96kB 0.08%
4873.js 67 bytes 89.38kB 0.08%

Files in 4873.js:

  • ./src/components/codeContext.tsx → Total Size: 2.47kB

  • ./src/components/codeContext.tsx → Total Size: 8.77kB

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 879.71kB -0.0%
static/chunks/1831-*.js -3 bytes 422.23kB -0.0%
static/chunks/4145-*.js 193 bytes 49.72kB 0.39%
static/yFvwjRAaH7y8ekKBvT0UR/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/yFvwjRAaH7y8ekKBvT0UR/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/13TBgYzCh1XrcZ9C2m3dI/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/13TBgYzCh1XrcZ9C2m3dI/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Files in static/chunks/4145-*.js:

  • ./src/components/codeContext.tsx → Total Size: 9.5kB

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

The docs changes look good to me, 'concepts' seems like a reasonable place to put this. the changes to the CodeContext component look good as well, but best to get a platform engineer to give it a quick look as well. Maybe @chargome or @sergical can take a look.

Copy link
Member

@AbhiPrasad AbhiPrasad left a comment

Choose a reason for hiding this comment

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

We need to make it clear that we don't support span events yet.

gggritso and others added 2 commits July 28, 2025 16:41
Co-authored-by: Alex Krawiec <[email protected]>
Co-authored-by: Abhijeet Prasad <[email protected]>
Copy link
Contributor

@sergical sergical left a comment

Choose a reason for hiding this comment

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

Just my 🪙🪙 also not sure if additional resources need to be updated: https://develop.sentry.dev/sdk/telemetry/traces/opentelemetry/

@gggritso
Copy link
Member Author

@AbhiPrasad @coolguyzone @sergical updated the PR with all of your suggestions, thanks! Please take a peek, and let me know if any other changes are needed

Copy link
Member

@AbhiPrasad AbhiPrasad left a comment

Choose a reason for hiding this comment

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

Good on my side!

Should we also add a note that we don't support OTLP metrics and logs explicitly? I know we explicitly mention traces but might be nice to have that there.

@gggritso
Copy link
Member Author

@AbhiPrasad 👍🏻 done, better to be explicit

@gggritso gggritso merged commit cf08de6 into master Jul 28, 2025
15 checks passed
@gggritso gggritso deleted the georgegritsouk/ope-18-write-public-onboarding-documentation-for-otlp-in-saas branch July 28, 2025 23:41
lucas-zimerman pushed a commit that referenced this pull request Jul 29, 2025
## DESCRIBE YOUR PR

Sentry is working on OTLP ingestion! This'll allow customers to
configure their OpenTelemetry SDKs to send traces directly to Sentry.
This is a major departure from our current OTLP support, which mostly
requires users to configure their SDKs in special ways.

We are gearing up for a Limited Availability Beta with a few select
customers. While we expect to hold their hand for a lot of it, it's
still a good idea to have some public documentation they can refer to.

I'm looking for feedback from the Docs team on where to best place this
kind of generic documentation (I took a shot!) and from the SDKs team
for how to make this document play nice with existing SDK documentation
about OpenTelemetry.

## IS YOUR CHANGE URGENT?  

Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [x] None: Not urgent, can wait up to 1 week+

## PRE-MERGE CHECKLIST

- [x] Checked Vercel preview for correctness, including links
- [x] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [x] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

---------

Co-authored-by: Alex Krawiec <[email protected]>
Co-authored-by: Abhijeet Prasad <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants