gruf-prometheus 1.0.1 → 2.0.0

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,11 @@ module Gruf
       VALID_CONFIG_KEYS = {
         process_label: 'grpc',
         process_name: 'grpc',
-        collection_frequency: 30
+        collection_frequency: 30,
+        type_collectors: [],
+        collectors: [],
+        client_measure_latency: false,
+        server_measure_latency: false
       }.freeze
 
       attr_accessor *VALID_CONFIG_KEYS.keys
@@ -39,13 +43,14 @@ module Gruf
       ##
       # Yield self for ruby-style initialization
       #
-      # @yields [Bigcommerce::Prometheus::Configuration]
-      # @return [Bigcommerce::Prometheus::Configuration]
+      # @yields [Gruf::Prometheus::Configuration]
+      # @return [Gruf::Prometheus::Configuration]
       #
       def configure
         reset unless @configured
         yield self
         @configured = true
+        self
       end
 
       ##
@@ -71,6 +76,8 @@ module Gruf
         self.process_label = ENV.fetch('PROMETHEUS_PROCESS_LABEL', 'grpc').to_s
         self.process_name = ENV.fetch('PROMETHEUS_PROCESS_NAME', 'grpc').to_s
         self.collection_frequency = ENV.fetch('PROMETHEUS_COLLECTION_FREQUENCY', 30).to_i
+        self.server_measure_latency = ENV.fetch('PROMETHEUS_SERVER_MEASURE_LATENCY', 0).to_i.positive?
+        self.client_measure_latency = ENV.fetch('PROMETHEUS_CLIENT_MEASURE_LATENCY', 0).to_i.positive?
       end
 
       ##

data/lib/gruf/prometheus/hook.rb

@@ -28,8 +28,13 @@ 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(::Gruf::Prometheus::Server::TypeCollector.new)
+        prometheus_server.add_type_collector(::Gruf::Prometheus::Client::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 +63,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,11 +81,11 @@ module Gruf
       #
       def stop_collectors
         ::PrometheusExporter::Instrumentation::Process.stop
-        ::Gruf::Prometheus::Collectors::Grpc.stop
+        ::Gruf::Prometheus::Collector.stop
       end
 
       ##
-      # @return [Gruf::Prometheus::Server]
+      # @return [Bigcommerce::Prometheus::Server]
       #
       def prometheus_server
         @prometheus_server ||= ::Bigcommerce::Prometheus::Server.new(
@@ -85,6 +96,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/request_types.rb

@@ -0,0 +1,27 @@
+# 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 RequestTypes
+      UNARY = 'UNARY'
+      CLIENT_STREAM = 'CLIENT_STREAM'
+      SERVER_STREAM = 'SERVER_STREAM'
+      BIDI_STREAM = 'BIDI_STREAM'
+    end
+  end
+end

data/lib/gruf/prometheus/server/collector.rb

@@ -0,0 +1,122 @@
+# 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 Server
+      ##
+      # Prometheus instrumentor for gRPC servers
+      #
+      class Collector < Bigcommerce::Prometheus::Collectors::Base
+        RESPONSE_CODE_OK = 'OK'
+
+        ##
+        # @param [Gruf::Controller::Request] request
+        #
+        def started_total(request:)
+          push(
+            grpc_server_started_total: 1,
+            custom_labels: custom_labels(request: request)
+          )
+        end
+
+        ##
+        # @param [Gruf::Controller::Request] request
+        # @param [Gruf::Interceptors::Timer::Result] result:party
+        #
+        def handled_total(request:, result:)
+          push(
+            grpc_server_handled_total: 1,
+            custom_labels: custom_labels(request: request, result: result)
+          )
+        end
+
+        ##
+        # @param [Gruf::Controller::Request] request
+        # @param [Gruf::Interceptors::Timer::Result] result
+        #
+        def handled_latency_seconds(request:, result:)
+          push(
+            grpc_server_handled_latency_seconds: result.elapsed.to_f,
+            custom_labels: custom_labels(request: request, result: result)
+          )
+        end
+
+        private
+
+        ##
+        # @param [Gruf::Controller::Request] request
+        # @param [Gruf::Interceptors::Timer::Result|NilClass] result
+        # @return [Hash]
+        #
+        def custom_labels(request:, result: nil)
+          labels = {
+            grpc_service: format_grpc_service_name(request.service.name.to_s),
+            grpc_method: format_grpc_method_name(request.method_key.to_s),
+            grpc_type: determine_type(request)
+          }
+          if result
+            labels[:grpc_code] = result.successful? ? RESPONSE_CODE_OK : result.message_class_name.split('::').last
+          end
+          labels
+        end
+
+        ##
+        # Format the service name as `path.to.Service` (from Path::To::Service)
+        #
+        # @param [String] name
+        # @return [String]
+        #
+        def format_grpc_service_name(name)
+          parts = name.split('::')
+          return '' unless parts.any?
+
+          svc = parts.pop.to_s
+          parts.map!(&:downcase)
+          parts << svc
+          parts.join('.')
+        end
+
+        ##
+        # Format the method name as `MethodName` (from method_name)
+        #
+        # @param [String] name
+        # @return [String]
+        #
+        def format_grpc_method_name(name)
+          name.split('_').map(&:capitalize).join
+        end
+
+        ##
+        # @param [Gruf::Controller::Request] request
+        # @return [String]
+        #
+        def determine_type(request)
+          if request.client_streamer?
+            Gruf::Prometheus::RequestTypes::CLIENT_STREAM
+          elsif request.server_streamer?
+            Gruf::Prometheus::RequestTypes::SERVER_STREAM
+          elsif request.bidi_streamer?
+            Gruf::Prometheus::RequestTypes::BIDI_STREAM
+          else
+            Gruf::Prometheus::RequestTypes::UNARY
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gruf/prometheus/server/interceptor.rb

@@ -0,0 +1,72 @@
+# 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 Server
+      ##
+      # Server interceptor for measuring counter/timers for gRPC inbound requests
+      #
+      class Interceptor < ::Gruf::Interceptors::ServerInterceptor
+        ##
+        # Intercept the call and send metrics
+        #
+        def call(&block)
+          result = ::Gruf::Interceptors::Timer.time(&block)
+
+          send_metrics(result)
+
+          raise result.message unless result.successful?
+
+          result.message
+        end
+
+        private
+
+        ##
+        # @param [Gruf::Interceptors::Timer::Result] result
+        #
+        def send_metrics(result)
+          prometheus_collector.started_total(request: request)
+          prometheus_collector.handled_total(request: request, result: result)
+          prometheus_collector.handled_latency_seconds(request: request, result: result) if measure_latency?
+        rescue StandardError => e
+          # we don't want this to affect actual RPC execution, so just log an error and move on
+          Gruf.logger.error "Failed registering metric to prometheus type collector: #{e.message} - #{e.class.name}"
+        end
+
+        ##
+        # @return [::Gruf::Prometheus::Server::Collector]
+        #
+        def prometheus_collector
+          @prometheus_collector ||= ::Gruf::Prometheus::Server::Collector.new(type: 'grpc_server')
+        end
+
+        ##
+        # @return [Boolean]
+        #
+        def measure_latency?
+          unless @measure_latency
+            v = @options.fetch(:measure_latency, ::Gruf::Prometheus.server_measure_latency)
+            @measure_latency = v.nil? ? false : v
+          end
+          @measure_latency
+        end
+      end
+    end
+  end
+end

data/lib/gruf/prometheus/server/type_collector.rb

@@ -0,0 +1,61 @@
+# 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 Server
+      ##
+      # Type Collector for grpc server metrics
+      #
+      class TypeCollector < Bigcommerce::Prometheus::TypeCollectors::Base
+        def type
+          'grpc_server'
+        end
+
+        private
+
+        ##
+        # Initialize the collector
+        #
+        def build_metrics
+          metrics = {
+            grpc_server_started_total: PrometheusExporter::Metric::Counter.new('grpc_server_started_total', 'Total number of RPCs started on the server'),
+            grpc_server_handled_total: PrometheusExporter::Metric::Counter.new('grpc_server_handled_total', 'Total number of RPCs completed on the server, regardless of success or failure')
+          }
+          metrics[:grpc_server_handled_latency_seconds] = PrometheusExporter::Metric::Histogram.new('grpc_server_handled_latency_seconds', 'Histogram of response latency of RPCs handled by the server, in seconds') if measure_latency?
+          metrics
+        end
+
+        ##
+        # Collect the object into the buffer
+        #
+        def collect_metrics(data: {}, labels: {})
+          metric(:grpc_server_started_total)&.observe(data['grpc_server_started_total'].to_i, labels)
+          metric(:grpc_server_handled_total)&.observe(data['grpc_server_handled_total'].to_i, labels)
+          metric(:grpc_server_handled_latency_seconds)&.observe(data['grpc_server_handled_latency_seconds'].to_f, labels) if measure_latency?
+        end
+
+        ##
+        # @return [Boolean]
+        #
+        def measure_latency?
+          @measure_latency ||= ::Gruf::Prometheus.server_measure_latency
+        end
+      end
+    end
+  end
+end