Package metrics

import "github.com/ipfs/go-metrics-interface"

Overview
Index

Overview

Index

Constants
Variables
func Active() bool
func CtxGetScope(ctx context.Context) string
func CtxScope(ctx context.Context, scope string) context.Context
func CtxSubScope(ctx context.Context, subscope string) context.Context
func InjectImpl(newimpl InternalNew) error
type Counter
type Creator
func New(name, helptext string) Creator
func NewCtx(ctx context.Context, name, helptext string) Creator
type Gauge
type Histogram
type InternalNew
type Summary
type SummaryOpts

Package files

context.go ctor.go interface.go noop.go

Constants

const CtxScopeKey = "ipfs.metrics.scope"

Variables

var ErrImplemented = errors.New("there is implemenation already injected")

func Active

func Active() bool

func CtxGetScope

func CtxGetScope(ctx context.Context) string

func CtxScope

func CtxScope(ctx context.Context, scope string) context.Context

func CtxSubScope

func CtxSubScope(ctx context.Context, subscope string) context.Context

func InjectImpl

func InjectImpl(newimpl InternalNew) error

type Counter

Increment only metric

type Counter interface {
    Inc()
    Add(float64) // Only positive
}

type Creator

type Creator interface {
    Counter() Counter
    Gauge() Gauge
    Histogram(buckets []float64) Histogram

    // opts cannot be nil, use empty summary instance
    Summary(opts SummaryOpts) Summary
}

func New

func New(name, helptext string) Creator

name is dot spearated path must be uniqe, use system naming, and unit postfix, examples:

ipfs.blockstore.bloomcache.bloom.miss.total
ipfs.routing.dht.notresuingstream.total

both arguemnts are obligatory

func NewCtx

func NewCtx(ctx context.Context, name, helptext string) Creator

type Gauge

Increse and decrese metric

type Gauge interface {
    Set(float64) // Introduced discontinuity
    Inc()
    Dec()
    Add(float64)
    Sub(float64)
}

type Histogram

type Histogram interface {
    Observe(float64) // Adds observation to Histogram
}

type InternalNew

type InternalNew func(string, string) Creator

type Summary

type Summary interface {
    Observe(float64) // Adds observation to Summary
}

type SummaryOpts

Consult http://godoc.org/github.com/prometheus/client_golang/prometheus#SummaryOpts

type SummaryOpts struct {
    Objectives map[float64]float64
    MaxAge     time.Duration
    AgeBuckets uint32
    BufCap     uint32
}

github.com/ipfs/go-metrics-interface