logging 2.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d4abf77abb948de12d0e860a18be03b9b2314bd
-  data.tar.gz: f3bb7dc5daf79b192d56de6d2a96d217bebbe24b
+SHA256:
+  metadata.gz: 1ec479cf977c621a6b42426cfe7c478a97e106c23762f3608ee67fcbaa49b324
+  data.tar.gz: 6a0c0107cf3c1a1f7504e19e85a9505ad94c4a84991d01eb6c65191257a01163
 SHA512:
-  metadata.gz: 31e6820636ea493830b4b880c112aa57a53fc4e283da0682b5dfbdb373d3040017889153e50f625525eb6e0e7e4d7e2752fd6fd60c8acbc909d249762b2fd879
-  data.tar.gz: c55a5532bcc8e6c8543f231484a11cb9f65a747afe231f58709fc13274962e6318a05a3e76d09b12c1793bc346cd87eca759e0eefa2185af1ea38d2caf554ab9
+  metadata.gz: 2cd72dabcd8b878b73f69ec8a445678b14635ca1c115576ef148a7160673f83939d7706e5d673c32ed11ef2c48046cc7a50bd2c2c0795b2fa79c35e9d4bccf87
+  data.tar.gz: 23422872b58d1bd0e0a146f64e4bb792ef5208da309b16e7650d5c74ca9969b12e6e65dd5ef79a90ce39e0d6c51dbc7514f7a2e913ec74b2e8404a06aefa8975

data/.gitignore

@@ -12,3 +12,4 @@ tmp/
 vendor/
 .rbx
 .rvmrc
+.tool-versions

data/.travis.yml

@@ -6,8 +6,11 @@ install:        "rake gem:install_dependencies"
 script: "rake"
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.1
-
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.7
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - jruby-9.2.9.0

data/History.txt

@@ -1,3 +1,62 @@
+== 2.3.0 / 2020-07-04
+
+Enhancements
+- all appender output is now synchronized [PR #219]
+- renamed the `LogEvent#method` to no longer conflict with `Kernel#method` [PR #218]
+- @bhuga (not the Fortnite star) added a `raise_errors` method for debugging [PR #203]
+- thanks to @olleolleolle for keeping on top of Travis and Ruby versions
+
+Bug Fixes
+- conosle appenders can be reopened [PR #220]
+- fixed a race condition in the rolling file appender [PR #216]
+- fixed a race condition when opening log file destinations [PR #208 #217]
+- @MikaelSmith fixed a race condition in Logger creation [PR #201]
+- documentation bug fixes [PR #184 #185 #188 #194 #209]
+
+== 2.2.2 / 2017-04-11
+
+Enhancements
+- limit the depth of nested exceptions [PR #167]
+
+== 2.2.1 / 2017-04-09
+
+Enhancements
+- show exception `cause` if one exists [PR #165]
+
+== 2.2.0 / 2017-03-09
+
+Enhancements
+- diagnostic context inheritance is now optional [PR #160]
+- add support for setting a UTC offset [PR #157]
+- setting a basepath for call tracing [PR #154]
+
+Bug Fixes
+- use thread-local variables for diagnostic contexts [PR #162]
+- replace `Fixnum` with `Integer` [PR #161]
+- fixed a race condition in the rolling file appender [PR #151]
+
+Deprecations
+- dropped Ruby 1.9 support
+
+== 2.1.0 / 2016-03-13
+
+Enhancements
+- appender factories now fail explicitly on bad arguments [PR #117]
+- console loggers (stdout, stderr) use `write` for compatibility [PR #127]
+- allow whitespace in traced method names [PR #128]
+- accessor methods for `backtrace` settings [PR #134]
+- asynchronous writing from buffered appenders [PR #135]
+- improve date format performance when outputting microseconds [PR #136]
+- added some thread safety to log level setters [PR #137]
+- use `write` everywhere instead of `syswrite` [PR #138]
+
+Bug Fixes
+- fixing encodings in tests [PR #116]
+- fix Rails4 logger compatibility [PR #121]
+- explicitly adding the MIT license [PR #123]
+- update `object_id` format in inspect methods [PR #133]
+- fixed Travis-CI tests
+
 == 2.0.0 / 2015-03-28
 
 Enhancements

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2007-2016 Tim Pease
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,12 +1,12 @@
 ## Logging
-by Tim Pease [![](https://secure.travis-ci.org/TwP/logging.png)](https://travis-ci.org/TwP/logging)
+by Tim Pease [![](https://secure.travis-ci.org/TwP/logging.svg)](https://travis-ci.org/TwP/logging)
 
 * [Homepage](http://rubygems.org/gems/logging)
 * [Github Project](https://github.com/TwP/logging)
 
 ### Description
 
-Logging is a flexible logging library for use in Ruby programs based on the
+**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,
 custom level names, multiple output destinations per log event, custom
 formatting, and more.
@@ -82,23 +82,23 @@ class SecondClass
 end
 ```
 
-There are many more examples in the [examples folder](https://github.com/TwP/logging/tree/master/examples)
-of the logging package. The recommended reading order is the following:
-
-* [simple.rb](https://github.com/TwP/logging/blob/master/examples/simple.rb)
-* [rspec_integration.rb](https://github.com/TwP/logging/blob/master/examples/rspec_integration.rb)
-* [loggers.rb](https://github.com/TwP/logging/blob/master/examples/loggers.rb)
-* [classes.rb](https://github.com/TwP/logging/blob/master/examples/classes.rb)
-* [hierarchies.rb](https://github.com/TwP/logging/blob/master/examples/hierarchies.rb)
-* [names.rb](https://github.com/TwP/logging/blob/master/examples/names.rb)
-* [lazy.rb](https://github.com/TwP/logging/blob/master/examples/lazy.rb)
-* [appenders.rb](https://github.com/TwP/logging/blob/master/examples/appenders.rb)
-* [layouts.rb](https://github.com/TwP/logging/blob/master/examples/layouts.rb)
-* [formatting.rb](https://github.com/TwP/logging/blob/master/examples/formatting.rb)
-* [colorization.rb](https://github.com/TwP/logging/blob/master/examples/colorization.rb)
-* [consolidation.rb](https://github.com/TwP/logging/blob/master/examples/consolidation.rb)
-* [fork.rb](https://github.com/TwP/logging/blob/master/examples/fork.rb)
-* [mdc.rb](https://github.com/TwP/logging/blob/master/examples/mdc.rb)
+There are many more examples in the [examples folder](/examples) of the logging
+package. The recommended reading order is the following:
+
+* [simple.rb](/examples/simple.rb)
+* [rspec_integration.rb](/examples/rspec_integration.rb)
+* [loggers.rb](/examples/loggers.rb)
+* [classes.rb](/examples/classes.rb)
+* [hierarchies.rb](/examples/hierarchies.rb)
+* [names.rb](/examples/names.rb)
+* [lazy.rb](/examples/lazy.rb)
+* [appenders.rb](/examples/appenders.rb)
+* [layouts.rb](/examples/layouts.rb)
+* [reusing_layouts.rb](/examples/reusing_layouts.rb)
+* [formatting.rb](/examples/formatting.rb)
+* [colorization.rb](/examples/colorization.rb)
+* [fork.rb](/examples/fork.rb)
+* [mdc.rb](/examples/mdc.rb)
 
 ### Extending
 
@@ -135,25 +135,4 @@ After this is done you can rake `rake -T` to see the available rake tasks.
 
 ### License
 
-The MIT License
-
-Copyright (c) 2015 Tim Pease
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License - see the [LICENSE](/LICENSE) file for the full text.

data/Rakefile

@@ -26,9 +26,9 @@ Bones {
   use_gmail
 
   depend_on 'little-plugger', '~> 1.1'
-  depend_on 'multi_json',     '~> 1.10'
+  depend_on 'multi_json',     '~> 1.14'
 
-  depend_on 'flexmock',  '~> 1.0', :development => true
+  depend_on 'test-unit', '~> 3.3', :development => true
   depend_on 'bones-git', '~> 1.3', :development => true
   #depend_on 'bones-rcov',   :development => true
 }

data/examples/appenders.rb

@@ -1,7 +1,7 @@
 # :stopdoc:
 #
 # Appenders are used to output log events to some logging destination. The
-# same log event can be sent to multiple desitnations by associating
+# same log event can be sent to multiple destinations by associating
 # multiple appenders with the logger.
 #
 # The following is a list of all the available appenders and a brief

data/examples/layouts.rb

@@ -33,7 +33,7 @@
   log.level = :debug
 
   log.debug "a very nice little debug message"
-  log.info "things are operating nominally"
+  log.info "things are operating normally"
   log.warn "this is your last warning"
   log.error StandardError.new("something went horribly wrong")
   log.fatal "I Die!"

data/examples/lazy.rb

@@ -2,7 +2,7 @@
 #
 # It happens sometimes that it is very expensive to construct a logging
 # message; for example, if a large object structure has to be traversed
-# during executing of an `object.to_s` method. It would be convenient to
+# during execution of an `object.to_s` method. It would be convenient to
 # delay creation of the message until the log event actually takes place.
 #
 # For example, with a logger configured only to show WARN messages and higher,

data/examples/mdc.rb

@@ -29,9 +29,9 @@
   Logging.mdc['first'] = 'John'
   Logging.mdc['last']  = 'Doe'
 
-  # in this first thread we will log some quotes by Allan Rickman
+  # in this first thread we will log some quotes by Alan Rickman
   t1 = Thread.new {
-    Logging.mdc['first'] = 'Allan'
+    Logging.mdc['first'] = 'Alan'
     Logging.mdc['last']  = 'Rickman'
 
     [ %q{I've never been able to plan my life. I just lurch from indecision to indecision.},

data/examples/rails4.rb

@@ -0,0 +1,21 @@
+# :stopdoc:
+#
+# Rails 4 allows you to hook up multiple loggers (even those external to this gem)
+# so you can use a single Rails.logger statement. For Rails developers, this is
+# easier because if you ever change logging frameworks, you don't have to change
+# all of your app code.
+#
+# See http://railsware.com/blog/2014/08/07/rails-logging-into-several-backends/
+#
+
+require 'logging'
+
+log = Logging.logger(STDOUT)
+log.level = :warn
+
+Rails.logger.extend(ActiveSupport::Logger.broadcast(log))
+
+Rails.logger.debug "this debug message will not be output by the logger"
+Rails.logger.warn "this is your last warning"
+
+# :startdoc:

data/examples/reusing_layouts.rb

@@ -0,0 +1,51 @@
+# :stopdoc:
+#
+# The formatting of log messages is controlled by the layout given to the
+# appender. By default all appenders use the Basic layout. It's pretty
+# basic. However, a more sophisticated Pattern layout can be used or one of
+# the Parseable layouts -- JSON or YAML.
+#
+# The available layouts are:
+#
+#   Logging.layouts.basic
+#   Logging.layouts.pattern
+#   Logging.layouts.json
+#   Logging.layouts.yaml
+#
+# After you configure a layout, you can reuse that layout among different
+# appenders if you so choose. This enables you to have some the style of log
+# output being sent to multiple destinations.
+#
+# We will store a Layout instance in a local variable, and then pass that
+# instance to each appender.
+#
+
+  require 'logging'
+
+  # create our pattern layout instance
+  layout = Logging.layouts.pattern \
+    :pattern      => '[%d] %-5l %c: %m\n',
+    :date_pattern => '%Y-%m-%d %H:%M:%S'
+
+  # only show "info" or higher messages on STDOUT using our layout
+  Logging.appenders.stdout \
+    :level  => :info,
+    :layout => layout
+
+  # send all log events to the development log (including debug) using our layout
+  Logging.appenders.rolling_file \
+    'development.log',
+    :age    => 'daily',
+    :layout => layout
+
+  log = Logging.logger['Foo::Bar']
+  log.add_appenders 'stdout', 'development.log'
+  log.level = :debug
+
+  log.debug "a very nice little debug message"
+  log.info "things are operating normally"
+  log.warn "this is your last warning"
+  log.error StandardError.new("something went horribly wrong")
+  log.fatal "I Die!"
+
+# :startdoc:

data/lib/logging.rb

@@ -23,6 +23,8 @@ module Logging
   PATH = ::File.expand_path('../..', __FILE__) + ::File::SEPARATOR
   LEVELS = {}
   LNAMES = []
+  DEFAULT_CAUSE_DEPTH = 8
+
   module Plugins; end
   # :startdoc:
 
@@ -95,9 +97,9 @@ module Logging
       layout = ::Logging::Layouts::Pattern.new(l_opts)
 
       a_opts = Hash.new
-      a_opts[:size] = size if size.instance_of?(Fixnum)
+      a_opts[:size] = size if size.is_a?(Integer)
       a_opts[:age]  = age  if age.instance_of?(String)
-      a_opts[:keep] = keep if keep.instance_of?(Fixnum)
+      a_opts[:keep] = keep if keep.is_a?(Integer)
       a_opts[:filename] = dev if dev.instance_of?(String)
       a_opts[:layout] = layout
       a_opts.merge! opts
@@ -255,6 +257,9 @@ module Logging
       longest = 'off' if longest.length < 3
       module_eval "MAX_LEVEL_LENGTH = #{longest.length}", __FILE__, __LINE__
 
+      self.cause_depth = nil unless defined? @cause_depth
+      self.raise_errors = false unless defined? @raise_errors
+
       initialize_plugins
       levels.keys
     end
@@ -264,8 +269,8 @@ module Logging
     #
     # Defines the default _obj_format_ method to use when converting objects
     # into string representations for logging. _obj_format_ can be one of
-    # <tt>:string</tt>, <tt>:inspect</tt>, or <tt>:yaml</tt>. These
-    # formatting commands map to the following object methods
+    # <tt>:string</tt>, <tt>:inspect</tt>, <tt>:json</tt> or <tt>:yaml</tt>.
+    # These formatting commands map to the following object methods
     #
     # * :string  => to_s
     # * :inspect => inspect
@@ -273,7 +278,7 @@ module Logging
     # * :json    => MultiJson.encode(obj)
     #
     # An +ArgumentError+ is raised if anything other than +:string+,
-    # +:inspect+, +:yaml+ is passed to this method.
+    # +:inspect+, +:json+ or +:yaml+ is passed to this method.
     #
     def format_as( f )
       f = f.intern if f.instance_of? String
@@ -311,6 +316,74 @@ module Logging
           end
     end
 
+    # Set the default UTC offset used when formatting time values sent to the
+    # appenders. If left unset, the default local time zone will be used for
+    # time values. This method accepts the `utc_offset` format supported by the
+    # `Time#localtime` method in Ruby.
+    #
+    # Passing "UTC" or `0` as the UTC offset will cause all times to be reported
+    # in the UTC timezone.
+    #
+    #   Logging.utc_offset = "-07:00"  # Mountain Standard Time in North America
+    #   Logging.utc_offset = "+01:00"  # Central European Time
+    #   Logging.utc_offset = "UTC"     # UTC
+    #   Logging.utc_offset = 0         # UTC
+    #
+    def utc_offset=( value )
+      @utc_offset = case value
+        when nil;             nil
+        when "UTC", "GMT", 0; 0
+        else
+          Time.now.localtime(value)
+          value
+        end
+    end
+
+    attr_reader :utc_offset
+
+    # Set the default Exception#cause depth used when formatting Exceptions.
+    # This sets the maximum number of nested errors that will be formatted by
+    # the layouts before giving up. This is used to avoid extremely large
+    # outputs.
+    #
+    #   Logging.cause_depth = nil    # set to the DEFAULT_CAUSE_DEPTH
+    #   Logging.cause_depth = 0      # do not show any exception causes
+    #   Logging.cause_depth = 1024   # show up to 1024 causes
+    #   Logging.cause_depth = -1     # results in the DEFAULT_CAUSE_DEPTH
+    #
+    def cause_depth=( value )
+      if value.nil?
+        @cause_depth = DEFAULT_CAUSE_DEPTH
+      else
+        value = Integer(value)
+        @cause_depth = value < 0 ? DEFAULT_CAUSE_DEPTH : value
+      end
+    end
+
+    attr_reader :cause_depth
+
+    # Used to define a `basepath` that will be removed from filenames when
+    # reporting tracing information for log events. Normally you would set this
+    # to the root of your project:
+    #
+    #   Logging.basepath = "/home/user/nifty_project"
+    #
+    # Or if you are in a Rails environment:
+    #
+    #   Logging.basepath = Rails.root.to_s
+    #
+    # The basepath is expanded to a full path with trailing slashes removed.
+    # This setting will be cleared by a call to `Logging.reset`.
+    def basepath=( path )
+      if path.nil? || path.to_s.empty?
+        @basepath = nil
+      else
+        @basepath = File.expand_path(path)
+      end
+    end
+
+    attr_reader :basepath
+
     # Returns the library path for the module. If any arguments are given,
     # they will be joined to the end of the library path using
     # <tt>File.join</tt>.
@@ -405,7 +478,7 @@ module Logging
     # to false. It uses its own appender to send messages to stderr.
     #
     def show_configuration( io = STDOUT, logger = 'root', indent = 0 )
-      logger = ::Logging::Logger[logger] unless ::Logging::Logger === logger
+      logger = ::Logging::Logger[logger] unless logger.is_a?(::Logging::Logger)
 
       io << logger._dump_configuration(indent)
 
@@ -418,6 +491,21 @@ module Logging
       io
     end
 
+    # Raise an exception when an error is encountered while logging, be it with
+    # a backing store, formatter, or anything else. You probably wouldn't want
+    # to enable this outside of test.
+    #
+    # Not that only one error will ever be raised per logging backend, as
+    # backends that raise errors on write will be set to :off.
+    def raise_errors=(boolean)
+      @raise_errors = boolean
+    end
+
+    # Whether or not we should raise errors when writing logs.
+    def raise_errors?
+      @raise_errors
+    end
+
     # :stopdoc:
     # Convert the given level into a canonical form - a lowercase string.
     def levelify( level )
@@ -446,7 +534,7 @@ module Logging
     # exception will be raised again.
     def log_internal_error( err )
       log_internal(-2) { err }
-      raise err if Thread.abort_on_exception
+      raise err if ::Logging.raise_errors?
     end
 
     # Close all appenders
@@ -466,8 +554,11 @@ module Logging
       LEVELS.clear
       LNAMES.clear
       remove_instance_variable :@backtrace if defined? @backtrace
+      remove_instance_variable :@basepath  if defined? @basepath
       remove_const :MAX_LEVEL_LENGTH if const_defined? :MAX_LEVEL_LENGTH
       remove_const :OBJ_FORMAT if const_defined? :OBJ_FORMAT
+      self.utc_offset  = nil
+      self.cause_depth = nil
       self
     end
 
@@ -494,8 +585,7 @@ module Logging
   require libpath('logging/diagnostic_context')
 
   require libpath('logging/rails_compat')
-end  # module Logging
-
+end
 
 # This finalizer will close all the appenders that exist in the system.
 # This is needed for closing IO streams and connections to the syslog server