metric

Documentation

Index

• Variables
• func Handler() http.Handler
• type Config
  • func DefaultConfig(key string) *Config
  • func StdConfig(key string, optionFunc ...OptionFunc) *Config
  • func (c *Config) Build() *Metric
  • func (c *Config) Path() string
• type CounterVec
  • func NewCounterVec(name, help string, labels []string) *CounterVec
• type GaugeVec
  • func NewGaugeVec(name, help string, labels []string) *GaugeVec
• type HistogramVec
  • func NewHistogramVec(name, help string, labels []string, buckets []float64) *HistogramVec
• type Metric
  • func (m *Metric) Handler() http.Handler
  • func (m *Metric) Name() string
  • func (m *Metric) NewCounterVec(name, help string, labels []string) *CounterVec
  • func (m *Metric) NewGaugeVec(name, help string, labels []string) *GaugeVec
  • func (m *Metric) NewHistogramVec(name, help string, labels []string, buckets []float64) *HistogramVec
  • func (m *Metric) NewSummaryVec(name, help string, labels []string, objectives map[float64]float64) *SummaryVec
  • func (m *Metric) Serve(context.Context) error
  • func (m *Metric) Shutdown(context.Context) error
• type OptionFunc
• type SummaryVec
  • func NewSummaryVec(name, help string, labels []string, objectives map[float64]float64) *SummaryVec

Variables

var (
	Default = StdConfig("").Build()
)

Functions

func Handler

func Handler() http.Handler

Handler metrics http

Types

type Config

type Config struct {
	Namespace     string        `config:"namespace"`
	Subsystem     string        `config:"subsystem"`
	PushEnabled   bool          `config:"pushEnabled"`
	PushTargetURL string        `config:"pushTargetURL"`
	PushInterval  time.Duration `config:"pushInterval"`
}

func DefaultConfig

func DefaultConfig(key string) *Config

DefaultConfig is default config.

func StdConfig

func StdConfig(key string, optionFunc ...OptionFunc) *Config

StdConfig load config from config center.

func (*Config) Build

func (c *Config) Build() *Metric

Build a instance.

func (*Config) Path

func (c *Config) Path() string

Path is config path.

type CounterVec

type CounterVec = prometheus.CounterVec

func NewCounterVec

func NewCounterVec(name, help string, labels []string) *CounterVec

NewCounterVec creates a new CounterVec based on the provided CounterOpts and partitioned by the given label names.

type GaugeVec

type GaugeVec = prometheus.GaugeVec

func NewGaugeVec

func NewGaugeVec(name, help string, labels []string) *GaugeVec

NewGaugeVec creates a new GaugeVec based on the provided GaugeOpts and partitioned by the given label names.

type HistogramVec

type HistogramVec = prometheus.HistogramVec

func NewHistogramVec

func NewHistogramVec(name, help string, labels []string, buckets []float64) *HistogramVec

NewHistogramVec creates a new HistogramVec based on the provided HistogramOpts and partitioned by the given label names.

type Metric

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

Metric config

func (*Metric) Handler

func (m *Metric) Handler() http.Handler

Handler metrics http

func (*Metric) Name

func (m *Metric) Name() string

Name config name

func (*Metric) NewCounterVec

func (m *Metric) NewCounterVec(name, help string, labels []string) *CounterVec

NewCounterVec creates a new CounterVec based on the provided CounterOpts and partitioned by the given label names.

func (*Metric) NewGaugeVec

func (m *Metric) NewGaugeVec(name, help string, labels []string) *GaugeVec

NewGaugeVec creates a new GaugeVec based on the provided GaugeOpts and partitioned by the given label names.

func (*Metric) NewHistogramVec

func (m *Metric) NewHistogramVec(name, help string, labels []string, buckets []float64) *HistogramVec

NewHistogramVec creates a new HistogramVec based on the provided HistogramOpts and partitioned by the given label names.

func (*Metric) NewSummaryVec

func (m *Metric) NewSummaryVec(name, help string, labels []string, objectives map[float64]float64) *SummaryVec

NewSummaryVec creates a new SummaryVec based on the provided SummaryOpts and partitioned by the given label names.

func (*Metric) Serve

func (m *Metric) Serve(context.Context) error

Serve start serve

func (*Metric) Shutdown

func (m *Metric) Shutdown(context.Context) error

Shutdown close clients when Shutdown

type OptionFunc

type OptionFunc func(*Config)

OptionFunc is option function.

type SummaryVec

type SummaryVec = prometheus.SummaryVec

func NewSummaryVec

func NewSummaryVec(name, help string, labels []string, objectives map[float64]float64) *SummaryVec

NewSummaryVec creates a new SummaryVec based on the provided SummaryOpts and partitioned by the given label names.