promenade 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 235f95d0b77870a9975ff9870428ed5a995b9174380b981c2df7d8a338519ffb
-  data.tar.gz: 7d6e327e2d602fd2b07342fb45c9be29e36ad266212ad4ed98a72eafee58bc9e
+  metadata.gz: c8f195d39a6967000ebf64da2a2143a85c934ad0a37b7303eb91511dd1f458bf
+  data.tar.gz: '030960d747dd81a33a2feea7b6f3a3460fdc3952160b4c000900645df163d402'
 SHA512:
-  metadata.gz: e8596f53e3110b636696cb38f2d3bfa872715de3e331fdf260da62e30c31949a1753702b935c3343545c7be19da56f0e30a65d89568eefd419b94a5ef80fe2f9
-  data.tar.gz: 7e65f494c50b2bc25b05b169794f73c02c64ad1548c3425399b1d2cb4e7077d930e0e7d9c99ea88088c76e1026bb64cfbda246ab1a6b09c057b4f2b717b130d8
+  metadata.gz: 3cb2cd2eaf07029afd1ac8ad574be62d5b5f848734ea67f1f94a919fe9a6f548c2bcb71d761b92a30077575114a7b505eebe21f20f380af47471401c62b898f6
+  data.tar.gz: 0e94c108cd6e98d0f1280e07412e2cb9a41ef7f5a0d7f33735d785c1253424246e46c5fc49ddc0757658301f697272baa1ee882f109327442d13ffa87e6f6429

data/.github/workflows/ci.yaml

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

data/.rubocop.yml

@@ -16,3 +16,7 @@ Rails/RakeEnvironment:
   Enabled: false
 Rails/EnvironmentVariableAccess:
   Enabled: false
+RSpec/DescribedClass:
+  Enabled: false
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promenade (0.6.0)
+    promenade (0.7.0)
       actionpack
       activesupport (> 6.0, < 8.0)
       prometheus-client-mmap (~> 0.16.0)
@@ -109,6 +109,7 @@ GEM
     highline (2.0.3)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
+    json (2.6.3)
     loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -138,7 +139,7 @@ GEM
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
     prometheus-client-mmap (0.16.2)
     pry (0.14.1)
@@ -176,7 +177,7 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -199,17 +200,20 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.11.0)
-    rubocop (1.30.1)
+    rubocop (1.46.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
     rubocop-performance (1.14.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
@@ -217,6 +221,9 @@ GEM
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.7.0, < 2.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -236,7 +243,7 @@ GEM
       sync
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.4.2)
     webrick (1.7.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
@@ -262,6 +269,7 @@ DEPENDENCIES
   rubocop
   rubocop-performance
   rubocop-rails
+  rubocop-rspec
   simplecov
   webrick
 

data/exe/promenade

@@ -8,7 +8,7 @@ Promenade.setup
 
 app = Rack::Builder.app do
   use Rack::Deflater
-  use ::Prometheus::Client::Rack::Exporter
+  use Prometheus::Client::Rack::Exporter
   map "/health" do
     run lambda { |_env| [200, { "Content-Type" => "text/plain" }, ["OK"]] }
   end

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

@@ -1,6 +1,6 @@
 require "action_dispatch/middleware/exception_wrapper"
 require_relative "singleton_caller"
-require_relative "request_labeler"
+require_relative "request_controller_action_labeler"
 
 module Promenade
   module Client
@@ -8,21 +8,19 @@ module Promenade
       class ExceptionHandler
         extend SingletonCaller
 
-        attr_reader :histogram_name, :requests_counter_name, :exceptions_counter_name, :registry
+        attr_reader :histogram_name, :exceptions_counter_name, :registry
 
-        def initialize(histogram_name:, requests_counter_name:, exceptions_counter_name:, registry:)
+        def initialize(histogram_name:, exceptions_counter_name:, registry:)
           @histogram_name = histogram_name
-          @requests_counter_name = requests_counter_name
           @exceptions_counter_name = exceptions_counter_name
           @registry = registry
         end
 
         def call(exception, env_hash, duration)
-          labels = RequestLabeler.call(env_hash)
+          labels = RequestControllerActionLabeler.call(env_hash)
           labels.merge!(code: status_code_for_exception(exception))
 
           histogram.observe(labels, duration.to_f)
-          requests_counter.increment(labels)
           exceptions_counter.increment(exception: exception.class.name)
 
           raise exception
@@ -34,10 +32,6 @@ module Promenade
             registry.get(histogram_name)
           end
 
-          def requests_counter
-            registry.get(requests_counter_name)
-          end
-
           def exceptions_counter
             registry.get(exceptions_counter_name)
           end

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

@@ -1,6 +1,6 @@
 require "prometheus/client"
 require_relative "middleware_base"
-require_relative "request_labeler"
+require_relative "request_controller_action_labeler"
 require_relative "exception_handler"
 require_relative "queue_time_duration"
 
@@ -10,17 +10,14 @@ module Promenade
       class HTTPRequestDurationCollector < MiddlwareBase
         REQUEST_DURATION_HISTOGRAM_NAME = :http_req_duration_seconds
 
-        REQUESTS_COUNTER_NAME = :http_requests_total
-
         EXCEPTIONS_COUNTER_NAME = :http_exceptions_total
 
         private_constant :REQUEST_DURATION_HISTOGRAM_NAME,
-          :REQUESTS_COUNTER_NAME,
           :EXCEPTIONS_COUNTER_NAME
 
         def initialize(app,
                        registry: ::Prometheus::Client.registry,
-                       label_builder: RequestLabeler,
+                       label_builder: RequestControllerActionLabeler,
                        exception_handler: nil)
 
           @latency_buckets = Promenade.configuration.rack_latency_buckets
@@ -45,7 +42,6 @@ module Promenade
           end
 
           def record_request_duration(labels, duration)
-            requests_counter.increment(labels)
             durations_histogram.observe(labels, duration)
           end
 
@@ -61,13 +57,7 @@ module Promenade
             registry.get(REQUEST_DURATION_HISTOGRAM_NAME)
           end
 
-          def requests_counter
-            registry.get(REQUESTS_COUNTER_NAME)
-          end
-
           def register_metrics!
-            registry.counter(REQUESTS_COUNTER_NAME,
-              "A counter of the total number of HTTP requests made.")
             registry.histogram(REQUEST_DURATION_HISTOGRAM_NAME,
               "A histogram of the response latency.", {}, latency_buckets)
             registry.counter(EXCEPTIONS_COUNTER_NAME,
@@ -81,7 +71,6 @@ module Promenade
           def default_exception_handler
             ExceptionHandler.initialize_singleton(
               histogram_name: REQUEST_DURATION_HISTOGRAM_NAME,
-              requests_counter_name: REQUESTS_COUNTER_NAME,
               exceptions_counter_name: EXCEPTIONS_COUNTER_NAME,
               registry: registry,
             )

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

@@ -0,0 +1,42 @@
+require_relative "request_labeler"
+module Promenade
+  module Client
+    module Rack
+      class RequestControllerActionLabeler < RequestLabeler
+        PARAMS_KEY = "action_dispatch.request.parameters".freeze
+
+        PATH_PARAMS_KEY = "action_dispatch.request.path_parameters".freeze
+
+        CONTROLLER = "controller".freeze
+
+        ACTION = "action".freeze
+
+        UNKNOWN = "unknown".freeze
+
+        SEPARATOR = "#".freeze
+
+        private_constant :PARAMS_KEY, :CONTROLLER, :ACTION, :UNKNOWN, :SEPARATOR
+
+        def call(env)
+          super.merge({
+            controller_action: controller_action_from_env(env),
+          })
+        end
+
+        private
+
+          def controller_action_from_env(env)
+            controller = env.dig(PARAMS_KEY, CONTROLLER) ||
+                         env.dig(PATH_PARAMS_KEY, CONTROLLER.to_sym) ||
+                         UNKNOWN
+
+            action = env.dig(PARAMS_KEY, ACTION) ||
+                     env.dig(PATH_PARAMS_KEY, ACTION.to_sym) ||
+                     UNKNOWN
+
+            [controller, action].join(SEPARATOR)
+          end
+      end
+    end
+  end
+end

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

@@ -9,41 +9,14 @@ module Promenade
 
         HTTP_HOST = "HTTP_HOST".freeze
 
-        PARAMS_KEY = "action_dispatch.request.parameters".freeze
-
-        PATH_PARAMS_KEY = "action_dispatch.request.path_parameters".freeze
-
-        CONTROLLER = "controller".freeze
-
-        ACTION = "action".freeze
-
-        UNKNOWN = "unknown".freeze
-
-        SEPARATOR = "#".freeze
-
-        private_constant :REQUEST_METHOD, :HTTP_HOST, :PARAMS_KEY, :CONTROLLER, :ACTION, :UNKNOWN, :SEPARATOR
+        private_constant :REQUEST_METHOD, :HTTP_HOST
 
         def call(env)
           {
             method: env[REQUEST_METHOD].to_s.downcase,
             host: env[HTTP_HOST].to_s,
-            controller_action: controller_action_from_env(env),
           }
         end
-
-        private
-
-          def controller_action_from_env(env)
-            controller = env.dig(PARAMS_KEY, CONTROLLER) ||
-                         env.dig(PATH_PARAMS_KEY, CONTROLLER.to_sym) ||
-                         UNKNOWN
-
-            action = env.dig(PARAMS_KEY, ACTION) ||
-                     env.dig(PATH_PARAMS_KEY, ACTION.to_sym) ||
-                     UNKNOWN
-
-            [controller, action].join(SEPARATOR)
-          end
       end
     end
   end

data/lib/promenade/version.rb

@@ -1,3 +1,3 @@
 module Promenade
-  VERSION = "0.6.0".freeze
+  VERSION = "0.7.0".freeze
 end

data/lib/promenade.rb

@@ -1,7 +1,7 @@
 require "promenade/version"
 require "promenade/setup"
 require "promenade/configuration"
-require "promenade/railtie" if defined? ::Rails::Railtie
+require "promenade/railtie" if defined? Rails::Railtie
 require "promenade/prometheus"
 
 module Promenade

data/promenade.gemspec

@@ -2,7 +2,7 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "promenade/version"
 
-Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
   spec.name          = "promenade"
   spec.version       = Promenade::VERSION
   spec.authors       = ["Ed Robinson"]
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.7", "< 3.2"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.add_dependency "actionpack"
   spec.add_dependency "activesupport", "> 6.0", "< 8.0"
@@ -39,6 +39,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "rubocop-rspec"
   spec.add_development_dependency "simplecov"
   spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promenade
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ed Robinson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -232,6 +232,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -276,6 +290,7 @@ files:
 - lib/promenade/client/rack/http_request_queue_time_collector.rb
 - lib/promenade/client/rack/middleware_base.rb
 - lib/promenade/client/rack/queue_time_duration.rb
+- lib/promenade/client/rack/request_controller_action_labeler.rb
 - lib/promenade/client/rack/request_labeler.rb
 - lib/promenade/client/rack/singleton_caller.rb
 - lib/promenade/configuration.rb
@@ -306,16 +321,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.7'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.18
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Promenade makes it simple to instrument Ruby apps for prometheus scraping