metrics

Documentation

Index

• func NewCastingOperationFailureCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec
• func NewDecodeRequestStatusCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec
• func NewExtractIdOperationCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec
• func NewGRPCRequestCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec
• func NewGRPCRequestLatencyCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.HistogramVec
• func NewInvalidRequestParametersCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec
• func NewRemoteOperationLatencyCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.HistogramVec
• func NewRemoteOperationStatusCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec
• type CoreMetrics
  • func NewCoreMetrics(engine *core_metrics.CoreMetricsEngine, serviceName string) *CoreMetrics
• type MetricsEngine
  • func NewMetricsEngine(engine *core_metrics.CoreMetricsEngine, serviceName string) *MetricsEngine

Functions

func NewCastingOperationFailureCounter

func NewCastingOperationFailureCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec

NewCastingOperationFailureCounter returns an instance of the casting operation failure counter

func NewDecodeRequestStatusCounter

func NewDecodeRequestStatusCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec

NewDecodeRequestStatusCounter returns an instance of the request status counter

func NewExtractIdOperationCounter

func NewExtractIdOperationCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec

NewExtractIdOperationCounter returns an instance of the status of the extract id operation counter

func NewGRPCRequestCounter

func NewGRPCRequestCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec

NewGRPCRequestCounter returns a counter instance capturing the number of grpd requests

func NewGRPCRequestLatencyCounter

func NewGRPCRequestLatencyCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.HistogramVec

NewGRPCRequestLatencyCounter returns a counter instance capturing the request latency of a grpc operation

func NewInvalidRequestParametersCounter

func NewInvalidRequestParametersCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec

NewInvalidRequestParametersCounter returns an instance of the invalid request parameters counter

func NewRemoteOperationLatencyCounter

func NewRemoteOperationLatencyCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.HistogramVec

NewRemoteOperationLatencyCounter returns an instance of the rpc operation latency counter

func NewRemoteOperationStatusCounter

func NewRemoteOperationStatusCounter(engine *core_metrics.CoreMetricsEngine, serviceName string) *core_metrics.CounterVec

NewRemoteOperationStatusCounter returns an instance of a counter capturing the status of an rpc operation

Types

type CoreMetrics

type CoreMetrics struct {
	ServiceName string
	// tracks the number of grpc requests partitioned by name and status code
	// used for monitoring and alerting (RED method)
	GRPCRequestCounter *core_metrics.CounterVec
	// tracks the latencies associated with a GRPC requests by operation name
	// used for horizontal pod auto-scaling (Kubernetes HPA v2)
	GRPCRequestLatencyCounter *core_metrics.HistogramVec
	// tracks the number of times there was a failure or success when trying to extract id from the request url
	ExtractIdOperationCounter *core_metrics.CounterVec
	// tracks the number of times there was a failure or success when trying to extract id from the request url
	RemoteOperationStatusCounter *core_metrics.CounterVec
	// tracks the latency of various remote operations
	RemoteOperationsLatencyCounter *core_metrics.HistogramVec
	// tracks the number of invalid requests processed by the service
	InvalidRequestParametersCounter *core_metrics.CounterVec
	// tracks the number of failed casting operations captured by the service
	CastingOperationFailureCounter *core_metrics.CounterVec
	// tracks the number of failed request decoding operations for the service
	DecodeRequestStatusCounter *core_metrics.CounterVec
}

func NewCoreMetrics

func NewCoreMetrics(engine *core_metrics.CoreMetricsEngine, serviceName string) *CoreMetrics

NewCoreMetrics returns a pointer reference to a metrics objects encapsulating all registered counters for this service

type MetricsEngine

type MetricsEngine struct {
	MicroServiceMetrics *CoreMetrics
	Engine              *core_metrics.CoreMetricsEngine
}

func NewMetricsEngine

func NewMetricsEngine(engine *core_metrics.CoreMetricsEngine, serviceName string) *MetricsEngine

NewMetricsEngine initializes a new instance of the metrics engins