metrics

Documentation

Overview

Package contains the collection of prometheus meters/counters and related update methods

Index

• Variables
• type Middleware
  • func NewMiddleware(prom *PrometheusRepository, name string) *Middleware
  • func (m *Middleware) CollapsePaths(flag bool) *Middleware
  • func (m *Middleware) ExcludePaths(paths ...string) *Middleware
  • func (m *Middleware) HidePaths(flag bool) *Middleware
  • func (m *Middleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• type PrometheusRepository
  • func NewConfigurablePrometheusRepository(d driver.Driver, logger *logrusx.Logger) *PrometheusRepository
  • func NewPrometheusRepository(logger *logrusx.Logger) *PrometheusRepository
  • func (r *PrometheusRepository) RequestDurationObserve(service, request, method string, statusCode int) func(float64)
  • func (r *PrometheusRepository) UpdateRequest(service, request, method string, statusCode int)
• type RequestDurationObserve
• type UpdateRequest

Variables

var (
	// RequestTotal provides the total number of requests
	RequestTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "ory_oathkeeper_requests_total",
			Help: "Total number of requests",
		},
		[]string{"service", "method", "request", "status_code"},
	)
	// HistogramRequestDuration provides the duration of requests
	HistogramRequestDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "ory_oathkeeper_requests_duration_seconds",
			Help:    "Time spent serving requests.",
			Buckets: prometheus.DefBuckets,
		},
		[]string{"service", "method", "request", "status_code"},
	)
)

Types

type Middleware

type Middleware struct {
	// Name is the name of the application as recorded in latency metrics
	Name string
	// Prometheus repository
	Prometheus *PrometheusRepository
	// contains filtered or unexported fields
}

Middleware is a middleware handler that logs the request as it goes in and the response as it goes out.

func NewMiddleware

func NewMiddleware(prom *PrometheusRepository, name string) *Middleware

NewMiddleware returns a new *Middleware, yay!

func (*Middleware) CollapsePaths

func (m *Middleware) CollapsePaths(flag bool) *Middleware

CollapsePaths if set to true, forces the value of the "request" label of the prometheus request metrics to be collapsed to the first context path segment only. eg. (when set to true):

• /decisions/service/my-service -> /decisions
• /decisions -> /decisions

func (*Middleware) ExcludePaths

func (m *Middleware) ExcludePaths(paths ...string) *Middleware

ExcludePaths adds new URL paths to be ignored during logging. The URL u is parsed, hence the returned error

func (*Middleware) HidePaths

func (m *Middleware) HidePaths(flag bool) *Middleware

func (*Middleware) ServeHTTP

func (m *Middleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

type PrometheusRepository

type PrometheusRepository struct {
	Registry *prometheus.Registry
	// contains filtered or unexported fields
}

PrometheusRepository provides methods to manage prometheus metrics

func NewConfigurablePrometheusRepository

func NewConfigurablePrometheusRepository(d driver.Driver, logger *logrusx.Logger) *PrometheusRepository

NewConfigurablePrometheusRepository creates a new prometheus repository with the given settings

func NewPrometheusRepository

func NewPrometheusRepository(logger *logrusx.Logger) *PrometheusRepository

NewPrometheusRepository creates a new prometheus repository

func (*PrometheusRepository) RequestDurationObserve

func (r *PrometheusRepository) RequestDurationObserve(service, request, method string, statusCode int) func(float64)

RequestDurationObserve tracks request durations

func (*PrometheusRepository) UpdateRequest

func (r *PrometheusRepository) UpdateRequest(service, request, method string, statusCode int)

UpdateRequest tracks total requests done

type RequestDurationObserve

type RequestDurationObserve func(histogram *prometheus.HistogramVec, service, request, method string, statusCode int) func(float64)

RequestDurationObserve tracks request durations

type UpdateRequest

type UpdateRequest func(counter *prometheus.CounterVec, service, request, method string, statusCode int)

UpdateRequest tracks total requests done