hanami-events-cloud_pubsub 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 338f493e08b2982228b7546e10c18452d48f451e88a96f34fbf36778d003b5bb
-  data.tar.gz: 647128eda207a71c1269dd6a3ac7581fa2f2655eb8960d2f9e6bffab52a1d274
+  metadata.gz: 753a636d5e7a7f4e76eb1865278d0979ad5d338c0c5283f7b22c11a491a42f92
+  data.tar.gz: 43ba31f43a4b5255d10c4682e9859d14d9f79c9d4036786bd947bf1faa77d042
 SHA512:
-  metadata.gz: 59c6d32caa054e83dfe743c0df16e47c2394bb8caefc03d5e6632a5f4477cd9c669e642affc3f41fab0cb76249ca4676abe673a2daf61b4be1f207550a59902a
-  data.tar.gz: 6e29e8a65c31ef38bef0d7ef7b871dc99025d135ce57fcf1a9cf6b3eee896f133710b8bf5f918b05ad8c864ae632d205b194a52cc5af974f14c3df863f4bf332
+  metadata.gz: d1ae226d26f497f50c447784421861e45d99b59624149cecc224d4f6ae9bf2e74f54c9438cfb2ed33c55ab938f4d12913200025d1c40a4b0518d8305ea089762
+  data.tar.gz: a1a1b64ca8dc346484a699a78508e92b9057ee14d599f1097bf9b84defee04e4af35c59aa039ad30659894d0395d890c490725e4989744a39c936525362fbfd2

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_from: .rubocop_todo.yml
 AllCops:
   Exclude:
     - bin/*
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Metrics/BlockLength:
   Exclude:

data/.tool-versions

@@ -1 +1 @@
-ruby 2.6.5
+ruby 2.6.6

data/Gemfile.lock

@@ -8,11 +8,12 @@ GIT
 PATH
   remote: .
   specs:
-    hanami-events-cloud_pubsub (2.5.1)
+    hanami-events-cloud_pubsub (2.6.0)
       dry-configurable (>= 0.8)
       google-cloud-pubsub (>= 0.38.1, < 1.4)
       hanami-cli (~> 0.2)
       hanami-events (~> 0.2.0)
+      rack
 
 GEM
   remote: https://rubygems.org/
@@ -24,7 +25,7 @@ GEM
     concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     docile (1.3.2)
-    dry-configurable (0.11.2)
+    dry-configurable (0.11.5)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
       dry-equalizer (~> 0.2)
@@ -34,13 +35,13 @@ GEM
     dry-core (0.4.9)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
-    faraday (0.17.3)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     google-cloud-core (1.5.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
-    google-cloud-env (1.3.0)
-      faraday (~> 0.11)
+    google-cloud-env (1.3.1)
+      faraday (>= 0.17.3, < 2.0)
     google-cloud-errors (1.0.0)
     google-cloud-pubsub (1.3.1)
       concurrent-ruby (~> 1.1)
@@ -56,25 +57,26 @@ GEM
       grpc (~> 1.24)
       rly (~> 0.2.3)
     google-protobuf (3.11.4)
-    googleapis-common-protos (1.3.9)
-      google-protobuf (~> 3.0)
-      googleapis-common-protos-types (~> 1.0)
-      grpc (~> 1.0)
-    googleapis-common-protos-types (1.0.4)
-      google-protobuf (~> 3.0)
-    googleauth (0.10.0)
-      faraday (~> 0.12)
+    googleapis-common-protos (1.3.10)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos-types (>= 1.0.5, < 2.0)
+      grpc (~> 1.27)
+    googleapis-common-protos-types (1.0.5)
+      google-protobuf (~> 3.11)
+    googleauth (0.12.0)
+      faraday (>= 0.17.3, < 2.0)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
-      signet (~> 0.12)
-    grpc (1.27.0)
+      signet (~> 0.14)
+    grpc (1.28.0)
       google-protobuf (~> 3.11)
       googleapis-common-protos-types (~> 1.0)
-    grpc-google-iam-v1 (0.6.9)
-      googleapis-common-protos (>= 1.3.1, < 2.0)
-      grpc (~> 1.0)
+    grpc-google-iam-v1 (0.6.10)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos (>= 1.3.10, < 2.0)
+      grpc (~> 1.27)
     hanami-cli (0.3.1)
       concurrent-ruby (~> 1.0)
       hanami-utils (~> 1.3)
@@ -84,17 +86,19 @@ GEM
     jaro_winkler (1.5.4)
     jwt (2.2.1)
     memoist (0.16.2)
-    method_source (0.9.2)
+    method_source (1.0.0)
     multi_json (1.14.1)
     multipart-post (2.1.1)
-    os (1.0.1)
+    os (1.1.0)
     parallel (1.19.1)
-    parser (2.7.0.2)
+    parser (2.7.1.1)
       ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (4.0.3)
+    prometheus-client (2.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.4)
+    rack (2.2.2)
     rainbow (3.0.0)
     rake (13.0.1)
     rexml (3.2.4)
@@ -105,33 +109,33 @@ GEM
       rspec-mocks (~> 3.9.0)
     rspec-core (3.9.1)
       rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.80.0)
+    rubocop (0.82.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
     ruby-progressbar (1.10.1)
-    signet (0.12.0)
+    signet (0.14.0)
       addressable (~> 2.3)
-      faraday (~> 0.9)
+      faraday (>= 0.17.3, < 2.0)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
-    simplecov (0.18.2)
+    simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.0)
+    simplecov-html (0.12.2)
     transproc (1.1.1)
-    unicode-display_width (1.6.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -140,6 +144,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   hanami-events!
   hanami-events-cloud_pubsub!
+  prometheus-client
   pry
   rake (~> 13.0)
   rspec (~> 3.0)
@@ -147,4 +152,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -106,6 +106,13 @@ Then, run the worker process:
 bundle exec cloudpubsub run
 ```
 
+# Prometheus Integration
+
+If you have the `prometheus-client` 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'`.
+
 # Testing
 
 If you would like to use an emulator process for testing:

data/hanami-events-cloud_pubsub.gemspec

@@ -26,8 +26,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'google-cloud-pubsub', '>= 0.38.1', '< 1.4'
   spec.add_dependency 'hanami-cli', '~> 0.2'
   spec.add_dependency 'hanami-events', '~> 0.2.0'
+  spec.add_dependency 'rack'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'prometheus-client'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

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

@@ -14,18 +14,18 @@ module Hanami
 
         def start
           logger.info 'Starting healthcheck server on port 0.0.0.0:8081'
-          server.start
+          start_server
         end
 
         def shutdown
           logger.info 'Shutting down healthcheck server'
-          server.shutdown
+          @server.shutdown
         end
 
         def run_in_background(on_shutdown: nil)
           prom = Concurrent::Promise.execute do
             start
-            on_shutdown&.call(server)
+            on_shutdown&.call(@server)
           end
 
           prom.catch { |err| logger.error(err) }
@@ -35,22 +35,38 @@ module Hanami
 
         attr_reader :logger, :runner
 
-        def server
-          @server ||=
-            WEBrick::HTTPServer.new(
-              Port: 8081,
-              BindAddress: '0.0.0.0',
-              Logger: WEBrick::Log.new('/dev/null'),
-              AccessLog: []
-            ).tap do |srv|
-              srv.mount_proc '/', method(:health_endpoint)
+        def start_server
+          require 'rack'
+
+          Rack::Handler::WEBrick.run(
+            rack_app,
+            AccessLog: [],
+            Host: '0.0.0.0',
+            Port: 8081,
+            Logger: WEBrick::Log.new('/dev/null')
+          ) do |server|
+            @server = server
+          end
+        end
+
+        def rack_app
+          health_endpoint_app = method(:health_endpoint)
+
+          Rack::Builder.new do |builder|
+            builder.use Rack::Deflater
+            if defined?(::Prometheus::Client)
+              require 'prometheus/middleware/exporter'
+              builder.use ::Prometheus::Middleware::Exporter
             end
+            builder.run health_endpoint_app
+          end
         end
 
-        def health_endpoint(_req, res)
-          res['Content-Type'] = 'text/plain'
-          res.status = runner.healthy? ? 200 : 503
-          res.body = runner.debug_info
+        def health_endpoint(_env)
+          headers = { 'Content-Type' => 'text/plain' }
+          status = runner.healthy? ? 200 : 503
+          body = [runner.debug_info]
+          [status, headers, body]
         end
       end
     end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Events
+    module CloudPubsub
+      module Middleware
+        # Middleware used for logging useful information about an event
+        class Prometheus
+          attr_reader :events_counter
+
+          def initialize
+            require 'prometheus/client'
+            prometheus = ::Prometheus::Client.registry
+            @events_counter = prometheus.counter(
+              :pubsub_events,
+              docstring: 'A counter of received pubsub events',
+              labels: %i[event_name subscription]
+            )
+          end
+
+          def call(msg, opts = {})
+            yield(opts)
+          ensure
+            sub = msg.subscription.subscriber.subscription_name
+            event_name = msg.attributes['event_name']
+            events_counter.increment(labels: { event_name: event_name, subscription: sub })
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Hanami
   module Events
     module CloudPubsub
-      VERSION = '2.5.1'
+      VERSION = '2.6.0'
     end
   end
 end

data/lib/hanami/events/cloud_pubsub.rb

@@ -6,6 +6,7 @@ require 'hanami/events/cloud_pubsub/version'
 require 'hanami/events/cloud_pubsub/middleware/stack'
 require 'hanami/events/cloud_pubsub/middleware/logging'
 require 'hanami/events/cloud_pubsub/middleware/auto_retry'
+require 'hanami/events/cloud_pubsub/middleware/prometheus'
 require 'hanami/events/cloud_pubsub/runner'
 require 'hanami/events/cloud_pubsub/errors'
 require 'google/cloud/pubsub'
@@ -57,11 +58,15 @@ module Hanami
         end
       ], reader: true
 
-      setting :middleware, Middleware::Stack.new(
+      middleware_stack = Middleware::Stack.new(
         Middleware::Logging.new,
         Middleware::AutoRetry.new
       )
 
+      middleware_stack.prepend(Middleware::Prometheus) if defined?(::Prometheus::Client)
+
+      setting :middleware, middleware_stack
+
       setting :on_shutdown_handlers, [], reader: true
 
       def self.finalize_settings!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-events-cloud_pubsub
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -152,6 +180,7 @@ files:
 - lib/hanami/events/cloud_pubsub/listener.rb
 - lib/hanami/events/cloud_pubsub/middleware/auto_retry.rb
 - lib/hanami/events/cloud_pubsub/middleware/logging.rb
+- lib/hanami/events/cloud_pubsub/middleware/prometheus.rb
 - lib/hanami/events/cloud_pubsub/middleware/stack.rb
 - lib/hanami/events/cloud_pubsub/register.rb
 - lib/hanami/events/cloud_pubsub/runner.rb