Project

zlogger

0.0
No commit activity in last 3 years
No release in over 3 years
This gem provides a daemon that reads log messages from a ZeroMQ socket. Messages are formatted and output to STDOUT.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
>= 0
~> 2.14
~> 0.7

Runtime

~> 1.7
 Project Readme

Zlogger - A distributed logging daemon.

This gem provides a daemon that reads log messages from a ZeroMQ socket. Messages are formatted and output to STDOUT.

Installation

Add this line to your application's Gemfile:

gem 'zlogger'

And then execute:

$ bundle

Or install it yourself as:

$ gem install zlogger

Usage

To run the logging daemon:

$ zlogger

And you when messages are sent to the logger, they will appear in STDOUT formatted with the senders name prefixed to each line.

The daemon uses two ZeroMQ sockets:

  • At the bind_address : port => a PULL socket to receive log messages.
  • At the bind_address : port + 1 => a PUB socket where re-formatted lines of the log are sent to.

To use the logging client in a Ruby process:

require 'zlogger'

logger = Zlogger::Client.new
logger.debug "log this debug message"

The logger client object behaves like a standard ruby Logger.

Using zlogger client in a Rails application with Phusion Passenger

Phusion passenger uses a forking model. ZeroMQ contexts do not survive a process fork, so it is important to start the zlogger client after passenger does the process fork. Using the following code snippet in config/environments/production.rb will allow zlogger to be used as the rails logger correctly:

# production log to Zlogger
if defined?(PhusionPassenger)
  # inside passenger, only create the zlogger after the app starts (and has been forked)
  PhusionPassenger.on_event(:starting_worker_process) do |forked|
    Rails.logger = Zlogger::Client.new({address: ENV['ZLOGGER_ADDRESS'], port: ENV['ZLOGGER_PORT']})
  end
else
  # rake tasks, irb, etc. Anything not in passenger: use a zlogger immediately.
  Rails.logger = Zlogger::Client.new({address: ENV['ZLOGGER_ADDRESS'], port: ENV['ZLOGGER_PORT']})
end

Contributing

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