circuitprom

Documentation

Overview

Package circuitprom provides a Prometheus collector for circuit breakers.

Index

• type Observer
  • func NewObserver(options ...Option) Observer
• type Option
  • func WithConstLabels(labels prometheus.Labels) Option
  • func WithNamespace(namespace string) Option

Types

type Observer

type Observer interface {
	circuit.Observer
	prometheus.Collector
}

An Observer is a Prometheus collector for a circuit breaker.

func NewObserver

func NewObserver(options ...Option) Observer

NewObserver returns an observer for a circuit breaker with the given options.

type Option

type Option interface {
	// contains filtered or unexported methods
}

An Option provides optional configuration for an Observer.

func WithConstLabels

func WithConstLabels(labels prometheus.Labels) Option

WithConstLabels returns an Option that adds constant labels to all metrics.

func WithNamespace

func WithNamespace(namespace string) Option

WithNamespace returns an Option that sets the namespace for all metrics. The default is empty.