metrics

Documentation

Overview

Package metrics provides metrics support shared among all packages in this Go module:

• the metrics registry
• exporting metrics via HTTP
• common metrics

It does NOT include code that is specific to other packages of this module.

Global State

The API of this packages makes use of global state to get access to instances so that keeping and passing references is not necessary. For non-test use cases this perfectly fits to the global nature of metric support.

For testing it may be required to let SUTs use test doubles instead of the original global instances of this package. This can be achieved by patching the global state of this package during test setup and reverting the patch at test teardown. Be aware that tests patching global state must not run concurrently to other tests to avoid interference. See the Testing type for test support.

Index

• Constants
• func CodeLocation(skip uint16) string
• func Registerer() prometheus.Registerer
• func StartServer(logger logr.Logger, port uint16)
• type RetriesMetric
• type Testing
  • func (Testing) PatchRegistry(replacement *prometheus.Registry) func()

Constants

const (
	// Subsystem is the subsystem name of Steward to be used
	// as part of metric names.
	Subsystem = "steward"
)

Functions

func CodeLocation

func CodeLocation(skip uint16) string

CodeLocation returns a string representation of the caller's code location. `skip` is the number of call stack frames to skip.

func Registerer

func Registerer() prometheus.Registerer

Registerer returns the registerer for metrics that should be exported by the metrics server

func StartServer

func StartServer(logger logr.Logger, port uint16)

StartServer starts the HTTP server providing the metrics for scraping.

Types

type RetriesMetric

type RetriesMetric interface {
	// Observe performs a single observation of a finished retry loop.
	// codeLocation is a string representation of the code location
	// of the retry loop.
	// retryCount is the number of retries performed, where the very
	// first attempt is not counted as retry.
	// latency is the elapsed time from the start of the retry loop
	// until is has been finished.
	Observe(codeLocation string, retryCount uint64, latency time.Duration)
}

RetriesMetric observes finished retried operations.

var (
	// Retries observes finished retried operations.
	Retries RetriesMetric = &retriesMetric{}
)

type Testing

type Testing struct{}

Testing provides utility functions for testing with this package. Do not use it for non-testing purposes!

func (Testing) PatchRegistry

func (Testing) PatchRegistry(replacement *prometheus.Registry) func()

PatchRegistry replaces the internal Prometheus metrics registry with a replacement and returns a function that reverts the patch. Multiple nested replacements must be reverted in exactly the opposite order (revert last replacement first).