gruf-prometheus 1.0.2 → 2.1.0

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.2'
+    VERSION = '2.1.0'
   end
 end

metadata

@@ -1,155 +1,183 @@
 --- !ruby/object:Gem::Specification
 name: gruf-prometheus
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bc-prometheus-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: 0.5.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: gruf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
+        version: '2.7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: bundler-audit
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.68'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.68'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: null-logger
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: gruf
+  name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
+        version: '0.5'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: bc-prometheus-ruby
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
-  type: :runtime
+        version: '1.8'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.19'
 description: Prometheus support for gruf
 email:
 - shaun.mccormick@bigcommerce.com
@@ -162,16 +190,23 @@ files:
 - README.md
 - gruf-prometheus.gemspec
 - lib/gruf/prometheus.rb
-- lib/gruf/prometheus/collectors/grpc.rb
+- lib/gruf/prometheus/client/collector.rb
+- lib/gruf/prometheus/client/interceptor.rb
+- lib/gruf/prometheus/client/type_collector.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/request_types.rb
+- lib/gruf/prometheus/server/collector.rb
+- lib/gruf/prometheus/server/interceptor.rb
+- lib/gruf/prometheus/server/type_collector.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,15 +214,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
 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: 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