This repository has been archived by the owner on Apr 18, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support non-default default Prometheus registry (#20)
* make server metrics registerable to custom registry * make client metrics registerable to custom registry
- Loading branch information
Showing
7 changed files
with
441 additions
and
313 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| package grpc_prometheus | ||
|
|
||
| import ( | ||
| "io" | ||
|
|
||
| prom "github.com/prometheus/client_golang/prometheus" | ||
| "golang.org/x/net/context" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/codes" | ||
| ) | ||
|
|
||
| // ClientMetrics represents a collection of metrics to be registered on a | ||
| // Prometheus metrics registry for a gRPC client. | ||
| type ClientMetrics struct { | ||
| clientStartedCounter *prom.CounterVec | ||
| clientHandledCounter *prom.CounterVec | ||
| clientStreamMsgReceived *prom.CounterVec | ||
| clientStreamMsgSent *prom.CounterVec | ||
| clientHandledHistogramEnabled bool | ||
| clientHandledHistogramOpts prom.HistogramOpts | ||
| clientHandledHistogram *prom.HistogramVec | ||
| } | ||
|
|
||
| // NewClientMetrics returns a ClientMetrics object. Use a new instance of | ||
| // ClientMetrics when not using the default Prometheus metrics registry, for | ||
| // example when wanting to control which metrics are added to a registry as | ||
| // opposed to automatically adding metrics via init functions. | ||
| func NewClientMetrics() *ClientMetrics { | ||
| return &ClientMetrics{ | ||
| clientStartedCounter: prom.NewCounterVec( | ||
| prom.CounterOpts{ | ||
| Name: "grpc_client_started_total", | ||
| Help: "Total number of RPCs started on the client.", | ||
| }, []string{"grpc_type", "grpc_service", "grpc_method"}), | ||
|
|
||
| clientHandledCounter: prom.NewCounterVec( | ||
| prom.CounterOpts{ | ||
| Name: "grpc_client_handled_total", | ||
| Help: "Total number of RPCs completed by the client, regardless of success or failure.", | ||
| }, []string{"grpc_type", "grpc_service", "grpc_method", "grpc_code"}), | ||
|
|
||
| clientStreamMsgReceived: prom.NewCounterVec( | ||
| prom.CounterOpts{ | ||
| Name: "grpc_client_msg_received_total", | ||
| Help: "Total number of RPC stream messages received by the client.", | ||
| }, []string{"grpc_type", "grpc_service", "grpc_method"}), | ||
|
|
||
| clientStreamMsgSent: prom.NewCounterVec( | ||
| prom.CounterOpts{ | ||
| Name: "grpc_client_msg_sent_total", | ||
| Help: "Total number of gRPC stream messages sent by the client.", | ||
| }, []string{"grpc_type", "grpc_service", "grpc_method"}), | ||
|
|
||
| clientHandledHistogramEnabled: false, | ||
| clientHandledHistogramOpts: prom.HistogramOpts{ | ||
| Name: "grpc_client_handling_seconds", | ||
| Help: "Histogram of response latency (seconds) of the gRPC until it is finished by the application.", | ||
| Buckets: prom.DefBuckets, | ||
| }, | ||
| clientHandledHistogram: nil, | ||
| } | ||
| } | ||
|
|
||
| // EnableClientHandlingTimeHistogram turns on recording of handling time of RPCs. | ||
| // Histogram metrics can be very expensive for Prometheus to retain and query. | ||
| func (m *ClientMetrics) EnableClientHandlingTimeHistogram(opts ...HistogramOption) { | ||
| for _, o := range opts { | ||
| o(&m.clientHandledHistogramOpts) | ||
| } | ||
| if !m.clientHandledHistogramEnabled { | ||
| m.clientHandledHistogram = prom.NewHistogramVec( | ||
| m.clientHandledHistogramOpts, | ||
| []string{"grpc_type", "grpc_service", "grpc_method"}, | ||
| ) | ||
| } | ||
| m.clientHandledHistogramEnabled = true | ||
| } | ||
|
|
||
| // UnaryClientInterceptor is a gRPC client-side interceptor that provides Prometheus monitoring for Unary RPCs. | ||
| func (m *ClientMetrics) UnaryClientInterceptor() func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error { | ||
| return func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error { | ||
| monitor := newClientReporter(m, Unary, method) | ||
| monitor.SentMessage() | ||
| err := invoker(ctx, method, req, reply, cc, opts...) | ||
| if err != nil { | ||
| monitor.ReceivedMessage() | ||
| } | ||
| monitor.Handled(grpc.Code(err)) | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // StreamServerInterceptor is a gRPC client-side interceptor that provides Prometheus monitoring for Streaming RPCs. | ||
| func (m *ClientMetrics) StreamClientInterceptor() func(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) { | ||
| return func(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) { | ||
| monitor := newClientReporter(m, clientStreamType(desc), method) | ||
| clientStream, err := streamer(ctx, desc, cc, method, opts...) | ||
| if err != nil { | ||
| monitor.Handled(grpc.Code(err)) | ||
| return nil, err | ||
| } | ||
| return &monitoredClientStream{clientStream, monitor}, nil | ||
| } | ||
| } | ||
|
|
||
| func clientStreamType(desc *grpc.StreamDesc) grpcType { | ||
| if desc.ClientStreams && !desc.ServerStreams { | ||
| return ClientStream | ||
| } else if !desc.ClientStreams && desc.ServerStreams { | ||
| return ServerStream | ||
| } | ||
| return BidiStream | ||
| } | ||
|
|
||
| // monitoredClientStream wraps grpc.ClientStream allowing each Sent/Recv of message to increment counters. | ||
| type monitoredClientStream struct { | ||
| grpc.ClientStream | ||
| monitor *clientReporter | ||
| } | ||
|
|
||
| func (s *monitoredClientStream) SendMsg(m interface{}) error { | ||
| err := s.ClientStream.SendMsg(m) | ||
| if err == nil { | ||
| s.monitor.SentMessage() | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| func (s *monitoredClientStream) RecvMsg(m interface{}) error { | ||
| err := s.ClientStream.RecvMsg(m) | ||
| if err == nil { | ||
| s.monitor.ReceivedMessage() | ||
| } else if err == io.EOF { | ||
| s.monitor.Handled(codes.OK) | ||
| } else { | ||
| s.monitor.Handled(grpc.Code(err)) | ||
| } | ||
| return err | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.