metrics

Documentation

Overview

Package metrics provides helpers for working with the library metrics.

Index

• Constants
• func PrometheusLabels() prometheus.Labels
• type PrometheusMetrics
  • func GetPrometheusMetrics(instance string, source Source) *PrometheusMetrics
  • func (pm *PrometheusMetrics) IncTokenIntrospectionsTotal(status string)
  • func (pm *PrometheusMetrics) MustCurryWith(labels prometheus.Labels) *PrometheusMetrics
  • func (pm *PrometheusMetrics) MustRegister()
  • func (pm *PrometheusMetrics) ObserveGRPCClientRequest(method string, code grpccodes.Code, elapsed time.Duration)
  • func (pm *PrometheusMetrics) ObserveHTTPClientRequest(method string, targetURL string, statusCode int, elapsed time.Duration, ...)
  • func (pm *PrometheusMetrics) Unregister()
• type Source

Constants

const (
	PrometheusLibInstanceLabel = "lib_instance"
	PrometheusLibSourceLabel   = "lib_source"
)

const (
	HTTPClientRequestLabelMethod     = "method"
	HTTPClientRequestLabelURL        = "url"
	HTTPClientRequestLabelStatusCode = "status_code"
	HTTPClientRequestLabelError      = "error"

	GRPCClientRequestLabelMethod = "grpc_method"
	GRPCClientRequestLabelCode   = "grpc_code"

	TokenIntrospectionLabelStatus = "status"
)

const (
	HTTPRequestErrorDo                   = "do_request_error"
	HTTPRequestErrorDecodeBody           = "decode_body_error"
	HTTPRequestErrorUnexpectedStatusCode = "unexpected_status_code"

	TokenIntrospectionStatusActive            = "active"
	TokenIntrospectionStatusNotActive         = "not_active"
	TokenIntrospectionStatusNotNeeded         = "not_needed"
	TokenIntrospectionStatusNotIntrospectable = "not_introspectable"
	TokenIntrospectionStatusInvalidClaims     = "invalid_claims"
	TokenIntrospectionStatusError             = "error"
)

const DefaultPrometheusLibInstanceLabel = "default"

const PrometheusNamespace = "go_authkit"

Functions

func PrometheusLabels

func PrometheusLabels() prometheus.Labels

Types

type PrometheusMetrics

type PrometheusMetrics struct {
	HTTPClientRequestDuration *prometheus.HistogramVec
	GRPCClientRequestDuration *prometheus.HistogramVec
	TokenIntrospectionsTotal  *prometheus.CounterVec
	TokenClaimsCache          *lrucache.PrometheusMetrics
	TokenNegativeCache        *lrucache.PrometheusMetrics
	EndpointDiscoveryCache    *lrucache.PrometheusMetrics
}

PrometheusMetrics represents the collector of metrics.

func GetPrometheusMetrics

func GetPrometheusMetrics(instance string, source Source) *PrometheusMetrics

func (*PrometheusMetrics) IncTokenIntrospectionsTotal

func (pm *PrometheusMetrics) IncTokenIntrospectionsTotal(status string)

func (*PrometheusMetrics) MustCurryWith

func (pm *PrometheusMetrics) MustCurryWith(labels prometheus.Labels) *PrometheusMetrics

MustCurryWith curries the metrics collector with the provided labels.

func (*PrometheusMetrics) MustRegister

func (pm *PrometheusMetrics) MustRegister()

MustRegister does registration of metrics collector in Prometheus and panics if any error occurs.

func (*PrometheusMetrics) ObserveGRPCClientRequest

func (pm *PrometheusMetrics) ObserveGRPCClientRequest(
	method string, code grpccodes.Code, elapsed time.Duration,
)

func (*PrometheusMetrics) ObserveHTTPClientRequest

func (pm *PrometheusMetrics) ObserveHTTPClientRequest(
	method string, targetURL string, statusCode int, elapsed time.Duration, errorType string,
)

func (*PrometheusMetrics) Unregister

func (pm *PrometheusMetrics) Unregister()

Unregister cancels registration of metrics collector in Prometheus.

type Source

type Source string

const (
	SourceJWKSClient        Source = "jwks_client"
	SourceJWTParser         Source = "jwt_parser"
	SourceGRPCClient        Source = "grpc_client"
	SourceTokenIntrospector Source = "token_introspector"
	SourceTokenProvider     Source = "token_provider"
	SourceHTTPMiddleware    Source = "http_middleware"
)