MetricsLogger

For OpenTSDB data logging. For duration data and arbitrary logged values, total, count, average values are calculated per minute interval and sent to the server every minute. The logger singleton runs in a separate thread so this gem works well with jruby which supports native threads. If endpoint returns error or times out, backup_endpoint is tried.

Installation

Add this line to your application's Gemfile:

gem 'metrics_logger'

And then execute:

$ bundle

Or install it yourself as:

$ gem install metrics_logger

Usage

Configure Logger

  MetricsLogger.configure do |config|
    config.app_name = "my_app" # used to make value key to opentsdb. eg: my_app.metric_name.total
    config.endpoint = "http://my_opentsdb_server:4242/api/put"
    config.backup_endpoint = "http://my_backup_opentsdb_server:4242/api/put"
    config.sync_interval = 60 #in seconds

Logging Things

1. log arbitrary values

MetricsLogger.log("metric_name", key_1: "value_1", key_2: "value_2")

2. log duration with block

MetricsLogger.log_duration "metric_name" do 
  #do something
end

Note: Remember that variables declared inside the block will not be accessible outside the block. If you want to initialize a varaible and use it after block closes, declare the variable before the block.

3. log duration without block

logger.MetricsLogger.new
#do something
logger.log_duration "metric_name"

4. Log values once per minute

MetricsLogger.sample("metric_name", object: some_ruby_object, method: "count")

###Start Logger Process

Thread.new { MetricsLogger.start }

Contributing

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