Documentation
¶
Overview ¶
Package metrics - Create a type for aggregating and propagating metrics to various services based on configuration. Use it like this:
``` go conf := metrics.NewConfig() conf.Type = "http_server"
met, err := metrics.New(conf)
if err != nil {
panic(err)
}
met.Incr("path.to.metric", 1) ```
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrInvalidMetricOutputType = errors.New("invalid metrics output type")
)
Errors for the metrics package.
var (
ErrTimedOut = errors.New("timed out")
)
Errors for the HTTP type.
Functions ¶
func Descriptions ¶
func Descriptions() string
Descriptions - Returns a formatted string of collated descriptions of each type.
Types ¶
type Config ¶
type Config struct {
Type string `json:"type" yaml:"type"`
HTTP HTTPConfig `json:"http_server" yaml:"http_server"`
Riemann RiemannConfig `json:"riemann" yaml:"riemann"`
Statsd StatsdConfig `json:"statsd" yaml:"statsd"`
}
Config - The all encompassing configuration struct for all metric output types.
type DudType ¶
type DudType struct{}
DudType - Implements the Type interface but doesn't actual do anything.
type HTTP ¶
HTTP - A stats object with capability to hold internal stats as a JSON endpoint.
func (*HTTP) Close ¶
Close - Stops the HTTP object from aggregating metrics and cleans up resources.
func (*HTTP) JSONHandler ¶
func (h *HTTP) JSONHandler() http.HandlerFunc
JSONHandler - Returns a handler for accessing metrics as a JSON blob.
type HTTPConfig ¶
type HTTPConfig struct {
Prefix string `json:"stats_prefix" yaml:"stats_prefix"`
Address string `json:"address" yaml:"address"`
Path string `json:"path" yaml:"path"`
}
HTTPConfig - Config for the HTTP metrics type.
func NewHTTPConfig ¶
func NewHTTPConfig() HTTPConfig
NewHTTPConfig - Creates an HTTPConfig struct with default values.
type Riemann ¶
Riemann - A Riemann client that supports the Type interface.
type RiemannConfig ¶
type RiemannConfig struct {
Server string `json:"server" yaml:"server"`
TTL float32 `json:"ttl" yaml:"ttl"`
Tags []string `json:"tags" yaml:"tags"`
FlushInterval string `json:"flush_interval" yaml:"flush_interval"`
Prefix string `json:"prefix" yaml:"prefix"`
}
RiemannConfig - Configuration fields for a riemann service.
func NewRiemannConfig ¶
func NewRiemannConfig() RiemannConfig
NewRiemannConfig - Create a new riemann config with default values.
type Statsd ¶
type Statsd struct {
// contains filtered or unexported fields
}
Statsd - A stats object with capability to hold internal stats as a JSON endpoint.
func (*Statsd) Close ¶
Close - Stops the Statsd object from aggregating metrics and cleans up resources.
type StatsdConfig ¶
type StatsdConfig struct {
Address string `json:"address" yaml:"address"`
FlushPeriod string `json:"flush_period" yaml:"flush_period"`
MaxPacketSize int `json:"max_packet_size" yaml:"max_packet_size"`
Network string `json:"network" yaml:"network"`
Prefix string `json:"prefix" yaml:"prefix"`
}
StatsdConfig - Config for the Statsd metrics type.
func NewStatsdConfig ¶
func NewStatsdConfig() StatsdConfig
NewStatsdConfig - Creates an StatsdConfig struct with default values.
type Type ¶
type Type interface {
// Incr - Increment a metric by an amount.
Incr(path string, count int64) error
// Decr - Decrement a metric by an amount.
Decr(path string, count int64) error
// Timing - Set a timing metric.
Timing(path string, delta int64) error
// Gauge - Set a gauge metric.
Gauge(path string, value int64) error
// Close - Stop aggregating stats and clean up resources.
Close() error
}
Type - An interface for metrics aggregation.
func NewRiemann ¶
NewRiemann - Create a new riemann client.
Source Files