requestid

Documentation

Index

• Constants
• func GenerateRequestID() string
• func GetOrGenerateRequestID(ctx context.Context) (string, context.Context)
• func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor
• func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor
• type IDGenerator
• type Option
  • func GenerateIfMissing(enable bool) Option
  • func WithIDGenerator(genFunc IDGenerator) Option

Constants

const RequestIDMetadataKey = "x-request-id"

RequestIDMetadataKey is the key in which request IDs are passed to metadata.

Functions

func GenerateRequestID

func GenerateRequestID() string

GenerateRequestID generates a new request ID.

func GetOrGenerateRequestID

func GetOrGenerateRequestID(ctx context.Context) (string, context.Context)

GetOrGenerateRequestID returns the request ID found in the given context. If not, a new request ID is generated and added to the returned context.

func StreamServerInterceptor

func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor

StreamServerInterceptor returns a new interceptor which handles request IDs according to the provided options.

func UnaryServerInterceptor

func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor

UnaryServerInterceptor returns a new interceptor which handles request IDs according to the provided options.

Types

type IDGenerator

type IDGenerator func() string

IDGenerator functions are used to generate request IDs if a new one is needed.

type Option

type Option func(*handleRequestID)

Option instances control how the middleware is initialized.

func GenerateIfMissing

func GenerateIfMissing(enable bool) Option

GenerateIfMissing will instruct the middleware to create a request ID if one isn't already on the incoming request.

default: false

func WithIDGenerator

func WithIDGenerator(genFunc IDGenerator) Option

WithIDGenerator gives the middleware a function to use for generating requestIDs.

default: 32 character hex string