Skip to content

feat(grpc): custom incoming server headers #1360

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.

Sign up for GitHub

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

Open
aldy505 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat(grpc): custom incoming server headers #1360

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef483df
feat(grpc): custom incoming server headers
aldy505 Jul 12, 2026
b827801
Merge branch 'master' into feat/grpc-custom-headers
aldy505 Jul 14, 2026
7e39eee
Merge branch 'master' into feat/grpc-custom-headers
aldy505 Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions grpc/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,28 @@ type ServerOptions struct {

// Timeout sets the maximum duration for Sentry event delivery.
Timeout time.Duration

// SentryTraceHeaderKey sets or overrides the header key used to propagate the trace id.
// It defaults to `sentry-trace`.
SentryTraceHeaderKey string

// SentryBaggageHeaderKey sets or overrides the header key used to propagate the baggage.
// It defaults to `baggage`.
SentryBaggageHeaderKey string
}

func (o *ServerOptions) setDefaults() {
if o.Timeout == 0 {
o.Timeout = sentry.DefaultFlushTimeout
}

if o.SentryTraceHeaderKey == "" {
o.SentryTraceHeaderKey = sentry.SentryTraceHeader
}

if o.SentryBaggageHeaderKey == "" {
o.SentryBaggageHeaderKey = sentry.SentryBaggageHeader
}
}

func recoverWithSentry(ctx context.Context, hub *sentry.Hub, o ServerOptions, onRecover func()) {
Expand Down Expand Up @@ -69,14 +85,14 @@ func hubFromServerContext(ctx context.Context) *sentry.Hub {
return hub
}

func traceHeadersFromContext(ctx context.Context) (metadata.MD, string, string) {
func traceHeadersFromContext(ctx context.Context, traceHeaderKey string, baggageHeaderKey string) (metadata.MD, string, string) {
md, _ := metadata.FromIncomingContext(ctx)
return md, getFirstHeader(md, sentry.SentryTraceHeader), getFirstHeader(md, sentry.SentryBaggageHeader)
return md, getFirstHeader(md, traceHeaderKey), getFirstHeader(md, baggageHeaderKey)
}

func startServerTransaction(ctx context.Context, fullMethod string) (context.Context, *sentry.Hub, *sentry.Span) {
func startServerTransaction(ctx context.Context, fullMethod string, o ServerOptions) (context.Context, *sentry.Hub, *sentry.Span) {
hub := hubFromServerContext(ctx)
md, sentryTraceHeader, sentryBaggageHeader := traceHeadersFromContext(ctx)
md, sentryTraceHeader, sentryBaggageHeader := traceHeadersFromContext(ctx, o.SentryTraceHeaderKey, o.SentryBaggageHeaderKey)
name, service, method := parseGRPCMethod(fullMethod)

setScopeMetadata(hub, name, md)
Expand Down Expand Up @@ -123,7 +139,7 @@ func UnaryServerInterceptor(opts ServerOptions) grpc.UnaryServerInterceptor {
opts.setDefaults()

return func(ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp any, err error) {
ctx, hub, transaction := startServerTransaction(ctx, info.FullMethod)
ctx, hub, transaction := startServerTransaction(ctx, info.FullMethod, opts)
defer transaction.Finish()

defer recoverWithSentry(ctx, hub, opts, func() {
Expand All @@ -142,7 +158,7 @@ func UnaryServerInterceptor(opts ServerOptions) grpc.UnaryServerInterceptor {
func StreamServerInterceptor(opts ServerOptions) grpc.StreamServerInterceptor {
opts.setDefaults()
return func(srv any, ss grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) (err error) {
ctx, hub, transaction := startServerTransaction(ss.Context(), info.FullMethod)
ctx, hub, transaction := startServerTransaction(ss.Context(), info.FullMethod, opts)
defer transaction.Finish()

stream := wrapServerStream(ctx, ss)
Expand Down
Loading