fxprometheus

Documentation

Index

• func Global() (prometheus.Registerer, prometheus.Gatherer)
• func MakeGlobal(registerer prometheus.Registerer, gatherer prometheus.Gatherer)
• func Module(config ModuleConfig) fx.Option
• func New() (prometheus.Registerer, prometheus.Gatherer)
• func NewWithGlobal() (prometheus.Registerer, prometheus.Gatherer)
• func RegisterCollectors(params CollectorParams) error
• func RegisterDefaultCollectors(registerer prometheus.Registerer) error
• type CollectorParams
• type CollectorResult
• type ModuleConfig

Functions

func Global

func Global() (prometheus.Registerer, prometheus.Gatherer)

Global registers the global instances registerer and gatherer in the container.

func MakeGlobal

func MakeGlobal(registerer prometheus.Registerer, gatherer prometheus.Gatherer)

MakeGlobal registers the global instances registerer and gatherer in the container.

Note: this modifies global state which is generally not a good idea. Make sure you know what you do when using this option.

func Module

func Module(config ModuleConfig) fx.Option

func New

func New() (prometheus.Registerer, prometheus.Gatherer)

New registers new instances of registerer and gatherer in the container.

func NewWithGlobal

func NewWithGlobal() (prometheus.Registerer, prometheus.Gatherer)

NewWithGlobal registers new instances of registerer and gatherer in the container.

It also merges the gatherer instance with the global one.

func RegisterCollectors

func RegisterCollectors(params CollectorParams) error

RegisterCollectors registers collector instances in the registerer.

func RegisterDefaultCollectors

func RegisterDefaultCollectors(registerer prometheus.Registerer) error

RegisterDefaultCollectors registers default metric collectors in a prometheus registerer instance.

Types

type CollectorParams

type CollectorParams struct {
	dig.In

	Registerer prometheus.Registerer
	Collectors []prometheus.Collector `group:"default"`
}

CollectorParams collects registered prometheus collectors.

type CollectorResult

type CollectorResult struct {
	dig.Out

	Collector prometheus.Collector `group:"default"`
}

CollectorResult can be used to provide a Collector attached to the metrics group.

type ModuleConfig

type ModuleConfig struct {
	// Use the global default registerer and gatherer instances.
	UseGlobal bool

	// MakeGlobal makes the registerer and gatherer instances the global default instances.
	//
	// This option can only be used when UseGlobal is false.
	//
	// Note: this modifies global state which is generally not a good idea.
	// Make sure you know what you do when using this option.
	MakeGlobal bool

	// MergeGlobalGatherer causes the global gatherer instance to be merged with a newly created one.
	// This is useful when some third-party libraries use the global gatherer instead of offering an extension point.
	//
	// This option can only be used when UseGlobal is false.
	MergeGlobalGatherer bool

	// RegisterDefaultCollectors registers the default Process and Go collectors in a newly created registerer instance.
	//
	// This option can only be used when UseGlobal is false.
	//
	// Note: Do not use this option with MergeGlobalGatherer because the new and the global gatherer might collide.
	RegisterDefaultCollectors bool
}