bc-prometheus-ruby 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c45a328936365a6af2f347292b2eb010593389726e55f4fb655db3b1789d10ee
-  data.tar.gz: 9d29a29091f1720929abff06f8e9e66f0435b56887b7e4c01bfa43e47c5b624d
+  metadata.gz: d996c929cb82a48d50a36f4bbd942a5cc7dd41d6ec7d10864808619a6ab08630
+  data.tar.gz: 10a28c621098fa9ecb0a06734d66c840663276dd3a3e84f5cdf5bb8bb21760b8
 SHA512:
-  metadata.gz: d489b1017fcd86d43adaf0f9e1eb7a504c5a52b1b68c56e04cae26d1d4068f0e75cf54814c7f09d1e70d9ae257ca022b9cc403bb8fb8adc5d50319c27d057e0b
-  data.tar.gz: 9c856f97bfda20fa39431d2fc328e2eb05c8f9f63ef54f192322b1850da0fdc604d592a94fc902450f5262b54ccd7daa3effa95af5afb64155e1d72d0b395d38
+  metadata.gz: 1400c730adf70a8f4f1d836e8a1b78ae5d34c5f11c66848a7cb47001e8e0502d2981b898c52953f2e549945c5c82e0cd1ceaad7aa5901a909241af4a829c85cd
+  data.tar.gz: 03dc5e33614b1f4bb27bb1636d91a37704727b2279a981abaa2d1355c3fc679936df78633df774ee2ec240d0c3614ce370f237b10a4a417be7db2ed19f6a8685

data/CHANGELOG.md

@@ -2,6 +2,16 @@ Changelog for the bc-prometheus-ruby gem.
 
 ### Pending Release
 
+## 0.8.2
+
+- Add `version=0.0.4` to `Content-Type` header for Prometheus exposition format 0.0.4 compliance
+
+## 0.8.1
+
+- Prometheus client respects the enabled setting
+- Upgrade prometheus_exporter
+- Expose SQL metrics for different dashboards
+
 ## 0.8.0
 
 - Add support for Ruby 3.4

data/bc-prometheus-ruby.gemspec

@@ -31,11 +31,13 @@ Gem::Specification.new do |spec|
 
   spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'bc-prometheus-ruby.gemspec']
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 3.2'
+  spec.required_ruby_version = '>= 3.3'
 
   spec.add_runtime_dependency 'bigcommerce-multitrap', '~> 0.1'
   spec.add_runtime_dependency 'prometheus_exporter', '~> 0.7'
   spec.add_runtime_dependency 'puma', '> 5'
   spec.add_runtime_dependency 'rack', '>= 3.0'
   spec.add_runtime_dependency 'rake', '>= 10.0'
+
+  spec.add_development_dependency 'activesupport', '>= 6.0'
 end

data/lib/bigcommerce/prometheus/client.rb

@@ -69,6 +69,14 @@ module Bigcommerce
         URI("http://#{@host}:#{@port}#{path}")
       end
 
+      ##
+      # @param [String] str
+      def send(str)
+        return unless Bigcommerce::Prometheus.enabled
+
+        super
+      end
+
       ##
       # Process the current queue and flush to the collector
       #

data/lib/bigcommerce/prometheus/collectors/base.rb

@@ -72,6 +72,8 @@ module Bigcommerce
           metrics = {}
           metrics = collect(metrics)
           push(metrics)
+        rescue StandardError => e
+          @logger.error("[bigcommerce-prometheus] Collector error (#{self.class}), continuing: #{e.message}")
         ensure
           sleep @frequency
         end

data/lib/bigcommerce/prometheus/configuration.rb

@@ -34,7 +34,7 @@ module Bigcommerce
         puma_collection_frequency: ENV.fetch('PROMETHEUS_PUMA_COLLECTION_FREQUENCY', 30).to_i,
         puma_process_label: ENV.fetch('PROMETHEUS_PUMA_PROCESS_LABEL', 'web').to_s,
         resque_collection_frequency: ENV.fetch('PROMETHEUS_RESQUE_COLLECTION_FREQUENCY', 30).to_i,
-        resque_process_label: ENV.fetch('PROMETHEUS_REQUEST_PROCESS_LABEL', 'resque').to_s,
+        resque_process_label: ENV.fetch('PROMETHEUS_RESQUE_PROCESS_LABEL', 'resque').to_s,
 
         # Server configuration
         not_found_body: ENV.fetch('PROMETHEUS_SERVER_NOT_FOUND_BODY', 'Not Found! The Prometheus Ruby Exporter only listens on /metrics and /send-metrics').to_s,
@@ -54,7 +54,8 @@ module Bigcommerce
         web_type_collectors: [],
 
         # Additional configuration
-        railtie_disabled: ENV.fetch('PROMETHEUS_DISABLE_RAILTIE', 0).to_i.positive?
+        railtie_disabled: ENV.fetch('PROMETHEUS_DISABLE_RAILTIE', 0).to_i.positive?,
+        active_record_enabled: ENV.fetch('PROMETHEUS_ACTIVE_RECORD_ENABLED', 1).to_i.positive?
       }.freeze
 
       attr_accessor *VALID_CONFIG_KEYS.keys

data/lib/bigcommerce/prometheus/instrumentors/hutch.rb

@@ -46,10 +46,12 @@ module Bigcommerce
 
           server.add_type_collector(PrometheusExporter::Server::ActiveRecordCollector.new)
           server.add_type_collector(PrometheusExporter::Server::HutchCollector.new)
+          ::Bigcommerce::Prometheus::Integrations::ActiveRecordSql.register_type_collector(server, process_name: @process_name)
           @type_collectors.each do |tc|
             server.add_type_collector(tc)
           end
           server.start
+          ::Bigcommerce::Prometheus::Integrations::ActiveRecordSql.start_safe(client: Bigcommerce::Prometheus.client, process_name: @process_name)
           setup_middleware
         rescue StandardError => e
           logger.error "[bigcommerce-prometheus][#{@process_name}] Failed to start hutch instrumentation - #{e.message} - #{e.backtrace[0..4].join("\n")}"

data/lib/bigcommerce/prometheus/instrumentors/web.rb

@@ -67,6 +67,7 @@ module Bigcommerce
             server.add_type_collector(PrometheusExporter::Server::ActiveRecordCollector.new)
             server.add_type_collector(PrometheusExporter::Server::WebCollector.new)
             server.add_type_collector(PrometheusExporter::Server::PumaCollector.new)
+            ::Bigcommerce::Prometheus::Integrations::ActiveRecordSql.register_type_collector(server, process_name: @process_name)
             @type_collectors.each do |tc|
               server.add_type_collector(tc)
             end
@@ -78,6 +79,7 @@ module Bigcommerce
           @app.config.after_fork_callbacks = [] unless @app.config.after_fork_callbacks
           @app.config.after_fork_callbacks << lambda do
             ::Bigcommerce::Prometheus::Integrations::Puma.start(client: Bigcommerce::Prometheus.client)
+            ::Bigcommerce::Prometheus::Integrations::ActiveRecordSql.start_safe(client: Bigcommerce::Prometheus.client, process_name: @process_name)
             @collectors.each(&:start)
           rescue StandardError => e
             logger.error "[bigcommerce-prometheus][#{@process_name}] Failed to start web prometheus middleware after fork: #{e.message}"

data/lib/bigcommerce/prometheus/integrations/active_record.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Bigcommerce
+  module Prometheus
+    module Integrations
+      ##
+      # Subscribes to ActiveSupport sql.active_record notifications and pushes a per-operation
+      # SQL query duration histogram to the Prometheus exporter.
+      #
+      class ActiveRecordSql
+        IGNORED_NAMES = %w[SCHEMA CACHE].freeze
+        TYPE = 'active_record_sql'
+
+        # Idempotent: returns the same instance on repeated calls within a process,
+        # so calling .start more than once (e.g. from both the gem's instrumentor and a
+        # consuming app's initializer) does not register duplicate subscribers and
+        # double-count every SQL query.
+        #
+        # Noop when ActiveRecord is not loaded so non-Rails consumers (or any process that
+        # never loads ActiveRecord) can call this safely.
+        def self.start(client: nil)
+          return unless active_record_loaded?
+
+          @start ||= new(client: client || ::Bigcommerce::Prometheus.client).tap(&:subscribe!)
+        end
+
+        # @return [Boolean] whether ActiveRecord is loaded in the current process.
+        def self.active_record_loaded?
+          defined?(::ActiveRecord) ? true : false
+        end
+
+        # Wrapper for instrumentor wiring: registers the AR SQL type collector on the given server,
+        # gated on the active_record_enabled config flag, and swallows errors so an additive
+        # feature failure cannot take down core instrumentation.
+        def self.register_type_collector(server, process_name: nil)
+          return unless ::Bigcommerce::Prometheus.active_record_enabled
+
+          server.add_type_collector(::Bigcommerce::Prometheus::TypeCollectors::ActiveRecordSql.new)
+        rescue StandardError => e
+          log_warn(process_name, "Failed to register ActiveRecord type collector: #{e.message}")
+        end
+
+        # Wrapper for instrumentor wiring: starts the AR integration, gated on the
+        # active_record_enabled config flag, and swallows errors so an additive feature
+        # failure cannot take down core instrumentation.
+        def self.start_safe(client: nil, process_name: nil)
+          return unless ::Bigcommerce::Prometheus.active_record_enabled
+
+          start(client: client)
+        rescue StandardError => e
+          log_warn(process_name, "Failed to start ActiveRecord integration: #{e.message}")
+        end
+
+        def self.log_warn(process_name, message)
+          process_name ||= ::Bigcommerce::Prometheus.process_name
+          ::Bigcommerce::Prometheus.logger&.warn("[bigcommerce-prometheus][#{process_name}] #{message}")
+        end
+        private_class_method :log_warn
+
+        def initialize(client:)
+          @client = client
+        end
+
+        def subscribe!
+          ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+            call(ActiveSupport::Notifications::Event.new(*args))
+          end
+        end
+
+        def call(event)
+          return if IGNORED_NAMES.include?(event.payload[:name])
+
+          @client.send_json(
+            type: TYPE,
+            duration_seconds: event.duration / 1000.0,
+            custom_labels: { operation: classify(event.payload[:sql]) }
+          )
+        rescue StandardError
+          # Never let metric instrumentation propagate into the request path.
+          nil
+        end
+
+        private
+
+        def classify(sql)
+          return 'other' if sql.nil?
+
+          first_token = sql.lstrip.split(/\s+/, 2).first&.upcase
+          case first_token
+          when 'SELECT' then 'select'
+          when 'INSERT' then 'insert'
+          when 'UPDATE' then 'update'
+          when 'DELETE' then 'delete'
+          else 'other'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/integrations/puma.rb

@@ -51,7 +51,7 @@ module Bigcommerce
         # @return [Boolean]
         #
         def self.active_record_enabled?
-          defined?(ActiveRecord) && ::ActiveRecord::Base.connection_pool.respond_to?(:stat)
+          defined?(::ActiveRecord) && ::ActiveRecord::Base.connection_pool.respond_to?(:stat)
         end
 
         ##

data/lib/bigcommerce/prometheus/server.rb

@@ -80,11 +80,12 @@ module Bigcommerce
       #
       def stop
         @server.stop
-        @run_thread.kill
-        @running = false
+        @run_thread&.kill
         $stdout.puts "[bigcommerce-prometheus][#{@process_name}] Prometheus exporter cleanly shut down"
       rescue ::StandardError => e
         warn "[bigcommerce-prometheus][#{@process_name}] Failed to stop exporter: #{e.message}"
+      ensure
+        @running = false
       end
 
       ##

data/lib/bigcommerce/prometheus/servers/puma/controllers/base_controller.rb

@@ -30,13 +30,15 @@ module Bigcommerce
             # @param [Bigcommerce::Prometheus::Servers::Puma::ServerMetrics]
             # @param [PrometheusExporter::Server::Collector] collector
             # @param [Logger] logger
+            # @param [Integer, nil] timeout scrape timeout in seconds; nil means no limit
             #
-            def initialize(request:, response:, server_metrics:, collector:, logger:)
+            def initialize(request:, response:, server_metrics:, collector:, logger:, timeout: nil)
               @request = request
               @response = response
               @collector = collector
               @server_metrics = server_metrics
               @logger = logger
+              @timeout = timeout
             end
 
             def handle

data/lib/bigcommerce/prometheus/servers/puma/controllers/metrics_controller.rb

@@ -34,10 +34,12 @@ module Bigcommerce
             def call
               collected_metrics = metrics
               if @request.accept_encoding.to_s.include?('gzip')
-                write_gzip(metrics)
+                write_gzip(collected_metrics)
               else
                 @response.write(collected_metrics)
               end
+
+              set_header('Content-Type', 'text/plain; version=0.0.4; charset=utf-8')
               @response
             end
 

data/lib/bigcommerce/prometheus/servers/puma/rack_app.rb

@@ -77,7 +77,8 @@ module Bigcommerce
               response: response,
               server_metrics: @server_metrics,
               collector: @collector,
-              logger: @logger
+              logger: @logger,
+              timeout: @timeout
             )
             con.handle
           end

data/lib/bigcommerce/prometheus/type_collectors/active_record.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Bigcommerce
+  module Prometheus
+    module TypeCollectors
+      ##
+      # Render-side counterpart to Integrations::ActiveRecordSql. Aggregates per-operation
+      # SQL query duration into a Prometheus Histogram exposed at /metrics.
+      #
+      class ActiveRecordSql < Bigcommerce::Prometheus::TypeCollectors::Base
+        def initialize(
+          default_labels: {},
+          buckets: [0.001, 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 20, 30, 60]
+        )
+          @buckets = buckets
+          super(type: Bigcommerce::Prometheus::Integrations::ActiveRecordSql::TYPE, default_labels: default_labels)
+        end
+
+        def build_metrics
+          {
+            sql_query_duration_seconds: PrometheusExporter::Metric::Histogram.new(
+              'sql_query_duration_seconds',
+              'ActiveRecord SQL query duration in seconds, labeled by operation.',
+              buckets: @buckets
+            )
+          }
+        end
+
+        def collect_metrics(data:, labels: {})
+          duration = data['duration_seconds']
+          return if duration.nil?
+
+          metric(:sql_query_duration_seconds).observe(duration.to_f, labels)
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/type_collectors/resque.rb

@@ -48,7 +48,7 @@ module Bigcommerce
           metric(:jobs_processed_total).observe(data['jobs_processed_total'], labels)
           metric(:queues_total).observe(data['queues_total'], labels)
 
-          data['queues'].each do |name, size|
+          (data['queues'] || {}).each do |name, size|
             metric(:queue_sizes).observe(size, labels.merge(queue: name))
           end
         end

data/lib/bigcommerce/prometheus/version.rb

@@ -17,6 +17,6 @@
 #
 module Bigcommerce
   module Prometheus
-    VERSION = '0.8.0'
+    VERSION = '0.8.2'
   end
 end

data/lib/bigcommerce/prometheus.rb

@@ -35,6 +35,8 @@ require_relative 'prometheus/collectors/base'
 require_relative 'prometheus/collectors/resque'
 require_relative 'prometheus/type_collectors/base'
 require_relative 'prometheus/type_collectors/resque'
+require_relative 'prometheus/integrations/active_record'
+require_relative 'prometheus/type_collectors/active_record'
 
 require_relative 'prometheus/instrumentors/web'
 require_relative 'prometheus/instrumentors/hutch'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bc-prometheus-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigcommerce-multitrap
@@ -80,6 +79,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: Simple integration of ruby and puma servers with prometheus
 email:
 - shaun.mccormick@bigcommerce.com
@@ -99,6 +112,7 @@ files:
 - lib/bigcommerce/prometheus/instrumentors/hutch.rb
 - lib/bigcommerce/prometheus/instrumentors/resque.rb
 - lib/bigcommerce/prometheus/instrumentors/web.rb
+- lib/bigcommerce/prometheus/integrations/active_record.rb
 - lib/bigcommerce/prometheus/integrations/puma.rb
 - lib/bigcommerce/prometheus/integrations/railtie.rb
 - lib/bigcommerce/prometheus/integrations/resque.rb
@@ -112,6 +126,7 @@ files:
 - lib/bigcommerce/prometheus/servers/puma/rack_app.rb
 - lib/bigcommerce/prometheus/servers/puma/server.rb
 - lib/bigcommerce/prometheus/servers/puma/server_metrics.rb
+- lib/bigcommerce/prometheus/type_collectors/active_record.rb
 - lib/bigcommerce/prometheus/type_collectors/base.rb
 - lib/bigcommerce/prometheus/type_collectors/resque.rb
 - lib/bigcommerce/prometheus/version.rb
@@ -119,7 +134,6 @@ homepage: https://github.com/bigcommerce/bc-prometheus-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,15 +141,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Simple integration of ruby and puma servers with prometheus
 test_files: []