Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 1.35 KB

README.md

File metadata and controls

49 lines (40 loc) · 1.35 KB
Raw

Metrico

NATS ruby client to write metrics Use it to push in InfluxDB format through NATS https://docs.influxdata.com/influxdb/v1.2/write_protocols/line_protocol_tutorial/

Installation

Add this line to your application's Gemfile:

gem 'metrico'
$ bundle install

# config/initializers/metrico.rb
Metrico.configure do |config|
  config.app_name = 'app_name' # required
  config.hostname = 'globalhost' # required
  config.nats_connect_options = {
    servers: ['nats://telegraf-0.somenatsnode.com:4222']
  }
  # define lambdas for these callbacks if you need some
  config.on_error = ->{}
  config.on_reconnect = ->{}
  config.on_disconnect = ->{}
  config.on_close = ->{}
end

For more nats connect options see https://github.com/nats-io/pure-ruby-nats/blob/master/lib/nats/io/client.rb#L154. You also can define most of all connection config via ENV variables.

Usage

In your app you have to push metrics, passing name, hash of metric/value and hash of tags.

Examples:

Metrico.push('3rd_party', {response_time: 1300, sidekiq_retry: 2}, {service: :first})

Metrico.push(
  'heartbeat',
  { cpu: 99, memory: 3200 }
)

License

The gem is available as open source under the terms of the MIT License.