Rack application monitoring with StatsD
Ruby Shell
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
CHANGELOG.md
Gemfile
README.md
Rakefile
scout_statsd_rack.gemspec

README.md

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.

rails app monitoring

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 support@scoutapp.com.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/scout_statsd_rack/fork )
  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