loga 2.3.1 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9144c2b13cb8e6ed178d6ee24e99c9d00d4ce23bf3198d487e1803d221038874
-  data.tar.gz: 2528a6ce89a60dccc50e22f98abd1e4e74ae3f49319adeed42a89a98ad4412f8
+  metadata.gz: 252a23996e615f29819c4465c083adb286278026baaf2c2d693883bf76560e24
+  data.tar.gz: c410a1c3442a4f66fd299c456cf62ae7cc21d8beb89ce16ba98460a0b1142b3f
 SHA512:
-  metadata.gz: 1d9b346f49a5661ab32f3cabe4a16edba7757aa5a5d10b830758d1ca12ff70ece723014701a5ba82da7d358736c320af4a91e7dee609ba657d200905b5afdb3f
-  data.tar.gz: e53c366b5efcb67136322cae79fa6f21fcfdbefd654cb982681067b02de0c86d02f678afe02b7e5c3db298024818ba06dd5ac4ad51f0c234ea799a906295782d
+  metadata.gz: bbeb468b6ddd72798c497a8f1f2f0d34acf189e9ada83d4dc6d878461e9d65b19365582deb9a9ce48886379f10e97185c551c228b4a0adc827a3d1d2d686c987
+  data.tar.gz: f063246243858c1645bfd9b02b50396268c0c3c72ae966d2e070f22cf2dd332635601c66ab4c550680c49eb9faaaafaae0c60e98c71fa249f14de5fd45881eb4

data/.circleci/config.yml

@@ -58,21 +58,25 @@ jobs:
           command: |
             ./tmp/cc-test-reporter sum-coverage tmp/codeclimate.*.json -o tmp/codeclimate.total.json
             ./tmp/cc-test-reporter upload-coverage -i tmp/codeclimate.total.json -r $CODECLIMATE_REPO_TOKEN
-  ruby-2.2:
-    docker:
-      - image: circleci/ruby:2.2.10
-    <<: *test_build
   ruby-2.3:
     docker:
-      - image: circleci/ruby:2.3.7
+      - image: circleci/ruby:2.3
     <<: *test_build
   ruby-2.4:
     docker:
-      - image: circleci/ruby:2.4.4
+      - image: circleci/ruby:2.4
     <<: *test_build
   ruby-2.5:
     docker:
-      - image: circleci/ruby:2.5.1
+      - image: circleci/ruby:2.5
+    <<: *test_build
+  ruby-2.6:
+    docker:
+      - image: circleci/ruby:2.6
+    <<: *test_build
+  ruby-2.7:
+    docker:
+      - image: circleci/ruby:2.7
     <<: *test_build
   rubocop:
     <<: *basic_build
@@ -111,25 +115,31 @@ workflows:
           filters:
             tags:
               only: /.*/
-      - ruby-2.2:
+      - ruby-2.3:
           filters:
             tags:
               only: /.*/
           requires:
             - build
-      - ruby-2.3:
+      - ruby-2.4:
           filters:
             tags:
               only: /.*/
           requires:
             - build
-      - ruby-2.4:
+      - ruby-2.5:
           filters:
             tags:
               only: /.*/
           requires:
             - build
-      - ruby-2.5:
+      - ruby-2.6:
+          filters:
+            tags:
+              only: /.*/
+          requires:
+            - build
+      - ruby-2.7:
           filters:
             tags:
               only: /.*/
@@ -140,10 +150,11 @@ workflows:
             tags:
               only: /.*/
           requires:
-            - ruby-2.2
             - ruby-2.3
             - ruby-2.4
             - ruby-2.5
+            - ruby-2.6
+            - ruby-2.7
       - push-to-rubygems:
           filters:
             tags:
@@ -152,7 +163,8 @@ workflows:
               ignore: /.*/
           requires:
             - rubocop
-            - ruby-2.2
             - ruby-2.3
             - ruby-2.4
             - ruby-2.5
+            - ruby-2.6
+            - ruby-2.7

data/Appraisals

@@ -8,20 +8,32 @@ if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4.0')
   end
 end
 
-appraise 'rails42' do
-  gem 'rails', '~> 4.2.0'
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7.0')
+  appraise 'rails42' do
+    gem 'rails', '~> 4.2.0'
+  end
+
+  appraise 'rails50' do
+    gem 'rails', '~> 5.0.0'
+  end
+
+  appraise 'rails52' do
+    gem 'rails', '~> 5.2.0'
+  end
 end
 
 appraise 'sinatra14' do
   gem 'sinatra', '~> 1.4.0'
 end
 
-appraise 'rails50' do
-  gem 'rails', '~> 5.0.0'
-end
+if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.5.0')
+  appraise 'rails60' do
+    gem 'rails', '~> 6.0.0'
+  end
 
-appraise 'rails52' do
-  gem 'rails', '~> 5.2.0'
+  appraise 'sidekiq6' do
+    gem 'sidekiq', '~> 6.0'
+  end
 end
 
 appraise 'sidekiq51' do

data/CHANGELOG.md

@@ -4,6 +4,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.5.3] - 2020-10-27
+### Fixed
+- Support for sidekiq 6 - previous versions were causing sidekiq to crash with `Internal exception!`
+
+## [2.5.2] - 2020-10-21
+### Fixed
+- Support for sidekiq 6
+
+## [2.5.1] - 2020-01-02
+### Fixed
+- Fixed a long standing bug that would mask exceptions raised by the host application when serving requests. The original exception would be replaced with a `TypeError` one due to a HTTP status code not being available within `Loga::Rack::Logger`.
+
+## [2.5.0] - 2019-11-12
+### Added
+- Add support for rails 6
+
+## [2.4.0] - 2019-09-03
+### Fixed
+- `duration` in the `sidekiq` integration is now calculated correctly
+### Added
+- Add build for ruby 2.6
+### Removed
+- Remove build for ruby 2.2
+
 ## [2.3.1] - 2019-05-14
 ### Added
 New configuration option `hide_pii` which defaults to `true` to hide email addresses in logs that get generate when an email is sent through action_mailer

data/Gemfile

@@ -4,5 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'simplecov'
+  gem 'simplecov', '~> 0.17.0'
 end

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://circleci.com/gh/FundingCircle/loga/tree/master.svg?style=shield&circle-token=9b81c3cf8468a8c3dc760f4c0398cf8914cb27d4)](https://circleci.com/gh/FundingCircle/loga/tree/master)
 [![Code Quality](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/gpa.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/feed)
 [![Test Coverage](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/coverage.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/coverage)
-[![Dependency Status](https://gemnasium.com/badges/github.com/FundingCircle/loga.svg)](https://gemnasium.com/github.com/FundingCircle/loga)
+[![Dependency Status](https://img.shields.io/librariesio/release/rubygems/loga)](https://libraries.io/rubygems/loga)
 
 ## Description
 

data/gemfiles/rails60.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.0"
+
+group :test do
+  gem "simplecov"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq6.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 6.0"
+
+group :test do
+  gem "simplecov"
+end
+
+gemspec path: "../"

data/lib/loga/configuration.rb

@@ -79,6 +79,7 @@ module Loga
       { format: ENV['LOGA_FORMAT'].presence }.reject { |_, v| v.nil? }
     end
 
+    # Note: sidekiq 6 will extend the logger -> https://github.com/mperham/sidekiq/blob/v6.1.2/lib/sidekiq.rb#L210
     def initialize_logger
       device.sync      = sync
       logger           = Logger.new(device)

data/lib/loga/formatters/gelf_formatter.rb

@@ -47,7 +47,8 @@ module Loga
                 end
 
         event.timestamp ||= time
-        event.data ||= {}
+        # Overwrite sidekiq_context data anything manually specified
+        event.data = sidekiq_context.merge!(event.data || {})
         event.data.tap do |hash|
           hash.merge! compute_exception(event.exception)
           hash.merge! compute_type(event.type)
@@ -101,6 +102,20 @@ module Loga
           tags: current_tags.join(' '),
         }
       end
+
+      def sidekiq_context
+        return {} unless defined?(::Sidekiq::Context)
+
+        c = ::Sidekiq::Context.current
+
+        # The context usually holds :class and :jid. :elapsed is added when the job ends
+        data = c.dup
+        if data.key?(:elapsed)
+          data[:duration] = data[:elapsed].to_f
+          data.delete(:elapsed)
+        end
+        data
+      end
     end
   end
 end

data/lib/loga/rack/logger.rb

@@ -44,6 +44,9 @@ module Loga
         data['user_agent'] = request.user_agent
         data['controller'] = request.controller_action_name if request.controller_action_name
         data['duration']   = duration_in_ms(started_at, Time.now)
+
+        # If data['status'] is nil we assume an exception was raised when calling the application
+        data['status']     ||= 500
       end
       # rubocop:enable Metrics/LineLength
 

data/lib/loga/railtie.rb

@@ -125,7 +125,7 @@ module Loga
       def silence_rails_rack_logger
         case Rails::VERSION::MAJOR
         when 3    then require 'loga/ext/rails/rack/logger3.rb'
-        when 4..5 then require 'loga/ext/rails/rack/logger.rb'
+        when 4..6 then require 'loga/ext/rails/rack/logger.rb'
         else
           raise Loga::ConfigurationError,
                 "Rails #{Rails::VERSION::MAJOR} is unsupported"

data/lib/loga/sidekiq.rb

@@ -1,16 +1,24 @@
-require 'loga/sidekiq/job_logger'
-
 module Loga
   module Sidekiq
     def self.configure_logging
       return unless defined?(::Sidekiq)
       return if Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('5.0')
 
-      ::Sidekiq.configure_server do |config|
-        config.options[:job_logger] = Loga::Sidekiq::JobLogger
+      if Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('6.0')
+        require 'loga/sidekiq5/job_logger'
+
+        ::Sidekiq.configure_server do |config|
+          config.options[:job_logger] = Loga::Sidekiq5::JobLogger
+        end
+      elsif Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('7.0')
+        require 'loga/sidekiq6/job_logger'
+
+        ::Sidekiq.configure_server do |config|
+          config.options[:job_logger] = Loga::Sidekiq6::JobLogger
+        end
       end
 
-      ::Sidekiq::Logging.logger = Loga.configuration.logger
+      ::Sidekiq.logger = Loga.configuration.logger
     end
   end
 end

data/lib/loga/{sidekiq → sidekiq5}/job_logger.rb

@@ -1,22 +1,22 @@
 module Loga
-  module Sidekiq
+  module Sidekiq5
     # The approach of using a custom job logger in sidekiq was introduced
     # in v5.0: https://github.com/mperham/sidekiq/pull/3235
-    # This job logger does not support logging for Sidekiq versions
-    # that are before 5.0
     class JobLogger
       include Loga::Utilities
 
       EVENT_TYPE = 'sidekiq'.freeze
 
-      attr_reader :started_at, :data
+      def started_at
+        @started_at ||= Time.now
+      end
 
-      def initialize
-        @started_at = Time.now
-        @data = {}
+      def data
+        @data ||= {}
       end
 
       def call(item, _queue)
+        reset_data
         yield
       rescue Exception => ex # rubocop:disable Lint/RescueException
         data['exception'] = ex
@@ -29,6 +29,11 @@ module Loga
 
       private
 
+      def reset_data
+        @data = {}
+        @started_at = Time.now
+      end
+
       def assign_data(item)
         data['created_at']  = item['created_at']
         data['enqueued_at'] = item['enqueued_at']

data/lib/loga/sidekiq6/job_logger.rb

@@ -0,0 +1,50 @@
+require 'sidekiq/job_logger'
+
+module Loga
+  module Sidekiq6
+    class JobLogger < ::Sidekiq::JobLogger
+      EVENT_TYPE = 'sidekiq'.freeze
+
+      def call(item, _queue)
+        start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+
+        yield
+
+        with_elapsed_time_context(start) do
+          loga_log(
+            message: "#{item['class']} with jid: '#{item['jid']}' done", item: item,
+          )
+        end
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        with_elapsed_time_context(start) do
+          loga_log(
+            message: "#{item['class']} with jid: '#{item['jid']}' fail", item: item,
+            exception: e
+          )
+        end
+
+        raise
+      end
+
+      private
+
+      def loga_log(message:, item:, exception: nil)
+        data = {
+          'created_at'  => item['created_at'],
+          'enqueued_at' => item['enqueued_at'],
+          'jid'         => item['jid'],
+          'queue'       => item['queue'],
+          'retry'       => item['retry'],
+          'params'      => item['args'],
+          'class'       => item['class'],
+        }
+        if exception
+          data['exception'] = exception
+          @logger.warn(Event.new(type: EVENT_TYPE, message: message, data: data))
+        else
+          @logger.info(Event.new(type: EVENT_TYPE, message: message, data: data))
+        end
+      end
+    end
+  end
+end

data/lib/loga/version.rb

@@ -1,3 +1,3 @@
 module Loga
-  VERSION = '2.3.1'.freeze
+  VERSION = '2.5.3'.freeze
 end

data/loga.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack'
 
   spec.add_development_dependency 'appraisal', '~> 2.2.0'
-  spec.add_development_dependency 'bundler',   '~> 1.6'
+  spec.add_development_dependency 'bundler',   '>= 1.6'
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'guard',         '~> 2.13'
   spec.add_development_dependency 'guard-rspec',   '~> 4.7.3'

data/spec/fixtures/rails60.rb

@@ -0,0 +1,80 @@
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+
+Bundler.require(*Rails.groups)
+
+STREAM = StringIO.new unless defined?(STREAM)
+
+class Dummy < Rails::Application
+  config.eager_load = true
+  config.filter_parameters += [:password]
+  config.secret_key_base = '2624599ca9ab3cf3823626240138a128118a87683bf03ab8f155844c33b3cd8cbbfa3ef5e29db6f5bd182f8bd4776209d9577cfb46ac51bfd232b00ab0136b24'
+  config.session_store :cookie_store, key: '_rails60_session'
+
+  config.log_tags = [:uuid, 'TEST_TAG']
+  config.loga = {
+    device: STREAM,
+    host: 'bird.example.com',
+    service_name: 'hello_world_app',
+    service_version: '1.0',
+  }
+  config.action_mailer.delivery_method = :test
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  protect_from_forgery with: :null_session
+
+  def ok
+    render plain: 'Hello Rails'
+  end
+
+  def error
+    nil.name
+  end
+
+  def show
+    render json: params
+  end
+
+  def create
+    render json: params
+  end
+
+  def new
+    redirect_to :ok
+  end
+
+  def update
+    @id = params[:id]
+    render '/user'
+  end
+end
+
+class FakeMailer < ActionMailer::Base
+  default from: 'notifications@example.com'
+
+  def self.send_email
+    basic_mail.deliver_now
+  end
+
+  def basic_mail
+    mail(
+      to: 'user@example.com',
+      subject: 'Welcome to My Awesome Site',
+      body: 'Banana muffin',
+      content_type: 'text/html',
+    )
+  end
+end
+
+Dummy.routes.append do
+  get 'ok'        => 'application#ok'
+  get 'error'     => 'application#error'
+  get 'show'      => 'application#show'
+  post 'users'    => 'application#create'
+  get 'new'       => 'application#new'
+  put 'users/:id' => 'application#update'
+end
+
+Dummy.initialize!

data/spec/integration/{sidekiq_spec.rb → sidekiq5_spec.rb}

@@ -19,11 +19,40 @@ class MySidekiqWorker
 end
 
 describe 'Sidekiq client logger' do
+  let(:mgr) do
+    Class.new do
+      attr_reader :latest_error, :mutex, :cond
+
+      def initialize
+        @mutex = ::Mutex.new
+        @cond = ::ConditionVariable.new
+      end
+
+      def processor_died(_inst, err)
+        @latest_error = err
+
+        @mutex.synchronize { @cond.signal }
+      end
+
+      def processor_stopped(_inst)
+        @mutex.synchronize { @cond.signal }
+      end
+
+      def options
+        {
+          concurrency: 3,
+          queues: ['default'],
+          job_logger: Loga::Sidekiq5::JobLogger,
+        }
+      end
+    end
+  end
+
   let(:target) { StringIO.new }
 
-  let(:json_line) do
+  def read_json_log(line:)
     target.rewind
-    JSON.parse(target.read)
+    JSON.parse(target.each_line.drop(line - 1).first)
   end
 
   before do
@@ -40,13 +69,7 @@ describe 'Sidekiq client logger' do
   end
 
   it 'has the proper job logger' do
-    job_logger = Loga::Sidekiq::JobLogger
-
-    expect(Sidekiq.options[:job_logger]).to eq job_logger
-  end
-
-  it 'has the proper logger Sidekiq::Logging.logger' do
-    expect(Sidekiq::Logging.logger).to eq Loga.logger
+    expect(Sidekiq.options[:job_logger]).to eq Loga::Sidekiq5::JobLogger
   end
 
   it 'has the proper logger for Sidekiq.logger' do
@@ -66,45 +89,24 @@ describe 'Sidekiq client logger' do
     end
   end
 
-  if ENV['BUNDLE_GEMFILE'] =~ /sidekiq51/
-    # https://github.com/mperham/sidekiq/blob/97363210b47a4f8a1d8c1233aaa059d6643f5040/test/test_actors.rb#L57-L79
-    let(:mgr) do
-      Class.new do
-        attr_reader :latest_error, :mutex, :cond
-
-        def initialize
-          @mutex = ::Mutex.new
-          @cond = ::ConditionVariable.new
-        end
-
-        def processor_died(_inst, err)
-          @latest_error = err
-
-          @mutex.synchronize { @cond.signal }
-        end
-
-        def processor_stopped(_inst)
-          @mutex.synchronize { @cond.signal }
-        end
-
-        def options
-          {
-            concurrency: 3,
-            queues: ['default'],
-            job_logger: Loga::Sidekiq::JobLogger,
-          }
-        end
-      end
-    end
+  it 'has the proper logger Sidekiq::Logging.logger' do
+    expect(Sidekiq::Logging.logger).to eq Loga.logger
+  end
 
-    it 'logs the job processing event' do
-      MySidekiqWorker.perform_async('Bob')
+  # https://github.com/mperham/sidekiq/blob/97363210b47a4f8a1d8c1233aaa059d6643f5040/test/test_actors.rb#L57-L79
 
-      require 'sidekiq/processor'
-      Sidekiq::Processor.new(mgr.new).start
-      sleep 0.5
+  it 'logs the job processing event' do
+    MySidekiqWorker.perform_async('Bob')
 
-      expected_attributes = {
+    require 'sidekiq/processor'
+
+    Sidekiq::Processor.new(mgr.new).start
+    sleep 0.5
+
+    json_line = read_json_log(line: 1)
+
+    aggregate_failures do
+      expect(json_line).to include(
         '_queue'=> 'default',
         '_retry'=> true,
         '_params'=> ['Bob'],
@@ -115,17 +117,27 @@ describe 'Sidekiq client logger' do
         '_tags'=> '',
         'level'=> 6,
         'version'=> '1.1',
-      }
+      )
 
-      aggregate_failures do
-        expect(json_line).to include(expected_attributes)
-
-        %w[_created_at _enqueued_at _jid _duration timestamp host].each do |key|
-          expect(json_line).to have_key(key)
-        end
-
-        expect(json_line['short_message']).to match(/MySidekiqWorker with jid:*/)
+      %w[_created_at _enqueued_at _jid _duration timestamp host].each do |key|
+        expect(json_line).to have_key(key)
       end
+
+      expect(json_line['short_message']).to match(/MySidekiqWorker with jid:*/)
     end
+
+    # This was a bug - the duration was constantly incresing based on when
+    # the logger was created. https://github.com/FundingCircle/loga/pull/117
+    #
+    # Test that after sleeping for few seconds the duration is still under 500ms
+    sleep 1
+
+    MySidekiqWorker.perform_async('Bob')
+
+    sleep 1
+
+    json_line = read_json_log(line: 2)
+
+    expect(json_line['_duration']).to be < 500
   end
 end

data/spec/integration/sidekiq6_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+require 'timecop'
+require 'fakeredis'
+
+dummy_redis_config = ConnectionPool.new(size: 5) { Redis.new }
+
+Sidekiq.configure_client do |config|
+  config.redis = dummy_redis_config
+end
+
+Sidekiq.configure_server do |config|
+  config.redis = dummy_redis_config
+end
+
+class MySidekiqWorker
+  include Sidekiq::Worker
+
+  def perform(_name)
+    logger.info('Hello from MySidekiqWorker')
+  end
+end
+
+describe 'Sidekiq client logger' do
+  let(:mgr) do
+    # https://github.com/mperham/sidekiq/blob/v6.1.2/test/test_actors.rb#L58-L82
+    Class.new do
+      attr_reader :latest_error, :mutex, :cond
+
+      def initialize
+        @mutex = ::Mutex.new
+        @cond = ::ConditionVariable.new
+      end
+
+      def processor_died(_inst, err)
+        @latest_error = err
+
+        @mutex.synchronize { @cond.signal }
+      end
+
+      def processor_stopped(_inst)
+        @mutex.synchronize { @cond.signal }
+      end
+
+      def options
+        {
+          concurrency: 3,
+          queues: ['default'],
+          job_logger: Loga::Sidekiq6::JobLogger,
+        }.tap { |opts| opts[:fetch] = ::Sidekiq::BasicFetch.new(opts) }
+      end
+    end
+  end
+
+  let(:target) { StringIO.new }
+
+  def read_json_log(line:)
+    target.rewind
+    JSON.parse(target.each_line.drop(line - 1).first)
+  end
+
+  before do
+    Redis.current.flushall
+
+    Loga.reset
+
+    Loga.configure(
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      device: target,
+      format: :gelf,
+    )
+  end
+
+  it 'has the proper job logger' do
+    expect(Sidekiq.options[:job_logger]).to eq Loga::Sidekiq6::JobLogger
+  end
+
+  it 'has the proper logger for Sidekiq.logger' do
+    expect(Sidekiq.logger).to eq Loga.logger
+  end
+
+  it 'pushes a new element in the default queue' do
+    MySidekiqWorker.perform_async('Bob')
+
+    last_element = JSON.parse(Redis.current.lpop('queue:default'))
+
+    aggregate_failures do
+      expect(last_element['class']).to eq 'MySidekiqWorker'
+      expect(last_element['args']).to eq ['Bob']
+      expect(last_element['retry']).to eq true
+      expect(last_element['queue']).to eq 'default'
+    end
+  end
+
+  def test_log_from_worker(json_line)
+    aggregate_failures do
+      expect(json_line).to include(
+        '_class' => 'MySidekiqWorker',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_tags' => '',
+        'level' => 6,
+        'version' => '1.1',
+        'short_message' => 'Hello from MySidekiqWorker',
+      )
+
+      %w[_jid timestamp host].each do |key|
+        expect(json_line).to have_key(key)
+      end
+
+      expect(json_line).not_to include('_duration')
+    end
+  end
+
+  def test_job_end_log(json_line) # rubocop:disable Metrics/MethodLength
+    aggregate_failures do
+      expect(json_line).to include(
+        '_queue' => 'default',
+        '_retry' => true,
+        '_params' => ['Bob'],
+        '_class' => 'MySidekiqWorker',
+        '_type' => 'sidekiq',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_tags' => '',
+        'level' => 6,
+        'version' => '1.1',
+      )
+
+      %w[_created_at _enqueued_at _jid _duration timestamp host].each do |key|
+        expect(json_line).to have_key(key)
+      end
+
+      expect(json_line['_duration']).to be < 500
+      expect(json_line['short_message']).to match(/MySidekiqWorker with jid:*/)
+    end
+  end
+
+  it 'logs the job processing event' do
+    MySidekiqWorker.perform_async('Bob')
+
+    require 'sidekiq/processor'
+
+    sidekiq_manager = mgr.new
+    Sidekiq::Processor.new(sidekiq_manager, sidekiq_manager.options).start
+    sleep 0.5
+
+    test_log_from_worker(read_json_log(line: 1))
+    test_job_end_log(read_json_log(line: 2))
+
+    # This was a bug - the duration was constantly incresing based on when
+    # the logger was created. https://github.com/FundingCircle/loga/pull/117
+    #
+    # Test that after sleeping for few seconds the duration is still under 500ms
+    sleep 1
+
+    MySidekiqWorker.perform_async('Bob')
+
+    sleep 1
+
+    test_log_from_worker(read_json_log(line: 3))
+    test_job_end_log(read_json_log(line: 4))
+  end
+end

data/spec/loga/{sidekiq → sidekiq5}/job_logger_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
+require 'loga/sidekiq5/job_logger'
 
-RSpec.describe Loga::Sidekiq::JobLogger do
+RSpec.describe Loga::Sidekiq5::JobLogger do
   subject(:job_logger) { described_class.new }
 
   let(:target) { StringIO.new }

data/spec/loga/sidekiq6/job_logger_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+require 'loga/sidekiq6/job_logger'
+
+RSpec.describe Loga::Sidekiq6::JobLogger do
+  subject(:job_logger) { described_class.new }
+
+  let(:target) { StringIO.new }
+
+  let(:json_line) do
+    target.rewind
+    JSON.parse(target.read.split("\n").last)
+  end
+
+  before do
+    Loga.reset
+
+    Loga.configure(
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      device: target,
+      format: :gelf,
+    )
+  end
+
+  # https://github.com/mperham/sidekiq/blob/v6.1.2/lib/sidekiq/job_logger.rb
+  it 'inherits from ::Sidekiq::JobLogger' do
+    expect(subject).to be_a(::Sidekiq::JobLogger)
+  end
+
+  describe '#call' do
+    context 'when the job passess successfully' do
+      let(:item_data) do
+        {
+          'class' => 'HardWorker',
+          'args' => ['asd'],
+          'retry' => true,
+          'queue' => 'default',
+          'jid' => '591f6f66ee0d218fb451dfb6',
+          'created_at' => 1_528_799_582.904939,
+          'enqueued_at' => 1_528_799_582.9049861,
+        }
+      end
+
+      it 'has the the required attributes on call' do
+        job_logger.call(item_data, 'queue') do
+          # something
+        end
+
+        expected_body = {
+          'version' => '1.1',
+          'level' => 6,
+          '_type' => 'sidekiq',
+          '_created_at' => 1_528_799_582.904939,
+          '_enqueued_at' => 1_528_799_582.9049861,
+          '_jid' => '591f6f66ee0d218fb451dfb6',
+          '_retry' => true,
+          '_queue' => 'default',
+          '_service.name' => 'hello_world_app',
+          '_class' => 'HardWorker',
+          '_service.version' => '1.0',
+          '_tags' => '',
+          '_params' => ['asd'],
+        }
+
+        aggregate_failures do
+          expect(json_line).to include(expected_body)
+          expect(json_line['timestamp']).to be_a(Float)
+          expect(json_line['host']).to be_a(String)
+          expect(json_line['short_message']).to match(/HardWorker with jid:*/)
+        end
+      end
+    end
+
+    context 'when the job fails' do
+      let(:item_data) do
+        {
+          'class' => 'HardWorker',
+          'args' => ['asd'],
+          'retry' => true,
+          'queue' => 'default',
+          'jid' => '591f6f66ee0d218fb451dfb6',
+          'created_at' => 1_528_799_582.904939,
+          'enqueued_at' => 1_528_799_582.9049861,
+        }
+      end
+
+      it 'has the the required attributes on call' do
+        failed_job = lambda do
+          job_logger.call(item_data, 'queue') do
+            raise StandardError
+          end
+        end
+
+        expected_body = {
+          'version' => '1.1',
+          'level' => 4,
+          '_type' => 'sidekiq',
+          '_created_at' => 1_528_799_582.904939,
+          '_enqueued_at' => 1_528_799_582.9049861,
+          '_jid' => '591f6f66ee0d218fb451dfb6',
+          '_retry' => true,
+          '_queue' => 'default',
+          '_service.name' => 'hello_world_app',
+          '_class' => 'HardWorker',
+          '_service.version' => '1.0',
+          '_tags' => '',
+          '_params' => ['asd'],
+          '_exception' => 'StandardError',
+        }
+
+        aggregate_failures do
+          expect(&failed_job).to raise_error(StandardError)
+          expect(json_line).to include(expected_body)
+          expect(json_line['timestamp']).to be_a(Float)
+          expect(json_line['host']).to be_a(String)
+          expect(json_line['short_message']).to match(/HardWorker with jid:*/)
+        end
+      end
+    end
+  end
+end

data/spec/loga/sidekiq_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 RSpec.describe Loga::Sidekiq do
   describe '.configure_logging' do
-    context 'when sidekiq version is 5.1' do
+    context 'when sidekiq is defined' do
       it 'gets invoked on Loga.configure' do
         allow(described_class).to receive(:configure_logging)
 
@@ -18,7 +18,7 @@ RSpec.describe Loga::Sidekiq do
         expect(described_class).to have_received(:configure_logging)
       end
 
-      it 'assigns our custom sidekiq job logger' do
+      it 'assigns our custom sidekiq job logger depending on the sidekiq version' do
         Loga.reset
 
         Loga.configure(
@@ -28,7 +28,14 @@ RSpec.describe Loga::Sidekiq do
           format: :gelf,
         )
 
-        expect(::Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq::JobLogger)
+        m = ENV['BUNDLE_GEMFILE'].match(/sidekiq(?<version>\d+)/)
+
+        case m['version']
+        when '51'
+          expect(::Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq5::JobLogger)
+        when '6'
+          expect(::Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq6::JobLogger)
+        end
       end
     end
 

data/spec/spec_helper.rb

@@ -29,14 +29,23 @@ when /sinatra/
 when /unit/
   rspec_pattern = 'unit/**/*_spec.rb'
   require 'loga'
-when /sidekiq/
-  sidekiq_specs = [
-    'integration/sidekiq_spec.rb',
-    'spec/loga/sidekiq/**/*_spec.rb',
-    'spec/loga/sidekiq_spec.rb',
-  ]
-
-  rspec_pattern = sidekiq_specs.join(',')
+when /sidekiq(?<version>\d+)/
+  case $LAST_MATCH_INFO['version']
+  when '51'
+    rspec_pattern = [
+      'spec/integration/sidekiq5_spec.rb',
+      'spec/loga/sidekiq5/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
+  when '6'
+    rspec_pattern = [
+      'spec/integration/sidekiq6_spec.rb',
+      'spec/loga/sidekiq6/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
+  else
+    raise 'FIXME: Unknown sidekiq - update this file.'
+  end
 
   require 'sidekiq'
   require 'sidekiq/cli'

data/spec/unit/loga/formatters/gelf_formatter_spec.rb

@@ -166,6 +166,49 @@ describe Loga::Formatters::GELFFormatter do
       end
     end
 
+    context 'when working with sidekiq context' do
+      let(:options) { { message: 'Wooden house' } }
+      let(:message) { Loga::Event.new(options) }
+      let(:sidekiq_context) { { class: 'MyWorker', jid: '123' } }
+
+      before do
+        klass = Class.new do
+          class << self
+            attr_accessor :current
+          end
+        end
+        klass.current = sidekiq_context
+        stub_const('::Sidekiq::Context', klass)
+      end
+
+      it 'includes the ::Sidekiq::Context.current data' do
+        expect(json['_class']).to eq('MyWorker')
+        expect(json['_jid']).to eq('123')
+      end
+
+      include_examples 'valid GELF message'
+
+      describe 'overwriting sidekiq context data with manual one' do
+        let(:options) { { message: 'Test', data: { class: 'CoolTest' } } }
+
+        it 'uses the manual data instead of the sidekiq context' do
+          expect(json['_class']).to eq('CoolTest')
+        end
+
+        include_examples 'valid GELF message'
+      end
+
+      describe ':elapsed in the sidekiq context' do
+        let(:sidekiq_context) { { class: 'MyWorker', jid: '123', elapsed: '22.2' } }
+
+        it 'transforms it to _duration' do
+          expect(json['_duration']).to eq(22.2)
+        end
+
+        include_examples 'valid GELF message'
+      end
+    end
+
     {
       'DEBUG'   => 7,
       'INFO'    => 6,

data/spec/unit/loga/rack/logger_spec.rb

@@ -65,12 +65,13 @@ describe Loga::Rack::Logger do
     let(:exception)        { StandardError.new }
     let(:logged_exception) { nil }
     let(:response_status)  { 200 }
+    let(:exception_class)  { Class.new(StandardError) }
 
     context 'when an exception is raised' do
-      let(:app) {  ->(_env) { raise exception } }
+      let(:app) {  ->(_env) { raise exception_class } }
 
       it 'does not rescue the exception' do
-        expect { subject.call(env) }.to raise_error(StandardError)
+        expect { subject.call(env) }.to raise_error(exception_class)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.5.3
 platform: ruby
 authors:
 - Funding Circle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,14 +56,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
@@ -259,7 +259,9 @@ files:
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
 - gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
 - gemfiles/sidekiq51.gemfile
+- gemfiles/sidekiq6.gemfile
 - gemfiles/sinatra14.gemfile
 - gemfiles/unit.gemfile
 - lib/loga.rb
@@ -279,7 +281,8 @@ files:
 - lib/loga/railtie.rb
 - lib/loga/service_version_strategies.rb
 - lib/loga/sidekiq.rb
-- lib/loga/sidekiq/job_logger.rb
+- lib/loga/sidekiq5/job_logger.rb
+- lib/loga/sidekiq6/job_logger.rb
 - lib/loga/tagged_logging.rb
 - lib/loga/utilities.rb
 - lib/loga/version.rb
@@ -290,13 +293,16 @@ files:
 - spec/fixtures/rails42.rb
 - spec/fixtures/rails50.rb
 - spec/fixtures/rails52.rb
+- spec/fixtures/rails60.rb
 - spec/fixtures/random_bin
 - spec/integration/rails/action_mailer_spec.rb
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
-- spec/integration/sidekiq_spec.rb
+- spec/integration/sidekiq5_spec.rb
+- spec/integration/sidekiq6_spec.rb
 - spec/integration/sinatra_spec.rb
-- spec/loga/sidekiq/job_logger_spec.rb
+- spec/loga/sidekiq5/job_logger_spec.rb
+- spec/loga/sidekiq6/job_logger_spec.rb
 - spec/loga/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/support/gethostname_shared.rb
@@ -345,13 +351,16 @@ test_files:
 - spec/fixtures/rails42.rb
 - spec/fixtures/rails50.rb
 - spec/fixtures/rails52.rb
+- spec/fixtures/rails60.rb
 - spec/fixtures/random_bin
 - spec/integration/rails/action_mailer_spec.rb
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
-- spec/integration/sidekiq_spec.rb
+- spec/integration/sidekiq5_spec.rb
+- spec/integration/sidekiq6_spec.rb
 - spec/integration/sinatra_spec.rb
-- spec/loga/sidekiq/job_logger_spec.rb
+- spec/loga/sidekiq5/job_logger_spec.rb
+- spec/loga/sidekiq6/job_logger_spec.rb
 - spec/loga/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/support/gethostname_shared.rb