Telltale
Report Rails application metrics to OpenTSDB.
Instructions
Add the following line to your Gemfile
and run bundle install
.
gem 'telltale'
Then set the environment variables and run your rails app:
TELLTALE_OPENTSDB_HOST=metrics.domain.com bundle exec rails s
It is recommended to use something like dotenv to manage your app's environment variables.
Metrics
These numbers are currently reported:
<prefix>.rails.total_time
: Total request time in seconds<prefix>.rails.request_count
: A counter for requests (always 1)
The default prefix
is "telltale" and can be configured with the environment variable TELLTALE_PREFIX
.
Tags
The following tags are available for all metrics:
http_status
: HTTP Status codecontroller
: Name of the controlleraction
: Name of the action in the formcontroller_name.action_name
host
: Name of the host the Rails app is running onenvironment
: The Rails app environmentapp
: The application's name
Configuration
Telltale uses the following environment variables for configuration:
TELLTALE_OPENTSDB_HOST
: The host to report toTELLTALE_OPENTSDB_PORT
: The port opentsdb listens on. Default is 4242TELLTALE_PREFIX
: Some prefix for the metric name. Default istelltale
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
About
This Gem is maintained and funded by nine.ch.
We run your Linux server infrastructure – without interruptions, around the clock