metrics

Documentation

Index

• Constants
• func MustRegister(name string, collector prometheus.Collector, opts ...RegisterOption)
• func Register(name string, collector prometheus.Collector, opts ...RegisterOption) error
• type Collector
  • func NewCollector(name string, collector prometheus.Collector, options ...CollectorOption) *Collector
  • func (c *Collector) Collect(ch chan<- prometheus.Metric)
  • func (c *Collector) Describe(ch chan<- *prometheus.Desc)
  • func (c *Collector) Enable(state bool)
  • func (c *Collector) Matches(glob string) bool
  • func (c *Collector) Name() string
  • func (c *Collector) Poll()
  • func (c *Collector) Polled(state bool)
• type CollectorOption
  • func WithPolled() CollectorOption
  • func WithoutNamespace() CollectorOption
  • func WithoutSubsystem() CollectorOption
• type Gatherer
  • func NewGatherer(opts ...GathererOption) (*Gatherer, error)
  • func (g *Gatherer) Block()
  • func (g *Gatherer) Gather() ([]*model.MetricFamily, error)
  • func (g *Gatherer) Poll()
  • func (g *Gatherer) Stop()
  • func (g *Gatherer) Unblock()
• type GathererOption
  • func WithMetrics(enabled, polled []string) GathererOption
  • func WithNamespace(namespace string) GathererOption
  • func WithPollInterval(interval time.Duration) GathererOption
  • func WithoutPolling() GathererOption
• type Group
  • func (g *Group) Collect(ch chan<- prometheus.Metric)
  • func (g *Group) Describe(ch chan<- *prometheus.Desc)
• type RegisterOption
  • func WithCollectorOptions(opts ...CollectorOption) RegisterOption
  • func WithGroup(name string) RegisterOption
• type RegisterOptions
• type Registry
  • func Default() *Registry
  • func NewRegistry() *Registry
  • func (r *Registry) Configure(enabled []string, polled []string) (State, error)
  • func (r *Registry) Gatherer(opts ...GathererOption) (*Gatherer, error)
  • func (r *Registry) NewGatherer(opts ...GathererOption) (*Gatherer, error)
  • func (r *Registry) Poll()
  • func (r *Registry) Register(name string, collector prometheus.Collector, opts ...RegisterOption) error
  • func (r *Registry) State() State
• type State
  • func (s State) IsEnabled() bool
  • func (s State) IsPolled() bool
  • func (s State) NeedsNamespace() bool
  • func (s State) NeedsSubsystem() bool
  • func (s State) String() string

Constants

const (
	// MinPollInterval is the most frequent allowed polling interval.
	MinPollInterval = 5 * time.Second
	// DefaultPollInterval is the default interval for polling collectors.
	DefaultPollInterval = 30 * time.Second
)

Functions

func MustRegister

func MustRegister(name string, collector prometheus.Collector, opts ...RegisterOption)

MustRegister registers a collector with the default registry, panicking on error.

func Register

func Register(name string, collector prometheus.Collector, opts ...RegisterOption) error

Register registers a collector with the default registry.

Types

type Collector

type Collector struct {
	State
	// contains filtered or unexported fields
}

Collector is a registered prometheus.Collector.

func NewCollector

func NewCollector(name string, collector prometheus.Collector, options ...CollectorOption) *Collector

NewCollector creates a new collector with the given name and collector.

func (*Collector) Collect

func (c *Collector) Collect(ch chan<- prometheus.Metric)

Collect implements the prometheus.Collector interface.

func (*Collector) Describe

func (c *Collector) Describe(ch chan<- *prometheus.Desc)

Describe implements the prometheus.Collector interface.

func (*Collector) Enable

func (c *Collector) Enable(state bool)

Enable enables or disables the collector.

func (*Collector) Matches

func (c *Collector) Matches(glob string) bool

Matches returns true if the collector matches the given glob pattern.

func (*Collector) Name

func (c *Collector) Name() string

Name returns the name of the collector.

func (*Collector) Poll

func (c *Collector) Poll()

Poll collects metrics from the collector if it is polled.

func (*Collector) Polled

func (c *Collector) Polled(state bool)

Polled marks the collector polled or non-polled.

type CollectorOption

type CollectorOption func(*Collector)

CollectorOption is an option for a Collector.

func WithPolled

func WithPolled() CollectorOption

WithPolled is an option to mark a collector polled.

func WithoutNamespace

func WithoutNamespace() CollectorOption

WithoutNamespace is an option to disable namespace prefixing for a collector.

func WithoutSubsystem

func WithoutSubsystem() CollectorOption

WithoutSubsystem is an option to disable group prefixing for a collector.

type Gatherer

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

Gatherer is a prometheus gatherer for our registry.

func NewGatherer

func NewGatherer(opts ...GathererOption) (*Gatherer, error)

NewGatherer creates a new gatherer for the default registry, with the given options.

func (*Gatherer) Block

func (g *Gatherer) Block()

Block the gatherer from polling collectors.

func (*Gatherer) Gather

func (g *Gatherer) Gather() ([]*model.MetricFamily, error)

Gather implements the prometheus.Gatherer interface.

func (*Gatherer) Poll

func (g *Gatherer) Poll()

Poll all enabled collectors in poll mode in the registry.

func (*Gatherer) Stop

func (g *Gatherer) Stop()

func (*Gatherer) Unblock

func (g *Gatherer) Unblock()

Allow the gatherer to poll collectors.

type GathererOption

type GathererOption func(*Gatherer)

GathererOption is an option for the gatherer.

func WithMetrics

func WithMetrics(enabled, polled []string) GathererOption

WithMetrics defines which groups or collectors will be enabled, and and polled if any.

func WithNamespace

func WithNamespace(namespace string) GathererOption

WithNamespace defines the common namespace prefix for gathered collectors.

func WithPollInterval

func WithPollInterval(interval time.Duration) GathererOption

WithPollInterval defines the polling interval for the gatherer.

func WithoutPolling

func WithoutPolling() GathererOption

WithoutPolling disables internally triggered polling for the gatherer.

type Group

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

Group is a collection of collectors.

func (*Group) Collect

func (g *Group) Collect(ch chan<- prometheus.Metric)

Collect implements the prometheus.Collector interface.

func (*Group) Describe

func (g *Group) Describe(ch chan<- *prometheus.Desc)

Describe implements the prometheus.Collector interface.

type RegisterOption

type RegisterOption func(*RegisterOptions)

RegisterOption is an option for registering collectors.

func WithCollectorOptions

func WithCollectorOptions(opts ...CollectorOption) RegisterOption

WithCollectorOptions is an option to register a collector with options.

func WithGroup

func WithGroup(name string) RegisterOption

WithGroup is an option to register a collector in a specific group.

type RegisterOptions

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

RegisterOptions are options for registering collectors.

type Registry

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

Registry is a collection of groups.

func Default

func Default() *Registry

Default returns the default registry.

func NewRegistry

func NewRegistry() *Registry

NewRegistry creates a new registry.

func (*Registry) Configure

func (r *Registry) Configure(enabled []string, polled []string) (State, error)

Configure enables the collectors matching any of the given globs. Any collector matching any glob in polled is forced to polled mode.

func (*Registry) Gatherer

func (r *Registry) Gatherer(opts ...GathererOption) (*Gatherer, error)

Getherer returns a gatherer for the registry, configured with the given options.

func (*Registry) NewGatherer

func (r *Registry) NewGatherer(opts ...GathererOption) (*Gatherer, error)

NewGatherer creates a new gatherer for the registry, with the given options.

func (*Registry) Poll

func (r *Registry) Poll()

Poll all collectors with are enabled and in polled mode.

func (*Registry) Register

func (r *Registry) Register(name string, collector prometheus.Collector, opts ...RegisterOption) error

Register registers a collector with the registry.

func (*Registry) State

func (r *Registry) State() State

State returns the collective state of all collectors in the registry.

type State

type State int

State represents the configuration of a collector or a group of collectors.

const (
	// Enabled marks a collector as enabled.
	Enabled State = (1 << iota)
	// Polled marks a collector as polled. Polled collectors return cached metrics
	// collected during the last polling cycle. This is useful for computationally
	// expensive metrics that should not be collected during normal collection.
	Polled
	// NamespacePrefix causes a collector's metrics to be prefixed with a common
	// namespace.
	NamespacePrefix
	// SubsystemPrefix causes a collecor's metrics to be prefixed with the name
	// of the group the collector belongs to.
	SubsystemPrefix

	// DefaultName is the name of the default group. An alias for "".
	DefaultName = "default"
)

func (State) IsEnabled

func (s State) IsEnabled() bool

IsEnabled returns true if the collector is enabled.

func (State) IsPolled

func (s State) IsPolled() bool

IsPolled returns true if the collector is polled.

func (State) NeedsNamespace

func (s State) NeedsNamespace() bool

NeedsNamespace returns true if the collector needs a namespace prefix.

func (State) NeedsSubsystem

func (s State) NeedsSubsystem() bool

NeedsSubsystem returns true if the collector needs a group prefix.

func (State) String

func (s State) String() string

String returns a string representation of the collector state.