ezlog 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad2b6dbcdd9a5f406ef62d7fb236b533f08b6b618ee471545838da63d9feaf45
-  data.tar.gz: 3f731ee481f1d4a05ec02a4276a6e787c2f0c11110255021a2b2187c17a21938
+  metadata.gz: dbc2b416fa5e9ad9fc27808ed7466061d9598d7d72cfa954111fd649c0140bac
+  data.tar.gz: eeeeb620f0e1e621e6e87004fc4d1ea764eb1192e22ce20a71ba460ea705fc13
 SHA512:
-  metadata.gz: 5702219d4387e9a628b83391b7f2f6a66b42413314969e48f60016e445d8a1ab328acaaca687f78452f67f92ebeadebf9d4b7951e3dc137b881ecd4f521a9404
-  data.tar.gz: d2f5e226bff51fa7d821f238b7633c3ba9fa0e328423576b854b26e0405bbc54ab6bdbfdd9dfc63214d8aaf443ee9fed79f99dd2c36e07e7cbf46ed42d191a59
+  metadata.gz: 4b4c04947195d99f7570586ebd28e5f11206950076f9f2f0a55cdbc392afa1855db5c8fdec9e6f7cedbe8b5d57d50348b21cf965dbc0efc9323a7db1762fd81d
+  data.tar.gz: 67567839defa31877a6d5df9600835d89bd45ae485d50e633f0ca7e3fa4f3bc27a30700a64fdf3c816c6f27a70083fe97e36520f999e11a698e4600f5d9b23f9

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.5.2 (2019-09-27)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.5.1...v0.5.2)
+
+* Bug fixes
+  * Sidekiq logger now supports the Sidekiq 6 logger interface which includes the method `with_context`. This is 
+    important because other gems (notably [sidekiq-unique-jobs](https://github.com/mhenrixon/sidekiq-unique-jobs))
+    depend on this method and might break if it's not present.
+
 ### 0.5.1 (2019-09-16)
 
 [Full Changelog](https://github.com/emartech/ezlog/compare/v0.5.0...v0.5.1)

data/README.md

@@ -11,7 +11,7 @@ projects using any (or all) of the following libraries or frameworks:
 * [Sequel](https://sequel.jeremyevans.net/) 
 * [Rack::Timeout](https://github.com/heroku/rack-timeout)
 
-It uses Tim Pease's wonderful [Logging](https://github.com/TwP/logging) gem for an all-purpose structured logging solution.
+It uses Tim Pease's wonderful [Logging](https://github.com/TwP/logging) gem under the hood for an all-purpose structured logging solution.
 
 Ezlog's purpose is threefold:
 1. Make sure that our applications are logging in a concise and sensible manner; emitting no unnecessary "noise" but 
@@ -21,7 +21,7 @@ Ezlog's purpose is threefold:
 
 ## Installation
 
-#### Rails
+### Rails
 
 Add this line to your application's Gemfile:
 
@@ -29,7 +29,17 @@ Add this line to your application's Gemfile:
 gem 'ezlog'
 ```
 
-That's it. Everything else is automatically configured.
+Although Ezlog sets up sensible defaults for all logging configuration settings, it leaves you the option to override these
+settings manually in the way you're used to; via [Rails](https://rubyonrails.org/)'s configuration mechanism. Unfortunately
+the [Rails](https://rubyonrails.org/) new project generator automatically generates code for the production environment
+configuration that overrides these settings.
+
+For Ezlog to work properly, you also need to delete the logging configuration options in the 
+`config/environments/production.rb` generated file.
+
+### Non-Rails applications
+
+At the moment Ezlog only support [Rails](https://rubyonrails.org/) apps. Non-Rails support is planned.
 
 ## What it does
 
@@ -37,6 +47,7 @@ That's it. Everything else is automatically configured.
 * Configures [Rails](https://rubyonrails.org/)'s logging
 * Configures [Sidekiq](https://github.com/mperham/sidekiq) logging
 * Configures [Rack::Timeout](https://github.com/heroku/rack-timeout) logging
+* Provides support for adding context information to log messages
 * Provides testing support for [RSpec](https://rspec.info/)
 
 ### Initializes the Logging library
@@ -152,6 +163,37 @@ TestWorker.perform_async 42
 but it is way too verbose by default and all of its important messages (i.e. Timeout errors) are logged by the application
 as well. For this reason, Ezlog turns off [Rack::Timeout](https://github.com/heroku/rack-timeout) logging completely. 
 
+### Provides support for adding context information to log messages
+
+Ezlog provides two helper methods which can be used to add context information to log messages:
+
+* `within_log_context(context)`: Starts a new log context initialized with `context` and executes the provided block 
+  within that context. Once execution is finished, the log context is cleaned up and the previous context (if any) is
+  reinstated. In practice, this means that every time we log something (within the block), the log message will include
+  the information that's in the current context. This can be useful for storing request-specific information 
+  (request ID, user ID, ...) in the log context early on (for example in a middleware) and not have to worry about 
+  including it every time we want to log a message.
+  
+  Example:
+  
+  ```ruby
+  within_log_context customer_id: 1234 do
+    Rails.logger.info 'test 1'
+  end
+  Rails.logger.info 'test 2'
+  
+  #=> {...,"level":"INFO","customer_id":1234,"message":"test 1"}
+  #=> {...,"level":"INFO","message":"test 2"}
+  ```
+  
+* `add_to_log_context(context)`: Adds the provided `context` to the current log context but provides no mechanism for
+  removing it later. Only use this method if you are sure that you're working within a specific log context and that it
+  will be cleaned up later (e.g. by only using this method in a block passed to the previously explained 
+  `within_log_context` method).
+
+You can access these methods either in the global scope by calling them via `Ezlog.within_log_context` and 
+`Ezlog.add_to_log_context` or locally by including the `Ezlog::LogContextHelper` module into your class/module.
+
 ### Provides testing support for RSpec
 
 Ezlog comes with built-in support for testing your logging activity using [RSpec](https://rspec.info/).

data/lib/ezlog/railtie.rb

@@ -45,7 +45,7 @@ module Ezlog
     private
 
     def initialize_sidekiq_logging(app)
-      ::Sidekiq.logger = Ezlog.logger('Sidekiq')
+      ::Sidekiq.logger = Ezlog.logger('Sidekiq').extend Ezlog::Sidekiq::LoggerExtension
       ::Sidekiq.logger.level = app.config.log_level
       ::Sidekiq.configure_server do |config|
         config.options[:job_logger] = Ezlog::Sidekiq::JobLogger

data/lib/ezlog/sidekiq.rb

@@ -3,5 +3,6 @@ module Ezlog
     autoload :ErrorLogger, 'ezlog/sidekiq/error_logger'
     autoload :JobContext, 'ezlog/sidekiq/job_context'
     autoload :JobLogger, 'ezlog/sidekiq/job_logger'
+    autoload :LoggerExtension, 'ezlog/sidekiq/logger_extension'
   end
 end

data/lib/ezlog/sidekiq/logger_extension.rb

@@ -0,0 +1,11 @@
+module Ezlog
+  module Sidekiq
+    module LoggerExtension
+      include LogContextHelper
+
+      def with_context(context, &block)
+        within_log_context context, &block
+      end
+    end
+  end
+end

data/lib/ezlog/version.rb

@@ -1,3 +1,3 @@
 module Ezlog
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezlog
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -159,6 +159,7 @@ files:
 - lib/ezlog/sidekiq/error_logger.rb
 - lib/ezlog/sidekiq/job_context.rb
 - lib/ezlog/sidekiq/job_logger.rb
+- lib/ezlog/sidekiq/logger_extension.rb
 - lib/ezlog/version.rb
 - lib/sequel/extensions/ezlog_logging.rb
 homepage: https://github.com/emartech/ezlog
@@ -181,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A zero-configuration logging solution for projects using Sidekiq, Rails,