grpc

Documentation

Index

• Constants
• func AppendCustomErrorHeader(ctx context.Context, errorData interface{}) error
• func AppendHeaders(parent context.Context, headers []string) context.Context
• func LogRequests(ctx context.Context, method string, req, reply interface{}, ...) error
• func LogStream(ctx context.Context, sd *grpc.StreamDesc, conn *grpc.ClientConn, method string, ...) (grpc.ClientStream, error)

Constants

const CustomErrorMetadataKey = "Custom-Error"

CustomErrorMetadataKey is the name of the metadata key storing additional error information. Metadata value is expected to be a byte-encoded JSON object.

const HttpCodeMetadataKey = "X-Http-Code"

HttpCodeMetadataKey is the key to use when setting custom HTTP status codes in gRPC metadata.

Functions

func AppendCustomErrorHeader

func AppendCustomErrorHeader(ctx context.Context, errorData interface{}) error

AppendCustomErrorHeader sets a CustomErrorMetadataKey gRPC header on the passed in context, using the passed in error data as the header's value. The data is serialized as JSON.

func AppendHeaders

func AppendHeaders(parent context.Context, headers []string) context.Context

AppendHeaders parses the provided GRPC headers and attaches them to the provided context.

func LogRequests

func LogRequests(
	ctx context.Context,
	method string, req,
	reply interface{},
	cc *grpc.ClientConn,
	invoker grpc.UnaryInvoker,
	opts ...grpc.CallOption,
) error

LogRequests logs the gRPC backend as well as request duration when the log level is set to debug or higher.

func LogStream

func LogStream(
	ctx context.Context,
	sd *grpc.StreamDesc,
	conn *grpc.ClientConn,
	method string,
	streamer grpc.Streamer,
	opts ...grpc.CallOption,
) (grpc.ClientStream, error)

LogStream prints the method at DEBUG level at the start of the stream.