loga 2.6.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c431f4c2be4360f29975cc8434c86647c77cf8a375bcd8fa6e6a0b47bb8a2e8
-  data.tar.gz: 2ec1e76ed48281e99acca8bdc3dd55b3fb6068dee599dd5c4bf92008e1af6eb0
+  metadata.gz: dc1346e981871beb7504038280a989df0b08f8758de0aafbc2ad6353bf15b37b
+  data.tar.gz: 7cca9a16fd0d79616445d8b497d28064b4e62c5b9ec075594787e069020d031c
 SHA512:
-  metadata.gz: 5c09402cb2b8f7e90bb53ccba07df43c759a9d4cea9cd5a19f8fbfcf332b0ce7914dca1d3c085cd43d9d081e40cc2c4d18452bd5c6b44d10e1df2771c7a88146
-  data.tar.gz: f9f937d8e0a600c05ca50e60c05b084d6756b76158f2b4dcfc7a070ee30ad535ef2df6f0c10d6f61a99152ec2fa2cdb1815b450ce600e4be72e51e797d1165b6
+  metadata.gz: 9b644025cbf6f8ff20b5980d8c261146a3832b2ea0e18eec3efabd1c8d7fbb75b540591fe5eb480a3475c8e646a85fd274a2352c9ed95baebf84ec01c29c8a8b
+  data.tar.gz: 5b5b9ae15e5383bb6b8b48e2a990b340134c2e77391fef261a275ae47e41b95538a9ba95553820d335634bdd8cbd1530f839bae8dade08b8bfd57af18dfd15aa

data/.circleci/config.yml

@@ -30,10 +30,6 @@ test_build: &test_build
 
 version: 2
 jobs:
-  ruby-2.4:
-    docker:
-      - image: circleci/ruby:2.4
-    <<: *test_build
   ruby-2.5:
     docker:
       - image: circleci/ruby:2.5
@@ -45,10 +41,12 @@ jobs:
   ruby-2.7:
     docker:
       - image: cimg/ruby:2.7
+      - image: redis:7
     <<: *test_build
   ruby-3.0:
     docker:
       - image: cimg/ruby:3.0
+      - image: redis:7
     <<: *test_build
   rubocop:
     <<: *basic_build
@@ -83,10 +81,6 @@ workflows:
           filters:
             tags:
               only: /.*/
-      - ruby-2.4:
-          filters:
-            tags:
-              only: /.*/
       - ruby-2.5:
           filters:
             tags:
@@ -112,7 +106,6 @@ workflows:
               ignore: /.*/
           requires:
             - rubocop
-            - ruby-2.4
             - ruby-2.5
             - ruby-2.6
             - ruby-2.7

data/Appraisals

@@ -1,13 +1,3 @@
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4.0')
-  appraise 'rails32' do
-    gem 'rails', '~> 3.2.0'
-  end
-
-  appraise 'rails40' do
-    gem 'rails', '~> 4.0.0'
-  end
-end
-
 if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7.0')
   appraise 'rails42' do
     gem 'rails', '~> 4.2.0'
@@ -31,13 +21,29 @@ if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.5.0')
     gem 'rails', '~> 6.0.0'
   end
 
-  appraise 'sidekiq6' do
-    gem 'sidekiq', '~> 6.0'
+  appraise 'sidekiq60' do
+    gem 'sidekiq', '~> 6.0.0'
   end
 
   appraise 'sidekiq61' do
     gem 'sidekiq', '~> 6.1.0'
   end
+
+  appraise 'sidekiq62' do
+    gem 'sidekiq', '~> 6.2.0'
+  end
+
+  appraise 'sidekiq63' do
+    gem 'sidekiq', '~> 6.3.0'
+  end
+
+  appraise 'sidekiq64' do
+    gem 'sidekiq', '~> 6.4.0'
+  end
+
+  appraise 'sidekiq65' do
+    gem 'sidekiq', '~> 6.5.0'
+  end
 end
 
 if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.7.0')
@@ -48,6 +54,18 @@ if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.7.0')
   appraise 'rails70' do
     gem 'rails', '~> 7.0.0'
   end
+
+  appraise 'sidekiq7' do
+    gem 'sidekiq', '~> 7.0'
+  end
+
+  appraise 'sidekiq70' do
+    gem 'sidekiq', '~> 7.0.0'
+  end
+
+  appraise 'sidekiq71' do
+    gem 'sidekiq', '~> 7.1.0'
+  end
 end
 
 appraise 'sidekiq51' do

data/CHANGELOG.md

@@ -4,6 +4,14 @@ 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.8.0] - 2023-11-14
+### Added
+- Support open-telemetry and add trace_id and span_id to logs events
+
+## [2.7.0] - 2023-03-28
+### Added
+- Support for sidekiq 7
+
 ## [2.6.1] - 2022-02-22
 ### Fixed
 - Fix compatibility with sidekiq 6.4.1

data/README.md

@@ -150,7 +150,7 @@ LOGA_FORMAT=simple rackup
 
 ### Sidekiq
 
-Loga `2.3` provides an out-of-the-box support for `Sidekiq ~> 5.0`.
+Loga `2.7` provides an out-of-the-box support for `Sidekiq ~> 7.0`.
 
 ## Output Example
 

data/gemfiles/{rails32.gemfile → sidekiq60.gemfile}

@@ -2,10 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 3.2.0"
+gem "sidekiq", "~> 6.0.0"
 
 group :test do
-  gem "simplecov"
+  gem "simplecov", "~> 0.17.0"
 end
 
 gemspec path: "../"

data/gemfiles/{rails40.gemfile → sidekiq62.gemfile}

@@ -2,10 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.0.0"
+gem "sidekiq", "~> 6.2.0"
 
 group :test do
-  gem "simplecov"
+  gem "simplecov", "~> 0.17.0"
 end
 
 gemspec path: "../"

data/gemfiles/sidekiq63.gemfile

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

data/gemfiles/sidekiq64.gemfile

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

data/gemfiles/sidekiq65.gemfile

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

data/gemfiles/{sidekiq6.gemfile → sidekiq7.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "sidekiq", "~> 6.0"
+gem "sidekiq", "~> 7.0"
 
 group :test do
   gem "simplecov", "~> 0.17.0"

data/gemfiles/sidekiq70.gemfile

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

data/gemfiles/sidekiq71.gemfile

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

data/lib/loga/formatters/gelf_formatter.rb

@@ -39,12 +39,7 @@ module Loga
       private
 
       def build_event(time, message)
-        event = case message
-                when Loga::Event
-                  message
-                else
-                  Loga::Event.new(message: message)
-                end
+        event = message.is_a?(Loga::Event) ? message : Loga::Event.new(message: message)
 
         event.timestamp ||= time
         # Overwrite sidekiq_context data anything manually specified
@@ -54,6 +49,7 @@ module Loga
           hash.merge! compute_type(event.type)
           # Overwrite hash with Loga's additional fields
           hash.merge! loga_additional_fields
+          hash.merge! open_telemetry_fields
         end
         event
       end
@@ -103,6 +99,17 @@ module Loga
         }
       end
 
+      def open_telemetry_fields
+        return {} unless defined?(::OpenTelemetry::Trace)
+
+        span = ::OpenTelemetry::Trace.current_span
+
+        {
+          trace_id: span.context.hex_trace_id,
+          span_id: span.context.hex_span_id,
+        }
+      end
+
       def sidekiq_context
         return {} unless defined?(::Sidekiq::Context)
 

data/lib/loga/sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Loga
   module Sidekiq
     def self.configure_logging
@@ -5,20 +7,41 @@ module Loga
       return if Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('5.0')
 
       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
+        configure_for_sidekiq5
       elsif Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('7.0')
-        require 'loga/sidekiq6/job_logger'
+        configure_for_sidekiq6
+      elsif Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('8.0')
+        configure_for_sidekiq7
+      end
+    end
 
-        ::Sidekiq.configure_server do |config|
-          config.options[:job_logger] = Loga::Sidekiq6::JobLogger
-        end
+    def self.configure_for_sidekiq5
+      require 'loga/sidekiq5/job_logger'
+
+      ::Sidekiq.configure_server do |config|
+        config.options[:job_logger] = Loga::Sidekiq5::JobLogger
       end
 
       ::Sidekiq.logger = Loga.configuration.logger
     end
+
+    def self.configure_for_sidekiq6
+      require 'loga/sidekiq6/job_logger'
+
+      ::Sidekiq.configure_server do |config|
+        config.options[:job_logger] = Loga::Sidekiq6::JobLogger
+      end
+
+      ::Sidekiq.logger = Loga.configuration.logger
+    end
+
+    def self.configure_for_sidekiq7
+      require 'loga/sidekiq7/job_logger'
+
+      ::Sidekiq.configure_server do |config|
+        config[:job_logger] = Loga::Sidekiq7::JobLogger
+        config.logger = Loga.configuration.logger
+      end
+    end
   end
 end

data/lib/loga/sidekiq7/job_logger.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'sidekiq/job_logger'
+
+module Loga
+  module Sidekiq7
+    class JobLogger < ::Sidekiq::JobLogger
+      EVENT_TYPE = 'sidekiq'.freeze
+
+      def call(item, _queue)
+        start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+
+        yield
+
+        ::Sidekiq::Context.add(:elapsed, elapsed(start))
+
+        loga_log(message: "#{item['class']} with jid: '#{item['jid']}' done", item: item)
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        ::Sidekiq::Context.add(:elapsed, elapsed(start))
+
+        loga_log(
+          message: "#{item['class']} with jid: '#{item['jid']}' fail", item: item,
+          exception: e
+        )
+
+        raise
+      end
+
+      private
+
+      def loga_log(message:, item:, exception: nil)
+        data = item.select do |k, _v|
+          %w[created_at enqueued_at jid queue retry
+             class].include? k
+        end
+
+        data['params'] = item['args']
+
+        data['exception'] = exception if exception
+
+        event = Event.new(type: EVENT_TYPE, message: message, data: data)
+
+        if exception
+          @logger.warn(event)
+        else
+          @logger.info(event)
+        end
+      end
+    end
+  end
+end

data/lib/loga/version.rb

@@ -1,3 +1,3 @@
 module Loga
-  VERSION = '2.6.1'.freeze
+  VERSION = '2.8.0'.freeze
 end

data/spec/integration/sidekiq60_spec.rb

@@ -0,0 +1,180 @@
+# 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::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.0.0/test/test_actors.rb#L57:79
+    Class.new do
+      attr_reader :latest_error
+      attr_reader :mutex
+      attr_reader :cond
+
+      def initialize
+        @mutex = ::Mutex.new
+        @cond = ::ConditionVariable.new
+      end
+
+      def processor_died(_inst, err)
+        @latest_error = err
+        @mutex.synchronize do
+          @cond.signal
+        end
+      end
+
+      def processor_stopped(_inst)
+        @mutex.synchronize do
+          @cond.signal
+        end
+      end
+
+      def options
+        {
+          concurrency: 3,
+          job_logger: Loga::Sidekiq6::JobLogger,
+          queues: ['default'],
+        }
+      end
+    end
+  end
+
+  let(:target) { StringIO.new }
+
+  def read_json_log(line:)
+    target.rewind
+    JSON.parse(target.each_line.drop(line - 1).first)
+  end
+
+  def dump_log
+    offset = target.pos
+
+    target.rewind
+    target.each_line { puts _1 }
+
+    target.pos = offset
+  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::Processor.new(mgr.new).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