mapsink

README

go-metrics-map

Simple map-based store for go-metrics

Documentation

Overview

Package mapsink provides a simple map-based sink for go-metrics. It does not support intervals, only totals since creation.

Index

• type MapSink
  • func New() *MapSink
  • func (s *MapSink) AddSample(key []string, val float32)
  • func (s *MapSink) EmitKey(key []string, val float32)
  • func (s *MapSink) FlattenKey(parts []string) string
  • func (s *MapSink) Get(key string) (float32, bool)
  • func (s *MapSink) IncrCounter(key []string, val float32)
  • func (s *MapSink) MarshalJSON() ([]byte, error)
  • func (s *MapSink) SetGauge(key []string, val float32)

Types

type MapSink

type MapSink struct {
	sync.RWMutex
	Data map[string]float32
}

MapSink is a simple sink that stores metrics in a map.

func New

func New() *MapSink

New initializes a new MapSink

func (*MapSink) AddSample

func (s *MapSink) AddSample(key []string, val float32)

AddSample just adds the sampls to all other samples. It acts like a counter in that regard.

func (*MapSink) EmitKey

func (s *MapSink) EmitKey(key []string, val float32)

EmitKey sets the flattend key to the value.

func (*MapSink) FlattenKey

func (s *MapSink) FlattenKey(parts []string) string

FlattenKey flattens the key for formatting, removes spaces

func (*MapSink) Get

func (s *MapSink) Get(key string) (float32, bool)

Get retrieves a single value.

func (*MapSink) IncrCounter

func (s *MapSink) IncrCounter(key []string, val float32)

IncrCounter increments the flattened key by val. If the key does not currently, exist then it is set to val

func (*MapSink) MarshalJSON

func (s *MapSink) MarshalJSON() ([]byte, error)

MarshalJSON marshals the sinks data into json

func (*MapSink) SetGauge

func (s *MapSink) SetGauge(key []string, val float32)

SetGauge sets the flattend key to the value.