metrics

package
v0.6.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 25, 2019 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BasePrinter

type BasePrinter struct {
}

BasePrinter simply logs stats as structured log

func NewBasePrinter

func NewBasePrinter() *BasePrinter

NewBasePrinter returns new base printer struct

func NewCustomPrinter

func NewCustomPrinter(path string) (*BasePrinter, error)

NewCustomPrinter generates log formatter from the provided (as path) Ruby script

func (*BasePrinter) Print

func (*BasePrinter) Print(snapshot map[string]int64)

Print logs stats data using global logger with info level

type Counter

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

Counter stores information about something "countable". Store

func NewCounter

func NewCounter(name string, desc string) *Counter

NewCounter creates new Counter.

func (*Counter) Add

func (c *Counter) Add(n int64) int64

Add adds the given number to the counter and returns the new value.

func (*Counter) Desc

func (c *Counter) Desc() string

Desc returns counter description

func (*Counter) Inc

func (c *Counter) Inc() int64

Inc is equivalent to Add(name, 1)

func (*Counter) IntervalValue

func (c *Counter) IntervalValue() int64

IntervalValue allows to get last interval value for counter.

func (*Counter) Name

func (c *Counter) Name() string

Name returns counter name

func (*Counter) UpdateDelta

func (c *Counter) UpdateDelta()

UpdateDelta updates the delta value for last interval based on current value and previous value.

func (*Counter) Value

func (c *Counter) Value() int64

Value allows to get raw counter value.

type Gauge

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

Gauge stores an int value

func NewGauge

func NewGauge(name string, desc string) *Gauge

NewGauge initializes Gauge.

func (*Gauge) Desc

func (g *Gauge) Desc() string

Desc returns gauge description

func (*Gauge) Name

func (g *Gauge) Name() string

Name returns gauge name

func (*Gauge) Set

func (g *Gauge) Set(value int)

Set gauge value

func (*Gauge) Value

func (g *Gauge) Value() int64

Value returns the current gauge value

type Metrics

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

Metrics stores some useful stats about node

func NewMetrics

func NewMetrics(printer Printer, logIntervalSeconds int) *Metrics

NewMetrics build new metrics struct

func (*Metrics) Counter

func (m *Metrics) Counter(name string) *Counter

Counter returns counter by name

func (*Metrics) EachCounter

func (m *Metrics) EachCounter(f func(c *Counter))

EachCounter applies function f(*Gauge) to each gauge in a set

func (*Metrics) EachGauge

func (m *Metrics) EachGauge(f func(g *Gauge))

EachGauge applies function f(*Gauge) to each gauge in a set

func (*Metrics) Gauge

func (m *Metrics) Gauge(name string) *Gauge

Gauge returns gauge by name

func (*Metrics) IntervalSnapshot

func (m *Metrics) IntervalSnapshot() map[string]int64

IntervalSnapshot returns recorded interval metrics snapshot

func (*Metrics) Prometheus

func (m *Metrics) Prometheus() string

Prometheus returns metrics info in Prometheus format

func (*Metrics) PrometheusHandler

func (m *Metrics) PrometheusHandler(w http.ResponseWriter, r *http.Request)

PrometheusHandler is provide metrics to the world

func (*Metrics) RegisterCounter

func (m *Metrics) RegisterCounter(name string, desc string)

RegisterCounter adds new counter to the registry

func (*Metrics) RegisterGauge

func (m *Metrics) RegisterGauge(name string, desc string)

RegisterGauge adds new counter to the registry

func (*Metrics) Run

func (m *Metrics) Run()

Run periodically updates counters delta (and logs metrics if necessary)

func (*Metrics) Shutdown

func (m *Metrics) Shutdown()

Shutdown stops metrics updates

type Printer

type Printer interface {
	Print(snapshot map[string]int64)
}

Printer describes metrics logging interface

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL