Home / Ruby / Logging

Log4r is a comprehensive and flexible logging library for use in Ruby programs. It features a heirarchical logging system of any number of levels, custom level names, multiple output destinations per log event, custom formatting, and more.

Log4r - A flexible logging library for Ruby This release 1.1.11 Release date 04/Jan/2014 License BSD Maintainer Colby Gutierrez-Kraybill
Information
Category: Ruby / Logging
Watchers: 18
Star: 248
Fork: 88
Last update: Nov 22, 2023
Resource links
http://log4r.rubyforge.org
https://github.com/colbygk/log4r

Log4r - A flexible logging library for Ruby
This release 1.1.11
Release date 04/Jan/2014
License BSD
Maintainer Colby Gutierrez-Kraybill
Contributor
Leon Torres Original Maintainer
Martain Stannard RollingFileOutputter
Steve Lumos SyslogOutputter
Mark Lewandowski ScribeOutputter
Andreas Hund YamlConfigurator
Jamis Buck log4r.gemspec
Charles Strahan log4jxml/chainsaw integration
Nitay Joffe STARTTLS
David Siegal Smart updates to RollingFileOutputter

Summary

Log4r is a comprehensive and flexible logging library written in Ruby for use in Ruby programs. It features a hierarchical logging system of any number of levels, custom level names, logger inheritance, multiple output destinations per log event, execution tracing, custom formatting, thread safteyness, XML and YAML configuration, and more.

Requirements

  1. (required) Ruby >= 1.7.0 (use log4r 1.0.2 for Ruby 1.6)
  2. (optional) RubyGems for installing Log4r as a gem
  3. (optional) Ruby syslog library for SyslogOutputter
  4. (optional) XML configuration requires REXML
  5. (optional) log4j chainsaw integration requires 'builder' >= 2.0
  6. (optional) STARTTLS email login, requires 'smtp_tls" if Ruby <= 1.8.6

More Info

  • Installation instructions are in the file INSTALL
  • Comprehensive examples are provided in examples/ and can be run right away
  • Log4r homepage: doc/index.html
  • Manual: doc/manual.html
  • RDoc API reference: doc/rdoc/index.html
  • The changelog
  • Feel free to bug the maintainer with any questions (listed at top of file)

Usability

Log4r works really well, so please take advantage of it right away! :) All versions since 0.9.2 have been stable and backward-compatible. The code is stable enough that updates are infrequent and usually only for adding features or keeping the code up to date with Ruby.

Platform Issues

Log4r is known to work on Linux and WindowsXP. It's safe to assume that Log4r will work on any Ruby-supported platform.

When Trouble Strikes

Log4r comes with an internal logger. To see its output, create a logger named 'log4r' before any others and give it a suitable outputter,

trouble = Logger.new['log4r'] trouble.add Outputter.stdout

Try running the unit tests provided (run the file tests/runtest.rb). Let the maintainer know what's up and feel free to explore and fix the code yourself. It's well documented and written in Ruby. :)

39 Open More issues
Closed

warning: `+' after local variable or literal is interpreted as binary operator

I'm getting errors like this on JRuby 9.1.2.0:

/Volumes/extra/git/mio/mio.salesstatistics/workers/gems/jruby/2.3.0/gems/log4r-1.1.10/lib/log4r/outputter/outputter.rb:54: warning: '+' after local variable or literal is interpreted as binary operator /Volumes/extra/git/mio/mio.salesstatistics/workers/gems/jruby/2.3.0/gems/log4r-1.1.10/lib/log4r/outputter>/outputter.rb:54: warning: even though it seems like unary operator /Volumes/extra/git/mio/mio.salesstatistics/workers/gems/jruby/2.3.0/gems/log4r-1.1.10/lib/log4r/formatter/formatter.rb:72: warning: '+' after local variable or literal is interpreted as binary operator /Volumes/extra/git/mio/mio.salesstatistics/workers/gems/jruby/2.3.0/gems/log4r-1.1.10/lib/log4r/formatter/formatter.rb:72: warning: even though it seems like unary operator

opened Jul 6, 2016 by perlun 10
Closed

undefined method `formatter' for Log4r::Logger in Rails?

Hi there,

I'm getting the following error: https://gist.github.com/solars/5af4e6743ac301a2ecdc when trying to run a rails project with log4r locally in production mode - somehow I don't get it with passenger on the server, not sure why.

It seems as if rails expects a formatter method somewhere else than log4r has it, versions are: log4r (1.1.10) rails (4.0.13)

Since I don't want to risk breaking the app, is there a fix/workaround for this in later versions? Or is it something else?

Thanks a lot, Christoph

opened Jul 29, 2015 by solars 5
Closed

License considerations

I work for VMWare, and we are open sourcing a large project called Cloud Foundry, which is available for download on Github, and also available as a service at cloudfoundry.com. We have a number of participants, including people in industry, academia, and government.

We have chosen to license our software under Apache v.2, which is incompatible with GPL and LGPL as you can read here: http://www.apache.org/licenses/GPL-compatibility.html and here http://www.apache.org/legal/resolved.html

If MIT or Apache is not your preference, the Ruby license offers both GPL, and Apache compatible terms.

http://www.ruby-lang.org/en/LICENSE.txt

Thanks for your consideration.

Matt

opened Feb 22, 2012 by mreider 3
Closed

1.1.11 introduces breaking changes

From what I can see, in 1.1.11 Log4r::Logger.root raises an error saying RootLogger is undefined. Is that not supported anymore? Sounds like a breaking change... I'm going to have to manually add "~> 1.1.0", "!= 1.1.11" in my project.

I think 1.1.11 could probably be yanked from RubyGems and 1.2 pushed up in its place.

opened Jan 5, 2014 by bradfeehan 2
Closed

Bundler integeration, test updates, and other minor changes

  1. Added support for bundler: $ git clone ... && cd ./log4r_checkout/ $ bundle update $ bundle exec rake test $ bundle exec rake install $ bundle exec rake build
  2. Migrated to a gemspec file
  3. I was wrapping my custom exceptions without the backtrace set and found out i was getting errors so i made this patch
opened May 31, 2011 by pcting 2
Closed

Is Log4r impacted by latest Log4j security vulnerability?

This issue is regarding https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-44228 security vulnerability

  1. Is there any way the log4r library has the same issue as log4j?

  2. Log4r is directly not using the Java Log4j library but it follows a very similar architecture, is this library also impacted by the same vulnerability vector(lookup eval)?

opened Dec 14, 2021 by lohithmv019 1
Open

Update to make log4r compatible with fresh ruby 3.2.0dev f8455a4faf w…

…hich has removed support to some deprecated methods.

Changes are mainly in rollingfileoutputter.rb:

exist? replaces exists? Fixnum check replaced with Integer

Gem requirements have been updated to start from ruby 2.5 version for backwards compatibility

opened Apr 8, 2022 by mansobeach 0
Open

Can not be used under Rails 6.

Hi, when using Log4r in Rails6, using this approach: https://stackoverflow.com/questions/5664136/how-to-configure-log4r-with-rails-3-0-x/5959013

I met this error:

undefined method `tagged' for #<Proc:0x000055da3886f700 /opt/app/maomao/config/initializers/log4r_path.rb:3>

from this line of code: 
  <%= javascript_pack_tag 'application' %>

full trace is as below:

activesupport (6.1.4.1) lib/active_support/tagged_logging.rb:99:in `tagged'
webpacker (5.4.2) lib/webpacker/manifest.rb:58:in `compile'
webpacker (5.4.2) lib/webpacker/manifest.rb:42:in `lookup'
webpacker (5.4.2) lib/webpacker/manifest.rb:49:in `lookup!'
webpacker (5.4.2) lib/webpacker/helper.rb:182:in `block in sources_from_manifest_entries'
webpacker (5.4.2) lib/webpacker/helper.rb:182:in `map'
webpacker (5.4.2) lib/webpacker/helper.rb:182:in `sources_from_manifest_entries'
webpacker (5.4.2) lib/webpacker/helper.rb:81:in `javascript_pack_tag'
app/views/layouts/application.html.erb:8
actionview (6.1.4.1) lib/action_view/base.rb:247:in `public_send'
actionview (6.1.4.1) lib/action_view/base.rb:247:in `_run'
actionview (6.1.4.1) lib/action_view/template.rb:154:in `block in render'
activesupport (6.1.4.1) lib/active_support/notifications.rb:205:in `instrument'
actionview (6.1.4.1) lib/action_view/template.rb:345:in `instrument_render_template'
actionview (6.1.4.1) lib/action_view/template.rb:152:in `render'
actionview (6.1.4.1) lib/action_view/renderer/template_renderer.rb:72:in `block in render_with_layout'
activesupport (6.1.4.1) lib/active_support/notifications.rb:203:in `block in instrument'
activesupport (6.1.4.1) lib/active_support/notifications/instrumenter.rb:24:in `instrument'
activesupport (6.1.4.1) lib/active_support/notifications.rb:203:in `instrument'
actionview (6.1.4.1) lib/action_view/renderer/template_renderer.rb:70:in `render_with_layout'
actionview (6.1.4.1) lib/action_view/renderer/template_renderer.rb:55:in `render_template'
actionview (6.1.4.1) lib/action_view/renderer/template_renderer.rb:11:in `render'
actionview (6.1.4.1) lib/action_view/renderer/renderer.rb:61:in `render_template_to_object'
actionview (6.1.4.1) lib/action_view/renderer/renderer.rb:29:in `render_to_object'
actionview (6.1.4.1) lib/action_view/rendering.rb:117:in `block in _render_template'
actionview (6.1.4.1) lib/action_view/base.rb:273:in `in_rendering_context'
actionview (6.1.4.1) lib/action_view/rendering.rb:116:in `_render_template'
actionpack (6.1.4.1) lib/action_controller/metal/streaming.rb:218:in `_render_template'
actionview (6.1.4.1) lib/action_view/rendering.rb:103:in `render_to_body'
actionpack (6.1.4.1) lib/action_controller/metal/rendering.rb:52:in `render_to_body'
actionpack (6.1.4.1) lib/action_controller/metal/renderers.rb:142:in `render_to_body'
actionpack (6.1.4.1) lib/abstract_controller/rendering.rb:25:in `render'
actionpack (6.1.4.1) lib/action_controller/metal/rendering.rb:36:in `render'
actionpack (6.1.4.1) lib/action_controller/metal/instrumentation.rb:46:in `block (2 levels) in render'
/home/ubuntu/.rbenv/versions/3.0.2/lib/ruby/3.0.0/benchmark.rb:308:in `realtime'
activesupport (6.1.4.1) lib/active_support/core_ext/benchmark.rb:14:in `ms'
actionpack (6.1.4.1) lib/action_controller/metal/instrumentation.rb:46:in `block in render'
actionpack (6.1.4.1) lib/action_controller/metal/instrumentation.rb:86:in `cleanup_view_runtime'
activerecord (6.1.4.1) lib/active_record/railties/controller_runtime.rb:34:in `cleanup_view_runtime'
actionpack (6.1.4.1) lib/action_controller/metal/instrumentation.rb:45:in `render'
actionpack (6.1.4.1) lib/action_controller/metal/implicit_render.rb:35:in `default_render'
actionpack (6.1.4.1) lib/action_controller/metal/basic_implicit_render.rb:6:in `block in send_action'
<internal:kernel>:90:in `tap'
actionpack (6.1.4.1) lib/action_controller/metal/basic_implicit_render.rb:6:in `send_action'
actionpack (6.1.4.1) lib/abstract_controller/base.rb:228:in `process_action'
actionpack (6.1.4.1) lib/action_controller/metal/rendering.rb:30:in `process_action'
actionpack (6.1.4.1) lib/abstract_controller/callbacks.rb:42:in `block in process_action'
activesupport (6.1.4.1) lib/active_support/callbacks.rb:117:in `block in run_callbacks'
actiontext (6.1.4.1) lib/action_text/rendering.rb:20:in `with_renderer'
actiontext (6.1.4.1) lib/action_text/engine.rb:59:in `block (4 levels) in <class:Engine>'
activesupport (6.1.4.1) lib/active_support/callbacks.rb:126:in `instance_exec'
activesupport (6.1.4.1) lib/active_support/callbacks.rb:126:in `block in run_callbacks'
activesupport (6.1.4.1) lib/active_support/callbacks.rb:137:in `run_callbacks'
actionpack (6.1.4.1) lib/abstract_controller/callbacks.rb:41:in `process_action'
actionpack (6.1.4.1) lib/action_controller/metal/rescue.rb:22:in `process_action'
actionpack (6.1.4.1) lib/action_controller/metal/instrumentation.rb:34:in `block in process_action'
activesupport (6.1.4.1) lib/active_support/notifications.rb:203:in `block in instrument'
activesupport (6.1.4.1) lib/active_support/notifications/instrumenter.rb:24:in `instrument'
activesupport (6.1.4.1) lib/active_support/notifications.rb:203:in `instrument'
actionpack (6.1.4.1) lib/action_controller/metal/instrumentation.rb:33:in `process_action'
actionpack (6.1.4.1) lib/action_controller/metal/params_wrapper.rb:249:in `process_action'
activerecord (6.1.4.1) lib/active_record/railties/controller_runtime.rb:27:in `process_action'
actionpack (6.1.4.1) lib/abstract_controller/base.rb:165:in `process'
actionview (6.1.4.1) lib/action_view/rendering.rb:39:in `process'
actionpack (6.1.4.1) lib/action_controller/metal.rb:190:in `dispatch'
actionpack (6.1.4.1) lib/action_controller/metal.rb:254:in `dispatch'
actionpack (6.1.4.1) lib/action_dispatch/routing/route_set.rb:50:in `dispatch'
actionpack (6.1.4.1) lib/action_dispatch/routing/route_set.rb:33:in `serve'
actionpack (6.1.4.1) lib/action_dispatch/journey/router.rb:50:in `block in serve'
actionpack (6.1.4.1) lib/action_dispatch/journey/router.rb:32:in `each'
actionpack (6.1.4.1) lib/action_dispatch/journey/router.rb:32:in `serve'
actionpack (6.1.4.1) lib/action_dispatch/routing/route_set.rb:842:in `call'
rack (2.2.3) lib/rack/tempfile_reaper.rb:15:in `call'
rack (2.2.3) lib/rack/etag.rb:27:in `call'
rack (2.2.3) lib/rack/conditional_get.rb:27:in `call'
rack (2.2.3) lib/rack/head.rb:12:in `call'
actionpack (6.1.4.1) lib/action_dispatch/http/permissions_policy.rb:22:in `call'
actionpack (6.1.4.1) lib/action_dispatch/http/content_security_policy.rb:18:in `call'
rack (2.2.3) lib/rack/session/abstract/id.rb:266:in `context'
rack (2.2.3) lib/rack/session/abstract/id.rb:260:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/cookies.rb:689:in `call'
activerecord (6.1.4.1) lib/active_record/migration.rb:601:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/callbacks.rb:27:in `block in call'
activesupport (6.1.4.1) lib/active_support/callbacks.rb:98:in `run_callbacks'
actionpack (6.1.4.1) lib/action_dispatch/middleware/callbacks.rb:26:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/executor.rb:14:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/actionable_exceptions.rb:18:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/debug_exceptions.rb:29:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/show_exceptions.rb:33:in `call'
railties (6.1.4.1) lib/rails/rack/logger.rb:37:in `call_app'
railties (6.1.4.1) lib/rails/rack/logger.rb:28:in `call'
sprockets-rails (3.2.2) lib/sprockets/rails/quiet_assets.rb:13:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/remote_ip.rb:81:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/request_id.rb:26:in `call'
rack (2.2.3) lib/rack/method_override.rb:24:in `call'
rack (2.2.3) lib/rack/runtime.rb:22:in `call'
activesupport (6.1.4.1) lib/active_support/cache/strategy/local_cache_middleware.rb:29:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/executor.rb:14:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/static.rb:24:in `call'
rack (2.2.3) lib/rack/sendfile.rb:110:in `call'
actionpack (6.1.4.1) lib/action_dispatch/middleware/host_authorization.rb:98:in `call'
webpacker (5.4.2) lib/webpacker/dev_server_proxy.rb:25:in `perform_request'
rack-proxy (0.7.0) lib/rack/proxy.rb:63:in `call'
railties (6.1.4.1) lib/rails/engine.rb:539:in `call'
puma (5.4.0) lib/puma/configuration.rb:249:in `call'
puma (5.4.0) lib/puma/request.rb:77:in `block in handle_request'
puma (5.4.0) lib/puma/thread_pool.rb:340:in `with_force_shutdown'
puma (5.4.0) lib/puma/request.rb:76:in `handle_request'
puma (5.4.0) lib/puma/server.rb:440:in `process_client'
puma (5.4.0) lib/puma/thread_pool.rb:147:in `block in spawn_thread'
opened Aug 28, 2021 by sg552 0
Open

make a new release?

Hi, Would it be possible to publish a release for log4r? there are no git tags here that match the rubygems.org releases and the last rubygems.org release was quite some time ago. Let me know if I can somehow help!

opened Jan 10, 2021 by bastelfreak 1
Open

Fixed yamlconfigurator #actual_load for Ruby 2.5

#60 Changed the deprectated YAML.load_documents to Psych.load_stream.

opened Mar 26, 2019 by MRod15 0
Open

log4r-color merge?

Would it be possible to merge this repo, which enables colorized stdout, into the existing library? Is there a reason this hasn't been done?

I did not write the colorize extension, but I've been looking through the code and the changes seem reasonable to me. Admittedly, I don't know what else those changes might impact.

I also imagine you all have considered this before, so forgive me if that conversation to add colorized output has already occurred.

log4r-color

It uses colorize

opened May 22, 2018 by maxglassie 2
Open

yamlconfigurator issue in Ruby 2.5.0

Processing a log4r yaml configuration file fails in Ruby 2.5.0 with the following error .rvm/gems/ruby-2.5.0/gems/log4r-1.1.10/lib/log4r/yamlconfigurator.rb:42:in load_yaml_file' .rvm/gems/ruby-2.5.0/gems/log4r-1.1.10/lib/log4r/yamlconfigurator.rb:56:inactual_load': undefined method `load_documents' for Psych:Module (NoMethodError) Did you mean? load_stream

opened Apr 5, 2018 by mguyre 0

Contents

    TwP A flexible logging library for use in Ruby programs based on the design of Java's log4j library.
    siddontang a golang log lib supports level and multi handlers
    kraklin Transform Elm Debug.log output into nice log object with custom formatter
    adamschwartz Console.log with style.
    radding A string based event system for django
    tony19 📄The reliable, generic, fast and flexible logging framework for Android
    wajahatkarim3 The widgets (EditText and TextView) for support of money requirements like currency, number formatting, comma formatting etc.
    codeplant A ruby gem for creating navigations (with multiple levels) for your Rails, Sinatra or Padrino applications. Render your navigation as html list, link list or breadcrumbs.
    sindresorhus Colored symbols for various log levels
    cihub Seelog is a native Go logging library that provides flexible asynchronous dispatching, filtering, and formatting.
    JSCU-NL A Windows event logging and collection baseline focused on finding balance between forensic value and optimising retention.
    vlinx-io A lite go logging component
    watson The most simple logger imaginable
    mafintosh Convert a string to a number based on a classic phone number pad encoding
    facebookresearch This code implements Prioritized Level Replay, a method for sampling training levels for reinforcement learning agents that exploits the fact that not all levels are equally useful for agents to learn from during training.
    baryon A powerful and customizable logging library for node.js
    rust-lang log — Logging implementation for Rust
    ubclaunchpad A Simple iOS Testing Framework
    MarcinOrlowski Android date/time formatting library supporting formatting placeholders
    go-playground :green_book: Simple, configurable and scalable Structured Logging for Go.
    joseluisq vue-input-number - A custom input number component for Vue.js 2.
    Share this repo

    Related Repos


    Logging
    247
    Rails ActiveRecord SQL queries log beautifier
    kvokka PpSql Replace standard ActiveRecord#to_sql method with anbt-sql-formatter gem for pretty SQL code output in console. Rails log will be formatted also. Example output: Or in console Require Ruby 2.4+
     
    Logging
    152
    Structured+contextual logging experiments in Ruby
    jordansissel Logging kind of sucks. I want: Context and Structured Data because logging with printf makes it hard to read later. Why write code that's easy to maintain but not write logs that are the same? Structured data means y
     
    Popular
    Logging
    12.3k
    Fluentd: Unified Logging Layer (project under CNCF)
    fluent Fluentd: Open-Source Log Collector Travis CI: Drone CI for Arm64: Fluentd collects events from various data sources and writes them to files, RDBMS, NoSQL, IaaS, SaaS, Hadoop and so on. Fluentd helps you unify your loggi
     
    Logging
    248
    Log4r is a comprehensive and flexible logging library for use in Ruby programs. It feature...
    colbygk Log4r - A flexible logging library for Ruby This release 1.1.11 Release date 04/Jan/2014 License BSD Maintainer Colby Gutierrez-Kraybill
     
    Logging
    524
    A flexible logging library for use in Ruby programs based on the design of Java's log4j li...
    TwP Logging by Tim Pease Homepage Github Project Description Logging is a flexible logging library for use in Ruby programs based on the design of Java's log4j library. It features a hierarchical logging system,
     
    Logging
    141
    MongoDB logger for Rails
    le0pard MongodbLogger MongodbLogger is a alternative logger for Rails or Rack based app, which log all requests of you application into MongoDB database. It: simple to integrate into existing Rails application; allow to store al
     
    Logging
    160
    Simple logging
    asenchi Scrolls Scrolls is a library for generating logs of the structure key=value. Installation Add this line to your application's Gemfile: gem 'scrolls' And then execute: $ bundle Or install it yourself as: $ gem i
     
    Logging
    312
    Yell - Your Extensible Logging Library
    rudionrails Yell Yell - Your Extensible Logging Library is a comprehensive logging replacement for Ruby. Yell works and its test suite currently runs on: ruby-head, 2.3.1, 2.2.5, 2.2.2, 2.1.0, 2.0.0 jruby-head, jruby-9.1.0.0, jrub