bc-prometheus-ruby 0.3.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 005ae1dcfa809b70f6842f4448a99101da4218b176b7cb2a7efd575cda266961
-  data.tar.gz: a9f8f5b8c0601294f1a6b4d123a73eaef140724b55adbfca0d03adbb9037c942
+  metadata.gz: f64feca1c573ea1651030c807d187ae729e4fc744c2d6ac5f31813694ae9102c
+  data.tar.gz: 6bdf42e5208734507d42741df44677d07ded19db3e1a4f55fe204b2b763bbc11
 SHA512:
-  metadata.gz: 41fd284c235b974405840ed5c95321442d37f0f3f84d451b8ce988247ddfa8c3139a70de74a1a3734e4d78de53671787efcfbc9223b51997432e7b0f66f22251
-  data.tar.gz: f782538242bb23e53404700a31ab727fec937ced0231207ecf1ae9f2dc11a35b043c2a5b8b482515abed8fe3eb5484659192a2377571825e09657671d2d69286
+  metadata.gz: f3712517b2e2b841b8dbeedabb9f822b7352af1b30f08d1f38fe4d65ad6722df69388222e088b923f6187bc8315896097640cd839a8bf7e4991d29bc11ec6097
+  data.tar.gz: 5ef32a6ffba766cb9fb3c7bcbc64ec81e0f718030c612430e4ce3ba8e54e8a72f4dfdc8e0f3ce6916c8e697bdb4c7ddb1c5fa0435088b2800c009473c6ebf932

data/CHANGELOG.md

@@ -2,6 +2,27 @@ Changelog for the bc-prometheus-ruby gem.
 
 ### Pending Release
 
+## 0.5.2
+
+- Better error handling post-fork for web/resque instrumentors
+- Fix issue with using `Collectors::Base` and keyword arguments in Ruby 2.7
+- Remove null-logger development dependency
+
+### 0.5.1
+
+- Fix keywords argument issue with Collectors::Base and Ruby 3.0+
+
+### 0.5.0
+
+- Add configuration to disable the Railtie that activates the web instrumentor automatically. This allows applications to choose how and when this is initialized.
+- Bump prometheus_exporter gem
+- Start testing against Ruby 3.0
+
+### 0.4.0
+
+- Add configuration to control Thin web server thread pool size. Note that the default number of threads is changing from 20 to 3. You can configure this using an environment variable or initializer.
+- Update rubocop to 1.0
+
 ### 0.3.1
 
 - Update prometheus_exporter dependency to ~> 0.5 to fix memory leaks

data/README.md

@@ -1,6 +1,6 @@
 # bc-prometheus-ruby - Drop-in Prometheus metrics
 
-[![CircleCI](https://circleci.com/gh/bigcommerce/bc-prometheus-ruby.svg?style=svg&circle-token=fc3e2c4405a1f53a31e298f0ef981c2d0dfdee90)](https://circleci.com/gh/bigcommerce/bc-prometheus-ruby) [![Gem Version](https://badge.fury.io/rb/bc-prometheus-ruby.svg)](https://badge.fury.io/rb/bc-prometheus-ruby) [![Documentation](https://inch-ci.org/github/bigcommerce/bc-prometheus-ruby.svg?branch=master)](https://inch-ci.org/github/bigcommerce/bc-prometheus-ruby?branch=master)
+[![CircleCI](https://circleci.com/gh/bigcommerce/bc-prometheus-ruby.svg?style=svg&circle-token=fc3e2c4405a1f53a31e298f0ef981c2d0dfdee90)](https://circleci.com/gh/bigcommerce/bc-prometheus-ruby) [![Gem Version](https://badge.fury.io/rb/bc-prometheus-ruby.svg)](https://badge.fury.io/rb/bc-prometheus-ruby) [![Documentation](https://inch-ci.org/github/bigcommerce/bc-prometheus-ruby.svg?branch=main)](https://inch-ci.org/github/bigcommerce/bc-prometheus-ruby?branch=main)
 
 ## Installation
 
@@ -39,15 +39,17 @@ Bigcommerce::Prometheus::Instrumentors::Resque.new(app: Rails.application).start
 
 After requiring the main file, you can further configure with:
 
-| Option | Description | Default |
-| ------ | ----------- | ------- |
-| client_custom_labels | A hash of custom labels to send with each client request | `{}` |
-| client_max_queue_size | The max amount of metrics to send before flushing | 10000 |
-| client_thread_sleep | How often to sleep the worker thread that manages the client buffer (seconds) | 0.5 |
-| puma_collection_frequency | How often to poll puma collection metrics (seconds) | 30 |
-| server_host | The host to run the exporter on | 0.0.0.0 |
-| server_port | The port to run the exporter on | 9394 |
-| process_name | What the current process name is. Used in logging. | `ENV['PROCESS']` | 
+| Option | Description | Default | Environment Variable |
+| ------ | ----------- | ------- | -------------------- |
+| client_custom_labels | A hash of custom labels to send with each client request | `{}` | None |
+| client_max_queue_size | The max amount of metrics to send before flushing | `10000` | `ENV['PROMETHEUS_CLIENT_MAX_QUEUE_SIZE']` |
+| client_thread_sleep | How often to sleep the worker thread that manages the client buffer (seconds) | `0.5` | `ENV['PROMETHEUS_CLIENT_THREAD_SLEEP']` |
+| puma_collection_frequency | How often to poll puma collection metrics (seconds) | `30` | `ENV['PROMETHEUS_PUMA_COLLECTION_FREQUENCY']` |
+| server_host | The host to run the exporter on | `"0.0.0.0"` | `ENV['PROMETHEUS_SERVER_HOST']` |
+| server_port | The port to run the exporter on | `9394` | `ENV['PROMETHEUS_SERVER_PORT']` |
+| server_thread_pool_size | The number of threads used for the exporter server | `3` | `ENV['PROMETHEUS_SERVER_THREAD_POOL_SIZE']` |
+| process_name | What the current process name is (used in logging) | `"unknown"` | `ENV['PROCESS']` |
+| railtie_disabled | Opt out flag for Railtie; use `Bigcommerce::Prometheus::Instrumentors::Web.new(app: Rails.application).start` in your app's code to start it up yourself  | `0` | `ENV['PROMETHEUS_DISABLE_RAILTIE']` |
 
 ## Custom Collectors
 

data/bc-prometheus-ruby.gemspec

@@ -15,7 +15,7 @@
 # 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.
 #
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'bigcommerce/prometheus/version'
 
 Gem::Specification.new do |spec|
@@ -33,16 +33,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.6'
 
+  spec.add_development_dependency 'bundler-audit', '>= 0.6'
+  spec.add_development_dependency 'pry', '>= 0.12'
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '>= 3.8'
   spec.add_development_dependency 'rspec_junit_formatter', '>= 0.4'
-  spec.add_development_dependency 'bundler-audit', '>= 0.6'
-  spec.add_development_dependency 'null-logger', '>= 0.1'
-  spec.add_development_dependency 'pry', '>= 0.12'
-  spec.add_development_dependency 'rubocop', '>= 0.74'
+  spec.add_development_dependency 'rubocop', '>= 1.0'
   spec.add_development_dependency 'simplecov', '>= 0.16'
 
   spec.add_runtime_dependency 'bigcommerce-multitrap', '~> 0.1'
-  spec.add_runtime_dependency 'prometheus_exporter', '~> 0.5'
+  spec.add_runtime_dependency 'prometheus_exporter', '~> 0.7'
   spec.add_runtime_dependency 'thin', '~> 1.7'
 end

data/lib/bigcommerce/prometheus/client.rb

@@ -24,6 +24,14 @@ module Bigcommerce
       include Singleton
       include Loggable
 
+      ##
+      # @param [String] host
+      # @param [Integer] port
+      # @param [Integer] max_queue_size
+      # @param [Integer|Float] thread_sleep
+      # @param [Hash] custom_labels
+      # @param [String] process_name
+      #
       def initialize(host: nil, port: nil, max_queue_size: nil, thread_sleep: nil, custom_labels: nil, process_name: nil)
         super(
           host: host || Bigcommerce::Prometheus.server_host,

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

@@ -25,8 +25,11 @@ module Bigcommerce
         ##
         # Start the collector
         #
-        def self.start(*args, &block)
-          process_collector = new(*args, &block)
+        # @param [Hash] args
+        #
+        def self.start(args = {}, &block)
+          args ||= {}
+          process_collector = new(**args, &block)
 
           stop if @thread
 

data/lib/bigcommerce/prometheus/configuration.rb

@@ -42,6 +42,7 @@ module Bigcommerce
         server_port: ENV.fetch('PROMETHEUS_SERVER_PORT', PrometheusExporter::DEFAULT_PORT).to_i,
         server_timeout: ENV.fetch('PROMETHEUS_DEFAULT_TIMEOUT', PrometheusExporter::DEFAULT_TIMEOUT).to_i,
         server_prefix: ENV.fetch('PROMETHEUS_DEFAULT_PREFIX', PrometheusExporter::DEFAULT_PREFIX).to_s,
+        server_thread_pool_size: ENV.fetch('PROMETHEUS_SERVER_THREAD_POOL_SIZE', 3).to_i,
 
         # Custom collector configuration
         collector_collection_frequency: ENV.fetch('PROMETHEUS_DEFAULT_COLLECTOR_COLLECTION_FREQUENCY_SEC', 15).to_i,
@@ -50,7 +51,10 @@ module Bigcommerce
         resque_collectors: [],
         resque_type_collectors: [],
         web_collectors: [],
-        web_type_collectors: []
+        web_type_collectors: [],
+
+        # Additional configuration
+        railtie_disabled: ENV.fetch('PROMETHEUS_DISABLE_RAILTIE', 0).to_i.positive?
       }.freeze
 
       attr_accessor *VALID_CONFIG_KEYS.keys
@@ -76,6 +80,7 @@ module Bigcommerce
         reset unless @configured
         yield self
         @configured = true
+        self
       end
 
       ##
@@ -118,8 +123,8 @@ module Bigcommerce
           self.logger = Application.logger
         else
           require 'logger'
-          self.logger = ::Logger.new(STDOUT)
-          self.logger.level = ::Logger::Severity::INFO
+          self.logger = ::Logger.new($stdout)
+          logger.level = ::Logger::Severity::INFO
         end
       end
 

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

@@ -70,6 +70,8 @@ module Bigcommerce
           ::Resque.before_first_fork do
             ::Bigcommerce::Prometheus::Integrations::Resque.start(client: Bigcommerce::Prometheus.client)
             @collectors.each(&:start)
+          rescue StandardError => e
+            logger.error "[bigcommerce-prometheus][#{@process_name}] Failed to start resque prometheus middleware after fork: #{e.message}"
           end
         end
       end

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

@@ -79,13 +79,15 @@ module Bigcommerce
           @app.config.after_fork_callbacks << lambda do
             ::Bigcommerce::Prometheus::Integrations::Puma.start(client: Bigcommerce::Prometheus.client)
             @collectors.each(&:start)
+          rescue StandardError => e
+            logger.error "[bigcommerce-prometheus][#{@process_name}] Failed to start web prometheus middleware after fork: #{e.message}"
           end
         end
 
         def setup_middleware
           @app.middleware.unshift(PrometheusExporter::Middleware, client: Bigcommerce::Prometheus.client)
         rescue StandardError => e
-          logger.warn "[bc-prometheus-ruby] Failed to attach app middleware in web instrumentor: #{e.message}"
+          logger.warn "[bigcommerce-prometheus] Failed to attach app middleware in web instrumentor: #{e.message}"
         end
       end
     end

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

@@ -23,7 +23,7 @@ module Bigcommerce
       #
       class Railtie < ::Rails::Railtie
         initializer 'zzz.bc_prometheus_ruby.configure_rails_initialization' do |app|
-          Bigcommerce::Prometheus::Instrumentors::Web.new(app: app).start
+          Bigcommerce::Prometheus::Instrumentors::Web.new(app: app).start unless ::Bigcommerce::Prometheus.railtie_disabled
         end
       end
     end

data/lib/bigcommerce/prometheus/server.rb

@@ -26,15 +26,21 @@ module Bigcommerce
       # @param [Integer] port
       # @param [Integer] timeout
       # @param [String] prefix
+      # @param [Integer] thread_pool_size
       #
-      def initialize(host: nil, port: nil, timeout: nil, prefix: nil, logger: nil)
+      def initialize(host: nil, port: nil, timeout: nil, prefix: nil, logger: nil, thread_pool_size: nil)
         @host = host || ::Bigcommerce::Prometheus.server_host
         @port = (port || ::Bigcommerce::Prometheus.server_port).to_i
         @timeout = (timeout || ::Bigcommerce::Prometheus.server_timeout).to_i
         @prefix = (prefix || ::PrometheusExporter::DEFAULT_PREFIX).to_s
         @process_name = ::Bigcommerce::Prometheus.process_name
         @logger = logger || ::Bigcommerce::Prometheus.logger
-        @server = ::Bigcommerce::Prometheus::Servers::Thin::Server.new(port: @port, timeout: @timeout, logger: @logger)
+        @server = ::Bigcommerce::Prometheus::Servers::Thin::Server.new(
+          port: @port,
+          timeout: @timeout,
+          logger: @logger,
+          thread_pool_size: (thread_pool_size || ::Bigcommerce::Prometheus.server_thread_pool_size).to_i
+        )
         @running = false
         ::PrometheusExporter::Metric::Base.default_prefix = @prefix
         setup_signal_handlers
@@ -51,7 +57,7 @@ module Bigcommerce
         end
         @running = true
 
-        @logger.info "[bigcommerce-prometheus][#{@process_name}] Prometheus exporter started on #{@host}:#{@port}"
+        @logger.info "[bigcommerce-prometheus][#{@process_name}] Prometheus exporter started on #{@host}:#{@port} with #{@server.threadpool_size} threads"
 
         @server
       rescue ::StandardError => e
@@ -78,7 +84,7 @@ module Bigcommerce
         @server.stop!
         @run_thread.kill
         @running = false
-        STDOUT.puts "[bigcommerce-prometheus][#{@process_name}] Prometheus exporter cleanly shut down"
+        $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}"
       end

data/lib/bigcommerce/prometheus/servers/thin/controllers/send_metrics_controller.rb

@@ -25,6 +25,7 @@ module Bigcommerce
           #
           class SendMetricsController < BaseController
             class BadMetricsError < StandardError; end
+
             class InvalidRequestError < StandardError; end
 
             ##

data/lib/bigcommerce/prometheus/servers/thin/server.rb

@@ -23,7 +23,7 @@ module Bigcommerce
         # Thin adapter for server
         #
         class Server < ::Thin::Server
-          def initialize(port:, host: nil, timeout: nil, logger: nil)
+          def initialize(port: nil, host: nil, timeout: nil, logger: nil, thread_pool_size: nil)
             @port = port || ::Bigcommerce::Prometheus.server_port
             @host = host || ::Bigcommerce::Prometheus.server_host
             @timeout = timeout || ::Bigcommerce::Prometheus.server_timeout
@@ -31,6 +31,7 @@ module Bigcommerce
             @rack_app = ::Bigcommerce::Prometheus::Servers::Thin::RackApp.new(timeout: timeout, logger: logger)
             super(@host, @port, @rack_app)
             ::Thin::Logging.logger = @logger
+            self.threadpool_size = (thread_pool_size || ::Bigcommerce::Prometheus.server_thread_pool_size).to_i
           end
 
           ##

data/lib/bigcommerce/prometheus/servers/thin/server_metrics.rb

@@ -35,7 +35,7 @@ module Bigcommerce
             @metrics_total = ::PrometheusExporter::Metric::Counter.new('collector_metrics_total', 'Total metrics processed by exporter.')
             @sessions_total = ::PrometheusExporter::Metric::Counter.new('collector_sessions_total', 'Total send_metric sessions processed by exporter.')
             @bad_metrics_total = ::PrometheusExporter::Metric::Counter.new('collector_bad_metrics_total', 'Total mis-handled metrics by collector.')
-            @collector_working_gauge = ::PrometheusExporter::Metric::Gauge.new('collector_working', 'Is the master process collector able to collect metrics')
+            @collector_working_gauge = ::PrometheusExporter::Metric::Gauge.new('collector_working', 'Is the main process collector able to collect metrics')
             @collector_rss_gauge = ::PrometheusExporter::Metric::Gauge.new('collector_rss', 'total memory used by collector process')
           end
 

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

@@ -29,6 +29,7 @@ module Bigcommerce
         # @param [Hash] default_labels
         #
         def initialize(type: nil, default_labels: {})
+          super()
           @type = type || self.class.to_s.downcase.gsub('::', '_').gsub('typecollector', '')
           @default_labels = default_labels || {}
           @metrics = build_metrics

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

@@ -25,6 +25,8 @@ module Bigcommerce
         ##
         # Initialize the collector
         #
+        # @return [Hash]
+        #
         def build_metrics
           {
             workers_total: PrometheusExporter::Metric::Gauge.new('resque_workers_total', 'Number of active workers'),

data/lib/bigcommerce/prometheus/version.rb

@@ -17,6 +17,6 @@
 #
 module Bigcommerce
   module Prometheus
-    VERSION = '0.3.1'
+    VERSION = '0.5.2'
   end
 end

data/lib/bigcommerce/prometheus.rb

@@ -58,6 +58,9 @@ module Bigcommerce
   module Prometheus
     extend Configuration
 
+    ##
+    # @return [Bigcommerce::Prometheus::Client]
+    #
     def self.client
       Client.instance
     end

metadata

@@ -1,113 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: bc-prometheus-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: bundler-audit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: null-logger
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +189,7 @@ homepage: https://github.com/bigcommerce/bc-prometheus-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -218,8 +204,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.2.31
+signing_key: 
 specification_version: 4
 summary: Simple integration of ruby and puma servers with prometheus
 test_files: []