statshouse

Documentation

Index

• Constants
• func Close() error
• func Configure(logf LoggerFunc, statsHouseAddr string, defaultEnv string)
• func ConfigureNetwork(logf LoggerFunc, network string, statsHouseAddr string, defaultEnv string)
• func LexDecode(x int32) float32
• func LexEncode(x float32) int32
• func LexEncodeStr(x float32) string
• func StartRegularMeasurement(f func(*Client)) (id int)
• func StopRegularMeasurement(id int)
• type Client
  • func NewClient(logf LoggerFunc, network string, statsHouseAddr string, defaultEnv string) *Client
  • func (c *Client) Close() error
  • func (c *Client) Metric(metric string, tags Tags) *MetricRef
  • func (c *Client) MetricNamed(metric string, tags NamedTags) *MetricRef
  • func (c *Client) SetEnv(env string)
  • func (c *Client) StartRegularMeasurement(f func(*Client)) (id int)
  • func (c *Client) StopRegularMeasurement(id int)
• type LoggerFunc
• type MetricRef
  • func Metric(metric string, tags Tags) *MetricRef
  • func MetricNamed(metric string, tags NamedTags) *MetricRef
  • func (m *MetricRef) Count(n float64)
  • func (m *MetricRef) StringTop(value string)
  • func (m *MetricRef) StringsTop(values []string)
  • func (m *MetricRef) Unique(value int64)
  • func (m *MetricRef) Uniques(values []int64)
  • func (m *MetricRef) Value(value float64)
  • func (m *MetricRef) Values(values []float64)
• type NamedTags
• type Tags

Constants

const (
	DefaultAddr    = "127.0.0.1:13337"
	DefaultNetwork = "udp"
)

Functions

func Close

func Close() error

Close calls *Client.Close on the global Client. Make sure to call Close during app exit to avoid losing the last batch of metrics.

func Configure

func Configure(logf LoggerFunc, statsHouseAddr string, defaultEnv string)

Configure is expected to be called once during app startup to configure the global Client. Specifying empty StatsHouse address will make the client silently discard all metrics.

func ConfigureNetwork

func ConfigureNetwork(logf LoggerFunc, network string, statsHouseAddr string, defaultEnv string)

network must be either "udp" or "unixgram"

func LexDecode

func LexDecode(x int32) float32

func LexEncode

func LexEncode(x float32) int32

Advanced feature. Encodes float as a raw tag in a special format, used by Statshouse. Ordering of all float values is preserved after encoding. Except all NaNs map to single value which is > +inf, and both zeroes map to 0.

func LexEncodeStr

func LexEncodeStr(x float32) string

func StartRegularMeasurement

func StartRegularMeasurement(f func(*Client)) (id int)

StartRegularMeasurement calls *Client.StartRegularMeasurement on the global Client. It is valid to call StartRegularMeasurement before Configure.

func StopRegularMeasurement

func StopRegularMeasurement(id int)

StopRegularMeasurement calls *Client.StopRegularMeasurement on the global Client. It is valid to call StopRegularMeasurement before Configure.

Types

type Client

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

Client manages metric aggregation and transport to a StatsHouse agent.

func NewClient

func NewClient(logf LoggerFunc, network string, statsHouseAddr string, defaultEnv string) *Client

NewClient creates a new Client to send metrics. Use NewClient only if you are sending metrics to two or more StatsHouse clusters. Otherwise, simply Configure the default global Client.

Specifying empty StatsHouse address will make the client silently discard all metrics. if you get compiler error after updating to recent version of library, pass statshouse.DefaultNetwork to network parameter

func (*Client) Close

func (c *Client) Close() error

Close the Client and flush unsent metrics to the StatsHouse agent. No data will be sent after Close has returned.

func (*Client) Metric

func (c *Client) Metric(metric string, tags Tags) *MetricRef

Metric is the preferred way to access MetricRef to record observations. Metric calls should be encapsulated in helper functions. Direct calls like

statshouse.Metric("packet_size", statshouse.Tags{1: "ok"}).Value(float64(len(pkg)))

should be replaced with calls via higher-level helper functions:

RecordPacketSize(true, len(pkg))

func RecordPacketSize(ok bool, size int) {
    status := "fail"
    if ok {
        status = "ok"
    }
    statshouse.Metric("packet_size", statshouse.Tags{1: status}).Value(float64(size))
}

As an optimization, it is possible to save the result of Metric for later use:

var countPacketOK = statshouse.Metric("foo", statshouse.Tags{1: "ok"})

countPacketOK.Count(1)  // lowest overhead possible

func (*Client) MetricNamed

func (c *Client) MetricNamed(metric string, tags NamedTags) *MetricRef

MetricNamed is similar to *Client.Metric but slightly slower, and allows to specify tags by name.

func (*Client) SetEnv

func (c *Client) SetEnv(env string)

SetEnv changes the default environment associated with Client.

func (*Client) StartRegularMeasurement

func (c *Client) StartRegularMeasurement(f func(*Client)) (id int)

StartRegularMeasurement will call f once per collection interval with no gaps or drift, until StopRegularMeasurement is called with the same ID.

func (*Client) StopRegularMeasurement

func (c *Client) StopRegularMeasurement(id int)

StopRegularMeasurement cancels StartRegularMeasurement with the specified ID.

type LoggerFunc

type LoggerFunc func(format string, args ...interface{})

type MetricRef

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

MetricRef pointer is obtained via *Client.Metric or *Client.MetricNamed and is used to record attributes of observed events.

func Metric

func Metric(metric string, tags Tags) *MetricRef

Metric calls *Client.Metric on the global Client. It is valid to call Metric before Configure.

func MetricNamed

func MetricNamed(metric string, tags NamedTags) *MetricRef

MetricNamed calls *Client.MetricNamed on the global Client. It is valid to call MetricNamed before Configure.

func (*MetricRef) Count

func (m *MetricRef) Count(n float64)

Count records the number of events or observations.

func (*MetricRef) StringTop

func (m *MetricRef) StringTop(value string)

StringTop records the observed value for popularity estimation.

func (*MetricRef) StringsTop

func (m *MetricRef) StringsTop(values []string)

StringsTop records the observed values for popularity estimation.

func (*MetricRef) Unique

func (m *MetricRef) Unique(value int64)

Unique records the observed value for cardinality estimation.

func (*MetricRef) Uniques

func (m *MetricRef) Uniques(values []int64)

Uniques records the observed values for cardinality estimation.

func (*MetricRef) Value

func (m *MetricRef) Value(value float64)

Value records the observed value for distribution estimation.

func (*MetricRef) Values

func (m *MetricRef) Values(values []float64)

Values records the observed values for distribution estimation.

type NamedTags

type NamedTags [][2]string

NamedTags are used to call *Client.MetricNamed.

type Tags

type Tags [maxTags]string

Tags are used to call *Client.Metric.