Archival Notice

This repository will no longer be maintained by UserTesting, and will be archived in the near future. The most recent version of this gem will still be published and available to use. Thank you to everyone who contributed to this project!

NullStatsd

NullStatsd is a Statsd implementation which utilizes the Null Object Pattern, allowing for a fully stubbed Statsd object in your development and testing environments.

Installation

Add this line to your application's Gemfile:

And then execute:

Or install it yourself as:

$ gem install null_statsd

Usage

Create a thin wrapper around your Statsd implementation:

class MyStatsd
  def self.new
    if ENV["STATSD_URL"] # OR if Rails.development || Rails.staging ...
      Statsd.new(statsd_host, statsd_port, *additional_params)
    else
      NullStatsd::Statsd.new(host: statsd_host, port: statsd_port, logger: Rails.logger)
    end
  end
end

Create an instance and use it as normal:

MyStatsd.new.increment(...)

Notice that your statsd endpoint is not receiving data. Also notice that your logs are receiving data.

[NullStatsD :-] Incrementing media.book.consumed with opts genre:science fiction
[NullStatsD :-] Decrementing media.book.on_hand
[NullStatsD :-] Recording timing info in book checkout -> 0.512917 sec

Supported API

instance = NullStatsd::Statsd.new(host: "https://fakestatsd.com", port: 4242, logger: $stdout

increment(stat, opts = {})

instance.increment "media.book.consumed", genre: "horror"

[NullStatsD :-] Incrementing media.book.consumed with opts genre:horror

decrement(stat, opts = {})

instance.decrement "media.book.on_hand", genre: "science fiction"

[NullStatsD :-] Decrementing media.book.on_hand with opts genre:science fiction

count(stat, opts = {})

instance.count "responses", 3

[NullStatsD :-] Increasing responses by 3

guage(stat, opts = {})

instance.guage "media.book.return_time", 12, measurement: "days"

[NullStatsD :-] Setting guage media.book.return_time to 12 with opts measurement:days

histogram(stat, opts = {})

instance.histogram "media.book.lent.hour", 42

[NullStatsD :-] Logging histogram media.book.lent.hour -> 42

timing(stat, ms, opts = {})

instance.timing "book checkout", 94, tags: "speedy"

[NullStatsD :-] Timing book checkout at 94 ms with opts tags:speedy

set(stat, opts = {})

instance.set "media.book.lent", 10_000_000

[NullStatsD :-] Setting media.book.lent to 10000000

service_check(stat, opts = {})

instance.service_check "door.locked", "ok"

[NullStatsD :-] Service check door.locked: ok

event(stat, opts = {})

instance.event "Leak", "The library roof has a leak on the west end. Please take care"

[NullStatsD :-] Event Leak: The library roof has a leak on the west end. Please take care

time(stat, opts = {})

instance.time("media.movie.consume") do
  Movie.new().watch
end

[NullStatsD :-] Recording timing info in media.movie.consumed -> 12323 sec

close(stat, opts = {})

[NullStatsD :-] Close called

Development

Testing

rake spec

License

The gem is available as open source under the terms of the MIT License.

Library created by UserTesting.

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. Create a new Pull Request

Bug reports and pull requests are welcome on GitHub at https://github.com/usertesting/null_statsd