gruf-prometheus 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4d188e003e056aad2639d57d67d87455f6ee1e579191337a94f8d8234f630c0
-  data.tar.gz: 92ebeb27934e4d4966663a70e2c6d4f32ac35571958f582fae1d332d0c390a12
+  metadata.gz: cd4a02507521f0e59c1242e42396a2ce66a33c1d6152268c1479239abed3f00b
+  data.tar.gz: 01b68639aa687e63d9fd525c69fe968100e00c7d75fcf61d7a0f21d0e47247d9
 SHA512:
-  metadata.gz: 9c2973b859cffa4a72ef328fec5013c4977a28a21eef80098f9abe010b7c2766f771e924ce52342def4a917088cfe686ddc622aa26224cf832b0245718ea152a
-  data.tar.gz: 339f3d05134b151167c7af0f59685a669ac5d967d950ddd4e12129712e942664328c518795aaa482d5873377cd5267ddf74e4ae47d9becf75ad418c3502977f0
+  metadata.gz: 99ba9ca706e42f165d08464d94ba92fc3c7450f68e91062b7717d66124c0f8108d6aaa3d119d1193ae68aeb2898a6d7b1266576919e757fe799d5f7e8f64b191
+  data.tar.gz: 8a05f7a59227f5ac0f428cd4b8e4d4fc384363337f5e7d93db2326c56be2de4effb6493c5f1e42ad6b35793bbb9a99e6098a86382723936909e1c908052aaebf

data/CHANGELOG.md

@@ -2,6 +2,11 @@ Changelog for the gruf-prometheus gem.
 
 ### Pending Release
 
+### 2.3.0
+
+- Add server collector and interceptor for measuring server failures
+- Add client collector and interceptor for measuring client failures
+
 ### 2.2.0
 
 - Add Ruby 3.1 support
@@ -44,7 +49,7 @@ Changelog for the gruf-prometheus gem.
 
 ### 1.0.0
 
-- *Breaking Changes* Move all prometheus core dependencies to bc-prometheus-ruby  
+- *Breaking Changes* Move all prometheus core dependencies to bc-prometheus-ruby
 
 ### 0.0.2
 

data/README.md

@@ -51,16 +51,17 @@ This will output the following metrics:
 |Name|Type|Description|
 |---|---|---|
 |ruby_grpc_server_started_total|counter|Total number of RPCs started on the server|
+|ruby_grpc_server_failed_total|counter|Total number of RPCs that throw an unknown, internal, data loss, failed precondition, unavailable, deadline exceeded, or cancelled exception on the server|
 |ruby_grpc_server_handled_total|counter|Total number of RPCs completed on the server, regardless of success or failure|
 |ruby_grpc_server_handled_latency_seconds|histogram|Histogram of response latency of RPCs handled by the server, in seconds|
 
 Note that the histogram is disabled by default - you'll have to turn it on either through the `server_measure_latency`
 configuration yielded in `Gruf::Prometheus.configure`, or through the `PROMETHEUS_SERVER_MEASURE_LATENCY` environment
-variable. Also, the `measure_latency: true` option can be passed as a second argument to `Gruf.interceptors.use` to 
+variable. Also, the `measure_latency: true` option can be passed as a second argument to `Gruf.interceptors.use` to
 configure this directly in the interceptor.
 
 The precedence order for this is, from first to last, with last taking precedence:
-1) `measure_latency: true` passed into the interceptor 
+1) `measure_latency: true` passed into the interceptor
 2) `Gruf::Prometheus.configure` explicit setting globally
 3) `PROMETHEUS_SERVER_MEASURE_LATENCY` ENV var globally. This is the only value set by default - to `false` - and will
    be the default unless other methods are invoked.
@@ -76,40 +77,41 @@ Gruf::Client.new(
     interceptors: [Gruf::Prometheus::Client::Interceptor.new]
   }
 )
-``` 
+```
 
 |Name|Type|Description|
 |---|---|---|
 |ruby_grpc_client_started_total|counter|Total number of RPCs started by the client|
+|ruby_grpc_client_failed_total|counter|Total number of RPCs that throw an unknown, internal, data loss, failed precondition, unavailable, deadline exceeded, or cancelled exception by the client|
 |ruby_grpc_client_completed|counter|Total number of RPCs completed by the client, regardless of success or failure|
 |ruby_grpc_client_completed_latency_seconds|histogram|Histogram of response latency of RPCs completed by the client, in seconds|
 
 Note that the histogram is disabled by default - you'll have to turn it on either through the `client_measure_latency`
 configuration yielded in `Gruf::Prometheus.configure`, or through the `PROMETHEUS_CLIENT_MEASURE_LATENCY` environment
-variable. Optionally, you can pass in `measure_latency: true` into the Interceptor directly as an option argument in the 
-initializer. 
+variable. Optionally, you can pass in `measure_latency: true` into the Interceptor directly as an option argument in the
+initializer.
 
 The precedence order for this is, from first to last, with last taking precedence:
-1) `measure_latency: true` passed into the interceptor 
+1) `measure_latency: true` passed into the interceptor
 2) `Gruf::Prometheus.configure` explicit setting globally
 3) `PROMETHEUS_CLIENT_MEASURE_LATENCY` ENV var globally. This is the only value set by default - to `false` - and will
-   be the default unless other methods are invoked. 
+   be the default unless other methods are invoked.
 
 ### Running the Client Interceptor in Non-gRPC Processes
 
 One caveat is that you _must_ have the appropriate Type Collector setup in whatever process you are running in. If
-you are already doing this in a gruf gRPC service that is using the hook provided by this gem above, no further 
+you are already doing this in a gruf gRPC service that is using the hook provided by this gem above, no further
 configuration is needed. Otherwise, in whatever bc-prometheus-ruby configuration you have setup, you'll need to ensure
-the type collector is loaded: 
+the type collector is loaded:
 
 ```ruby
 # prometheus_server is whatever `::Bigcommerce::Prometheus::Server` instance you are using in the current process
 # Often hooks into these are exposed as configuration options, e.g. `web_collectors`, `resque_collectors`, etc
-prometheus_server.add_type_collector(::Gruf::Prometheus::Client::TypeCollector.new)  
+prometheus_server.add_type_collector(::Gruf::Prometheus::Client::TypeCollector.new)
 ```
 
 Note that you don't need to do this for the `Gruf::Prometheus::Client::Collector`, as it is an on-demand collector
-that does not run in a threaded loop.  
+that does not run in a threaded loop.
 
 See [bc-prometheus-ruby](https://github.com/bigcommerce/bc-prometheus-ruby#custom-server-integrations)'s documentation
 on custom server integrations for more information.
@@ -129,7 +131,7 @@ where the options available are:
 | Option | Description | Default | ENV Name |
 | ------ | ----------- | ------- | -------- |
 | process_label | The label to use for metric prefixing | grpc | PROMETHEUS_PROCESS_LABEL |
-| process_name | Label to use for process name in logging | grpc | PROMETHEUS_PROCESS_NAME | 	
+| process_name | Label to use for process name in logging | grpc | PROMETHEUS_PROCESS_NAME |
 | collection_frequency | The period in seconds in which to collect metrics | 30 | PROMETHEUS_COLLECTION_FREQUENCY |
 | 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 | [] | |
@@ -138,17 +140,17 @@ where the options available are:
 
 ## License
 
-Copyright (c) 2019-present, BigCommerce Pty. Ltd. All rights reserved 
+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 
+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 
+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 
+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.

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

@@ -23,6 +23,15 @@ module Gruf
       #
       class Collector < Bigcommerce::Prometheus::Collectors::Base
         RESPONSE_CODE_OK = 'OK'
+        FAILURE_CLASSES = %w[
+          GRPC::Unknown
+          GRPC::Internal
+          GRPC::DataLoss
+          GRPC::FailedPrecondition
+          GRPC::Unavailable
+          GRPC::DeadlineExceeded
+          GRPC::Cancelled
+        ].freeze
 
         ##
         # @param [Gruf::Outbound::RequestContext] request_context
@@ -34,6 +43,19 @@ module Gruf
           )
         end
 
+        ##
+        # @param [Gruf::Controller::RequestContext] request_context
+        # @param [Gruf::Interceptors::Timer::Result] result
+        #
+        def failed_total(request_context:, result:)
+          return unless failure?(result)
+
+          push(
+            grpc_client_failed_total: 1,
+            custom_labels: custom_labels(request_context: request_context)
+          )
+        end
+
         ##
         # @param [Gruf::Controller::RequestContext] request_context
         # @param [Gruf::Interceptors::Timer::Result] result
@@ -101,6 +123,14 @@ module Gruf
             Gruf::Prometheus::RequestTypes::UNARY
           end
         end
+
+        ##
+        # @param [Gruf::Interceptors::Timer::Result] result
+        # @return [Boolean]
+        #
+        def failure?(result)
+          FAILURE_CLASSES.include?(result.message_class_name)
+        end
       end
     end
   end

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

@@ -43,6 +43,7 @@ module Gruf
         #
         def send_metrics(request_context:, result:)
           prometheus_collector.started_total(request_context: request_context)
+          prometheus_collector.failed_total(request_context: request_context, result: result) unless result.successful?
           prometheus_collector.completed(request_context: request_context, result: result)
           prometheus_collector.completed_latency_seconds(request_context: request_context, result: result) if measure_latency?
         rescue StandardError => e

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

@@ -34,6 +34,7 @@ module Gruf
         def build_metrics
           metrics = {
             grpc_client_started_total: PrometheusExporter::Metric::Counter.new('grpc_client_started_total', 'Total number of RPCs started by the client'),
+            grpc_client_failed_total: PrometheusExporter::Metric::Counter.new('grpc_client_failed_total', 'Total number of RPCs failed by the client'),
             grpc_client_completed: PrometheusExporter::Metric::Counter.new('grpc_client_completed', 'Total number of RPCs completed by the client, regardless of success or failure')
           }
           metrics[:grpc_client_completed_latency_seconds] = PrometheusExporter::Metric::Histogram.new('grpc_client_completed_latency_seconds', 'Histogram of response latency of RPCs completed by the client, in seconds') if measure_latency?
@@ -45,6 +46,7 @@ module Gruf
         #
         def collect_metrics(data: {}, labels: {})
           metric(:grpc_client_started_total)&.observe(data['grpc_client_started_total'].to_i, labels)
+          metric(:grpc_client_failed_total)&.observe(data['grpc_client_failed_total'].to_i, labels)
           metric(:grpc_client_completed)&.observe(data['grpc_client_completed'].to_i, labels)
           metric(:grpc_client_completed_latency_seconds)&.observe(data['grpc_client_completed_latency_seconds'].to_f, labels) if measure_latency?
         end

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

@@ -23,6 +23,15 @@ module Gruf
       #
       class Collector < Bigcommerce::Prometheus::Collectors::Base
         RESPONSE_CODE_OK = 'OK'
+        FAILURE_CLASSES = %w[
+          GRPC::Unknown
+          GRPC::Internal
+          GRPC::DataLoss
+          GRPC::FailedPrecondition
+          GRPC::Unavailable
+          GRPC::DeadlineExceeded
+          GRPC::Cancelled
+        ].freeze
 
         ##
         # @param [Gruf::Controller::Request] request
@@ -34,6 +43,19 @@ module Gruf
           )
         end
 
+        ##
+        # @param [Gruf::Controller::Request] request
+        # @param [Gruf::Interceptors::Timer::Result] result
+        #
+        def failed_total(request:, result:)
+          return unless failure?(result)
+
+          push(
+            grpc_server_failed_total: 1,
+            custom_labels: custom_labels(request: request)
+          )
+        end
+
         ##
         # @param [Gruf::Controller::Request] request
         # @param [Gruf::Interceptors::Timer::Result] result:party
@@ -116,6 +138,14 @@ module Gruf
             Gruf::Prometheus::RequestTypes::UNARY
           end
         end
+
+        ##
+        # @param [Gruf::Interceptors::Timer::Result] result
+        # @return [Boolean]
+        #
+        def failure?(result)
+          FAILURE_CLASSES.include?(result.message_class_name)
+        end
       end
     end
   end

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

@@ -42,6 +42,7 @@ module Gruf
         #
         def send_metrics(result)
           prometheus_collector.started_total(request: request)
+          prometheus_collector.failed_total(request: request, result: result) unless result.successful?
           prometheus_collector.handled_total(request: request, result: result)
           prometheus_collector.handled_latency_seconds(request: request, result: result) if measure_latency?
         rescue StandardError => e

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

@@ -34,6 +34,7 @@ module Gruf
         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_failed_total: PrometheusExporter::Metric::Counter.new('grpc_server_failed_total', 'Total number of RPCs failed 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?
@@ -45,6 +46,7 @@ module Gruf
         #
         def collect_metrics(data: {}, labels: {})
           metric(:grpc_server_started_total)&.observe(data['grpc_server_started_total'].to_i, labels)
+          metric(:grpc_server_failed_total)&.observe(data['grpc_server_failed_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

data/lib/gruf/prometheus/version.rb

@@ -17,6 +17,6 @@
 #
 module Gruf
   module Prometheus
-    VERSION = '2.2.0'
+    VERSION = '2.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf-prometheus
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bc-prometheus-ruby