README.md in sidekiq-statsd-2.0.1 vs README.md in sidekiq-statsd-2.1.0

- old
+ new

@@ -1,12 +1,17 @@ # Sidekiq::Statsd [![Build Status](https://secure.travis-ci.org/phstc/sidekiq-statsd.png)](http://travis-ci.org/phstc/sidekiq-statsd) [![Dependency Status](https://gemnasium.com/phstc/sidekiq-statsd.png)](https://gemnasium.com/phstc/sidekiq-statsd) -Sidekiq StatsD is a [Sidekiq server middleware](https://github.com/mperham/sidekiq/wiki/Middleware) to send [Sidekiq worker metrics](https://github.com/mperham/sidekiq/wiki/API#wiki-stats) through [statsd](https://github.com/reinh/statsd). +Sidekiq StatsD is a [Sidekiq server middleware](https://github.com/mperham/sidekiq/wiki/Middleware) to send Sidekiq metrics through [statsd](https://github.com/reinh/statsd): + - [global metrics](https://github.com/mperham/sidekiq/wiki/API#wiki-stats) + - [queue metrics](https://github.com/mperham/sidekiq/wiki/API#queue) + - [worker metrics](https://github.com/mperham/sidekiq/wiki/API#workers) (`processing`, `runtime`) + - job metrics (`processing_time` and `success` / `failure`) + ## Compatibility Sidekiq::Statsd is tested against [several Ruby versions](.travis.yml#L4). ## Installation @@ -48,18 +53,14 @@ ### Sidekiq::Statsd::ServerMiddleware options ```ruby # @param [Hash] options The options to initialize the StatsD client. -# @option options [Statsd] :statsd Existing statsd client to use. +# @option options [Statsd] :statsd Existing [statsd client](https://github.com/github/statsd-ruby) to use. # @option options [String] :env ("production") The env to segment the metric key (e.g. env.prefix.worker_name.success|failure). # @option options [String] :prefix ("worker") The prefix to segment the metric key (e.g. env.prefix.worker_name.success|failure). -# @option options [String] :host ("localhost") The StatsD host. -# @option options [String] :port ("8125") The StatsD port. # @option options [String] :sidekiq_stats ("true") Send Sidekiq global stats e.g. total enqueued, processed and failed. ``` - -If you have a [statsd instance](https://github.com/github/statsd-ruby) you can pass it through the `:statsd` option. If not you can pass the `:host` and `:port` to connect to statsd. ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)