Skip to content
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

feat(node): Add more detailed OTEL docs #10872

Merged
merged 17 commits into from
Aug 7, 2024
Merged

feat(node): Add more detailed OTEL docs #10872

merged 17 commits into from
Aug 7, 2024

Conversation

mydea
Copy link
Member

@mydea mydea commented Jul 26, 2024

This PR extracts the OTEL docs for node out, which used to be nested under "Set Up Tracing > Instrumentation > OpenTelemetry Support", and put it on the top level (TBD - is there a better place for this?)

In addition, it splits this out into dedicated pages explaining how to do different things.

The following docs already existed, and are now split out:

  • Using a custom sampler
  • Using a custom setup
  • Using an otel tracer
  • Using custom otel instrumentation

I also added two more:

  • Accessing the tracer provider
  • Required OTEL instrumentation (explaining that you need http integration, for example) - related to this, also extended the http integration docs to show newly added options for config there.

For discussion

  • Where do we place this? I put it on the top level for now, to make it more explorable, but open for other suggestions.
  • For now, I included "OpenTelemetry..." in all the sub page titles. This makes it explicit and searchable, but is maybe a bit redundant - e.g. "Using a Custom OpenTelemetry Sampler" vs "Using a Custom Sampler"

Copy link

vercel bot commented Jul 26, 2024

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

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 7, 2024 10:03am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 7, 2024 10:03am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Aug 7, 2024 10:03am

Copy link

codecov bot commented Jul 26, 2024

Bundle Report

Changes will increase total bundle size by 38.2kB ⬆️

Bundle name Size Change
sentry-docs-server 8.29MB 38.07kB ⬆️
sentry-docs-edge-server 252.74kB 137 bytes ⬆️
sentry-docs-client 6.24MB 6 bytes ⬇️

Copy link
Member

@chargome chargome left a comment

Choose a reason for hiding this comment

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

I think that's really good!

We have just created a few 404s with this change, but that means the linter works fine ;)

Copy link
Member

@s1gr1d s1gr1d left a comment

Choose a reason for hiding this comment

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

Thanks for adding this!

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

Just some rewording suggestions. Otherwise this looks good to me!

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

Thanks for rewording. It's more clear to me now.

docs/platforms/javascript/common/opentelemetry/index.mdx Outdated Show resolved Hide resolved
docs/platforms/javascript/common/opentelemetry/index.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Thanks so much for making these updates! I think the flow is much easier to digest. I love the split into "using an existing setup" vs "using an API" <3

@mydea mydea merged commit def093a into master Aug 7, 2024
11 checks passed
@mydea mydea deleted the fn/node-otel-docs branch August 7, 2024 11:22
@github-actions github-actions bot locked and limited conversation to collaborators Aug 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants