heavylog 0.1.1.beta.1 → 0.1.1.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d206e10d13818be551a6ddd6df008c174a0ae15c4e9499f340461df61ebf04d2
-  data.tar.gz: db09d3d4a4d186702094c6526b13e04f19ebd9150520d12f1397acfda6705401
+  metadata.gz: e9be53c2397c651f826a3ef86abefb2810441016a74d42986408d297ef3be5ad
+  data.tar.gz: 488f0bdb405cca4741ff047beea5a2593b0db2f082a3b77af6486ea8cb2268ef
 SHA512:
-  metadata.gz: cd1e47ed895ff0e25750ddae9634e49c06910f594f3f0e8413ab0be6d4abc7f8f3c6260f54deb7436d8d80fe74abb3dd1103b28e7c21dfcb91a73b8c4245eee0
-  data.tar.gz: 2304461fa1d4c1b7fdbbbceebd591edb61a6d05c30e3a0a4d2ce65b5a8cbb6b7700d93e2ef44823903a26258b98ee15cff78393d64b9adddcf2957c78488af6f
+  metadata.gz: eb6d23398d5c98954c9417e17edc21e10b61a54b0fc488f928cf502c8b23ceecef9a75b25c393014bf1491f18e02f32af7030d39ce6dbf19d60f6d4c6c85eab1
+  data.tar.gz: a318645d04ae152a15298926e02d0fb8308ec9f9c49a1e34696b518aa734459431f877481d58ed32249d8982de83ca72538d77e944c23e893b84840ae5ceeac7

data/.github/workflows/ci.yml

@@ -1,6 +1,11 @@
 name: Test
 
-on: [push]
+on:
+  push:
+    branches: ["**"]
+    tags-ignore: ["**"]
+  pull_request:
+    branches: [main]
 
 jobs:
   test:

data/.github/workflows/release.yml

@@ -71,43 +71,6 @@ jobs:
             echo "Version mismatch: tag base=$BASE_VERSION, gem=$GEM_VER" >&2
             exit 1
           fi
-  publish_npm:
-    name: Publish npm package
-    needs: verify
-    if: ${{ !github.event.release.prerelease }}
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "24"
-          registry-url: "https://registry.npmjs.org"
-      - name: Ensure modern npm for OIDC trusted publishing
-        run: npm install -g npm@latest
-      - name: Publish package
-        run: npm publish --access public
-  publish_npm_canary:
-    name: Publish npm canary
-    needs: verify_prerelease
-    if: github.event.release.prerelease
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "22"
-          registry-url: "https://registry.npmjs.org"
-      - name: Ensure modern npm for OIDC trusted publishing
-        run: npm install -g npm@latest
-      - name: Set canary version from tag
-        run: |
-          TAG_VERSION="${GITHUB_REF_NAME#v}"
-          echo "Setting canary version: $TAG_VERSION"
-          npm version "$TAG_VERSION" --no-git-tag-version
-      - name: Publish canary
-        run: npm publish --tag canary --access public
   publish_gem:
     name: Publish Ruby gem
     needs: verify

data/CHANGELOG.md

@@ -2,8 +2,9 @@
 
 ### Unreleased
 
-- build: Github actions automatic publishing
+- feat: Karafka consumer logging.
+- build: Github actions automatic publishing.
 
 ### [0.1.0] - 2026-02-10
 
-- Start of changelog
+- Start of changelog.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    heavylog (0.1.1.beta.1)
+    heavylog (0.1.1.beta.2)
       actionpack (>= 8.0, < 8.2)
       activerecord (>= 8.0, < 8.2)
       activesupport (>= 8.0, < 8.2)
@@ -58,6 +58,14 @@ GEM
     drb (2.2.3)
     erb (6.0.1)
     erubi (1.13.1)
+    ffi (1.17.3-aarch64-linux-gnu)
+    ffi (1.17.3-aarch64-linux-musl)
+    ffi (1.17.3-arm-linux-gnu)
+    ffi (1.17.3-arm-linux-musl)
+    ffi (1.17.3-arm64-darwin)
+    ffi (1.17.3-x86_64-darwin)
+    ffi (1.17.3-x86_64-linux-gnu)
+    ffi (1.17.3-x86_64-linux-musl)
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
     io-console (0.8.2)
@@ -67,12 +75,51 @@ GEM
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.18.1)
+    karafka (2.5.5)
+      karafka-core (>= 2.5.6, < 2.6.0)
+      karafka-rdkafka (>= 0.23.1)
+      waterdrop (>= 2.8.14, < 3.0.0)
+      zeitwerk (~> 2.3)
+    karafka-core (2.5.8)
+      karafka-rdkafka (>= 0.20.0)
+      logger (>= 1.6.0)
+    karafka-rdkafka (0.23.1)
+      ffi (~> 1.17.1)
+      json (> 2.0)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.23.1-aarch64-linux-gnu)
+      ffi (~> 1.17.1)
+      json (> 2.0)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.23.1-arm64-darwin)
+      ffi (~> 1.17.1)
+      json (> 2.0)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.23.1-x86_64-linux-gnu)
+      ffi (~> 1.17.1)
+      json (> 2.0)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.23.1-x86_64-linux-musl)
+      ffi (~> 1.17.1)
+      json (> 2.0)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
     loofah (2.25.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
+    mini_portile2 (2.8.9)
     minitest (6.0.1)
       prism (~> 1.5)
     nokogiri (1.19.0-aarch64-linux-gnu)
@@ -200,6 +247,10 @@ GEM
     unicode-emoji (4.2.0)
     uri (1.1.1)
     useragent (0.16.11)
+    waterdrop (2.8.15)
+      karafka-core (>= 2.4.9, < 3.0.0)
+      karafka-rdkafka (>= 0.23.1)
+      zeitwerk (~> 2.3)
     zeitwerk (2.7.4)
 
 PLATFORMS
@@ -214,6 +265,7 @@ PLATFORMS
 
 DEPENDENCIES
   heavylog!
+  karafka (>= 2.5.5)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (< 1.84.1)
@@ -238,15 +290,31 @@ CHECKSUMS
   drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
   erb (6.0.1) sha256=28ecdd99c5472aebd5674d6061e3c6b0a45c049578b071e5a52c2a7f13c197e5
   erubi (1.13.1) sha256=a082103b0885dbc5ecf1172fede897f9ebdb745a4b97a5e8dc63953db1ee4ad9
-  heavylog (0.1.1.beta.1)
+  ffi (1.17.3-aarch64-linux-gnu) sha256=28ad573df26560f0aedd8a90c3371279a0b2bd0b4e834b16a2baa10bd7a97068
+  ffi (1.17.3-aarch64-linux-musl) sha256=020b33b76775b1abacc3b7d86b287cef3251f66d747092deec592c7f5df764b2
+  ffi (1.17.3-arm-linux-gnu) sha256=5bd4cea83b68b5ec0037f99c57d5ce2dd5aa438f35decc5ef68a7d085c785668
+  ffi (1.17.3-arm-linux-musl) sha256=0d7626bb96265f9af78afa33e267d71cfef9d9a8eb8f5525344f8da6c7d76053
+  ffi (1.17.3-arm64-darwin) sha256=0c690555d4cee17a7f07c04d59df39b2fba74ec440b19da1f685c6579bb0717f
+  ffi (1.17.3-x86_64-darwin) sha256=1f211811eb5cfaa25998322cdd92ab104bfbd26d1c4c08471599c511f2c00bb5
+  ffi (1.17.3-x86_64-linux-gnu) sha256=3746b01f677aae7b16dc1acb7cb3cc17b3e35bdae7676a3f568153fb0e2c887f
+  ffi (1.17.3-x86_64-linux-musl) sha256=086b221c3a68320b7564066f46fed23449a44f7a1935f1fe5a245bd89d9aea56
+  heavylog (0.1.1.beta.2)
   i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5
   io-console (0.8.2) sha256=d6e3ae7a7cc7574f4b8893b4fca2162e57a825b223a177b7afa236c5ef9814cc
   irb (1.17.0) sha256=168c4ddb93d8a361a045c41d92b2952c7a118fa73f23fe14e55609eb7a863aae
   json (2.18.1) sha256=fe112755501b8d0466b5ada6cf50c8c3f41e897fa128ac5d263ec09eedc9f986
+  karafka (2.5.5) sha256=ccc78e167d668298308c88c2f05eaaafb9736f2660433fc632f8ee66bd2531d7
+  karafka-core (2.5.8) sha256=3b056abe55cede3f189a3b68c444012f9fb70ec49afd8689c99702ab72837041
+  karafka-rdkafka (0.23.1) sha256=b248150477f672d047de44da24c89cf71a0bf5bd475f12a6214cc5fddeb65297
+  karafka-rdkafka (0.23.1-aarch64-linux-gnu) sha256=ce73057b9dee87155fc49328749c222a8780a54ed571ed2c0417970a70cfea37
+  karafka-rdkafka (0.23.1-arm64-darwin) sha256=2629f77b9cef4e9bb5f6a6baf5d15fd2b3fc9578ba2c914309d7ef655afe9a00
+  karafka-rdkafka (0.23.1-x86_64-linux-gnu) sha256=1e70456f94b6c0decec2bfecf250322830bef4d67fafe44384751b44093da415
+  karafka-rdkafka (0.23.1-x86_64-linux-musl) sha256=ba060677f5036b53c0bb4245f1472bbec87518d81d6d6054ffa23eb8ac2a7357
   language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
   lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
   logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
   loofah (2.25.0) sha256=df5ed7ac3bac6a4ec802df3877ee5cc86d027299f8952e6243b3dac446b060e6
+  mini_portile2 (2.8.9) sha256=0cd7c7f824e010c072e33f68bc02d85a00aeb6fce05bb4819c03dfd3c140c289
   minitest (6.0.1) sha256=7854c74f48e2e975969062833adc4013f249a4b212f5e7b9d5c040bf838d54bb
   nokogiri (1.19.0-aarch64-linux-gnu) sha256=11a97ecc3c0e7e5edcf395720b10860ef493b768f6aa80c539573530bc933767
   nokogiri (1.19.0-aarch64-linux-musl) sha256=eb70507f5e01bc23dad9b8dbec2b36ad0e61d227b42d292835020ff754fb7ba9
@@ -299,6 +367,7 @@ CHECKSUMS
   unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
   uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
   useragent (0.16.11) sha256=700e6413ad4bb954bb63547fa098dddf7b0ebe75b40cc6f93b8d54255b173844
+  waterdrop (2.8.15) sha256=1a8f515533dc9ef2528f1cd33d6135b6ed1cc33e8d2a8562212ebc1bb4c60c10
   zeitwerk (2.7.4) sha256=2bef90f356bdafe9a6c2bd32bcd804f83a4f9b8bc27f3600fff051eb3edcec8b
 
 BUNDLED WITH

data/heavylog.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   end
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "karafka", ">= 2.5.5"
   s.add_development_dependency "rake", "~> 13.0"
   s.add_development_dependency "rspec", "~> 3.0"
   s.add_development_dependency "rubocop", "< 1.84.1"

data/lib/heavylog/adapters/karafka_consumer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Heavylog
+  module Adapters
+    class KarafkaConsumer < ::Karafka::BaseConsumer
+      # Runs inside the Rails reloader wrap, any earlier would run outside the thread the consume method runs in.
+      def on_consume
+        args = "topic=#{topic.name} partition=#{partition} messages=#{messages.count}"
+        Heavylog.log_job(SecureRandom.uuid, "KarafkaLogger", self.class.name, args)
+        super
+      end
+
+      def wrap(action)
+        yield
+      ensure
+        Heavylog.finish_job if action == :consume
+      end
+    end
+  end
+end

data/lib/heavylog/adapters/sidekiq_exception_handler.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Heavylog
+  module Adapters
+    class SidekiqExceptionHandler
+      def call(exception, context)
+        Heavylog.log(:warn, Sidekiq.dump_json(context)) unless context.empty?
+        Heavylog.log(:warn, "#{exception.class.name}: #{exception.message}")
+        Heavylog.log(:warn, exception.backtrace.join("\n")) unless exception.backtrace.nil?
+        Heavylog.finish_job
+      end
+    end
+  end
+end

data/lib/heavylog/{sidekiq_logger.rb → adapters/sidekiq_logger.rb}

@@ -1,20 +1,17 @@
 # frozen_string_literal: true
 
-begin
-  require "sidekiq/job_logger"
-
-  module Heavylog
+module Heavylog
+  module Adapters
     class SidekiqLogger < Sidekiq::JobLogger
       def call(item, _queue)
         # item = {"class"=>"SuspiciousJob", "args"=>[12754545, [3858890], "invoice"], "retry"=>true, "queue"=>"default",
         #   "jid"=>"5ec968571e358497d70a3cf2", "created_at"=>1540484817.3950138, "enqueued_at"=>1540484817.395076}
 
-        Heavylog.log_sidekiq(item["jid"], item["class"], item["args"])
+        Heavylog.log_job(item["jid"], "SidekiqLogger", item["class"], item["args"])
         super
       ensure
-        Heavylog.finish_sidekiq
+        Heavylog.finish_job
       end
     end
   end
-rescue LoadError
 end

data/lib/heavylog/adapters.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Heavylog
+  module Adapters
+    autoload :KarafkaConsumer,        "heavylog/adapters/karafka_consumer"
+    autoload :SidekiqLogger,          "heavylog/adapters/sidekiq_logger"
+    autoload :SidekiqExceptionHandler, "heavylog/adapters/sidekiq_exception_handler"
+  end
+end

data/lib/heavylog/formatters/ecs.rb

@@ -37,7 +37,15 @@ module Heavylog
         dig_set(data, %w[event category], "web")
 
         unless data.dig("event", "dataset")
-          value = data.dig("heavylog", "controller") == "SidekiqLogger" ? "heavylog.sidekiq" : "heavylog.rails"
+          value = case data.dig("heavylog", "controller")
+                  when "SidekiqLogger"
+                    "heavylog.sidekiq"
+                  when "KarafkaLogger"
+                    "heavylog.karafka"
+                  else
+                    "heavylog.rails"
+                  end
+
           dig_set(data, %w[event dataset], value)
         end
 

data/lib/heavylog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Heavylog
-  VERSION = "0.1.1.beta.1"
+  VERSION = "0.1.1.beta.2"
 end

data/lib/heavylog.rb

@@ -9,8 +9,7 @@ require "heavylog/middleware"
 require "heavylog/ordered_options"
 require "heavylog/request_logger"
 require "heavylog/proxy_logger"
-require "heavylog/sidekiq_logger"
-require "heavylog/sidekiq_exception_handler"
+require "heavylog/adapters"
 
 module Heavylog
   module_function
@@ -61,9 +60,9 @@ module Heavylog
     return unless config.log_sidekiq
 
     Sidekiq.configure_server do |config|
-      config[:job_logger] = SidekiqLogger
+      config[:job_logger] = Adapters::SidekiqLogger
 
-      config.error_handlers << SidekiqExceptionHandler.new
+      config.error_handlers << Adapters::SidekiqExceptionHandler.new
     end
   end
 
@@ -116,22 +115,6 @@ module Heavylog
     end
   end
 
-  def log_sidekiq(jid, klass, args)
-    return unless config.enabled
-
-    RequestStore.store[:heavylog_request_id] = jid
-    RequestStore.store[:heavylog_request_start] = Time.now.iso8601
-    RequestStore.store[:heavylog_request_ip] = "127.0.0.1"
-
-    RequestStore.store[:heavylog_request_data] = {
-      controller: "SidekiqLogger",
-      action:     klass,
-      args:       args.to_s,
-    }
-
-    RequestStore.store[:heavylog_buffer] ||= StringIO.new
-  end
-
   def finish
     return unless config.enabled
 
@@ -151,9 +134,29 @@ module Heavylog
     config.error_handler&.call(e)
   end
 
-  def finish_sidekiq
+  def log_job(jid, controller, klass, args)
+    return unless config.enabled
+
+    RequestStore.store[:heavylog_request_id] = jid
+    RequestStore.store[:heavylog_request_start] = Time.now.iso8601
+    RequestStore.store[:heavylog_request_ip] = "127.0.0.1"
+
+    RequestStore.store[:heavylog_request_data] = {
+      controller: controller,
+      action:     klass,
+      args:       args.to_s,
+    }
+
+    RequestStore.store[:heavylog_buffer] ||= StringIO.new
+  end
+
+  def finish_job
     finish
-    RequestStore.store[:heavylog_buffer] = nil
+    RequestStore.clear!
+  end
+
+  def request_id
+    RequestStore.store[:heavylog_request_id]
   end
 
   def config

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heavylog
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta.1
+  version: 0.1.1.beta.2
 platform: ruby
 authors:
 - Signmax AB
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: karafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +209,10 @@ files:
 - Rakefile
 - heavylog.gemspec
 - lib/heavylog.rb
+- lib/heavylog/adapters.rb
+- lib/heavylog/adapters/karafka_consumer.rb
+- lib/heavylog/adapters/sidekiq_exception_handler.rb
+- lib/heavylog/adapters/sidekiq_logger.rb
 - lib/heavylog/formatters/ecs.rb
 - lib/heavylog/formatters/json.rb
 - lib/heavylog/formatters/raw.rb
@@ -204,8 +222,6 @@ files:
 - lib/heavylog/proxy_logger.rb
 - lib/heavylog/railtie.rb
 - lib/heavylog/request_logger.rb
-- lib/heavylog/sidekiq_exception_handler.rb
-- lib/heavylog/sidekiq_logger.rb
 - lib/heavylog/version.rb
 homepage: https://github.com/skyltmax/heavylog
 licenses:

data/lib/heavylog/sidekiq_exception_handler.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Heavylog
-  class SidekiqExceptionHandler
-    def call(exception, context)
-      Heavylog.log(:warn, Sidekiq.dump_json(context)) unless context.empty?
-      Heavylog.log(:warn, "#{exception.class.name}: #{exception.message}")
-      Heavylog.log(:warn, exception.backtrace.join("\n")) unless exception.backtrace.nil?
-      Heavylog.finish_sidekiq
-    end
-  end
-end