gruf-prometheus 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c3aed24d2b55ffbf676b7a27acab6fdcdff134856f294ae1c7b5ffd3f6c39c9
-  data.tar.gz: d6221023c0bdbe602c00e46433aea36b746bcb5d37f107df92809f0590a6e61e
+  metadata.gz: 9125b43ec8d517f1bf324d3d3400f182638f95d74aff3c15aaebdd165ac373da
+  data.tar.gz: 25a42e807dd8271ee51b1bf034bdffd604d942a2e4ce431942d7b5442a9aa641
 SHA512:
-  metadata.gz: f3df08b6a3032a196bf88999ca838f4a2bc6042913eaa0534ecdc72077ebfc7a0981878b98fcc1cafa847a4b4ba381eb890ad7dc7a2791d96da1dc4f85aefe45
-  data.tar.gz: d4df8e1ccd75da130d23bd894e6a088005fa7c7c90958b64fca22d486158d92d58df1f0848d2f43fa3fb1aa75c9b98c13dc8f9fdf8c013001335bd4a3471ee84
+  metadata.gz: 208c6b8581538e752a792e27677dc28ce6da9169805d823a890848f636588556d526a6bbb0879beda0605133cde09b090226f3f2da85c81867753a090fe2f852
+  data.tar.gz: 16278ab75bb295ed885aec4f4d641fc4841db3ecb63782b5bc608db22fe56f7ede66d6ecea3f564ec730b563499053129d73c346531dd0fc2ff70a4716a0a7d4

data/CHANGELOG.md

@@ -2,6 +2,30 @@ Changelog for the gruf-prometheus gem.
 
 ### Pending Release
 
+### 1.3.0
+
+- Drop Ruby < 2.6 support
+- Bump bc-prometheus-ruby dependency to 0.3
+- Adds support for Ruby 2.7
+- Adds help script for testing locally
+
+### 1.2.0
+
+- Add the ability to have custom collectors and type collectors
+
+### 1.1.0
+
+- Refactor collector/type collector to utilize new base abstractions
+- Bump bc-prometheus-ruby dependency
+
+### 1.0.2
+
+- Bump bc-prometheus-ruby dependency
+
+### 1.0.1
+
+- Bump bc-prometheus-ruby dependency
+
 ### 1.0.0
 
 - *Breaking Changes* Move all prometheus core dependencies to bc-prometheus-ruby  

data/README.md

@@ -33,6 +33,8 @@ You can further configure via bc-prometheus-ruby with:
 | process_label | The label to use for metric prefixing | grpc |
 | process_name | Label to use for process name in logging | grpc | 	
 | collection_frequency | The period in seconds in which to collect metrics | 30 |
+| collectors | Any collectors you would like to start with the server. Passed as a hash of collector class => options | {} |
+| type_collectors | Any type collectors you would like to start with the server. Passed as an array of collector objects | [] |
         
 ## License
 

data/gruf-prometheus.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-prometheus.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'
@@ -42,5 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '>= 0.12'
 
   spec.add_runtime_dependency 'gruf', '>= 2.7'
-  spec.add_runtime_dependency 'bc-prometheus-ruby', '~> 0.1.3'
+  spec.add_runtime_dependency 'bc-prometheus-ruby', '~> 0.3'
 end

data/lib/gruf/prometheus.rb

@@ -27,8 +27,8 @@ require 'bigcommerce/prometheus'
 
 require_relative 'prometheus/version'
 require_relative 'prometheus/configuration'
-require_relative 'prometheus/collectors/grpc'
-require_relative 'prometheus/type_collectors/grpc'
+require_relative 'prometheus/collector'
+require_relative 'prometheus/type_collector'
 require_relative 'prometheus/hook'
 
 module Gruf

data/lib/gruf/prometheus/collector.rb

@@ -0,0 +1,56 @@
+# 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 Gruf
+  module Prometheus
+    ##
+    # Prometheus instrumentor for gRPC servers
+    #
+    class Collector < Bigcommerce::Prometheus::Collectors::Base
+      def collect(metrics = {})
+        metrics[:type] = 'grpc'
+        rpc_server = grpc_server
+        return metrics unless rpc_server
+
+        rpc_server.instance_variable_get(:@run_mutex).synchronize do
+          collect_server_metrics(rpc_server, metrics)
+        end
+        metrics
+      end
+
+      ##
+      # @param [GRPC::RpcServer] rpc_server
+      # @param [Hash] metrics
+      #
+      def collect_server_metrics(rpc_server, metrics)
+        pool = rpc_server.instance_variable_get(:@pool)
+        metrics[:pool_jobs_waiting_total] = pool.jobs_waiting.to_i
+        metrics[:pool_ready_workers_total] = pool.instance_variable_get(:@ready_workers).size
+        metrics[:pool_workers_total] = pool.instance_variable_get(:@workers)&.size
+        metrics[:pool_initial_size] = rpc_server.instance_variable_get(:@pool_size).to_i
+        metrics[:poll_period] = rpc_server.instance_variable_get(:@poll_period).to_i
+      end
+
+      ##
+      # @return [GRPC::RpcServer]
+      #
+      def grpc_server
+        @options.fetch(:server, nil)&.server
+      end
+    end
+  end
+end

data/lib/gruf/prometheus/configuration.rb

@@ -24,7 +24,9 @@ module Gruf
       VALID_CONFIG_KEYS = {
         process_label: 'grpc',
         process_name: 'grpc',
-        collection_frequency: 30
+        collection_frequency: 30,
+        type_collectors: [],
+        collectors: []
       }.freeze
 
       attr_accessor *VALID_CONFIG_KEYS.keys

data/lib/gruf/prometheus/hook.rb

@@ -28,8 +28,11 @@ module Gruf
       #
       def before_server_start(server:)
         logger.info "[gruf-prometheus][#{::Gruf::Prometheus.process_name}] Starting #{server.class}"
-        prometheus_server.add_type_collector(::Gruf::Prometheus::TypeCollectors::Grpc.new)
+        prometheus_server.add_type_collector(::Gruf::Prometheus::TypeCollector.new)
         prometheus_server.add_type_collector(::PrometheusExporter::Server::ActiveRecordCollector.new)
+        custom_type_collectors.each do |tc|
+          prometheus_server.add_type_collector(tc)
+        end
         prometheus_server.start
         sleep 2 unless ENV['RACK_ENV'] == 'test' # wait for server to come online
         start_collectors(server: server)
@@ -58,11 +61,17 @@ module Gruf
           client: ::Bigcommerce::Prometheus.client,
           frequency: ::Gruf::Prometheus.collection_frequency
         )
-        ::Gruf::Prometheus::Collectors::Grpc.start(
-          server: server,
+        ::Gruf::Prometheus::Collector.start(
+          options: {
+            server: server
+          },
+          type: 'grpc',
           client: ::Bigcommerce::Prometheus.client,
           frequency: ::Gruf::Prometheus.collection_frequency
         )
+        custom_collectors.each do |collector, arguments|
+          collector.start(arguments)
+        end
       end
 
       ##
@@ -70,7 +79,7 @@ module Gruf
       #
       def stop_collectors
         ::PrometheusExporter::Instrumentation::Process.stop
-        ::Gruf::Prometheus::Collectors::Grpc.stop
+        ::Gruf::Prometheus::Collector.stop
       end
 
       ##
@@ -85,6 +94,20 @@ module Gruf
           logger: logger
         )
       end
+
+      ##
+      # @return [Array<Bigcommerce::Prometheus::TypeCollectors::Base>]
+      #
+      def custom_type_collectors
+        @options.fetch(:type_collectors, [])
+      end
+
+      ##
+      # @return [Array<Bigcommerce::Prometheus::Collectors::Base>]
+      #
+      def custom_collectors
+        @options.fetch(:collectors, [])
+      end
     end
   end
 end

data/lib/gruf/prometheus/type_collector.rb

@@ -0,0 +1,57 @@
+# 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 Gruf
+  module Prometheus
+    ##
+    # Type Collector for prometheus and grpc instrumentation
+    #
+    class TypeCollector < Bigcommerce::Prometheus::TypeCollectors::Base
+      def type
+        'grpc'
+      end
+
+      private
+
+      ##
+      # Initialize the collector
+      #
+      def build_metrics
+        {
+          pool_jobs_waiting_total: PrometheusExporter::Metric::Gauge.new('grpc_pool_jobs_waiting_total', 'Number jobs in the gRPC thread pool that are actively waiting'),
+          pool_ready_workers_total: PrometheusExporter::Metric::Gauge.new('grpc_pool_ready_workers_total', 'The amount of non-busy workers in the thread pool'),
+          pool_workers_total: PrometheusExporter::Metric::Gauge.new('grpc_pool_workers_total', 'Number of workers in the gRPC thread pool'),
+          pool_initial_size: PrometheusExporter::Metric::Gauge.new('grpc_pool_initial_size', 'Initial size of the gRPC thread pool'),
+          poll_period: PrometheusExporter::Metric::Gauge.new('grpc_poll_period', 'Polling period for the gRPC thread pool'),
+          thread_pool_exhausted: PrometheusExporter::Metric::Counter.new('grpc_thread_pool_exhausted', 'Times the gRPC thread pool has been exhausted')
+        }
+      end
+
+      ##
+      # Collect the object into the buffer
+      #
+      def collect_metrics(data: {}, labels: {})
+        metric(:pool_jobs_waiting_total)&.observe(data['pool_jobs_waiting_total'].to_i, labels)
+        metric(:pool_ready_workers_total)&.observe(data['pool_ready_workers_total'].to_i, labels)
+        metric(:pool_workers_total)&.observe(data['pool_workers_total'].to_i, labels)
+        metric(:pool_initial_size)&.observe(data['pool_initial_size'].to_i, labels)
+        metric(:poll_period)&.observe(data['poll_period'].to_i, labels)
+        metric(:thread_pool_exhausted)&.observe(data['thread_pool_exhausted'].to_i, labels)
+      end
+    end
+  end
+end

data/lib/gruf/prometheus/version.rb

@@ -17,6 +17,6 @@
 #
 module Gruf
   module Prometheus
-    VERSION = '1.0.0'
+    VERSION = '1.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf-prometheus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '0.3'
 description: Prometheus support for gruf
 email:
 - shaun.mccormick@bigcommerce.com
@@ -162,16 +162,16 @@ files:
 - README.md
 - gruf-prometheus.gemspec
 - lib/gruf/prometheus.rb
-- lib/gruf/prometheus/collectors/grpc.rb
+- lib/gruf/prometheus/collector.rb
 - lib/gruf/prometheus/configuration.rb
 - lib/gruf/prometheus/hook.rb
-- lib/gruf/prometheus/type_collectors/grpc.rb
+- lib/gruf/prometheus/type_collector.rb
 - lib/gruf/prometheus/version.rb
 homepage: https://github.com/bigcommerce/gruf-prometheus
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,7 +179,7 @@ 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:
   - - ">="
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Prometheus support for gruf
 test_files: []

data/lib/gruf/prometheus/collectors/grpc.rb

@@ -1,111 +0,0 @@
-# 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 Gruf
-  module Prometheus
-    module Collectors
-      ##
-      # Prometheus instrumentor for gRPC servers
-      #
-      class Grpc
-        include Gruf::Loggable
-
-        ##
-        # @param [Gruf::Server] server
-        # @param [Gruf::Prometheus::Client] client
-        # @param [Integer] frequency
-        #
-        def initialize(server:, client:, frequency: nil)
-          @server = server
-          @client = client
-          @frequency = frequency || 15
-        end
-
-        ##
-        # Start the collector
-        #
-        # @param [Gruf::Server] server
-        # @param [Gruf::Prometheus::Client] client
-        # @param [Integer] frequency
-        #
-        def self.start(server:, client: nil, frequency: nil)
-          stop if @thread
-
-          client ||= Bigcommerce::Prometheus::Client.instance
-          collector = new(server: server, client: client, frequency: frequency)
-          @thread = Thread.new do
-            loop do
-              collector.run
-            end
-          end
-        end
-
-        ##
-        # Stop the collector
-        #
-        def self.stop
-          t = @thread
-          return unless t
-
-          t.kill
-          @thread = nil
-        end
-
-        def run
-          metric = collect
-          logger.debug "[gruf-prometheus] Pushing gruf metrics to type collector: #{metric.inspect}"
-          @client.send_json metric
-        rescue StandardError => e
-          logger.error "[gruf-prometheus] Failed to collect gruf-prometheus stats: #{e.message}"
-        ensure
-          sleep @frequency
-        end
-
-        private
-
-        def collect
-          metric = {}
-          metric[:type] = 'grpc'
-          rpc_server = @server.server
-          rpc_server.instance_variable_get(:@run_mutex).synchronize do
-            collect_server_metrics(rpc_server, metric)
-          end
-          metric
-        end
-
-        ##
-        # @param [GRPC::RpcServer] rpc_server
-        #
-        def collect_server_metrics(rpc_server, metric)
-          pool = rpc_server.instance_variable_get(:@pool)
-          metric[:pool_jobs_waiting_total] = pool.jobs_waiting.to_i
-          metric[:pool_ready_workers_total] = pool.instance_variable_get(:@ready_workers).size
-          metric[:pool_workers_total] = pool.instance_variable_get(:@workers)&.size
-          metric[:pool_initial_size] = rpc_server.instance_variable_get(:@pool_size).to_i
-          metric[:poll_period] = rpc_server.instance_variable_get(:@poll_period).to_i
-        end
-
-        ##
-        # @return [GRPC::RpcServer]
-        #
-        def grpc_server
-          @server.server
-        end
-      end
-    end
-  end
-end

data/lib/gruf/prometheus/type_collectors/grpc.rb

@@ -1,80 +0,0 @@
-# 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 Gruf
-  module Prometheus
-    module TypeCollectors
-      ##
-      # Type Collector for prometheus and grpc instrumentation
-      #
-      class Grpc < PrometheusExporter::Server::TypeCollector
-        ##
-        # Initialize the collector
-        #
-        def initialize
-          @pool_jobs_waiting_total = PrometheusExporter::Metric::Gauge.new('grpc_pool_jobs_waiting_total', 'Number jobs in the gRPC thread pool that are actively waiting')
-          @pool_ready_workers_total = PrometheusExporter::Metric::Gauge.new('grpc_pool_ready_workers_total', 'The amount of non-busy workers in the thread pool')
-          @pool_workers_total = PrometheusExporter::Metric::Gauge.new('grpc_pool_workers_total', 'Number of workers in the gRPC thread pool')
-          @pool_initial_size = PrometheusExporter::Metric::Gauge.new('grpc_pool_initial_size', 'Initial size of the gRPC thread pool')
-          @poll_period = PrometheusExporter::Metric::Gauge.new('grpc_poll_period', 'Polling period for the gRPC thread pool')
-          @thread_pool_exhausted = PrometheusExporter::Metric::Counter.new('grpc_thread_pool_exhausted', 'Times the gRPC thread pool has been exhausted')
-        end
-
-        ##
-        # @return [String]
-        #
-        def type
-          'grpc'
-        end
-
-        ##
-        # @return [Array]
-        #
-        def metrics
-          return [] unless @pool_jobs_waiting_total
-
-          [
-            @pool_jobs_waiting_total,
-            @pool_ready_workers_total,
-            @pool_workers_total,
-            @pool_initial_size,
-            @poll_period,
-            @thread_pool_exhausted
-          ]
-        end
-
-        ##
-        # Collect the object into the buffer
-        #
-        def collect(obj)
-          default_labels = {}
-          default_labels['environment'] = obj['environment'] if obj['environment']
-
-          custom_labels = obj['custom_labels'] || {}
-          labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
-
-          @pool_jobs_waiting_total.observe(obj['pool_jobs_waiting_total'].to_i, labels)
-          @pool_ready_workers_total.observe(obj['pool_ready_workers_total'].to_i, labels)
-          @pool_workers_total.observe(obj['pool_workers_total'].to_i, labels)
-          @pool_initial_size.observe(obj['pool_initial_size'].to_i, labels)
-          @poll_period.observe(obj['poll_period'].to_i, labels)
-          @thread_pool_exhausted.observe(obj['thread_pool_exhausted'].to_i, labels)
-        end
-      end
-    end
-  end
-end