bc-prometheus-ruby 0.2.4 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 777810436bcae4dfe552e0376be8e174b7d751497e4e9fc7b5ada857d606cc50
-  data.tar.gz: 720817317a900dee51a5c8c3e418f3012e1695150326cce6b23d031b5f5922cb
+  metadata.gz: 4a5bc3a1ae57f782c0f94d6cf490830fce96e78ab0f782a4761cad8dcc5850ae
+  data.tar.gz: 694ede704dc83a7c9fd0f1abfd4300bd7e464b464b305833be44c7b06bf62bd5
 SHA512:
-  metadata.gz: 68dce4e18b32c60a9a857050934754bbc659242ad34928414c5a437dd5990d2cc46eca24aa7e7a8f5ec44743856109332a6b65c9deef4e64bc2b6cedfc77ea56
-  data.tar.gz: 84f41b8ab19e3b650e34f09868fa8d9c6f46f355ad96898cab37fe9724d21ee78a77072ca0e944a74d374f04e227a1632e9b46ce68e69a0fc112f2102f4b5212
+  metadata.gz: 20a0ccb53fc272f5f80425503fe492908c6cca2a01186b0489141091239671e848d4930ba29c54ada04c78149ebbda6f2f240880e0da24d2bc7a5b7b98c2b8bc
+  data.tar.gz: ebe5d43de15abe3d933050add69fb785280506bbe6f6acab6065eee215534aeb61bd025eaec545ca9bd682083b7751e01a1569c80daa43313dfaeac72b7d5163

data/CHANGELOG.md

@@ -2,6 +2,34 @@ Changelog for the bc-prometheus-ruby gem.
 
 ### Pending Release
 
+### 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
+
+### 0.3.0
+
+- Support for only Ruby 2.6+ going forward
+- Updated README around custom metrics and collectors
+- Add ability to pass custom resque and hutch Collectors/TypeCollectors
+- Add ENV support for all configuration elements
+- Fix issue where base collector did not use Bigcommerce::Prometheus.client
+- Expose new `push` method for Collectors::Base to ease use of custom ad hoc metrics 
+
 ### 0.2.4
 
 - Fix cant modify frozen array error when using bc-prometheus-ruby outside a web process 

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,138 @@ 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
+
+To create custom metrics and collectors, simply create two files: a collector (the class that runs and collects metrics),
+and the type collector, which runs on the threaded prometheus server and 
+
+### Type Collector
+
+First, create a type collector. Note that the "type" of this will be the full name of the class, with `TypeCollector`
+stripped. This is important later. Our example here will have a "type" of "app".
+
+```ruby
+class AppTypeCollector < ::Bigcommerce::Prometheus::TypeCollectors::Base
+  def build_metrics
+    {
+      honks: PrometheusExporter::Metric::Counter.new('honks', 'Running counter of honks'),
+      points: PrometheusExporter::Metric::Gauge.new('points', 'Current amount of points')
+    }
+  end
+
+  def collect_metrics(data:, labels: {})
+    metric(:points).observe(data.fetch('points', 0))
+    metric(:honks).observe(1, labels) if data.fetch('honks', 0).to_i.positive?
+  end
+end
+```
+
+There are two important methods here: `build_metrics`, which registers the different metrics you want to measure, and
+`collect_metrics`, which actually takes in the metrics and prepares them to be rendered so that Prometheus can scrape
+them.
+
+Note also in the example the different ways of observing Gauges vs Counters. 
+
+### Collector
+
+Next, create a collector. Your "type" of the Collector must match the type collector above, so that bc-prometheus-ruby
+knows how to map the metrics to the right TypeCollector. This is inferred from the class name. Here, it is "app":
+
+```ruby
+class AppCollector < ::Bigcommerce::Prometheus::Collectors::Base
+  def honk!
+    push(
+      honks: 1,
+      custom_labels: {
+        volume: 'loud'
+      }
+    )
+  end
+
+  def collect(metrics)
+    metrics[:points] = rand(1..100)
+    metrics
+  end
+end
+```
+
+There are two types of metrics here: on-demand, and polled. Let's look at the first:
+
+#### On-Demand Metrics
+
+To issue an on-demand metric (usually a counter) that then automatically updates, in your application code, you would
+then run:
+
+```ruby
+app_collector = AppCollector.new
+app_collector.honk!
+```
+
+This will "push" the metrics to our `AppTypeCollector` instance, which will render them as:
+
+```
+# HELP ruby_honks Running counter of honks
+# TYPE ruby_honks counter
+ruby_honks{volume="loud"} 2
+```
+
+As you can see this will respect any custom labels we push in as well.
+
+### Polling Metrics
+
+Using our same AppCollector, if you note the `collect` method: this method will run on a 15 second polled basis
+(the frequency of which is configurable in the initializer of the AppCollector). Here we're just spitting out random
+points, so it'll look something like this:
+
+```
+# HELP ruby_points Current amount of points
+# TYPE ruby_points gauge
+ruby_points 42
+```
+
+### Registering Our Collectors
+
+Each different type of integration will need to have the collectors passed into them, where appropriate. For example,
+if we want these collectors to run on our web, resque, and hutch processes, we'll need to:
+
+```ruby
+::Bigcommerce::Prometheus.configure do |c|
+  c.web_collectors = [AppCollector]
+  c.web_type_collectors = [AppTypeCollector.new]
+  c.resque_collectors = [AppCollector]
+  c.resque_type_collectors = [AppTypeCollector.new]
+  c.hutch_collectors = [AppCollector]
+  c.hutch_type_collectors = [AppTypeCollector.new]
+end
+```
+
+#### Custom Server Integrations
+
+For custom integrations that initialize their own server, you'll need to pass your TypeCollector instance via the 
+`.add_type_collector` method on the prometheus server instance before starting it:
+
+```ruby
+server = ::Bigcommerce::Prometheus::Server.new
+Bigcommerce::Prometheus.web_type_collectors.each do |tc|
+  server.add_type_collector(tc)
+end
+
+# and for polling:
+
+AppCollector.start
+```
 
 ## License
 

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|
@@ -31,17 +31,18 @@ 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 = '>= 2.6'
 
-  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 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.8'
+  spec.add_development_dependency 'rspec_junit_formatter', '>= 0.4'
+  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.4'
+  spec.add_runtime_dependency 'prometheus_exporter', '~> 0.7'
   spec.add_runtime_dependency 'thin', '~> 1.7'
 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

data/lib/bigcommerce/prometheus/client.rb

@@ -24,16 +24,24 @@ module Bigcommerce
       include Singleton
       include Loggable
 
-      def initialize
+      ##
+      # @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: Bigcommerce::Prometheus.server_host,
-          port: Bigcommerce::Prometheus.server_port,
-          max_queue_size: Bigcommerce::Prometheus.client_max_queue_size,
-          thread_sleep: Bigcommerce::Prometheus.client_thread_sleep,
-          custom_labels: Bigcommerce::Prometheus.client_custom_labels
+          host: host || Bigcommerce::Prometheus.server_host,
+          port: port || Bigcommerce::Prometheus.server_port,
+          max_queue_size: max_queue_size || Bigcommerce::Prometheus.client_max_queue_size,
+          thread_sleep: thread_sleep || Bigcommerce::Prometheus.client_thread_sleep,
+          custom_labels: custom_labels || Bigcommerce::Prometheus.client_custom_labels
         )
         PrometheusExporter::Client.default = self
-        @process_name = ::Bigcommerce::Prometheus.process_name
+        @process_name = process_name || ::Bigcommerce::Prometheus.process_name
       end
 
       ##
@@ -55,7 +63,7 @@ module Bigcommerce
 
       ##
       # @param [String] path
-      # @return [URI]
+      # @return [Module<URI>]
       #
       def uri_path(path)
         URI("http://#{@host}:#{@port}#{path}")

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

@@ -25,8 +25,8 @@ module Bigcommerce
         ##
         # Start the collector
         #
-        def self.start(*args, &block)
-          process_collector = new(*args, &block)
+        def self.start(args, &block)
+          process_collector = new(**args, &block)
 
           stop if @thread
 
@@ -49,15 +49,15 @@ module Bigcommerce
         end
 
         ##
-        # @param [PrometheusExporter::Client] client
+        # @param [Bigcommerce::Prometheus::Client] client
         # @param [String] type
         # @param [Integer] frequency
         # @param [Hash] options
         #
         def initialize(client: nil, type: nil, frequency: nil, options: nil)
-          @client = client || PrometheusExporter::Client.default
+          @client = client || Bigcommerce::Prometheus.client
           @type = type || self.class.to_s.downcase.gsub('::', '_').gsub('collector', '')
-          @frequency = frequency || 15
+          @frequency = frequency || Bigcommerce::Prometheus.collector_collection_frequency
           @options = options || {}
           @logger = Bigcommerce::Prometheus.logger
         end
@@ -66,12 +66,9 @@ module Bigcommerce
         # Run the collector and send stats
         #
         def run
-          metrics = { type: @type }
+          metrics = {}
           metrics = collect(metrics)
-          @logger.debug "[bigcommerce-prometheus] Pushing #{@type} metrics to type collector: #{metrics.inspect}"
-          @client.send_json(metrics)
-        rescue StandardError => e
-          @logger.error("Prometheus Exporter Failed To Collect #{@type} Stats #{e}")
+          push(metrics)
         ensure
           sleep @frequency
         end
@@ -85,6 +82,19 @@ module Bigcommerce
         def collect(metrics = {})
           metrics
         end
+
+        private
+
+        ##
+        # @param [Hash] metric
+        #
+        def push(metric)
+          metric[:type] = @type unless metric.key?(:type)
+          @logger.debug("[bigcommerce-prometheus] Pushing #{metric[:type]} metrics to type collector: #{metric.inspect}")
+          @client.send_json(metric)
+        rescue StandardError => e
+          @logger.error("[bigcommerce-prometheus] Prometheus Exporter failed to send #{metric[:type]} stats to type collector #{e}")
+        end
       end
     end
   end

data/lib/bigcommerce/prometheus/configuration.rb

@@ -23,20 +23,38 @@ module Bigcommerce
     module Configuration
       VALID_CONFIG_KEYS = {
         logger: nil,
+        enabled: ENV.fetch('PROMETHEUS_ENABLED', 1).to_i.positive?,
+
+        # Client configuration
         client_custom_labels: nil,
-        client_max_queue_size: 10_000,
-        client_thread_sleep: 0.5,
-        enabled: true,
-        puma_collection_frequency: 30,
-        puma_process_label: 'web',
-        resque_collection_frequency: 30,
-        resque_process_label: 'resque',
-        server_host: '0.0.0.0',
-        server_port: PrometheusExporter::DEFAULT_PORT,
-        server_timeout: PrometheusExporter::DEFAULT_TIMEOUT,
-        server_prefix: PrometheusExporter::DEFAULT_PREFIX,
+        client_max_queue_size: ENV.fetch('PROMETHEUS_CLIENT_MAX_QUEUE_SIZE', 10_000).to_i,
+        client_thread_sleep: ENV.fetch('PROMETHEUS_CLIENT_THREAD_SLEEP', 0.5).to_f,
+
+        # Integration configuration
+        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,
+
+        # 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,
+        server_host: ENV.fetch('PROMETHEUS_SERVER_HOST', '0.0.0.0').to_s,
+        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,
+        hutch_collectors: [],
+        hutch_type_collectors: [],
+        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
@@ -62,6 +80,7 @@ module Bigcommerce
         reset unless @configured
         yield self
         @configured = true
+        self
       end
 
       ##
@@ -85,12 +104,7 @@ module Bigcommerce
           send("#{k}=".to_sym, v)
         end
         determine_logger
-        self.enabled = ENV.fetch('PROMETHEUS_ENABLED', 1).to_i.positive?
-        self.server_host = ENV.fetch('PROMETHEUS_SERVER_HOST', '0.0.0.0').to_s
-        self.server_port = ENV.fetch('PROMETHEUS_SERVER_PORT', PrometheusExporter::DEFAULT_PORT).to_i
 
-        self.puma_process_label = ENV.fetch('PROMETHEUS_PUMA_PROCESS_LABEL', 'web').to_s
-        self.puma_collection_frequency = ENV.fetch('PROMETHEUS_PUMA_COLLECTION_FREQUENCY', 30).to_i
         self.web_type_collectors = []
       end
 
@@ -109,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/hutch.rb

@@ -31,6 +31,8 @@ module Bigcommerce
           @server_port = Bigcommerce::Prometheus.server_port
           @server_timeout = Bigcommerce::Prometheus.server_timeout
           @server_prefix = Bigcommerce::Prometheus.server_prefix
+          @collectors = Bigcommerce::Prometheus.hutch_collectors || []
+          @type_collectors = Bigcommerce::Prometheus.hutch_type_collectors || []
         end
 
         ##
@@ -44,6 +46,9 @@ module Bigcommerce
 
           server.add_type_collector(PrometheusExporter::Server::ActiveRecordCollector.new)
           server.add_type_collector(PrometheusExporter::Server::HutchCollector.new)
+          @type_collectors.each do |tc|
+            server.add_type_collector(tc)
+          end
           server.start
           setup_middleware
         rescue StandardError => e
@@ -65,6 +70,9 @@ module Bigcommerce
           require 'hutch'
           ::Hutch::Config.set(:tracer, PrometheusExporter::Instrumentation::Hutch)
           @app.middleware.unshift(PrometheusExporter::Middleware, client: Bigcommerce::Prometheus.client)
+          @collectors.each(&:start)
+        rescue StandardError => e
+          logger.warn "[bigcommerce-prometheus][#{@process_name}] Failed to setup hutch prometheus middleware: #{e.message}"
         end
       end
     end

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

@@ -31,6 +31,8 @@ module Bigcommerce
           @server_port = Bigcommerce::Prometheus.server_port
           @server_timeout = Bigcommerce::Prometheus.server_timeout
           @server_prefix = Bigcommerce::Prometheus.server_prefix
+          @collectors = Bigcommerce::Prometheus.resque_collectors || []
+          @type_collectors = Bigcommerce::Prometheus.resque_type_collectors || []
         end
 
         ##
@@ -44,6 +46,9 @@ module Bigcommerce
 
           server.add_type_collector(PrometheusExporter::Server::ActiveRecordCollector.new)
           server.add_type_collector(Bigcommerce::Prometheus::TypeCollectors::Resque.new)
+          @type_collectors.each do |tc|
+            server.add_type_collector(tc)
+          end
           server.start
           setup_middleware
         rescue StandardError => e
@@ -63,7 +68,8 @@ module Bigcommerce
         def setup_middleware
           logger.info "[bigcommerce-prometheus][#{@process_name}] Setting up resque prometheus middleware"
           ::Resque.before_first_fork do
-            ::Bigcommerce::Prometheus::Integrations::Resque.start
+            ::Bigcommerce::Prometheus::Integrations::Resque.start(client: Bigcommerce::Prometheus.client)
+            @collectors.each(&:start)
           end
         end
       end

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

@@ -77,7 +77,7 @@ module Bigcommerce
         def setup_after_fork
           @app.config.after_fork_callbacks = [] unless @app.config.after_fork_callbacks
           @app.config.after_fork_callbacks << lambda do
-            ::Bigcommerce::Prometheus::Integrations::Puma.start
+            ::Bigcommerce::Prometheus::Integrations::Puma.start(client: Bigcommerce::Prometheus.client)
             @collectors.each(&:start)
           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/integrations/resque.rb

@@ -25,13 +25,13 @@ module Bigcommerce
         ##
         # Start the resque integration
         #
-        def self.start
+        def self.start(client: nil)
           ::PrometheusExporter::Instrumentation::Process.start(
-            client: ::Bigcommerce::Prometheus.client,
+            client: client || ::Bigcommerce::Prometheus.client,
             type: ::Bigcommerce::Prometheus.resque_process_label
           )
           ::Bigcommerce::Prometheus::Collectors::Resque.start(
-            client: ::Bigcommerce::Prometheus.client,
+            client: client || ::Bigcommerce::Prometheus.client,
             frequency: ::Bigcommerce::Prometheus.resque_collection_frequency
           )
         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/not_found_controller.rb

@@ -26,7 +26,7 @@ module Bigcommerce
           class NotFoundController < BaseController
             def call
               @response.status = 404
-              @response.body << 'Not Found! The Prometheus Ruby Exporter only listens on /metrics and /send-metrics'
+              @response.body << Bigcommerce::Prometheus.not_found_body
             end
           end
         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,14 +23,15 @@ module Bigcommerce
         # Thin adapter for server
         #
         class Server < ::Thin::Server
-          def initialize(port:, host: nil, timeout: nil, logger: nil)
-            @port = port || ::PrometheusExporter::DEFAULT_PORT
-            @host = host || '0.0.0.0'
-            @timeout = timeout || ::PrometheusExporter::DEFAULT_TIMEOUT
+          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
             @logger = logger || ::Bigcommerce::Prometheus.logger
             @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.2.4'
+    VERSION = '0.5.1'
   end
 end

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: bc-prometheus-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.5.1
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: null-logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.1'
 - !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 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +203,7 @@ homepage: https://github.com/bigcommerce/bc-prometheus-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -211,15 +211,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Simple integration of ruby and puma servers with prometheus
 test_files: []