grpc-ecosystem/grpc-gateway

Support OpenCensus trace propagation

Open

#673 opened on Jun 19, 2018

View on GitHub
 (10 comments) (12 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
enhancementhelp wanted

Description

If not direct support we should have clear documentation on how to pass traces across http<>grpc boundaries.

Contributor guide

Tech stack
go
Domain
apiobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programminggRPC basicsOpenCensus tracing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the 10 comments on the issue for suggested approaches or workarounds. The grpc gateway project generates gRPC to JSON proxies; to support OpenCensus trace propagation across HTTP/gRPC boundaries, you would likely need to add middleware or interceptors that extract/inject trace context. Check if there are existing tracing integrations in the codebase, e.g., in the 'runtime' package. Also, consider that the repository now may prefer OpenTelemetry over OpenCensus. If implementing, follow the OpenCensus Go propagation format. Alternatively, if the community decided on a documentation only fix, write clear instructions with code examples on how to manually propagate traces.