deimos-ruby 2.0.15 → 2.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6c9d3bcbf085821dc0be156389bd223dbce36ba8c34ff452612cf82ca3b3be4
-  data.tar.gz: fc9bf56f6ad566a9e197e50b5b167af620e9c0d6ec0fd9f50999059b7fded6ee
+  metadata.gz: a6b4516c780cd6c4acfe46092cf4ff7342a3db20b5d259f6fee59e85c2dd6c01
+  data.tar.gz: 02347f3bb35d9cd1c0435f097d453c6f7d90bccee6892d637954c862155164fd
 SHA512:
-  metadata.gz: 88ac68371a699744e87fcc0c7e8a1294af1b02d4ff6973f95c1667c3754ac8fd0eeda65afddd966a4451058028409e3183e6bca112c553dbf7ac67f72929ffdd
-  data.tar.gz: 30f93b2f6aefbdf3b8554bb0a6b5bac53e6638a88adc75bdded31fde88b783ca6311fb50b652f9b8085d32da6175449181dd8229a1544018e0e1c7c51ddc158f
+  metadata.gz: 8b1c2de2fa812f2385b07f3e9fde5135e734571f5bb34d96dd31536ebaf7576c3acdccc7df03098632d549e264d8ef1a5d8f2589995287dda4628dbd535a1840
+  data.tar.gz: 600268d4111cb77b2f4c06a6e07ee95d7e7e4387c298a6099c4498f247a64a443426d639c09b1e30455e3f74ebca7a3790ca5b54abcf34d3ab8918811f58a765

data/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+## 2.0.17 - 2025-07-03
+
+- Feature: Allow producers to specify `:message` and `:key` in the `publish` methods.
+
+## 2.0.16 - 2025-05-30
+
+- Fix: Send `publish` metric even if the producer was not a Deimos producer.
+
 ## 2.0.15 - 2025-05-29
 
 - Fix: Do not force data to JSON when logging payloads. This allows log formatters to handle the payloads on their own (e.g. adding additional fields).

data/README.md

@@ -259,13 +259,22 @@ If you publish a payload `{ "test_id" => "123", "some_int" => 123 }`, this
 will be turned into a key that looks like `{ "test_id" => "123"}` and schema-encoded
 before being sent to Kafka. 
 
-If you are using `plain` or `schema` as your config, you will need to have a
-special `payload_key` key to your payload hash. This will be extracted and
+If you are using `plain` or `schema` as your config, you can specify the key in two ways:
+
+* Add a special `payload_key` key to your payload hash. This will be extracted and
 used as the key (for `plain`, it will be used directly, while for `schema`
 it will be encoded first against the schema). So your payload would look like
 `{ "test_id" => "123", "some_int" => 123, payload_key: "some_other_key"}`.
 Remember that if you're using `schema`, the `payload_key` must be a *hash*,
 not a plain value.
+* Specify `:message` and `:key` values when producing messages. This can be helpful when using [schema classes](#generated-schema-classes):
+
+```ruby
+MyProducer.publish({
+                     message: MySchema.new("test_id" => "123", "some_int" => 123),
+                     key: MySchemaKey.new("test_id" => "123")
+                   })
+```
 
 ## Instrumentation
 

data/lib/deimos/backends/kafka.rb

@@ -7,11 +7,6 @@ module Deimos
       # :nodoc:
       def self.execute(producer_class:, messages:)
         Karafka.producer.produce_many_sync(messages)
-        Deimos.config.metrics&.increment(
-          'publish',
-          tags: %W(status:success topic:#{messages.first[:topic]}),
-          by: messages.size
-        )
       end
     end
   end

data/lib/deimos/backends/kafka_async.rb

@@ -7,11 +7,6 @@ module Deimos
       # :nodoc:
       def self.execute(producer_class:, messages:)
         Karafka.producer.produce_many_async(messages)
-        Deimos.config.metrics&.increment(
-          'publish',
-          tags: %W(status:success topic:#{messages.first[:topic]}),
-          by: messages.size
-        )
       end
     end
   end

data/lib/deimos/ext/producer_metrics_listener.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Deimos
+  class ProducerMetricsListener
+      %i[
+        produced_sync
+        produced_async
+      ].each do |event_scope|
+        define_method(:"on_message_#{event_scope}") do |event|
+          Deimos.config.metrics&.increment(
+            'publish',
+            tags: %W(status:success topic:#{event[:message][:topic]})
+          )
+        end
+
+        define_method(:"on_messages_#{event_scope}") do |event|
+          Deimos.config.metrics&.increment(
+            'publish',
+            tags: %W(status:success topic:#{event[:messages].first[:topic]}),
+            by: event[:messages].size
+          )
+        end
+      end
+  end
+end

data/lib/deimos/producer.rb

@@ -111,12 +111,17 @@ module Deimos
         backend = determine_backend_class(sync, force_send)
 
         messages = Array(payloads).map do |p|
-          {
+          m = {
             payload: p&.to_h,
             headers: headers,
             topic: topic,
             partition_key: self.partition_key(p)
           }
+          if m.dig(:payload, :key).present? && m.dig(:payload, :message).present?
+            m[:key] = m[:payload][:key].to_h
+            m[:payload] = m[:payload][:message].to_h
+          end
+          m
         end
         self.produce(messages, backend: backend)
       end

data/lib/deimos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deimos
-  VERSION = '2.0.15'
+  VERSION = '2.0.17'
 end

data/lib/deimos.rb

@@ -25,6 +25,7 @@ require 'deimos/ext/schema_route'
 require 'deimos/ext/consumer_route'
 require 'deimos/ext/producer_route'
 require 'deimos/ext/producer_middleware'
+require 'deimos/ext/producer_metrics_listener'
 require 'deimos/ext/routing_defaults'
 
 require 'deimos/railtie' if defined?(Rails)
@@ -146,6 +147,8 @@ module Deimos
         Karafka::Setup::AttributesMap.producer(Karafka::Setup::Config.config.kafka.dup)
       EVENT_TYPES.each { |type| Karafka.monitor.notifications_bus.register_event(type) }
 
+      Karafka.producer.monitor.subscribe(ProducerMetricsListener.new)
+
       Karafka.producer.monitor.subscribe('error.occurred') do |event|
         if event.payload.key?(:messages)
           topic = event[:messages].first[:topic]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.15
+  version: 2.0.17
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-29 00:00:00.000000000 Z
+date: 2025-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro_turf
@@ -457,6 +457,7 @@ files:
 - lib/deimos/consumer.rb
 - lib/deimos/exceptions.rb
 - lib/deimos/ext/consumer_route.rb
+- lib/deimos/ext/producer_metrics_listener.rb
 - lib/deimos/ext/producer_middleware.rb
 - lib/deimos/ext/producer_route.rb
 - lib/deimos/ext/routing_defaults.rb