istox_gruf 2.7.1

data/lib/gruf/interceptors/instrumentation/statsd.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-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 Interceptors
+    module Instrumentation
+      ##
+      # Adds increment and timing stats to gRPC routes, pushing data to StatsD
+      #
+      class Statsd < Gruf::Interceptors::ServerInterceptor
+        ##
+        # Push data to StatsD, only doing so if a client is set
+        #
+        def call
+          unless client
+            Gruf.logger.error 'Statsd module loaded, but no client configured!'
+            return yield
+          end
+
+          client.increment(route_key)
+
+          result = Gruf::Interceptors::Timer.time do
+            yield
+          end
+
+          client.increment("#{route_key}.#{postfix(result.successful?)}")
+          client.timing(route_key, result.elapsed)
+
+          raise result.message unless result.successful?
+
+          result.message
+        end
+
+        private
+
+        ##
+        # @param [Boolean] successful Whether or not the request was successful
+        # @return [String] The appropriate postfix for the key dependent on response status
+        #
+        def postfix(successful)
+          successful ? 'success' : 'failure'
+        end
+
+        ##
+        # @return [String] Return a composed route key that is used in the statsd metric
+        #
+        def route_key
+          "#{key_prefix}#{request.method_name}"
+        end
+
+        ##
+        # @return [String] Return the sanitized key prefix for the statsd metric key
+        #
+        def key_prefix
+          prefix = options.fetch(:prefix, '').to_s
+          prefix.empty? ? '' : "#{prefix}."
+        end
+
+        ##
+        # @return [::Statsd] Return the given StatsD client
+        #
+        def client
+          @client ||= options.fetch(:client, nil)
+        end
+      end
+    end
+  end
+end

data/lib/gruf/interceptors/registry.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-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 Interceptors
+    ##
+    # Handles registration of interceptors
+    #
+    class Registry
+      class InterceptorNotFoundError < StandardError; end
+
+      def initialize
+        @registry = []
+      end
+
+      ##
+      # Add an interceptor to the registry
+      #
+      # @param [Class] interceptor_class The class of the interceptor to add
+      # @param [Hash] options A hash of options to pass into the interceptor during initialization
+      #
+      def use(interceptor_class, options = {})
+        interceptors_mutex do
+          @registry << {
+            klass: interceptor_class,
+            options: options
+          }
+        end
+      end
+
+      ##
+      # Remove an interceptor from the registry
+      #
+      # @param [Class] interceptor_class The interceptor class to remove
+      # @raise [InterceptorNotFoundError] if the interceptor is not found
+      #
+      def remove(interceptor_class)
+        pos = @registry.find_index { |opts| opts.fetch(:klass, '') == interceptor_class }
+        raise InterceptorNotFoundError if pos.nil?
+
+        @registry.delete_at(pos)
+      end
+
+      ##
+      # Insert an interceptor before another specified interceptor
+      #
+      # @param [Class] before_class The interceptor to insert before
+      # @param [Class] interceptor_class The class of the interceptor to add
+      # @param [Hash] options A hash of options to pass into the interceptor during initialization
+      # @raise [InterceptorNotFoundError] if the before interceptor is not found
+      #
+      def insert_before(before_class, interceptor_class, options = {})
+        interceptors_mutex do
+          pos = @registry.find_index { |opts| opts.fetch(:klass, '') == before_class }
+          raise InterceptorNotFoundError if pos.nil?
+
+          @registry.insert(
+            pos,
+            klass: interceptor_class,
+            options: options
+          )
+        end
+      end
+
+      ##
+      # Insert an interceptor after another specified interceptor
+      #
+      # @param [Class] after_class The interceptor to insert after
+      # @param [Class] interceptor_class The class of the interceptor to add
+      # @param [Hash] options A hash of options to pass into the interceptor during initialization
+      # @raise [InterceptorNotFoundError] if the after interceptor is not found
+      #
+      def insert_after(after_class, interceptor_class, options = {})
+        interceptors_mutex do
+          pos = @registry.find_index { |opts| opts.fetch(:klass, '') == after_class }
+          raise InterceptorNotFoundError if pos.nil?
+
+          @registry.insert(
+            (pos + 1),
+            klass: interceptor_class,
+            options: options
+          )
+        end
+      end
+
+      ##
+      # Return a list of the interceptor classes in the registry in their execution order
+      #
+      # @return [Array<Class>]
+      #
+      def list
+        interceptors_mutex do
+          @registry.map { |h| h[:klass] }
+        end
+      end
+
+      ##
+      # Load and return all interceptors for the given request
+      #
+      # @param [Gruf::Controllers::Request] request
+      # @param [Gruf::Error] error
+      # @return [Array<Gruf::Interceptors::Base>]
+      #
+      def prepare(request, error)
+        is = []
+        interceptors_mutex do
+          @registry.each do |o|
+            is << o[:klass].new(request, error, o[:options])
+          end
+        end
+        is
+      end
+
+      ##
+      # Clear the registry
+      #
+      def clear
+        interceptors_mutex do
+          @registry = []
+        end
+      end
+
+      ##
+      # @return [Integer] The number of interceptors currently loaded
+      #
+      def count
+        interceptors_mutex do
+          @registry ||= []
+          @registry.count
+        end
+      end
+
+      private
+
+      ##
+      # Handle mutations to the interceptor registry in a thread-safe manner
+      #
+      def interceptors_mutex(&block)
+        @interceptors_mutex ||= begin
+          require 'monitor'
+          Monitor.new
+        end
+        @interceptors_mutex.synchronize(&block)
+      end
+    end
+  end
+end

data/lib/gruf/interceptors/server_interceptor.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-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 Interceptors
+    ##
+    # Intercepts server requests
+    #
+    class ServerInterceptor < Base
+      include Gruf::Errors::Helpers
+
+      ##
+      # Call the interceptor
+      #
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/gruf/interceptors/timer.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-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 Interceptors
+    ##
+    # Utility class that can be used by interceptors to time requests
+    #
+    class Timer
+      ##
+      # Represents a timed result for an interceptor
+      #
+      class Result
+        attr_reader :message
+        attr_reader :elapsed
+
+        ##
+        # @param [Object] message The protobuf message
+        # @param [Float] elapsed The elapsed time of the request
+        # @param [Boolean] successful If the request was successful
+        #
+        def initialize(message, elapsed, successful)
+          @message = message
+          @elapsed = elapsed.to_f
+          @successful = successful ? true : false
+        end
+
+        ##
+        # @return [Boolean] True if this was a successful request
+        #
+        def successful?
+          @successful
+        end
+
+        ##
+        # @return [String] The name of the message class
+        #
+        def message_class_name
+          @message.class.name
+        end
+
+        ##
+        # Return the execution time rounded to a specified precision
+        #
+        # @param [Integer] precision The amount of decimal places to round to
+        # @return [Float] The execution time rounded to the appropriate decimal point
+        #
+        def elapsed_rounded(precision: 2)
+          @elapsed.to_f.round(precision)
+        end
+      end
+
+      ##
+      # Time a given code block and return a Timer::Result object
+      #
+      # @return [Gruf::Interceptors::Timer::Result]
+      #
+      def self.time
+        start_time = Time.now
+        message = yield
+        end_time = Time.now
+        elapsed = (end_time - start_time) * 1000.0
+        Result.new(message, elapsed, true)
+      rescue GRPC::BadStatus => e
+        end_time = Time.now
+        elapsed = (end_time - start_time) * 1000.0
+        Result.new(e, elapsed, false)
+      end
+    end
+  end
+end

data/lib/gruf/loggable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-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
+  ##
+  # Mixin that allows any Gruf class to have easy access to the Gruf logger
+  #
+  module Loggable
+    ##
+    # @return [Logger] The set logger for Gruf
+    #
+    def logger
+      Gruf.logger
+    end
+  end
+end

data/lib/gruf/logging.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2017-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
+  ##
+  # Handles internal gruf logging requests
+  #
+  module Logger
+    ##
+    # Return the current Gruf logger
+    #
+    # @return [Logger]
+    #
+    def logger
+      Gruf.logger
+    end
+  end
+
+  ##
+  # Handles grpc internal logging requests
+  #
+  module GrpcLogger
+    ##
+    # Return the current Gruf gRPC core logger
+    #
+    # @return [Logger]
+    #
+    def logger
+      Gruf.grpc_logger
+    end
+  end
+end
+
+##
+# Implements gruf's gRPC logger into the gRPC library logger
+#
+module GRPC
+  extend Gruf::GrpcLogger
+end