README.md in sidekiq-statsd-0.1.2 vs README.md in sidekiq-statsd-0.1.3
- old
+ new
@@ -1,11 +1,11 @@
# Sidekiq::Statsd
[](http://travis-ci.org/phstc/sidekiq-statsd)
[](https://gemnasium.com/phstc/sidekiq-statsd)
-Sidekiq StatsD is a middleware to increment your worker executions counter (success and failures).
+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).
## Compatibility
Sidekiq::Statsd is tested against MRI 1.9.3.
@@ -32,17 +32,23 @@
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
chain.add Sidekiq::Statsd::ServerMiddleware, env: "production", prefix: "worker", host: "localhost", port: 8125
end
end
+```
+### 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 [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.
```
+
+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`)