prometheus

Documentation

Overview

Package prometheus provides a module which collects metrics and exposes them via an HTTP route.

See: https://prometheus.io/.

Index

• type Prometheus
  • func (mod *Prometheus) Descriptor() gotenberg.ModuleDescriptor
  • func (mod *Prometheus) Provision(ctx *gotenberg.Context) error
  • func (mod *Prometheus) Routes() ([]api.Route, error)
  • func (mod *Prometheus) Start() error
  • func (mod *Prometheus) StartupMessage() string
  • func (mod *Prometheus) Stop(ctx context.Context) error
  • func (mod *Prometheus) Validate() error

Types

type Prometheus

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

Prometheus is a module which collects metrics and exposes them via an HTTP route.

func (*Prometheus) Descriptor

func (mod *Prometheus) Descriptor() gotenberg.ModuleDescriptor

Descriptor returns a Prometheus's module descriptor.

func (*Prometheus) Provision

func (mod *Prometheus) Provision(ctx *gotenberg.Context) error

Provision sets the modules properties.

func (*Prometheus) Routes

func (mod *Prometheus) Routes() ([]api.Route, error)

Routes returns the HTTP route.

func (*Prometheus) Start

func (mod *Prometheus) Start() error

Start starts the collect.

func (*Prometheus) StartupMessage

func (mod *Prometheus) StartupMessage() string

StartupMessage returns a custom startup message.

func (*Prometheus) Stop

func (mod *Prometheus) Stop(ctx context.Context) error

Stop does nothing.

func (*Prometheus) Validate

func (mod *Prometheus) Validate() error

Validate validates the module properties.