Utilities for collecting metrics in a Rails Application
This gem provides utilities for collecting and reporting metrics in a Rails Application. This gem uses metriks.
The first category of utilities is Reporters.
Reporters
Reporters are available for OpenTSDB, SignalFX and AWS Cloudwatch. The design is heavily inspired by Librato Reporter
OpenTSDBReporter
reporter = Metriks::OpenTSDBReporter.new(host, , )
reporter.start
- host: hostname of OpenTSDB
- tags: A hash of tags that should be associated with every metric.
- options: A hash to control behavior of the reporter. Valid options are:
SignalFXReporter
reporter = Metriks::SignalFXReporter.new(token, , = {})
reporter.start
- token: Token provided by SignalFX
- tags: A hash of tags that should be associated with every metric.
CloudWatchReporter
reporter = Metriks::CloudWatchReporter.new((access_key, secret_key, namespace, , = {}))
reporter.start
- access_key: Access Key provided by AWS
- secret_key: Secret Key provided by AWS
- namespace: AWS CloudWatch namespace of the metric
- tags: A hash of tags that should be associated with every metric.
Options
All reporters accept a hash of options. Options are used to control the behavior of the reporter.
Option | Description (Default) |
---|---|
prefix | Add a prefix to the metric name () |
batch_size | Number of metrics to report in a API call (50) |
logger | Logger for debug and info messages (nil) |
registry | Metriks::Registry to use. (Metriks::Registry.default) |
interval | Interval between two runs (60 secs) |