sbmt-kafka_producer 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01390ee8af51126fefcebfc7a1cdebc8c61cff6660d064568b01e1508f1bc616'
-  data.tar.gz: 1402bc1e9e5b51ff2998411b6154711b9af3f583c539cab01deae04c9d8e29fc
+  metadata.gz: df2d6a732b779366dbb7f47c0f3b97020cdf21772f72c94ea20bc929ddc8cdad
+  data.tar.gz: 3327e30a17a00cc1a200e87cf40db7e22d03a4494c54fae4d4dcc237e88e1ff2
 SHA512:
-  metadata.gz: db848372986b9b6107b3911dad1f36c62f6532cc25d22d573bd2c1ab4afb37e4e3c27616a2ad70611c8f5006e00bf0dd6e36821cdc91acf96d010f3f22a741fe
-  data.tar.gz: 55082c9462c97377276ebc9c1b3406a409993b737828a0a13e72bd1c7eb09263ad68f61678b59b21178c6ada97665116b27d6fd09094b5e570f3546ac8ed9855
+  metadata.gz: dc264c48c8979e1a8ae288132a83e384957e2a8341b6f699d5a0801124d3a17c062fb45e80b6bdec389b0a29fab1afeed689b8598802ec233d68050254c59dc1
+  data.tar.gz: 51b34e850f32e9f7442455f2dab19dbc924ee3dd91c22cfb9824556c2c8674472f3e5d0ba490718a054207613980b3a52b4cd13221a6a4f04e8c8336d1fbd660

data/CHANGELOG.md

@@ -13,6 +13,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+## [3.1.1] - 2024-10-31
+
+### Changed
+
+- Update README
+
+## [3.1.0] - 2024-09-13
+
+### Added
+
+- For synchronous messages and errors, we place logs in tags
+
+### Fixed
+
+- Fixed mock for tests
+
 ## [3.0.0] - 2024-08-27
 
 ## BREAKING

data/Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source ENV.fetch("NEXUS_PUBLIC_SOURCE_URL", "https://rubygems.org")
 
 gemspec

data/README.md

@@ -66,7 +66,7 @@ default: &default
   # see more options at https://github.com/karafka/waterdrop/blob/master/lib/waterdrop/config.rb
   wait_on_queue_full: true
   max_payload_size: 1000012
-  max_wait_timeout_ms: 60000
+  max_wait_timeout: 60000
   auth:
     kind: plaintext
   kafka:
@@ -77,9 +77,9 @@ default: &default
     retry_backoff: 1000 # in milliseconds, optional, default: 1000
     connect_timeout: 2000 # in milliseconds, optional, default: 2000
     message_timeout: 55000 # in milliseconds, optional, default: 55000
-    kafka_config: # low-level custom Kafka options
-      queue.buffering.max.messages: 1
-      queue.buffering.max.ms: 10000
+    # kafka_config: # optional, low-level custom Kafka options (see https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md)
+    #   queue.buffering.max.messages: 100000
+    #   queue.buffering.max.ms: 5
 
 development:
   <<: *default

data/lib/sbmt/kafka_producer/base_producer.rb

@@ -5,14 +5,18 @@ module Sbmt
     class BaseProducer
       extend Dry::Initializer
 
+      MSG_SUCCESS = "Message has been successfully sent to Kafka"
+
       option :client, default: -> { KafkaClientFactory.default_client }
       option :topic
 
       def sync_publish!(payload, options = {})
-        report = around_publish do
-          client.produce_sync(payload: payload, **options.merge(topic: topic))
+        report, produce_duration = around_publish do
+          measure_time do
+            client.produce_sync(payload: payload, **options.merge(topic: topic))
+          end
         end
-        log_success(report)
+        log_success(report, produce_duration)
         true
       end
 
@@ -78,12 +82,19 @@ module Sbmt
       def log_error(error)
         return true if ignore_kafka_errors?
 
-        logger.error "KAFKA ERROR: #{format_exception_error(error)}\n#{error.backtrace.join("\n")}"
+        log_tags = {stacktrace: error.backtrace.join("\n")}
+
+        logger.tagged(log_tags) do
+          logger.send(:error, "KAFKA ERROR: #{format_exception_error(error)}")
+        end
+
         ErrorTracker.error(error)
       end
 
-      def log_success(report)
-        logger.info "Message has been successfully sent to Kafka - topic: #{report.topic_name}, partition: #{report.partition}, offset: #{report.offset}"
+      def log_success(report, produce_duration)
+        log_tags = {kafka: log_tags(report, produce_duration)}
+
+        log_with_tags(log_tags)
       end
 
       def format_exception_error(error)
@@ -100,6 +111,33 @@ module Sbmt
         error.respond_to?(:cause) && error.cause.present?
       end
 
+      def log_tags(report, produce_duration)
+        {
+          topic: report.topic_name,
+          partition: report.partition,
+          offset: report.offset,
+          produce_duration_ms: produce_duration
+        }
+      end
+
+      def log_with_tags(log_tags)
+        return unless logger.respond_to?(:tagged)
+
+        logger.tagged(log_tags) do
+          logger.send(:info, MSG_SUCCESS)
+        end
+      end
+
+      def measure_time
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        result = yield
+        end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        elapsed_time = end_time - start_time
+
+        [result, elapsed_time]
+      end
+
       def config
         Config::Producer
       end

data/lib/sbmt/kafka_producer/logger.rb

@@ -20,6 +20,10 @@ module Sbmt
       def add(...)
         logger.add(...)
       end
+
+      def tagged(...)
+        logger.tagged(...)
+      end
     end
   end
 end

data/lib/sbmt/kafka_producer/testing/configure_producer_client.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 class FakeWaterDropClient
+  Report = Struct.new(:topic_name, :partition, :offset)
+
   def produce_sync(*)
-    # no op
+    Report.new("fake_topic", 0, 0)
   end
 
   def produce_async(*)

data/lib/sbmt/kafka_producer/version.rb

@@ -2,6 +2,6 @@
 
 module Sbmt
   module KafkaProducer
-    VERSION = "3.0.0"
+    VERSION = "3.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sbmt-kafka_producer
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Kuper Ruby-Platform Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -426,7 +426,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby gem for producing Kafka messages