salopulse 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec917de87f35b31c9d7209c371690972280dd03fff4c45c631e8d997032194b
-  data.tar.gz: dc7e512fca6d8d777db443fbbd24bba3c79b23609135ba6d4e939255d803813e
+  metadata.gz: 5c06e78cb26ed1b47d866b3cf8a0d403373cf9c8beb76ca91292b76505a56753
+  data.tar.gz: 71295dd725c6063cfd8bb72ea668ac8160e9e92878fcd46997eed64a8245a1b7
 SHA512:
-  metadata.gz: e0c6c894cf599d0ae88616b619773e9ce38415d3fbd92405bf40d12bd40f9c2582fc8644f183fe0a8c02591bb57e824e464447f52c1bdf8ab91120fd8ba4b7d0
-  data.tar.gz: e772de5379104c022958a411c850162cfa3e8bfbb3578241917b3fe620db6f2e3cf7e6eee284a0e145b019cc6df5affdc45c0c5ba2c518b294012ef195282e7d
+  metadata.gz: 4181cb25abebd7be379e294e136a0c33e9c07e8bcaac9d01b1abc7fb14ed5b9927ad1e6adb645e7cb3233ab578b307ba248a8b0dcf135a796c06b470b20d5429
+  data.tar.gz: 732c617c949e3f8f7897f229ed0ad5fb82aa7d99828afb6d5b2891e8bee591f86330c5899b3dc14a3e6ff4606d343226ff95e2ad05a37b5c420bc8b9bfc5d4a9

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [0.3.0] - 2026-06-08
+
+### Added
+- Sidekiq instrumentation with auto-install via Railtie
+  - `SidekiqServerMiddleware` opens a `RequestContext` for each job
+    (`endpoint: "Foo::BarJob"`, `http_method: "JOB"`, `source: :sidekiq`),
+    captures exceptions, emits a `capture_performance` event with the job
+    duration, and flushes request-scoped SQL events
+  - `SidekiqClientMiddleware` propagates `parent_request_id` from the
+    enqueueing request into the job payload so background work can be
+    correlated back to the originating HTTP request
+- `Salopulse::RequestContext.start` now accepts `source:`,
+  `request_id:`, and `parent_request_id:` keyword arguments
+
 ## [0.2.3] - 2026-06-04
 
 First public release of the rewritten Salopulse APM SDK. Bumped past the

data/lib/salopulse/instrumentation/sidekiq.rb

@@ -0,0 +1,31 @@
+require_relative "sidekiq_server_middleware"
+require_relative "sidekiq_client_middleware"
+
+module Salopulse
+  module Instrumentation
+    module Sidekiq
+      module_function
+
+      def install!
+        return false unless defined?(::Sidekiq)
+
+        ::Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add(Salopulse::Instrumentation::SidekiqServerMiddleware) unless chain.exists?(Salopulse::Instrumentation::SidekiqServerMiddleware)
+          end
+          config.client_middleware do |chain|
+            chain.add(Salopulse::Instrumentation::SidekiqClientMiddleware) unless chain.exists?(Salopulse::Instrumentation::SidekiqClientMiddleware)
+          end
+        end
+
+        ::Sidekiq.configure_client do |config|
+          config.client_middleware do |chain|
+            chain.add(Salopulse::Instrumentation::SidekiqClientMiddleware) unless chain.exists?(Salopulse::Instrumentation::SidekiqClientMiddleware)
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/salopulse/instrumentation/sidekiq_client_middleware.rb

@@ -0,0 +1,15 @@
+require_relative "../request_context"
+
+module Salopulse
+  module Instrumentation
+    class SidekiqClientMiddleware
+      PARENT_REQUEST_ID_KEY = "salopulse_parent_request_id".freeze
+
+      def call(_worker_class, job, _queue, _redis_pool)
+        ctx = Salopulse::RequestContext.current
+        job[PARENT_REQUEST_ID_KEY] = ctx[:request_id] if ctx && !job.key?(PARENT_REQUEST_ID_KEY)
+        yield
+      end
+    end
+  end
+end

data/lib/salopulse/instrumentation/sidekiq_server_middleware.rb

@@ -0,0 +1,57 @@
+require_relative "../request_context"
+
+module Salopulse
+  module Instrumentation
+    class SidekiqServerMiddleware
+      PARENT_REQUEST_ID_KEY = "salopulse_parent_request_id".freeze
+
+      def initialize(client = Salopulse::Client.instance)
+        @client = client
+      end
+
+      def call(worker, job, _queue)
+        return yield if @client.disabled?
+
+        endpoint = derive_endpoint(worker, job)
+        parent_request_id = job[PARENT_REQUEST_ID_KEY]
+        Salopulse::RequestContext.start(
+          endpoint: endpoint,
+          http_method: "JOB",
+          source: :sidekiq,
+          parent_request_id: parent_request_id
+        )
+
+        status = 200
+        begin
+          yield
+        rescue Exception => e # rubocop:disable Lint/RescueException
+          status = 500
+          @client.capture_exception(e)
+          raise
+        ensure
+          begin
+            @client.capture_performance(
+              endpoint: endpoint,
+              http_method: "JOB",
+              duration_ms: Salopulse::RequestContext.elapsed_ms,
+              status_code: status
+            )
+            @client.flush_request_scope_events
+          rescue StandardError
+            # never let SDK errors propagate
+          end
+          Salopulse::RequestContext.clear
+        end
+      end
+
+      private
+
+      def derive_endpoint(worker, job)
+        wrapped = job["wrapped"] || job["class"]
+        return wrapped.to_s if wrapped && !wrapped.to_s.empty?
+
+        worker.class.name.to_s
+      end
+    end
+  end
+end

data/lib/salopulse/railtie.rb

@@ -10,6 +10,13 @@ module Salopulse
       end
     end
 
+    initializer "salopulse.sidekiq" do
+      if defined?(::Sidekiq)
+        require_relative "instrumentation/sidekiq"
+        Salopulse::Instrumentation::Sidekiq.install!
+      end
+    end
+
     config.after_initialize do
       client = Salopulse::Client.instance
       if client.uninitialized? && ENV["SALOPULSE_DSN"]

data/lib/salopulse/request_context.rb

@@ -7,11 +7,13 @@ module Salopulse
 
     module_function
 
-    def start(endpoint:, http_method:)
+    def start(endpoint:, http_method:, source: :http, request_id: nil, parent_request_id: nil)
       Thread.current[KEY] = {
-        request_id: SecureRandom.uuid,
+        request_id: request_id || SecureRandom.uuid,
+        parent_request_id: parent_request_id,
         endpoint: endpoint,
         http_method: http_method,
+        source: source,
         sql_events: [],
         sql_fingerprint_counts: Hash.new(0),
         started_at: monotonic_now,

data/lib/salopulse/version.rb

@@ -1,3 +1,3 @@
 module Salopulse
-  VERSION = "0.2.3".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salopulse
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Salih İmran Büker
@@ -87,6 +87,9 @@ files:
 - lib/salopulse/flusher.rb
 - lib/salopulse/instrumentation/active_record_subscriber.rb
 - lib/salopulse/instrumentation/rack_middleware.rb
+- lib/salopulse/instrumentation/sidekiq.rb
+- lib/salopulse/instrumentation/sidekiq_client_middleware.rb
+- lib/salopulse/instrumentation/sidekiq_server_middleware.rb
 - lib/salopulse/local_fingerprint.rb
 - lib/salopulse/railtie.rb
 - lib/salopulse/request_context.rb