rkgrpcctx

Documentation

Overview

Package rkgrpcctx provides utility functions deal with metadata in RPC context

Index

• Constants
• func AddHeaderToClient(ctx context.Context, key, value string)
• func AddHeaderToServer(ctx context.Context, key, value string)
• func EndTraceSpan(ctx context.Context, span trace.Span, success bool)
• func FinishClientStream(ctx context.Context, stream grpc.ClientStream)
• func GetEntryName(ctx context.Context) string
• func GetError(ctx context.Context) error
• func GetEvent(ctx context.Context) rkquery.Event
• func GetIncomingHeaders(ctx context.Context) metadata.MD
• func GetLogger(ctx context.Context) *zap.Logger
• func GetMethodName(ctx context.Context) string
• func GetRequestId(ctx context.Context) string
• func GetRpcType(ctx context.Context) string
• func GetTraceId(ctx context.Context) string
• func GetTraceSpan(ctx context.Context) trace.Span
• func GetTracer(ctx context.Context) trace.Tracer
• func GetTracerPropagator(ctx context.Context) propagation.TextMapPropagator
• func GetTracerProvider(ctx context.Context) trace.TracerProvider
• func InjectSpanToHttpRequest(ctx context.Context, req *http.Request)
• func InjectSpanToNewContext(ctx context.Context) context.Context
• func NewTraceSpan(ctx context.Context, name string) trace.Span
• func WrapContext(ctx context.Context) context.Context
• type GrpcMetadataCarrier
  • func (carrier *GrpcMetadataCarrier) Get(key string) string
  • func (carrier *GrpcMetadataCarrier) Keys() []string
  • func (carrier *GrpcMetadataCarrier) Set(key string, value string)
• type WrappedServerStream
  • func WrapServerStream(stream grpc.ServerStream) *WrappedServerStream
  • func (w *WrappedServerStream) Context() context.Context

Constants

const (
	// RequestIdKey request id key in response header
	RequestIdKey = "X-Request-Id"
	// TraceIdKey trace id key in response header
	TraceIdKey = "X-Trace-Id"
)

Functions

func AddHeaderToClient

func AddHeaderToClient(ctx context.Context, key, value string)

AddHeaderToClient Headers that would be sent to client.

func AddHeaderToServer

func AddHeaderToServer(ctx context.Context, key, value string)

AddHeaderToServer Headers that would be sent to server.

func EndTraceSpan

func EndTraceSpan(ctx context.Context, span trace.Span, success bool)

EndTraceSpan End span

func FinishClientStream

func FinishClientStream(ctx context.Context, stream grpc.ClientStream)

FinishClientStream This function is mainly used for client stream.

Streaming client is a little bit tricky. It is not an easy work to get headers sent from server while receiving message since client stream interceptor will finish before client start receiving message.

As a result, what event will log is the time before Recv() start to be called. No request id nor trace id would be logged since we are unable to call stream.Header() function which would be blocked until stream.Recv() has been called.

We believe it is not a good idea to wrap client stream or do anything tricky with stream.

If user hope to log request id and trace id into event, user need to call bellow function as soon as stream.Header() is ready. The downside is you will get multiple event logs with same event id.

func GetEntryName

func GetEntryName(ctx context.Context) string

GetEntryName Extract the call-scoped entry name.

func GetError

func GetError(ctx context.Context) error

GetError Extract the call-scoped error.

func GetEvent

func GetEvent(ctx context.Context) rkquery.Event

GetEvent Extract the call-scoped EventData from context.

func GetIncomingHeaders

func GetIncomingHeaders(ctx context.Context) metadata.MD

GetIncomingHeaders Extract call-scoped incoming headers

func GetLogger

func GetLogger(ctx context.Context) *zap.Logger

GetLogger Extract the call-scoped zap logger from context.

func GetMethodName

func GetMethodName(ctx context.Context) string

GetMethodName Extract the call-scoped method name.

func GetRequestId

func GetRequestId(ctx context.Context) string

GetRequestId Get request id in outgoing metadata.

func GetRpcType

func GetRpcType(ctx context.Context) string

GetRpcType Extract the call-scoped rpc type.

func GetTraceId

func GetTraceId(ctx context.Context) string

GetTraceId Get trace id in context.

func GetTraceSpan

func GetTraceSpan(ctx context.Context) trace.Span

GetTraceSpan Extract the call-scoped span from context.

func GetTracer

func GetTracer(ctx context.Context) trace.Tracer

GetTracer Extract the call-scoped tracer from context.

func GetTracerPropagator

func GetTracerPropagator(ctx context.Context) propagation.TextMapPropagator

GetTracerPropagator Extract the call-scoped span processor from middleware.

func GetTracerProvider

func GetTracerProvider(ctx context.Context) trace.TracerProvider

GetTracerProvider Extract the call-scoped tracer provider from context.

func InjectSpanToHttpRequest

func InjectSpanToHttpRequest(ctx context.Context, req *http.Request)

InjectSpanToHttpRequest Inject current trace information into http request

func InjectSpanToNewContext

func InjectSpanToNewContext(ctx context.Context) context.Context

InjectSpanToNewContext Inject current trace information into context

func NewTraceSpan

func NewTraceSpan(ctx context.Context, name string) trace.Span

NewTraceSpan Start a new span

func WrapContext

func WrapContext(ctx context.Context) context.Context

WrapContext We will add payload into context for further usage. Used for client side only.

Types

type GrpcMetadataCarrier

type GrpcMetadataCarrier struct {
	Md *metadata.MD
}

GrpcMetadataCarrier Grpc metadata carrier which will carries tracing info into grpc metadata to server side.

func (*GrpcMetadataCarrier) Get

func (carrier *GrpcMetadataCarrier) Get(key string) string

Get value with key from grpc metadata.

func (*GrpcMetadataCarrier) Keys

func (carrier *GrpcMetadataCarrier) Keys() []string

Keys List keys in grpc metadata.

func (*GrpcMetadataCarrier) Set

func (carrier *GrpcMetadataCarrier) Set(key string, value string)

Set value with key into grpc metadata.

type WrappedServerStream

type WrappedServerStream struct {
	grpc.ServerStream
	// WrappedContext is the wrapper's own Context. You can assign it.
	WrappedContext context.Context
}

WrappedServerStream is a thin wrapper around grpc.ServerStream that allows modifying context.

func WrapServerStream

func WrapServerStream(stream grpc.ServerStream) *WrappedServerStream

WrapServerStream returns a ServerStream that has the ability to overwrite context.

func (*WrappedServerStream) Context

func (w *WrappedServerStream) Context() context.Context

Context returns the wrapper's WrappedContext, overwriting the nested grpc.ServerStream.Context()