ezlog 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 224d8e39821229350d6b406645432d210cc2b2e8
-  data.tar.gz: 45d821f0923048e29c085a3a86a6104776b2dbc0
+SHA256:
+  metadata.gz: e820d0ac516dc835494a109ac51e172f73f90be55e756ccc248a4a87fc7c890c
+  data.tar.gz: 83153708c674634ccbe37193a7945038d3b1758e1f114b9cd33609c937cda102
 SHA512:
-  metadata.gz: 8ad716714f7e5cef573a434828bca5984ed5af24222a339f1e9712a9e4ccb3478f326c01219fac4f01e34afad0b25b052c550309626d4c04a861be673b2bb46b
-  data.tar.gz: febe42af5f6d3356e644cce5c43c289bcba87cc8a1caa2ace751f9fd7d23cbc66be7ea59c5251c44cdd55436f4136fab9985ece9e41552d77b05b48a95e8dd8e
+  metadata.gz: c68f24ec9b95d3175d1d2140cdf1b918704fda5d6dab419cf6a2dac370137860d4c25d2ef2433af660d124e80aa152138db3be8991e09da93bde0ba5d70b2867
+  data.tar.gz: 0f1614756509f95871e96330aa95b2f498d91ed3be358d8b8d6b3c18699b5015511dac9c413b4e355f72ccc05f837ce86599908811572e2d928a85cacd9134b7

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.3.3 (2019-08-10)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.3.2...v0.3.3)
+
+* Features & enhancements
+  * [Sidekiq](https://github.com/mperham/sidekiq) logging respects the log level configured for the application.
+  * Log level can be set from an environment variable (LOG_LEVEL).
+
 ### 0.3.2 (2019-06-18)
 
 [Full Changelog](https://github.com/emartech/ezlog/compare/v0.3.1...v0.3.2)

data/README.md

@@ -39,7 +39,7 @@ That's it. Everything else is automatically configured.
 * Configures [Rack::Timeout](https://github.com/heroku/rack-timeout) logging
 * Provides testing support for [RSpec](https://rspec.info/)
 
-#### Initializes the Logging library
+### Initializes the Logging library
 
 Ezlog sets up [Logging](https://github.com/TwP/logging)'s root logger to have an appender that writes to STDOUT.
 Any loggers created by the application will inherit this appender and will thus write their logs to STDOUT.
@@ -70,11 +70,10 @@ logger.error ex
 #=> {"logger":"App","timestamp":"2019-05-11T16:08:38+02:00","level":"ERROR","hostname":"MacbookPro.local","pid":71674,"message":"Error message","error":{"class":"StandardError","message":"Error message","backtrace":[...]}}
 ```
 
-#### Configures Rails logging
+### Configures Rails logging
 
 Ezlog configures the `Rails.logger` to be an instance of a [Logging](https://github.com/TwP/logging) logger by the name 
-of `Application`, behaving as described above. The logger uses the log level set in `application.rb` if present, or 
-INFO as a default log level.
+of `Application`, behaving as described above. 
 
 In addition to this, Ezlog also does the following:
 * It adds the environment (`Rails.env`) to the logger's initial context, so it will automatically be appended to all log messages 
@@ -108,15 +107,25 @@ With Ezlog:
 {"logger":"AccessLog","timestamp":"2019-06-08T08:49:31+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75463,"environment":"development","request_id":"9a43631b-284c-4677-9d08-9c1cc5c7d3a7","duration_sec":0.031,"message":"GET /welcome?subsession_id=34ea8596f9764f475f81158667bc2654 - 200 (OK)","remote_ip":"127.0.0.1","method":"GET","path":"/welcome?subsession_id=34ea8596f9764f475f81158667bc2654","params":{"subsession_id":"34ea8596f9764f475f81158667bc2654","controller":"pages","action":"welcome"},"response_status_code":200}
 ```
 
-#### Configures Sidekiq logging
+#### The log level
+
+The logger's log level is determined as follows (in order of precedence):
+* the log level set in the application's configuration,
+* the LOG_LEVEL environment variable, or
+* `INFO` as the default log level if none of the above are set.
+
+The following log levels are available: `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`.
+
+### Configures Sidekiq logging
 
 Ezlog configures the `Sidekiq.logger` to be an instance of a [Logging](https://github.com/TwP/logging) logger by the name
-of `Sidekiq`, behaving as described above. It also comes with its own job logger for [Sidekiq](https://github.com/mperham/sidekiq) 
+of `Sidekiq`, behaving as described above. The logger uses the same log level as the [Rails](https://rubyonrails.org/) 
+logger (see above). Ezlog also comes with its own job logger for [Sidekiq](https://github.com/mperham/sidekiq) 
 which does several things that come in very handy when working with background jobs.
  
 * It emits two log messages per job run; one when the job is started and another one when the job is finished (successfully or unsuccessfuly).
 * It measures the time it took to execute the job and appends the benchmark information to the final log message.
-* It adds all basic information about the job (worker, queue, JID, created_at, enqueued_at) to the log context so
+* It adds all basic information about the job (worker, queue, JID, created_at, enqueued_at, run_count) to the log context so
 all log messages emitted during the execution of the job will contain this information.
 * It also adds all of the job's parameters (by name) to the log context, which means that all log messages emitted 
 during the execution of the job will contain this information as well.
@@ -132,18 +141,18 @@ end
 
 TestWorker.perform_async 42
 
-#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:10+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"abcdef1234567890","queue":"default","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":42,"message":"TestWorker started"}
-#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:10+02:00","level":"WARN","hostname":"MacbookPro.local","pid":75538,"jid":"abcdef1234567890","queue":"default","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":42,"message":"Customer not found"}
-#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:12+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"abcdef1234567890","queue":"default","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":42,"duration_sec":2.667,"message":"TestWorker finished"}
+#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:10+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"abcdef1234567890","queue":"default","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","run_count":1,"customer_id":42,"message":"TestWorker started"}
+#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:10+02:00","level":"WARN","hostname":"MacbookPro.local","pid":75538,"jid":"abcdef1234567890","queue":"default","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","run_count":1,"customer_id":42,"message":"Customer not found"}
+#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:12+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"abcdef1234567890","queue":"default","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","run_count":1,"customer_id":42,"duration_sec":2.667,"message":"TestWorker finished"}
 ```
 
-#### Configures Rack::Timeout logging
+### Configures Rack::Timeout logging
 
 [Rack::Timeout](https://github.com/heroku/rack-timeout) is a very useful tool for people running services on Heroku
 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 testing support for RSpec
+### Provides testing support for RSpec
 
 Ezlog comes with built-in support for testing your logging activity using [RSpec](https://rspec.info/).
 To enable spec support for Ezlog, put this line in your `spec_helper.rb` or `rails_helper.rb`:

data/lib/ezlog/railtie.rb

@@ -5,8 +5,8 @@ module Ezlog
       ::Logging.logger.root.level = app.config.log_level
     end
 
-    initializer 'ezlog.configure_sidekiq_logging' do
-      initialize_sidekiq_logging if defined? ::Sidekiq
+    initializer 'ezlog.configure_sidekiq_logging' do |app|
+      initialize_sidekiq_logging(app) if defined? ::Sidekiq
     end
 
     initializer 'ezlog.configure_rack_timeout_logging' do
@@ -27,14 +27,14 @@ module Ezlog
 
     config.before_configuration do |app|
       app.config.logger = Ezlog.logger('Application')
-      app.config.log_level = :info
+      app.config.log_level = ENV['LOG_LEVEL'] || :info
     end
 
     private
 
-    def initialize_sidekiq_logging
+    def initialize_sidekiq_logging(app)
       ::Sidekiq.logger = Ezlog.logger('Sidekiq')
-      ::Sidekiq.logger.level = :info
+      ::Sidekiq.logger.level = app.config.log_level
       ::Sidekiq.configure_server do |config|
         config.options[:job_logger] = Ezlog::Sidekiq::JobLogger
         config.error_handlers << Ezlog::Sidekiq::ErrorLogger.new

data/lib/ezlog/version.rb

@@ -1,3 +1,3 @@
 module Ezlog
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezlog
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-18 00:00:00.000000000 Z
+date: 2019-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -150,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A zero-configuration logging solution for projects using Sidekiq, Rails,