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

Add OpenTelemetry Node SDK docs #5760

Merged
merged 8 commits into from Nov 16, 2022
Merged

Add OpenTelemetry Node SDK docs #5760

merged 8 commits into from Nov 16, 2022

Conversation

AbhiPrasad
Copy link
Member

@AbhiPrasad AbhiPrasad self-assigned this Nov 10, 2022
@vercel
Copy link

vercel bot commented Nov 10, 2022

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

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Nov 16, 2022 at 8:14AM (UTC)

@AbhiPrasad
Copy link
Member Author

Moving this to draft because it may be blocked by @onurtemizkan's work in #5710.

Copy link
Contributor

@imatwawana imatwawana left a 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.

AbhiPrasad and others added 5 commits November 15, 2022 14:37
….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>
@lforst lforst assigned mydea and unassigned mydea and AbhiPrasad Nov 15, 2022
@mydea mydea marked this pull request as ready for review November 15, 2022 15:13
Copy link
Contributor

@imatwawana imatwawana left a 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

Comment on lines +9 to +16
<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>
Copy link
Contributor

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?

Copy link
Member

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>
@mydea mydea deleted the abhi-otel-node-docs branch November 16, 2022 13:10
@github-actions github-actions bot locked and limited conversation to collaborators Dec 2, 2022
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.

None yet

3 participants