Scout StatsD Rack
The scout_statsd_rack
gem instruments Ruby applications served by Rack with StatsD.
The gem is maintained by Scout for our hosted StatsD service but is compatible with any StatsD collector.
Reported Metrics
The following metrics are reported:
- Response code rates (2XX,3XX,4XX,5XX,etc)
- Response time
- Request throughput
Rails Installation
Add this line to your application's Gemfile:
gem 'scout_statsd_rack'
And then execute:
$ bundle
That's it! The gem uses a Railtie that automatically includes the middleware instrumentation into your app.
Non-Rails Installation
Add this line to your application's Gemfile:
gem 'scout_statsd_rack'
And then execute:
$ bundle
Use the ScoutStatsdRack
middleware:
use ScoutStatsdRack::Middleware
Using with Scout
Just install the Scoutd agent on the host(s) serving the app to see the Rack metrics in the Scout UI.
Environment Variables
To define a different hostname or port, please set the following environment variables:
STATSD_HOST #default: 'localhost'
STATSD_PORT #default: 8125
Scope
This gem is laser-focused on Rack-related metrics. Other scout_statsd_X
gems instrument different areas of your code.
Questions? Feedback?
Create an issue or shoot an email to [email protected].
Contributing
- Fork it ( https://github.com/[my-github-username]/scout_statsd_rack/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request