Skip to content

docs(go): Sync configuration options with sentry-go ClientOptions#16655

Open
philprime wants to merge 5 commits intomasterfrom
docs/go-sync-options
Open

docs(go): Sync configuration options with sentry-go ClientOptions#16655
philprime wants to merge 5 commits intomasterfrom
docs/go-sync-options

Conversation

@philprime
Copy link
Member

@philprime philprime commented Mar 3, 2026

DESCRIBE YOUR PR

Sync the Go SDK configuration options doc (docs/platforms/go/common/configuration/options.mdx) with ClientOptions in sentry-go client.go. The SDK is the source of truth; docs were updated to match.

Added missing options:

  • Tracing: TracePropagationTargets, PropagateTraceparent, TraceIgnoreStatusCodes
  • Hooks: BeforeSendLog, BeforeSendMetric
  • Core: Tags (default event tags)
  • Metrics: DisableMetrics (new Metrics Options section)
  • Transport: DisableTelemetryBuffer

Aligned with SDK:

  • Removed TracesSampleRate envVar (Go SDK does not read SENTRY_TRACES_SAMPLE_RATE)
  • Debug description and envelope size-limits URL (sdk/envelopes/#size-limits) match SDK comments
  • TracesSampler copy fix: traces-samplerTracesSampler
  • Use NewSentryRoundTripper instead of non-existent SentryHTTPClient
  • Zerolog example should use NewWithHub to avoid creating multiple clients
  • Fix GetCurrentHub to CurrentHub

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


Co-Authored-By: Claude noreply@anthropic.com

Add missing options from client.go: TracePropagationTargets,
PropagateTraceparent, TraceIgnoreStatusCodes, BeforeSendLog,
BeforeSendMetric, Tags, DisableMetrics, DisableTelemetryBuffer.

- Remove TracesSampleRate envVar (Go SDK does not read it)
- Align Debug description and envelope size-limits URL with SDK
- Fix TracesSampleRate copy (traces-sampler -> TracesSampler)

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Mar 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Mar 5, 2026 10:11am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Mar 5, 2026 10:11am

Request Review

due to a bug we had in the SDK this option is currently nooped, so we
should not document it
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants