promenade 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc0749131d57843e9243eb47058cc0615c73865b92b753772308ceb13cd6b096
-  data.tar.gz: 66c5a9376ea0cd02dbd64bd63e67d3178f440a30701646912ef459586e14a1e6
+  metadata.gz: 9bfd38ab707b83cd27b230470eee4ec780ba798b483722a68fbf523f126468a5
+  data.tar.gz: 9f44f7722eeec1d4e0f80c96e9f47f315e8f17545dd1c5c18e7a7213ba1092b7
 SHA512:
-  metadata.gz: 5569ffe88cbaf2a0a738b605c15673a6866e51c345fc53a8000f01004dd77b23a8175af32f1242ed2492aa444c6a71e20d760fb1d377b2c02ead531470108f47
-  data.tar.gz: b2fe6be44e09a45f9e6cf051971b27140d9af03e436265815ccb0e527d85dfcc890dc271654e3b404ff9cfce8c8a633ff4efe1c17797781ef6751732bb7d92f3
+  metadata.gz: 8b46d28958a5065ebf3e1311b0b7edaed1e01d626cbccac657d2a40ba644b48dad611ab44ce7c3418c346c8266b6704710f2fc8ba84ba4727dc9e47843549518
+  data.tar.gz: c33f7d5b259e82fed2fe3856733db53ae4b663ff3a4f9ed5190c9dc59c0053afc66f00d40c31be474472e3527f2eb522ef33b36189f99b14a466e9b060bc86b1

data/.github/workflows/ci.yaml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7', '3.0', "3.1", "3.2"]
+        ruby: ["3.0", "3.1", "3.2"]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promenade (0.9.0)
+    promenade (0.11.0)
       actionpack
       activesupport (> 6.0, < 8.0)
       prometheus-client-mmap (~> 0.16.0)
@@ -10,67 +10,67 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actioncable (7.0.6)
+      actionpack (= 7.0.6)
+      activesupport (= 7.0.6)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailbox (7.0.6)
+      actionpack (= 7.0.6)
+      activejob (= 7.0.6)
+      activerecord (= 7.0.6)
+      activestorage (= 7.0.6)
+      activesupport (= 7.0.6)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailer (7.0.6)
+      actionpack (= 7.0.6)
+      actionview (= 7.0.6)
+      activejob (= 7.0.6)
+      activesupport (= 7.0.6)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.4.2)
-      actionview (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (7.0.6)
+      actionview (= 7.0.6)
+      activesupport (= 7.0.6)
+      rack (~> 2.0, >= 2.2.4)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actiontext (7.0.6)
+      actionpack (= 7.0.6)
+      activerecord (= 7.0.6)
+      activestorage (= 7.0.6)
+      activesupport (= 7.0.6)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionview (7.0.6)
+      activesupport (= 7.0.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activejob (7.0.6)
+      activesupport (= 7.0.6)
       globalid (>= 0.3.6)
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activerecord (7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activestorage (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activemodel (7.0.6)
+      activesupport (= 7.0.6)
+    activerecord (7.0.6)
+      activemodel (= 7.0.6)
+      activesupport (= 7.0.6)
+    activestorage (7.0.6)
+      actionpack (= 7.0.6)
+      activejob (= 7.0.6)
+      activerecord (= 7.0.6)
+      activesupport (= 7.0.6)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.4.2)
+    activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -89,12 +89,13 @@ GEM
     erubi (1.12.0)
     globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    loofah (2.19.1)
+    language_server-protocol (3.17.0.3)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
@@ -103,9 +104,9 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.8.1)
-    minitest (5.17.0)
-    net-imap (0.3.4)
+    mini_portile2 (2.8.4)
+    minitest (5.18.1)
+    net-imap (0.3.6)
       date
       net-protocol
     net-pop (0.1.2)
@@ -114,58 +115,61 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.14.2)
-      mini_portile2 (~> 2.8.0)
+    nio4r (2.5.9)
+    nokogiri (1.15.3)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.2.1.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     prometheus-client-mmap (0.16.2)
-    racc (1.6.2)
-    rack (2.2.6.2)
-    rack-test (2.0.2)
+    racc (1.7.1)
+    rack (2.2.7)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.4.2)
-      actioncable (= 7.0.4.2)
-      actionmailbox (= 7.0.4.2)
-      actionmailer (= 7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actiontext (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    rails (7.0.6)
+      actioncable (= 7.0.6)
+      actionmailbox (= 7.0.6)
+      actionmailer (= 7.0.6)
+      actionpack (= 7.0.6)
+      actiontext (= 7.0.6)
+      actionview (= 7.0.6)
+      activejob (= 7.0.6)
+      activemodel (= 7.0.6)
+      activerecord (= 7.0.6)
+      activestorage (= 7.0.6)
+      activesupport (= 7.0.6)
       bundler (>= 1.15.0)
-      railties (= 7.0.4.2)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 7.0.6)
+    rails-dom-testing (2.1.1)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.6)
+      actionpack (= 7.0.6)
+      activesupport (= 7.0.6)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-rails (5.1.2)
@@ -176,40 +180,44 @@ GEM
       rspec-expectations (~> 3.10)
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
-    rspec-support (3.12.0)
-    rubocop (1.47.0)
+    rspec-support (3.12.1)
+    rubocop (1.54.2)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
+    rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
-    rubocop-performance (1.16.0)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.18.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.18.0)
+    rubocop-rails (2.20.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
-    rubocop-rspec (2.18.1)
+    rubocop-rspec (2.22.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.12.0)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    thor (1.2.1)
-    timeout (0.3.2)
+    thor (1.2.2)
+    timeout (0.4.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
@@ -217,7 +225,7 @@ GEM
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   ruby
@@ -240,4 +248,4 @@ DEPENDENCIES
   webrick
 
 BUNDLED WITH
-   2.3.16
+   2.4.17

data/lib/promenade/client/rack/http_request_duration_collector.rb

@@ -8,12 +8,12 @@ module Promenade
   module Client
     module Rack
       class HTTPRequestDurationCollector < MiddlwareBase
-        REQUEST_DURATION_HISTOGRAM_NAME = :http_req_duration_seconds
+        REQUEST_DURATION_HISTOGRAM_NAME = :http_request_duration_seconds
 
         # We specifically want to record a separate metric `http_requests_total` even
-        # though we know it is a duplicate of http_req_duration_seconds_count.
+        # though we know it is a duplicate of http_request_duration_seconds_count.
         # This is a very commonly used prometheus metric name, and is very useful
-        # e.g. for autoscaling.  Using the http_req_duration_seconds_count in such
+        # e.g. for autoscaling.  Using the http_request_duration_seconds_count in such
         # queries can be confusing
         REQUESTS_COUNTER_NAME = :http_requests_total
 

data/lib/promenade/client/rack/http_request_queue_time_collector.rb

@@ -7,7 +7,7 @@ module Promenade
   module Client
     module Rack
       class HTTPRequestQueueTimeCollector < MiddlwareBase
-        REQUEST_QUEUE_TIME_HISTOGRAM_NAME = :http_req_queue_time_seconds
+        REQUEST_QUEUE_TIME_HISTOGRAM_NAME = :http_request_queue_time_seconds
 
         private_constant :REQUEST_QUEUE_TIME_HISTOGRAM_NAME
 

data/lib/promenade/version.rb

@@ -1,3 +1,3 @@
 module Promenade
-  VERSION = "0.9.0".freeze
+  VERSION = "0.11.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.11.0
 platform: ruby
 authors:
 - Ed Robinson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-07-19 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.4.10
 signing_key:
 specification_version: 4
 summary: Promenade makes it simple to instrument Ruby apps for prometheus scraping