stats

Documentation

Index

• type Prometheus
  • func New(ctx context.Context, opts options.Prometheus) *Prometheus
  • func (p *Prometheus) GetAddress() string
  • func (p *Prometheus) GetName() string
  • func (p *Prometheus) IsEnabled() bool
  • func (p *Prometheus) Register(collectors ...prometheus.Collector) error
  • func (p *Prometheus) Start() error

Types

type Prometheus

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

Prometheus encapsulates the prometheus server configuration.

func New

func New(ctx context.Context, opts options.Prometheus) *Prometheus

New creates a new Prometheus instance with the specified listen address.

func (*Prometheus) GetAddress

func (p *Prometheus) GetAddress() string

GetAddress returns the address on which prometheus server will be listening on

func (*Prometheus) GetName

func (p *Prometheus) GetName() string

GetName returns options service name associated with prometheus server

func (*Prometheus) IsEnabled

func (p *Prometheus) IsEnabled() bool

IsEnabled returns if prometheus server is enabled or not (via configuration)

func (*Prometheus) Register

func (p *Prometheus) Register(collectors ...prometheus.Collector) error

Register registers new prometheus collectors for future use. Can accept one or many collectors.

func (*Prometheus) Start

func (p *Prometheus) Start() error

Start initializes the pprof HTTP server on the configured address.