Liking cljdoc? Tell your friends :D
Clojure only.

goose.metrics.statsd

StatsD is a specimen Metrics Backend for Goose. Plugins can be customized by implementing goose.metrics/Metrics protocol.

StatsD is a specimen Metrics Backend for Goose.
Plugins can be customized by implementing [[goose.metrics/Metrics]] protocol.
raw docstring

default-optsclj

Map of sample config for StatsD Metric Backend.

Keys

:enabled? : Boolean flag for enabling/disabling metrics.

:host : Host of StatsD Aggregator.

:port : Port of StatsD Aggregator.

:prefix : Prefix for all metrics.
Can be a generic term like "goose." or specific to microservice name.

:sample-rate : Sample rate of metric collection.

:tags : Map of key-value pairs to be attached to every metric.

Map of sample config for StatsD Metric Backend.

### Keys
`:enabled?`    : Boolean flag for enabling/disabling metrics.

`:host`        : Host of StatsD Aggregator.

`:port`        : Port of StatsD Aggregator.

`:prefix`      : Prefix for all metrics.\
Can be a generic term like `"goose."` or specific to microservice name.

`:sample-rate` : Sample rate of metric collection.

`:tags`        : Map of key-value pairs to be attached to every metric.
sourceraw docstring

newclj

(new {:keys [enabled? host port prefix] :as opts})

Creates a Metrics implementation for StatsD Backend.

Args

opts : Map of :enabled?, :host, :port, :prefix, :sample-rate & :tags.
Example : default-opts

Note

Goose library for StatsD, clj-statsd, uses agents internally. Post stopping a worker, (shutdown-agents) must be called in order to exit the program.

Creates a Metrics implementation for StatsD Backend.

### Args
`opts`  : Map of `:enabled?`, `:host`, `:port`, `:prefix`, `:sample-rate` & `:tags`.\
Example : [[default-opts]]

### Note
Goose library for StatsD, `clj-statsd`, uses agents internally. Post stopping a worker,
 `(shutdown-agents)` must be called in order to exit the program.

- [Monitoring & Alerting wiki](https://github.com/nilenso/goose/wiki/Monitoring-&-Alerting)
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close