loga 2.6.1 → 2.8.0

data/spec/integration/sidekiq65_spec.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+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::Job
+
+  def perform(_name)
+    logger.info('Hello from MySidekiqWorker')
+  end
+end
+
+module Sidekiq
+  def self.reset!
+    @config = DEFAULTS.dup
+  end
+end
+
+describe 'Sidekiq client logger' do
+  let(:target) { StringIO.new }
+  let(:config) do
+    c = Sidekiq
+
+    c[:queues] = %w[default]
+    c[:fetch] = Sidekiq::BasicFetch.new(c)
+    c[:error_handlers] << Sidekiq.method(:default_error_handler)
+
+    c
+  end
+
+  def read_json_log(line:)
+    target.rewind
+    JSON.parse(target.each_line.drop(line - 1).first)
+  end
+
+  before do
+    Sidekiq.reset!
+    Sidekiq.redis(&:flushdb)
+
+    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
+
+  context 'with processor' do
+    let(:mutex) { Mutex.new }
+    let(:cond) { ConditionVariable.new }
+
+    def result(_processor, _exception)
+      mutex.synchronize { cond.signal }
+    end
+
+    def await(timeout: 0.5)
+      mutex.synchronize do
+        yield
+        cond.wait(mutex, timeout)
+      end
+    end
+
+    it 'logs the job processing event' do
+      MySidekiqWorker.perform_async('Bob')
+
+      require 'sidekiq/processor'
+
+      p = Sidekiq::Processor.new(config) { |pr, ex| result(pr, ex) }
+
+      await { p.start }
+
+      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
+
+      await { MySidekiqWorker.perform_async('Bob') }
+
+      test_log_from_worker(read_json_log(line: 3))
+      test_job_end_log(read_json_log(line: 4))
+    end
+  end
+end

data/spec/integration/sidekiq7_spec.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Sidekiq client logger' do
+  let(:target) { StringIO.new }
+  let(:config) { Sidekiq.instance_variable_get :@config }
+
+  before do
+    Sidekiq.configure_server do |config|
+      config.redis = { pool_name: :default }
+    end
+
+    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(config[:job_logger]).to eq Loga::Sidekiq7::JobLogger
+  end
+
+  it 'has the proper logger for Sidekiq.logger' do
+    expect(Sidekiq.logger).to eq Loga.logger
+  end
+
+  context 'with processor' do
+    require 'sidekiq/processor'
+
+    let(:mutex) { Mutex.new }
+    let(:cond) { ConditionVariable.new }
+    let(:processor) do
+      Sidekiq::Processor.new(config.default_capsule) { |pr, ex| result(pr, ex) }
+    end
+
+    before do
+      @exception = nil
+    end
+
+    context 'with a successful job' do
+      before do
+        MySidekiqWorker.perform_async('Bob')
+
+        await { processor.start }
+
+        processor.terminate(true)
+      end
+
+      it 'logs the job processing event' do
+        test_log_from_worker(read_json_log(line: -2))
+      end
+
+      it 'logs the "done" event' do
+        test_job_end_log(read_json_log(line: -1))
+      end
+    end
+
+    context 'with an error' do
+      before do
+        MySidekiqWorker.perform_async('Boom')
+
+        await { processor.start }
+
+        processor.terminate(true)
+      end
+
+      it 'logs the "error" event' do
+        test_job_fail_log(read_json_log(line: 0))
+      end
+
+      it 're-throws the error' do
+        # rubocop:disable RSpec/InstanceVariable
+        expect(@exception.message).to eq('Boom')
+        # rubocop:enable RSpec/InstanceVariable
+      end
+    end
+
+    def result(_processor, exception)
+      @exception = exception
+      mutex.synchronize { cond.signal }
+    end
+
+    def await(timeout: 0.1)
+      mutex.synchronize do
+        yield
+        cond.wait(mutex, timeout)
+      end
+    end
+
+    def common_log_fields
+      {
+        '_class' => 'MySidekiqWorker',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_tags' => '',
+        'version' => '1.1',
+      }.freeze
+    end
+
+    def job_logger_common_fields
+      common_log_fields.merge(
+        '_queue' => 'default',
+        '_retry' => true,
+        '_type' => 'sidekiq',
+      )
+    end
+
+    def test_log_from_worker(json_line)
+      aggregate_failures do
+        expect(json_line).to include(
+          common_log_fields.merge(
+            'level' => 6,
+            '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)
+      aggregate_failures do
+        expect(json_line).to include(
+          job_logger_common_fields.merge(
+            '_params' => ['Bob'],
+            'level' => 6,
+          ),
+        )
+
+        %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: '\w+' done/)
+      end
+    end
+
+    def test_job_fail_log(json_line)
+      aggregate_failures do
+        expect(json_line).to include(
+          job_logger_common_fields.merge(
+            '_params' => ['Boom'],
+            'level' => 4,
+          ),
+        )
+
+        %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: '\w+' fail/)
+      end
+    end
+  end
+
+  def dump_log
+    offset = target.pos
+
+    target.rewind
+    target.each_line { puts _1 }
+
+    target.pos = offset
+  end
+
+  def read_json_log(line:)
+    target.rewind
+
+    JSON.parse(target.readlines[line])
+  end
+end
+
+class MySidekiqWorker
+  include Sidekiq::Job
+
+  def perform(name)
+    raise name if name == 'Boom'
+
+    logger.info('Hello from MySidekiqWorker')
+  end
+end

data/spec/loga/sidekiq7/job_logger_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+require 'loga/sidekiq7/job_logger'
+
+RSpec.describe Loga::Sidekiq7::JobLogger do
+  subject(:job_logger) { described_class.new(logger) }
+
+  let(:target) { StringIO.new }
+
+  let(:json_line) do
+    target.rewind
+    JSON.parse(target.read.split("\n").last)
+  end
+
+  let(:logger) { Loga.logger }
+
+  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['_duration']).to be_a(Float)
+          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['_duration']).to be_a(Float)
+          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/spec_helper.rb

@@ -30,21 +30,40 @@ when /unit/
   rspec_pattern = 'unit/**/*_spec.rb'
   require 'loga'
 when /sidekiq(?<version>\d+)/
-  case $LAST_MATCH_INFO['version']
+  sidekiq_version = $LAST_MATCH_INFO['version']
+  case sidekiq_version
   when '51'
     rspec_pattern = [
       'spec/integration/sidekiq5_spec.rb',
       'spec/loga/sidekiq5/**/*_spec.rb',
       'spec/loga/sidekiq_spec.rb',
     ].join(',')
-  when '6', '61'
+  when '60'
     rspec_pattern = [
-      'spec/integration/sidekiq6_spec.rb',
+      'spec/integration/sidekiq60_spec.rb',
+      'spec/loga/sidekiq5/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
+  when '61', '62', '63', '64'
+    rspec_pattern = [
+      'spec/integration/sidekiq61_spec.rb',
       'spec/loga/sidekiq6/**/*_spec.rb',
       'spec/loga/sidekiq_spec.rb',
     ].join(',')
+  when '65'
+    rspec_pattern = [
+      'spec/integration/sidekiq65_spec.rb',
+      'spec/loga/sidekiq6/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
+  when '7', '70', '71'
+    rspec_pattern = [
+      'spec/integration/sidekiq7_spec.rb',
+      'spec/loga/sidekiq7/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
   else
-    raise 'FIXME: Unknown sidekiq - update this file.'
+    raise "FIXME: Unknown sidekiq #{sidekiq_version} - update this file."
   end
 
   require 'sidekiq'

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

@@ -209,6 +209,29 @@ describe Loga::Formatters::GELFFormatter do
       end
     end
 
+    context 'when working with additional fields via otel' do
+      let(:options) { { message: 'Wooden house' } }
+      let(:message) { Loga::Event.new(options) }
+      let(:trace_context) { { hex_trace_id: '123', hex_span_id: '456' } }
+
+      before do
+        klass = Class.new do
+          class << self
+            attr_accessor :current_span
+          end
+        end
+        klass.current_span = OpenStruct.new(context: OpenStruct.new(trace_context))
+        stub_const('::OpenTelemetry::Trace', klass)
+      end
+
+      it 'includes the trace_id and span_id' do
+        expect(json['_trace_id']).to eq('123')
+        expect(json['_span_id']).to eq('456')
+      end
+
+      include_examples 'valid GELF message'
+    end
+
     {
       'DEBUG'   => 7,
       'INFO'    => 6,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Funding Circle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -254,8 +254,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/rails32.gemfile
-- gemfiles/rails40.gemfile
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
 - gemfiles/rails52.gemfile
@@ -263,8 +261,15 @@ files:
 - gemfiles/rails61.gemfile
 - gemfiles/rails70.gemfile
 - gemfiles/sidekiq51.gemfile
-- gemfiles/sidekiq6.gemfile
+- gemfiles/sidekiq60.gemfile
 - gemfiles/sidekiq61.gemfile
+- gemfiles/sidekiq62.gemfile
+- gemfiles/sidekiq63.gemfile
+- gemfiles/sidekiq64.gemfile
+- gemfiles/sidekiq65.gemfile
+- gemfiles/sidekiq7.gemfile
+- gemfiles/sidekiq70.gemfile
+- gemfiles/sidekiq71.gemfile
 - gemfiles/sinatra14.gemfile
 - gemfiles/unit.gemfile
 - lib/loga.rb
@@ -286,13 +291,12 @@ files:
 - lib/loga/sidekiq.rb
 - lib/loga/sidekiq5/job_logger.rb
 - lib/loga/sidekiq6/job_logger.rb
+- lib/loga/sidekiq7/job_logger.rb
 - lib/loga/tagged_logging.rb
 - lib/loga/utilities.rb
 - lib/loga/version.rb
 - loga.gemspec
 - spec/fixtures/README.md
-- spec/fixtures/rails32.rb
-- spec/fixtures/rails40.rb
 - spec/fixtures/rails42.rb
 - spec/fixtures/rails50.rb
 - spec/fixtures/rails52.rb
@@ -304,10 +308,14 @@ files:
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
 - spec/integration/sidekiq5_spec.rb
-- spec/integration/sidekiq6_spec.rb
+- spec/integration/sidekiq60_spec.rb
+- spec/integration/sidekiq61_spec.rb
+- spec/integration/sidekiq65_spec.rb
+- spec/integration/sidekiq7_spec.rb
 - spec/integration/sinatra_spec.rb
 - spec/loga/sidekiq5/job_logger_spec.rb
 - spec/loga/sidekiq6/job_logger_spec.rb
+- spec/loga/sidekiq7/job_logger_spec.rb
 - spec/loga/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/support/gethostname_shared.rb
@@ -350,8 +358,6 @@ specification_version: 4
 summary: Facilitate log aggregation via unified logging
 test_files:
 - spec/fixtures/README.md
-- spec/fixtures/rails32.rb
-- spec/fixtures/rails40.rb
 - spec/fixtures/rails42.rb
 - spec/fixtures/rails50.rb
 - spec/fixtures/rails52.rb
@@ -363,10 +369,14 @@ test_files:
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
 - spec/integration/sidekiq5_spec.rb
-- spec/integration/sidekiq6_spec.rb
+- spec/integration/sidekiq60_spec.rb
+- spec/integration/sidekiq61_spec.rb
+- spec/integration/sidekiq65_spec.rb
+- spec/integration/sidekiq7_spec.rb
 - spec/integration/sinatra_spec.rb
 - spec/loga/sidekiq5/job_logger_spec.rb
 - spec/loga/sidekiq6/job_logger_spec.rb
+- spec/loga/sidekiq7/job_logger_spec.rb
 - spec/loga/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/support/gethostname_shared.rb