telemetry

Documentation

Overview

Package telemetry contains metrics and tracing constructs

Index

• func HTTPStatsHandler(getInstallationID func() string, service string) func(next http.Handler) http.Handler
• func HTTPStatsRoundTripper(getInstallationID func() string, service string) func(next http.RoundTripper) http.RoundTripper
• func NewGRPCServerStatsHandler(service string) grpcstats.Handler
• func ServiceName(service string) string
• type GRPCClientStatsHandler
  • func NewGRPCClientStatsHandler(service string) *GRPCClientStatsHandler
• type GRPCServerStatsHandler
  • func (h *GRPCServerStatsHandler) TagRPC(ctx context.Context, tagInfo *grpcstats.RPCTagInfo) context.Context

Functions

func HTTPStatsHandler

func HTTPStatsHandler(getInstallationID func() string, service string) func(next http.Handler) http.Handler

HTTPStatsHandler creates tracing and metrics Handler for a pomerium service

func HTTPStatsRoundTripper

func HTTPStatsRoundTripper(getInstallationID func() string, service string) func(next http.RoundTripper) http.RoundTripper

HTTPStatsRoundTripper creates tracing and metrics RoundTripper for a pomerium service

func NewGRPCServerStatsHandler

func NewGRPCServerStatsHandler(service string) grpcstats.Handler

NewGRPCServerStatsHandler creates a new GRPCServerStatsHandler for a pomerium service

func ServiceName

func ServiceName(service string) string

ServiceName turns a pomerium service option into the appropriate external label for telemetry purposes

Ex: service 'all' -> 'pomerium' service 'proxy' -> 'pomerium-proxy'

Types

type GRPCClientStatsHandler

type GRPCClientStatsHandler struct {
	UnaryInterceptor grpc.UnaryClientInterceptor
	// TODO: we should have a streaming interceptor too
	grpcstats.Handler
}

GRPCClientStatsHandler provides DialOptions for grpc clients to instrument network calls with both metrics and tracing

func NewGRPCClientStatsHandler

func NewGRPCClientStatsHandler(service string) *GRPCClientStatsHandler

NewGRPCClientStatsHandler returns a new GRPCClientStatsHandler used to create telemetry related client DialOptions

type GRPCServerStatsHandler

type GRPCServerStatsHandler struct {
	grpcstats.Handler
	// contains filtered or unexported fields
}

GRPCServerStatsHandler provides a grpc stats.Handler for metrics and tracing for a pomerium service

func (*GRPCServerStatsHandler) TagRPC

func (h *GRPCServerStatsHandler) TagRPC(ctx context.Context, tagInfo *grpcstats.RPCTagInfo) context.Context

TagRPC implements grpc.stats.Handler and adds metrics and tracing metadata to the context of a given RPC