prometheus

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, server *echo.Server) error
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)
• type Prometheus
  • func NewPrometheus() *Prometheus
  • func NewPrometheusWithConfigPath(path string) (*Prometheus, error)
  • func NewPrometheusWithOptions(options *Options) *Prometheus
  • func (i *Prometheus) Register(ctx context.Context, server *echo.Server) error

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, server *echo.Server) error

Register registers a new prometheus plugin for echo server.

Types

type Options

type Options struct {
	Enabled bool
	Route   string
}

Options prometheus plugin for echo server options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.

type Prometheus

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

Prometheus represents prometheus plugin for echo server.

func NewPrometheus

func NewPrometheus() *Prometheus

NewPrometheus returns a new prometheus plugin with default options.

func NewPrometheusWithConfigPath

func NewPrometheusWithConfigPath(path string) (*Prometheus, error)

NewPrometheusWithConfigPath returns a new prometheus plugin with options from config path.

func NewPrometheusWithOptions

func NewPrometheusWithOptions(options *Options) *Prometheus

NewPrometheusWithOptions returns a new prometheus plugin with options.

func (*Prometheus) Register

func (i *Prometheus) Register(ctx context.Context, server *echo.Server) error

Register registers this prometheus plugin for echo server.