Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thinker0/go.statsd
Provides a simple and flexible StatsD client library in Go.
https://github.com/thinker0/go.statsd
Last synced: 10 days ago
JSON representation
Provides a simple and flexible StatsD client library in Go.
- Host: GitHub
- URL: https://github.com/thinker0/go.statsd
- Owner: thinker0
- License: mit
- Created: 2019-12-05T02:37:52.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2016-01-11T20:48:40.000Z (almost 9 years ago)
- Last Synced: 2024-06-20T11:58:03.443Z (5 months ago)
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
go.statsd
=========
Provides a simple and flexible [StatsD](https://github.com/etsy/statsd) client library
in [Go](http://golang.org).
#### To install
go get github.com/strava/go.statsd
#### To use, imports as package name `statsd`:
import "github.com/strava/go.statsd"
[](https://travis-ci.org/strava/go.statsd)
[](https://coveralls.io/r/strava/go.statsd?branch=master)
[](https://godoc.org/github.com/strava/go.statsd)
## Usage
A statsd client defines a UDP connection to the given server. The prefix
is optional and will be prepended to any stat using this client, useful for namespacing
your metrics.
client, err := statsd.New("statsd-server:8125", "gopher_service")
Suggested usage is to set your client as the package's `statsd.DefaultClient`.
This allows the convenient usage of the package's Count, CountMultiple, Measure and Gauge functions throughout your application.
statsd.DefaultClient = client
// usage
statsd.Count("event")
statsd.CountMultiple("event", 5)
statsd.Timer("measurement", time.Millisecond)
statsd.Gauge("queue_size", size)
The default `statsd.DefaultClient` is a NoopClient that does nothing when called.
Specifically, it doesn't error since you don't have a connection to the server.
This allows for easy testing and local development.
### Counters
func Count(stat string, rate ...float32) error // uses the default client
func (s *Client) Count(stat string, rate ...float32) error
func CountMultiple(stat string, count int, rate ...float32) error // uses the default client
func (s *Client) CountMultiple(stat string, count int, rate ...float32) error
Count adds 1 to the provided stat (plus the prefix).
CountMultiple added to provided `count` to the stat.
Rate is optional, a value of 0.1 will send one in every 10 calls to the server.
The statsd server will adjust its counts accordingly.
The default rate is 1.0 and is defined as the package variable `stats.DefaultRate`.
### Timers / Measure
func Measure(stat string, delta time.Duration, rate ...float32) error
func (s *Client) Measure(stat string, delta time.Duration, rate ...float32) error
Measure sends a delta time to the provided stat (plus the prefix).
The rate value is optional.
Example usage:
func FunctionToMeasure() {
start := time.Now()
defer func() {
go statsd.Measure("function_time", time.Since(start))
}()
// do something you want to measure
}
### Gauges
func Gauge(stat string, value interface{}) error
func (s *Client) Gauge(stat string, value interface{}) error
Gauges are arbitrary values that maintain their values' until set to something else.
Useful for queue sizes.
Example usage:
// update the queue size every minute in the background
go func() {
tick := time.Tick(1 * time.Minute)
for _ = range tick {
statsd.Gauge("queue_size", queueSize())
}
}()
## Credits
The guys at Etsy for building the [StatsD aggregation daemon](https://github.com/etsy/statsd).
For full description of the client API see [StatsD Metric Types](https://github.com/etsy/statsd/blob/master/docs/metric_types.md).
This code builds on work that came before it:
[github.com/cactus/go-statsd-client](http://github.com/cactus/go-statsd-client/)
and [github.com/peterbourgon/g2s](http://github.com/peterbourgon/g2s).