Skip to content

Add JavaScript manual instrumentation docs for non-HTTP protocols#12933

Merged
chargome merged 2 commits intogetsentry:masterfrom
jdaison:docs/js-manual-instrumentation-non-http-protocols
Mar 7, 2025
Merged

Add JavaScript manual instrumentation docs for non-HTTP protocols#12933
chargome merged 2 commits intogetsentry:masterfrom
jdaison:docs/js-manual-instrumentation-non-http-protocols

Conversation

@jdaison
Copy link
Copy Markdown
Contributor

@jdaison jdaison commented Mar 5, 2025

DESCRIBE YOUR PR

adds comprehensive documentation for manually instrumenting non-HTTP protocols in JavaScript applications, with a specific focus on gRPC. The documentation includes:

  • Detailed guidance on creating and managing manual spans for long-running operations
  • Examples of server-side instrumentation for gRPC with Sentry
  • Client-side trace propagation for distributed tracing across services
  • Code examples demonstrating proper span creation, management, and closure
  • Key points and best practices for manual instrumentation

These additions will help developers implement proper distributed tracing in applications that use protocols beyond standard HTTP/HTTPS, which aren't automatically instrumented by the Sentry JavaScript SDK.

IS YOUR CHANGE URGENT?

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

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • 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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 5, 2025

@jdaison is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@coolguyzone coolguyzone requested a review from chargome March 5, 2025 23:41
@lforst lforst self-assigned this Mar 6, 2025
Copy link
Copy Markdown
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.

Hey @jdaison, thanks for contributing!

EDIT: I updated your changes

@chargome chargome self-assigned this Mar 6, 2025
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 6, 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 Mar 6, 2025 11:06am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Mar 6, 2025 11:06am
develop-docs ⬜️ Ignored (Inspect) Mar 6, 2025 11:06am

@chargome chargome merged commit 4fca665 into getsentry:master Mar 7, 2025
11 checks passed
codyde added a commit that referenced this pull request Mar 13, 2025
…om/getsentry/sentry-docs into codyde/javascript-tracing-refactor

* 'codyde/javascript-tracing-refactor' of https://github.com/getsentry/sentry-docs: (104 commits)
  Update docs/concepts/key-terms/tracing/index.mdx
  Update docs/concepts/key-terms/tracing/index.mdx
  Update docs/concepts/key-terms/tracing/index.mdx
  Update docs/concepts/key-terms/tracing/index.mdx
  Update docs/concepts/key-terms/tracing/index.mdx
  Update docs/concepts/key-terms/tracing/index.mdx
  Update index.mdx (#12928)
  docs(self-hosted): monitor self-hosted instance (#12660)
  fix(feedback): rm per-feedback attach limit (#12968)
  fix(404): php integrations (#12966)
  docs(js): Update stale reference (#12964)
  fix(solidstart): Remove outdated `sentrySolidStartVite` option (#12962)
  chore(sandbox): change sandbox link (#12814)
  feat: Godot debug symbols guide (#12843)
  fix 404s (#12961)
  Fix SDK getting started pages (onboarding options) (#12960)
  fix(platform): Update onboarding options on tab switch (#12913)
  Fix Apollo links (#12952)
  chore(Android): Update docs to match actual SDK behavior (#12954)
  docs(js): Add example docs for non-HTTP protocols (#12933)
  ...
@github-actions github-actions bot locked and limited conversation to collaborators Mar 23, 2025
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.

4 participants