hanami-events-cloud_pubsub 3.0.7 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9761e02377d807f35d3c4e005d4948237bf89204ba7d7dc619d46e91d7bca38
-  data.tar.gz: fade5b3c8657111ab4e485ad5b03bb584b69d4557cd2416d5e0c358bcf5dc3f4
+  metadata.gz: c39281bf95b089129d91b5c00b4e73d03dfe32269c2ee9a57f8af9b69c9ebdee
+  data.tar.gz: bf46742e1b0b73347516e53c6f140375cd38b9f5dffe595bc53b724c2d73765a
 SHA512:
-  metadata.gz: c89ad6a21c559f77c671b10cd7da95bbd7fbf09a5b0489615e46338677cac4cab129faa2b8e8d69faf6f762cda00d9b0bbf261dd82998634ebc7702e55c4ddb3
-  data.tar.gz: 0c785630df1938f248a4c5fc2f5ad5470ea8f75e872dada244dcc0229bedebbf8214ee98cbe28c5b745ba8037ce8d40ea48bafea028dc2e30329e01e6f7d623c
+  metadata.gz: 14d84ed126a93b4324fccec58cbf91508e18d03cebbc7c6f214716c5974160b7f4f9164ea0e6001fb39d0702ae50596d3a6dc0c12f8f509d52356dee2d17b63e
+  data.tar.gz: 3dd0a1882517fbbd041f4e0c8014b50f865d3af4261c6a2d8b93808b5c0be063622a74397157b9ef0cc449d9fcc404eb2ba2316a381c282da5cafad4e3313ca5

data/Gemfile

@@ -11,7 +11,7 @@ RUBY_MAJOR = RUBY_VERSION[0].to_i
 
 gem 'hanami-events', github: 'hanami/events'
 gem 'pry'
+gem 'request_id', '~> 0.4.3'
 gem 'rubocop'
 gem 'simplecov', require: false
-gem 'request_id', '~> 0.4.3'
 gem 'webrick' if RUBY_MAJOR > 2

data/README.md

@@ -119,12 +119,12 @@ end
 ```
 
 
-# Prometheus Integration
+# Yabeda Prometheus Integration
 
-If you have the `prometheus-client` gem installed, a `/metrics` endpoint will
+If you have the `yabeda-prometheus` gem installed, a `/metrics` endpoint will
 be available on the health check server which can be scraped.
 
-All you need to do to activate this is to make sure to `require 'prometheus/client'`.
+All you need to do to activate this is to make sure to `require 'yabeda/prometheus'`.
 
 # Testing
 

data/hanami-events-cloud_pubsub.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'prometheus-client'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yabeda-prometheus-mmap'
 end

data/lib/hanami/events/cloud_pubsub.rb

@@ -7,7 +7,6 @@ require 'hanami/events/cloud_pubsub/middleware/stack'
 require 'hanami/events/cloud_pubsub/middleware/logging'
 require 'hanami/events/cloud_pubsub/runner'
 require 'hanami/events/cloud_pubsub/errors'
-require 'google/cloud/pubsub'
 require 'dry-configurable'
 
 module Hanami
@@ -60,12 +59,13 @@ module Hanami
         Middleware::Logging.new
       )
 
-      begin
-        require 'prometheus/client'
-        require 'hanami/events/cloud_pubsub/middleware/prometheus'
-        middleware_stack.prepend(Middleware::Prometheus.new)
-      rescue LoadError
-        # ok
+      if defined?(Yabeda::Prometheus::Exporter)
+        begin
+          require 'hanami/events/cloud_pubsub/middleware/prometheus'
+          middleware_stack << Middleware::Prometheus.new
+        rescue LoadError
+          # ok
+        end
       end
 
       setting :middleware, middleware_stack
@@ -96,6 +96,7 @@ module Hanami
       end
 
       def self.finalize_settings!
+        require 'google/cloud/pubsub'
         conf_hash = config.pubsub
         conf_hash.each { |key, val| Google::Cloud::Pubsub.configure[key] = val }
       end

data/lib/hanami/events/cloud_pubsub/cli.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'hanami/cli'
-require 'hanami/events/cloud_pubsub'
-require 'hanami/events/cloud_pubsub/health_check_server'
 
 module Hanami
   module Events
@@ -55,6 +53,7 @@ module Hanami
             end
 
             def start_server
+              require 'hanami/events/cloud_pubsub/health_check_server'
               server = HealthCheckServer.new(runner, logger)
               on_shutdown = proc { @event_queue << proc { shutdown } }
               server.run_in_background(on_shutdown: on_shutdown)
@@ -77,6 +76,7 @@ module Hanami
             def start_runner
               logger.debug 'Running in emulator mode' if @emulator
               logger.info "Starting worker (pid: #{Process.pid})"
+              GC.compact if GC.respond_to?(:compact)
               runner.start
             end
 
@@ -86,6 +86,7 @@ module Hanami
             end
 
             def build_runner
+              require 'hanami/events/cloud_pubsub'
               Hanami::Components.resolve 'events'
               events = Hanami::Components['events']
               @runner = Runner.new(logger: logger, adapter: events.adapter)

data/lib/hanami/events/cloud_pubsub/errors.rb

@@ -6,9 +6,13 @@ module Hanami
       # Errors
       module Errors
         class Error < StandardError; end
+
         class TopicNotFoundError < Error; end
+
         class SubscriptionNotFoundError < Error; end
+
         class SubscriptionTopicNameMismatch < Error; end
+
         class NoSubscriberError < Error; end
       end
     end

data/lib/hanami/events/cloud_pubsub/health_check_server.rb

@@ -54,10 +54,8 @@ module Hanami
 
           Rack::Builder.new do |builder|
             builder.use Rack::Deflater
-            if defined?(::Prometheus::Client)
-              require 'prometheus/middleware/exporter'
-              builder.use ::Prometheus::Middleware::Exporter
-            end
+            builder.use Yabeda::Prometheus::Exporter if defined?(Yabeda::Prometheus::Exporter)
+
             builder.run health_endpoint_app
           end
         end

data/lib/hanami/events/cloud_pubsub/integration.rb

@@ -33,11 +33,10 @@ module Hanami
                   conf.cloud_pubsub.each { |blk| blk.call(config) }
                 end
 
-                ::Hanami::Events.initialize(
-                  :cloud_pubsub,
-                  pubsub: Google::Cloud::Pubsub.new,
-                  logger: Hanami::Components['logger']
-                )
+                require 'google/cloud/pubsub'
+
+                opts = { pubsub: Google::Cloud::Pubsub.new, logger: Hanami::Components['logger'] }
+                ::Hanami::Events.initialize(:cloud_pubsub, **opts)
               end
             end
           end

data/lib/hanami/events/cloud_pubsub/middleware/prometheus.rb

@@ -6,23 +6,31 @@ module Hanami
       module Middleware
         # Middleware used for logging useful information about an event
         class Prometheus
-          attr_reader :events_counter
+          LONG_RUNNING_JOB_RUNTIME_BUCKETS = [
+            0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, # standard (from Prometheus)
+            30, 60, 120, 300, 1800, 3600, 21_600 # Tasks may be very long-running
+          ].freeze
 
-          def initialize
-            require 'prometheus/client'
-            prometheus = ::Prometheus::Client.registry
-            @events_counter = prometheus.counter(
+          Yabeda.configure do
+            counter(
               :received_pubsub_events,
-              docstring: 'A counter of received pubsub events',
-              labels: %i[event_name subscription status]
+              tags: %i[event_name subscription status],
+              comment: 'A counter of received pubsub events'
             )
+
+            histogram :subscriber_runtime, comment: 'A histogram of the subscriber execution time.',
+                                           unit: :seconds,
+                                           per: :message,
+                                           tags: %i[event_name subscription status],
+                                           buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
           end
 
           def call(msg, **opts)
+            start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
             status = :running
 
             begin
-              ret = yield(**opts)
+              ret = yield(**opts) if block_given?
               status = :succeeded
               ret
             rescue StandardError
@@ -30,10 +38,20 @@ module Hanami
               raise
             end
           ensure
+            record_metrics(msg, status, start)
+          end
+
+          private
+
+          def record_metrics(msg, status, start)
+            elapsed = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start).round(3)
             sub = msg.subscription.subscriber.subscription_name
             event_name = msg.attributes['event_name']
             labels = { event_name: event_name, subscription: sub, status: status }
-            events_counter.increment(labels: labels)
+            Yabeda.received_pubsub_events.increment(labels, by: 1)
+            Yabeda.subscriber_runtime.measure(labels, elapsed)
+          rescue StandardError
+            # ok
           end
         end
       end

data/lib/hanami/events/cloud_pubsub/version.rb

@@ -3,7 +3,7 @@
 module Hanami
   module Events
     module CloudPubsub
-      VERSION = '3.0.7'
+      VERSION = '3.1.4'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-events-cloud_pubsub
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 3.1.4
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -115,47 +115,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: prometheus-client
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: yabeda-prometheus-mmap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Makes it easy to use Cloud Pub/Sub with Hanami
 email:
 - i.kerseymer@gmail.com
@@ -187,7 +187,6 @@ files:
 - lib/hanami/events/cloud_pubsub.rb
 - lib/hanami/events/cloud_pubsub/cli.rb
 - lib/hanami/events/cloud_pubsub/errors.rb
-- lib/hanami/events/cloud_pubsub/handler.rb
 - lib/hanami/events/cloud_pubsub/health_check_server.rb
 - lib/hanami/events/cloud_pubsub/integration.rb
 - lib/hanami/events/cloud_pubsub/listener.rb