postmates/ex-stats-tracker

StatsD Client for Elixir

Now Archived and Forked

ex-stats-tracker will not be maintained in this repository going forward. Please use, create issues on, and make PRs to the fork of ex-stats-tracker located here.

ex-stats-tracker

A statsd client for Elixir.

ExStatsTracker is a process-based statsd client that supports batch stat flushes to avoid file descriptor exhaustion.

Installation

Add ex-stats-tracker to your list of dependencies in mix.exs:

def deps do
  [{:ex_stats_tracker, "~> 0.1.2"}]
end

Ensure ex_stats_tracker is started before your application:

def application do
  [extra_applications: [:ex_stats_tracker]]
end

Configuration

Configure ex_stats_tracker in config:

use Mix.Config

config :ex_stats_tracker,
  host: "your.statsd.host.com",
  port: 1234,
  prefix: "your_prefix"
  flush_interval: 10000
  chunk_size: 20

The defaults are:

• host: 127.0.0.1
• port: 8125
• prefix: nil
• flush_interval: 15000
• chunk_size: 25

Usage

iex> ExStatsTracker.counter(your_key, 1)
iex> ExStatsTracker.increment(your_key)
iex> ExStatsTracker.gauge(your_key)
iex> ExStatsTracker.timing(your_metric, 1)
iex> ExStatsTracker.histogram(your_metric, 1)
iex> ExStatsTracker.meter(your_metric, 1)

Documentation

mix docs
open docs/index.html

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

See LICENSE.md.