promenade 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc0749131d57843e9243eb47058cc0615c73865b92b753772308ceb13cd6b096
-  data.tar.gz: 66c5a9376ea0cd02dbd64bd63e67d3178f440a30701646912ef459586e14a1e6
+  metadata.gz: 74c2f57f687ffba42cadfb976e0132ff7396568802cdafe06cd3386dc824be6d
+  data.tar.gz: 021cea56c7dacde62e90c2b638796dfb995b95ea64e6a9dd811c1f8e656f3a02
 SHA512:
-  metadata.gz: 5569ffe88cbaf2a0a738b605c15673a6866e51c345fc53a8000f01004dd77b23a8175af32f1242ed2492aa444c6a71e20d760fb1d377b2c02ead531470108f47
-  data.tar.gz: b2fe6be44e09a45f9e6cf051971b27140d9af03e436265815ccb0e527d85dfcc890dc271654e3b404ff9cfce8c8a633ff4efe1c17797781ef6751732bb7d92f3
+  metadata.gz: aa1e090da77fc3546b24dd57f6494beed29c11641cae29acc6f914e04140d06c058d00f2eb20a39e37a6c510a3451f4fd2b229267cd9835f8d3d204632f513b2
+  data.tar.gz: 90b71c399a0d107ee01334a011f0a253acbb5d71ad3fedd809cb7956587e241f4dfceb728077799665e08365c396ef0a9e7072828ac1c5bbabc1b8fcdaf37fcb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promenade (0.9.0)
+    promenade (0.10.0)
       actionpack
       activesupport (> 6.0, < 8.0)
       prometheus-client-mmap (~> 0.16.0)
@@ -123,7 +123,7 @@ GEM
       ast (~> 2.4.1)
     prometheus-client-mmap (0.16.2)
     racc (1.6.2)
-    rack (2.2.6.2)
+    rack (2.2.6.3)
     rack-test (2.0.2)
       rack (>= 1.3)
     rails (7.0.4.2)

data/lib/promenade/version.rb

@@ -1,3 +1,3 @@
 module Promenade
-  VERSION = "0.9.0".freeze
+  VERSION = "0.10.0".freeze
 end

data/lib/promenade/waterdrop/error_subscriber.rb

@@ -0,0 +1,27 @@
+require "promenade/waterdrop/subscriber"
+
+module Promenade
+  module Waterdrop
+    class ErrorSubscriber < Subscriber
+      attach_to "error.waterdrop"
+
+      Promenade.counter :waterdrop_errors_total do
+        doc "Count of Waterdrop errors"
+      end
+
+      def occurred(event)
+        labels = get_labels(event)
+
+        Promenade.metric(:waterdrop_errors_total).increment(labels)
+      end
+
+      private
+
+        def get_labels(event)
+          {
+            error_type: event.payload[:type],
+          }
+        end
+    end
+  end
+end

data/lib/promenade/waterdrop/message_subscriber.rb

@@ -0,0 +1,48 @@
+require "promenade/waterdrop/subscriber"
+
+module Promenade
+  module Waterdrop
+    class MessageSubscriber < Subscriber
+      attach_to "message.waterdrop"
+
+      Promenade.counter :waterdrop_producer_messages_total do
+        doc "Number of messages written to Kafka producer"
+      end
+
+      Promenade.counter :waterdrop_producer_ack_messages_total do
+        doc "Count of the number of messages Acked by Kafka"
+      end
+
+      def produced_async(event)
+        Promenade.metric(
+          :waterdrop_producer_messages_total,
+        ).increment(get_labels(event).merge(producer_type: "async"))
+      end
+
+      def produced_sync(event)
+        Promenade.metric(
+          :waterdrop_producer_messages_total,
+        ).increment(get_labels(event).merge(producer_type: "sync"))
+      end
+
+      def acknowledged(event)
+        labels = {
+          client: event.payload[:producer_id],
+        }
+
+        Promenade.metric(:waterdrop_producer_ack_messages_total).increment(labels)
+      end
+
+      private
+
+        def get_labels(event)
+          payload = event.payload
+
+          {
+            client: payload[:producer_id],
+            topic: event.payload[:message][:topic],
+          }
+        end
+    end
+  end
+end

data/lib/promenade/waterdrop/statistics_subscriber.rb

@@ -0,0 +1,94 @@
+require "promenade/waterdrop/subscriber"
+require "active_support/core_ext/hash"
+
+module Promenade
+  module Waterdrop
+    class StatisticsSubscriber < Subscriber
+      attach_to "statistics.waterdrop"
+
+      Promenade.histogram :waterdrop_producer_message_size do
+        doc "Historgram of message sizes written to Kafka producer"
+        buckets :memory
+      end
+
+      Promenade.counter :waterdrop_producer_delivered_messages do
+        doc "A count of the total messages delivered to Kafka"
+      end
+
+      Promenade.histogram :waterdrop_producer_delivery_attempts do
+        doc "A count of the total message deliveries attempted"
+        buckets [0, 6, 12, 18, 24, 30]
+      end
+
+      Promenade.histogram :waterdrop_producer_ack_latency_seconds do
+        doc "Delay between message being produced and Acked in seconds"
+        buckets :network
+      end
+
+      Promenade.gauge :waterdrop_async_producer_queue_size do
+        doc "Size of Kafka async producer queue"
+      end
+
+      Promenade.gauge :waterdrop_async_producer_max_queue_size do
+        doc "Max size of Kafka async producer queue"
+      end
+
+      Promenade.gauge :waterdrop_async_producer_queue_fill_ratio do
+        doc "Size of Kafka async producer queue"
+      end
+
+      Promenade.counter :waterdrop_async_producer_dropped_messages do
+        doc "Count of dropped messages"
+      end
+
+      def emitted(event)
+        statistics = event.payload[:statistics].with_indifferent_access
+        labels = get_labels(statistics)
+
+        report_root_metrics(statistics, labels)
+        report_broker_metrics(statistics[:brokers], labels)
+      end
+
+      private
+
+        def report_root_metrics(statistics, labels)
+          queue_size = statistics[:msg_cnt]
+          max_queue_size = statistics[:msg_max]
+          message_size = statistics[:msg_size]
+          delivered_messages = statistics[:txmsgs]
+          queue_fill_ratio = queue_size.to_f / max_queue_size
+
+          Promenade.metric(:waterdrop_async_producer_queue_size).set(labels, queue_size)
+          Promenade.metric(:waterdrop_async_producer_max_queue_size).set(labels, max_queue_size)
+          Promenade.metric(:waterdrop_async_producer_queue_fill_ratio).set(labels, queue_fill_ratio)
+          Promenade.metric(:waterdrop_producer_message_size).observe(labels, message_size)
+          Promenade.metric(:waterdrop_producer_delivered_messages).increment(labels, delivered_messages)
+        end
+
+        def report_broker_metrics(brokers, labels)
+          brokers.map do |broker_name, broker_values|
+            next if broker_values[:nodeid] == -1
+
+            attempts = broker_values[:txretries]
+            ack_latency = convert_microseconds_to_seconds(broker_values[:rtt][:avg])
+            broker_labels = {
+              broker_id: broker_name,
+            }
+
+            Promenade.metric(:waterdrop_producer_delivery_attempts).observe(labels.merge(broker_labels), attempts)
+            Promenade.metric(:waterdrop_producer_ack_latency_seconds).observe(labels, ack_latency)
+          end
+        end
+
+        def get_labels(statistics)
+          {
+            client: statistics[:client_id],
+          }
+        end
+
+        def convert_microseconds_to_seconds(time_in_microseconds)
+          time_in_microseconds / 1_000_000.to_f
+        end
+    end
+  end
+end

data/lib/promenade/waterdrop/subscriber.rb

@@ -0,0 +1,8 @@
+require "active_support/subscriber"
+
+module Promenade
+  module Waterdrop
+    class Subscriber < ActiveSupport::Subscriber
+    end
+  end
+end

data/lib/promenade/waterdrop.rb

@@ -0,0 +1,3 @@
+require "promenade/waterdrop/message_subscriber"
+require "promenade/waterdrop/error_subscriber"
+require "promenade/waterdrop/statistics_subscriber"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promenade
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Ed Robinson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -297,6 +297,11 @@ files:
 - lib/promenade/railtie.rb
 - lib/promenade/setup.rb
 - lib/promenade/version.rb
+- lib/promenade/waterdrop.rb
+- lib/promenade/waterdrop/error_subscriber.rb
+- lib/promenade/waterdrop/message_subscriber.rb
+- lib/promenade/waterdrop/statistics_subscriber.rb
+- lib/promenade/waterdrop/subscriber.rb
 - promenade.gemspec
 homepage: https://github.com/errm/promenade
 licenses:
@@ -318,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Promenade makes it simple to instrument Ruby apps for prometheus scraping