sbmt-kafka_consumer 2.5.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e41656d16c2a1b741868c2d079e4e83c3df397e5e7491680e417738231afe71
-  data.tar.gz: '09117d5de7194d45bf44235f731adfd4e6f60cc18d6c613c1fe2a3800048a89c'
+  metadata.gz: '08fdb32c69e94b244084454a41b71743a059d11fa1ae35e564ca32a3ee87dafd'
+  data.tar.gz: b3e4365734439f273a5e42ebe6135d53627afb22a375a0d7d557d38d13a70cd5
 SHA512:
-  metadata.gz: 0ce2e28e58baf91e4e1612d02c37767399e643ed99c78f26adfcae1e23e77aab8f1af8bda64c6f91b16456e069b24f7db53812843347924b124b9e890d8f4e69
-  data.tar.gz: 3447e5c1c06c3f636d4c5f37070a9f349714aea586710ba7c87d2cd3248ba5ad686bfca28d1550ec0af86d18cd556315945596c7b7c069fa31a4d0db2e1425b9
+  metadata.gz: 0744b29e11d89164bf95d0573990bf694cf3e1d09e3861402449d86f142701d2e3982fc7928bc903102bd832e03494960335df5208b3fb3d5a403f60cd9cd93a
+  data.tar.gz: 30c0c560a036a1febcf5af0cd66c08dc25c04ec8b5973c8f58892589c16aed4b40ca9d0358d6340228f2b715ea025afc7e2debcb1b962db6c458095f0ab48c7f

data/CHANGELOG.md

@@ -13,6 +13,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+## [2.6.1] - 2024-07-05
+
+### Fixed
+
+- Use the current `trace_id` instead of creating a new one
+
+## [2.6.0] - 2024-07-01
+
+### Added
+
+- Added instrumentation for methods `process_message` and `mark_as_consumed!`
+
+### Fixed
+
+- From `do_consume(message)` to `yield`
+
 ## [2.5.0] - 2024-06-24
 
 ### Added

data/lib/sbmt/kafka_consumer/base_consumer.rb

@@ -3,8 +3,6 @@
 module Sbmt
   module KafkaConsumer
     class BaseConsumer < Karafka::BaseConsumer
-      attr_reader :trace_id
-
       def self.consumer_klass(skip_on_error: false, middlewares: [])
         Class.new(self) do
           const_set(:SKIP_ON_ERROR, skip_on_error)
@@ -41,8 +39,6 @@ module Sbmt
       private
 
       def with_instrumentation(message)
-        @trace_id = SecureRandom.base58
-
         logger.tagged(
           trace_id: trace_id,
           topic: message.metadata.topic, partition: message.metadata.partition,
@@ -52,7 +48,7 @@ module Sbmt
             "consumer.consumed_one",
             caller: self, message: message, trace_id: trace_id
           ) do
-            do_consume(message)
+            yield
           rescue SkipUndeserializableMessage => ex
             instrument_error(ex, message)
             logger.warn("skipping undeserializable message: #{ex.message}")
@@ -69,8 +65,6 @@ module Sbmt
       end
 
       def with_batch_instrumentation(messages)
-        @trace_id = SecureRandom.base58
-
         logger.tagged(
           trace_id: trace_id,
           first_offset: messages.first.metadata.offset,
@@ -87,6 +81,21 @@ module Sbmt
         end
       end
 
+      def with_common_instrumentation(name, message)
+        logger.tagged(
+          trace_id: trace_id
+        ) do
+          ::Sbmt::KafkaConsumer.monitor.instrument(
+            "consumer.#{name}",
+            caller: self,
+            message: message,
+            trace_id: trace_id
+          ) do
+            yield
+          end
+        end
+      end
+
       def do_consume(message)
         log_message(message) if log_payload?
 
@@ -94,9 +103,13 @@ module Sbmt
         # so we trigger it explicitly to catch undeserializable message early
         message.payload
 
-        call_middlewares(message, middlewares) { process_message(message) }
+        with_common_instrumentation("process_message", message) do
+          call_middlewares(message, middlewares) { process_message(message) }
+        end
 
-        mark_as_consumed!(message)
+        with_common_instrumentation("mark_as_consumed", message) do
+          mark_as_consumed!(message)
+        end
       end
 
       def skip_on_error
@@ -152,6 +165,10 @@ module Sbmt
         end
         traverse_chain.call
       end
+
+      def trace_id
+        @trace_id ||= SecureRandom.base58
+      end
     end
   end
 end

data/lib/sbmt/kafka_consumer/instrumentation/base_monitor.rb

@@ -10,6 +10,8 @@ module Sbmt
           consumer.consumed_one
           consumer.inbox.consumed_one
           consumer.consumed_batch
+          consumer.process_message
+          consumer.mark_as_consumed
         ].freeze
 
         def initialize

data/lib/sbmt/kafka_consumer/instrumentation/logger_listener.rb

@@ -32,6 +32,14 @@ module Sbmt
           logger.info("Successfully consumed message in #{event.payload[:time]} ms")
         end
 
+        def on_consumer_mark_as_consumed(event)
+          logger.info("Processing message in #{event.payload[:time]} ms")
+        end
+
+        def on_consumer_process_message(event)
+          logger.info("Commit offset in #{event.payload[:time]} ms")
+        end
+
         # InboxConsumer events
         def on_consumer_inbox_consumed_one(event)
           logger.tagged(status: event[:status]) do

data/lib/sbmt/kafka_consumer/instrumentation/open_telemetry_tracer.rb

@@ -6,6 +6,11 @@ module Sbmt
   module KafkaConsumer
     module Instrumentation
       class OpenTelemetryTracer < ::Sbmt::KafkaConsumer::Instrumentation::Tracer
+        CONSUMED_EVENTS = %w[
+          consumer.process_message
+          consumer.mark_as_consumed
+        ].freeze
+
         class << self
           def enabled?
             !!@enabled
@@ -22,6 +27,7 @@ module Sbmt
           return handle_consumed_one(&block) if @event_id == "consumer.consumed_one"
           return handle_consumed_batch(&block) if @event_id == "consumer.consumed_batch"
           return handle_inbox_consumed_one(&block) if @event_id == "consumer.inbox.consumed_one"
+          return handle_common_event(&block) if CONSUMED_EVENTS.include?(@event_id)
           return handle_error(&block) if @event_id == "error.occurred"
 
           yield
@@ -79,6 +85,16 @@ module Sbmt
           end
         end
 
+        def handle_common_event(&block)
+          return yield unless enabled?
+
+          if @payload[:inbox_name].present?
+            handle_inbox_consumed_one(&block)
+          else
+            handle_consumed_one(&block)
+          end
+        end
+
         def handle_error
           return yield unless enabled?
 

data/lib/sbmt/kafka_consumer/instrumentation/sentry_tracer.rb

@@ -13,8 +13,14 @@ module Sbmt
           consumer.inbox.consume_one
         ].freeze
 
+        EVENTS = %w[
+          consumer.consumed_one
+          consumer.process_message
+          consumer.mark_as_consumed
+        ].freeze
+
         def trace(&block)
-          return handle_consumed_one(&block) if @event_id == "consumer.consumed_one"
+          return handle_consumed_one(&block) if EVENTS.include?(@event_id)
           return handle_consumed_batch(&block) if @event_id == "consumer.consumed_batch"
           return handle_error(&block) if @event_id == "error.occurred"
 

data/lib/sbmt/kafka_consumer/version.rb

@@ -2,6 +2,6 @@
 
 module Sbmt
   module KafkaConsumer
-    VERSION = "2.5.0"
+    VERSION = "2.6.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sbmt-kafka_consumer
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Sbermarket Ruby-Platform Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-25 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails