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 node and browser sdk transport option docs #5740

Merged
merged 4 commits into from Nov 10, 2022

Conversation

AbhiPrasad
Copy link
Member

@AbhiPrasad AbhiPrasad commented Nov 8, 2022

Only can get merged once getsentry/sentry-javascript#6161 is released.

Add documentation for Node Transport options.

@vercel
Copy link

vercel bot commented Nov 8, 2022

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

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Nov 10, 2022 at 4:23PM (UTC)

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.

LGTM

Copy link
Member

@JonasBa JonasBa left a comment

Choose a reason for hiding this comment

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

Thank you @AbhiPrasad

@AbhiPrasad AbhiPrasad self-assigned this Nov 10, 2022
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.

Found some weirdness with the way the platformsection is working in the preview and left a question.


- `headers`: An object containing headers to be sent with every request.
- `proxy`: A proxy used for outbound requests. Can be http or https.
- `caCerts`: A single or list of a path to a file or directory, or a buffer of CA certificates
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 a bit unclear. A single cert or a single path?

Suggested change
- `caCerts`: A single or list of a path to a file or directory, or a buffer of CA certificates
- `caCerts`: A single or list of a path to a file or directory, or a buffer of CA certificates

Copy link
Member Author

Choose a reason for hiding this comment

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

it can be:

  • a path to a CA certificate
  • a list of paths to a CA certificate
  • a buffer of CA certificates

src/platforms/common/configuration/options.mdx Outdated Show resolved Hide resolved
src/platforms/common/configuration/options.mdx Outdated Show resolved Hide resolved
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
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.

Preview looks good! I just made a small tweak, but otherwise LGTM!

src/platforms/common/configuration/options.mdx Outdated Show resolved Hide resolved
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
@AbhiPrasad AbhiPrasad merged commit 23e6fa0 into master Nov 10, 2022
@AbhiPrasad AbhiPrasad deleted the abhi-transport-options branch November 10, 2022 16:15
@github-actions github-actions bot locked and limited conversation to collaborators Nov 26, 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

4 participants