metrics

Documentation

Overview

Package metrics contains the prometheus infrastructure.

Index

• type CacheReadStatus
• type PullService
  • func NewPullService(pullEndpoint string, rootLogger *log.Logger) (*PullService, error)
  • func (s *PullService) StartInstrumentation()
• type RequestMetrics
  • func NewDefaultRequestMetrics(pkg string) RequestMetrics
  • func (m *RequestMetrics) RequestCounts(endpoint, status string) prometheus.Counter
  • func (m *RequestMetrics) RequestLatencies(endpoint string) *prometheus.Timer
• type StorageMetrics
  • func NewDefaultStorageMetrics(runtime string) StorageMetrics
  • func (m *StorageMetrics) DatabaseLatencies(db string, operation string) *prometheus.Timer
  • func (m *StorageMetrics) DatabaseOperations(db, operation, status string) prometheus.Counter
  • func (m *StorageMetrics) LocalCacheReads(status CacheReadStatus) prometheus.Counter

Types

type CacheReadStatus

type CacheReadStatus string

const (
	CacheReadStatusHit      CacheReadStatus = "hit"
	CacheReadStatusMiss     CacheReadStatus = "miss"
	CacheReadStatusBadValue CacheReadStatus = "bad_value" // Value in cache was not valid (likely because of mismatched types / CBOR encoding).
	CacheReadStatusError    CacheReadStatus = "error"     // Other internal error reading from cache.
)

type PullService

type PullService struct {
	// contains filtered or unexported fields
}

PullService is a service that supports the Prometheus pull method.

func NewPullService

func NewPullService(pullEndpoint string, rootLogger *log.Logger) (*PullService, error)

Creates a new Prometheus pull service.

func (*PullService) StartInstrumentation

func (s *PullService) StartInstrumentation()

StartInstrumentation starts the pull metrics service.

type RequestMetrics

type RequestMetrics struct {
	// contains filtered or unexported fields
}

Default service metrics for requests.

func NewDefaultRequestMetrics

func NewDefaultRequestMetrics(pkg string) RequestMetrics

NewDefaultRequestMetrics creates Prometheus metric instrumentation for basic metrics common to serving requests. Default metrics include:

1. Counts of service endpoints hit. 2. Latencies for requests.

func (*RequestMetrics) RequestCounts

func (m *RequestMetrics) RequestCounts(endpoint, status string) prometheus.Counter

RequestCounts returns the counter for the calling request. Provided labels should be endpoint, status, and cause.

func (*RequestMetrics) RequestLatencies

func (m *RequestMetrics) RequestLatencies(endpoint string) *prometheus.Timer

RequestLatencies creates a new latency timer for the provided request endpoint.

type StorageMetrics

type StorageMetrics struct {
	// contains filtered or unexported fields
}

Default service metrics for database operations.

func NewDefaultStorageMetrics

func NewDefaultStorageMetrics(runtime string) StorageMetrics

NewDefaultStorageMetrics creates Prometheus metric instrumentation for basic metrics common to storage accesses.

func (*StorageMetrics) DatabaseLatencies

func (m *StorageMetrics) DatabaseLatencies(db string, operation string) *prometheus.Timer

DatabaseLatencies returns a new latency timer for the provided database operation. The provided params are used as labels.

func (*StorageMetrics) DatabaseOperations

func (m *StorageMetrics) DatabaseOperations(db, operation, status string) prometheus.Counter

DatabaseOperations returns the counter for the database operation. The provided params are used as labels.

func (*StorageMetrics) LocalCacheReads

func (m *StorageMetrics) LocalCacheReads(status CacheReadStatus) prometheus.Counter

LocalCacheReads returns the counter for the local cache read. The provided params are used as labels.