gelf-rb 0 travis-ci ruby Rubygems

Ruby GELF library (Graylog Extended Log Format). Download the Gem via Gemcutter. (https://rubygems.org/gems/gelf)

2 years after MIT

GELF Ruby library

This is the new GELF gem written by Alexey Palazhchenko. It is based on the old gem by Lennart Koopmann and allows you to send GELF messages to Graylog2 server instances. See http://www.graylog2.org/about/gelf for more information about GELF and http://rdoc.info/github/Graylog2/gelf-rb/master/frames for API documentation.

Tested with Ruby 1.9, 2.0, 2.1, 2.2 and 2.3.

Code Climate

Usage

Gelf::Notifier

This allows you to sent arbitary messages via UDP to your Graylog2 server.

n = GELF::Notifier.new("localhost", 12201)

# Send with custom attributes and an additional parameter "foo"
n.notify!(:short_message => "foo", :full_message => "something here\n\nbacktrace?!", :_foo => "bar")

# Pass any object that responds to .to_hash
n.notify!(Exception.new)

The recommended default is to send via UDP but you can choose to send via TCP like this:

n = GELF::Notifier.new("127.0.0.1", 12201, "LAN", { :protocol => GELF::Protocol::TCP })

Note that the LAN or WAN option is ignored for TCP because no chunking happens. (Read below for more information.)

Gelf::Logger

The Gelf::Logger is compatible with the standard Ruby Logger interface and can be used interchangeably. Under the hood it uses Gelf::Notifier to send log messages via UDP to Graylog.

logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "appname" })

logger.debug "foobar"
logger.info "foobar"
logger.warn "foobar"
logger.error "foobar"
logger.fatal "foobar"

logger << "foobar"

Then WAN or LAN option influences the UDP chunk size depending on if you send in your own network (LAN) or on a longer route (i.e. through the internet) and should be set accordingly.

Since it's compatible with the Logger interface, you can also use it in your Rails application:

# config/environments/production.rb
config.logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "appname" })

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2010-2016 Lennart Koopmann and Alexey Palazhchenko. See LICENSE for details.

Related Repositories

chef-td-agent

chef-td-agent

Chef Cookbook for td-agent (Treasure Agent or Fluentd) ...

chef-gelf

chef-gelf

A Chef handler that reports to Graylog2 servers. ...

apache-mod_log_gelf

apache-mod_log_gelf

Apache2 module for writing access logs to Graylog ...

log4r-gelf

log4r-gelf

A Log4r appender for logging to a gelf sink, e.g. the graylog2 server ...


Top Contributors

lennartkoopmann AlekSi bernd milgner zsprackett markglenn joschi mollstam mrnugget barooo defsprite dennisoelkers edefaria slawosz

Releases

-   v3.0.0 zip tar
-   v2.0.0 zip tar
-   v1.4.0 zip tar
-   v1.4.0.beta1 zip tar
-   v1.3.2 zip tar
-   v1.3.1 zip tar
-   v1.3.0 zip tar
-   v1.2.0.beta1 zip tar
-   v1.1.3 zip tar
-   v1.1.1 zip tar
-   v1.1.0 zip tar
-   v1.1.0.rc1 zip tar
-   v1.1.0.beta6 zip tar
-   v1.1.0.beta5 zip tar
-   v1.1.0.beta4 zip tar
-   v1.1.0.beta3 zip tar
-   v1.1.0.beta2 zip tar
-   v1.1.0.beta1 zip tar
-   v1.0.2 zip tar
-   v1.0.1 zip tar
-   v1.0.0 zip tar
-   semver zip tar
-   r1.3.1 zip tar