hanami-events-cloud_pubsub 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b625cc3f94218143ebafd31a854fdefb3e4b3ab5d54aa66385784f6560265c8
-  data.tar.gz: e7eb0b9995c66e2c4610b9eba4913a4ff94e8c89981302b4f736ccc9cdddf6aa
+  metadata.gz: ce3a1788cccaf44d604f113f700ffe69b2e198d068b6dce7ed25f85bc1c2f72a
+  data.tar.gz: 0cbbe24fb26de4fc989dcfc53f2cb73fccaacc58408deaae623d1d6d7e249ba2
 SHA512:
-  metadata.gz: f3e44b4a055f90493bfafe9cbeb8243ddc2bba0c6eb693f5b29c664f2675546a5415387519fbe9075a110304aa3d8136b8da9b0ce0dddfa793a155fa39aeca98
-  data.tar.gz: e7107a4d84b881d2522b04002f07395783912d83a3653673650b2947a1e500cf47b4d8282adaaf0aabacbcfb3572a6780e828ff994ffcdffe160805dd30272ec
+  metadata.gz: 9789652777e1a651533eab9c0f68a418815ce7694b2888e4d6e01ffb0d2b8f5099cea2dbd9903fc6abb8c82b547f7107fcc3ce8356396414baa443335b2bc021
+  data.tar.gz: 585fc1954bc4431f5770f1eb7fb8d659c22f28726e69ecc60bdd4751e9a627de1e2f5321e142a04222a46c03d18d08aa5a6304102d8dd976b48ba0fb09aef770

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

@@ -54,7 +54,7 @@ module Hanami
         # @param id [String] A unique identifier for the subscriber
         # @param subscriber_opts [String] Additional options for the subscriber
         # @param block [Block] to execute when event is broadcasted
-        def subscribe(name, id:, **subscriber_opts, &block)
+        def subscribe(name, id:, auto_ack: true, **subscriber_opts, &block)
           event_name = namespaced(name)
           namespaced_id = namespaced(id)
 
@@ -64,7 +64,7 @@ module Hanami
           @subscribers << sub
           topic = topic_for event_name
 
-          register_listener(event_name, topic, namespaced_id, subscriber_opts)
+          register_listener(event_name, topic, namespaced_id, auto_ack, subscriber_opts)
         end
 
         def flush_messages
@@ -76,7 +76,7 @@ module Hanami
 
         attr_reader :logger
 
-        def register_listener(event_name, topic, subscriber_id, subscriber_opts)
+        def register_listener(event_name, topic, subscriber_id, auto_ack, subscriber_opts)
           listener = ::Hanami::Events::CloudPubsub::Listener.new(
             subscriber_id: subscriber_id,
             event_name: event_name,
@@ -84,7 +84,8 @@ module Hanami
             logger: logger,
             topic: topic,
             subscriber_opts: subscriber_opts,
-            dead_letter_topic: dead_letter_topic
+            dead_letter_topic: dead_letter_topic,
+            auto_ack: auto_ack
           )
 
           @listeners << listener

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
@@ -63,7 +62,7 @@ module Hanami
       if defined?(Yabeda::Prometheus::Exporter)
         begin
           require 'hanami/events/cloud_pubsub/middleware/prometheus'
-          middleware_stack.prepend(Middleware::Prometheus.new)
+          middleware_stack << Middleware::Prometheus.new
         rescue LoadError
           # ok
         end
@@ -97,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/health_check_server.rb

@@ -54,7 +54,6 @@ module Hanami
 
           Rack::Builder.new do |builder|
             builder.use Rack::Deflater
-            require 'pry'
             builder.use Yabeda::Prometheus::Exporter if defined?(Yabeda::Prometheus::Exporter)
 
             builder.run health_endpoint_app

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/listener.rb

@@ -26,6 +26,7 @@ module Hanami
                        subscriber_id:,
                        subscriber_opts: {},
                        middleware: CloudPubsub.config.middleware,
+                       auto_ack: true,
                        dead_letter_topic: nil)
           @topic = topic
           @logger = logger
@@ -35,6 +36,7 @@ module Hanami
           @input_subscriber_opts = subscriber_opts
           @middleware = middleware
           @dead_letter_topic = dead_letter_topic
+          @auto_ack = auto_ack
         end
         # rubocop:enable Metrics/ParameterLists
 
@@ -86,7 +88,7 @@ module Hanami
 
         def run_handler(message)
           middleware.invoke(message) { handler.call(message) }
-          message.ack!
+          message.ack! if @auto_ack
         rescue StandardError => e
           run_error_handlers(e, message.message_id.to_s)
           message.nack! if CloudPubsub.config.auto_retry.enabled

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

@@ -6,15 +6,27 @@ module Hanami
       module Middleware
         # Middleware used for logging useful information about an event
         class Prometheus
+          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
+
           Yabeda.configure do
             counter(
               :received_pubsub_events,
               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
@@ -26,16 +38,18 @@ module Hanami
               raise
             end
           ensure
-            record_metrics(msg, status)
+            record_metrics(msg, status, start)
           end
 
           private
 
-          def record_metrics(msg, status)
+          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 }
             Yabeda.received_pubsub_events.increment(labels, by: 1)
+            Yabeda.subscriber_runtime.measure(labels, elapsed)
           rescue StandardError
             # ok
           end

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

@@ -3,7 +3,7 @@
 module Hanami
   module Events
     module CloudPubsub
-      VERSION = '3.1.0'
+      VERSION = '3.2.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-events-cloud_pubsub
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable