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
Add OpenTelemetry Node SDK docs #5760
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Moving this to draft because it may be blocked by @onurtemizkan's work in #5710. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've made a couple small edits, but this isn't yet able to be viewed in the preview. Some tweaks required.
src/platforms/common/performance/instrumentation/opentelemetry.mdx
Outdated
Show resolved
Hide resolved
src/platforms/common/performance/instrumentation/opentelemetry.mdx
Outdated
Show resolved
Hide resolved
src/platform-includes/performance/opentelemetry-install/node.mdx
Outdated
Show resolved
Hide resolved
src/platforms/common/performance/instrumentation/opentelemetry.mdx
Outdated
Show resolved
Hide resolved
….mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
….mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
f63ab9b
to
3e2b794
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made a couple suggestions, but otherwise this looks good
<Note> | ||
|
||
Note that @sentry/opentelemetry-node depends on the following peer dependencies: | ||
|
||
- @opentelemetry/api, version 1.0.0 or greater | ||
- @opentelemetry/sdk-trace-base, version 1.0.0 or greater, or a package that implements it, like @opentelemetry/sdk-node | ||
|
||
</Note> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the note about dependencies come before the install step?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
personally I find it better placed below (so the flow: this is how to install sentry. But make sure that you also have these dependencies installed). But we can of course still adjust this later as well! :)
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Mainly based on the README here: https://www.npmjs.com/package/@sentry/opentelemetry-node
Initial Context: getsentry/sentry#40712
Node SDK work: getsentry/sentry-javascript#6000