metrics

Documentation

Index

• Constants
• func Default() nirvana.Configurer
• func Disable() nirvana.Configurer
• func Namespace(ns string) nirvana.Configurer
• func Path(path string) nirvana.Configurer
• type Option
  • func (p *Option) Configure(cfg *nirvana.Config) error
  • func (p *Option) Name() string

Constants

const ExternalConfigName = "metrics"

ExternalConfigName is the external config name of metrics.

Functions

func Default

func Default() nirvana.Configurer

Default Configurer does nothing but ensure default config was set.

func Disable

func Disable() nirvana.Configurer

Disable returns a configurer to disable metrics.

func Namespace

func Namespace(ns string) nirvana.Configurer

Namespace returns a configure to set metrics namespace.

func Path

func Path(path string) nirvana.Configurer

Path returns a configurer to set metrics path.

Types

type Option

type Option struct {
	// Namespace is metrics namespace.
	Namespace string `desc:"Metrics namespace"`
	// Path is metrics path.
	Path string `desc:"Metrics path"`
}

Option contains basic configurations of metrics.

func (*Option) Configure

func (p *Option) Configure(cfg *nirvana.Config) error

Configure configures nirvana config via current options.

func (*Option) Name

func (p *Option) Name() string

Name returns plugin name.