README.md

RocketGraylog

Safe for production async wrapper around GELF & Graylog

Features

• async send messages with concurrent-ruby actor
• slow block execution notification
• all internal errors supressed by default (but you can turn it on)
• retry politics with Retriable gem
• custom _topic with method_missing
• test-ready

Rails configuration

Gemfile:

currently install available only through github:

gem 'rocket_graylog', git: 'https://github.com/rocketbank/rocket_graylog.git'

create config/initializers/rocket_graylog.rb with content:

RocketGraylog.configure do |cfg|
  cfg.facility    = "APPLICATION"
  cfg.host        = ENV["GRAYLOG"]
  cfg.port        = 5514
  cfg.protocol    = :tcp # :upd

  # raise errors on graylog host errors 
  # false means errors will be supressed and do not affect application
  # but message will be lost
  cfg.graylog_errors = false 

  # to retry request on graylog host errors just provide options for Retriable gem:
  # cfg.retry_on_host_errors = {
  #  :on => [Timeout::Error, Errno::ECONNREFUSED], :tries => 3
  # }

  # timeout for sending message to Gelf 
  cfg.send_timeout = 0.5

  # provide block for error notifications
  # cfg.error_hook = lambda do |error|
  #   Honeybadger.notify(error)
  # end

  cfg.test_mode = Rails.env.test?
end

Rails logging config/environments/production.rb:

Rails.application.configure do
  gelf = GELF::Logger.new(ENV['GRAYLOG'], 5514, "LAN", { :facility => "APPLICATION", :protocol => GELF::Protocol::UDP })
  gelf.rescue_network_errors = true # prevents application crashes on log failuring
  config.logger = gelf
end

Usage

send event

RocketGraylog.notify("message", { :a => 100 })

send event with _topic: 'alerts'

RocketGraylog.notify_alerts("message")

notify if block time execution exceed threshold (10 seconds by default)

RocketGraylog.long_execution_detector(name: 'my_tag', threshold: 100.seconds) do
  sleep(101)
end

you will receive message long_execution_detector long_execution_detector_my_tag cost:101 threshold:100

tests/specs:

before(:each) do
  RocketGraylog.clear_test_queue!
end

it '...' do
  expect(RocketGraylog.queue.size).to eq(1)
  # ...
end

handy alias

Graylog.notify("test log message")