gruf-rollbar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48ee4ba3cf754c3bf4dce75434d43a4b69b2896e1e2c4ec3bde8f3e87e4cd8d5
+  data.tar.gz: 01a3c1a6fd02d3ed73d568ea950386cbab2b65ef81d7fd6c3f1a5d2b1fe68ae8
+SHA512:
+  metadata.gz: 8592f18d2acb307e752000e3fd1957fcaa8f08d706939c34c477a96b7a6618d76ed828892f29510fff8861fae85d9062d40bfc2d574498acea3f05d6fda8735d
+  data.tar.gz: f9171a43316226457726857bc9f30fc02a91862ab1fef2704b3e09d8fb1cf5cd388b62d45b9d2e6c8f8bf1eabede8e86400ce957878fadbe2a212dae19c2a8f9

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## Unreleased
+
+- [PLAT-816] Fix github action
+
+## 0.0.1
+
+- [PLAT-787] Gruf rollbar reporting

data/README.md

@@ -0,0 +1,45 @@
+# gruf-rollbar - Rollbar reporting for gruf
+
+Adds Rollbar error reporting support for [gruf](https://github.com/bigcommerce/gruf) 2.7.0+
+and [sentry-ruby](https://github.com/rollbar/rollbar-gem)
+
+This gem will automatically report grpc failures and Gruf errors into Rollbar as they happen in servers and clients.
+
+## Installation
+
+Simply install the gem:
+
+```ruby
+gem 'gruf-rollbar'
+```
+
+Then after, in your gruf initializer:
+
+```ruby
+Gruf.configure do |c|
+  c.interceptors.use(Gruf::Rollbar::ServerInterceptor)
+end
+```
+
+It comes with a few more options as well:
+
+| Option             | Description                                                                                    | Default                                                                                                                         | ENV Key                           |
+| ------------------ | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
+| ignore_methods     | A list of method names to ignore from logging. E.g. `['namespace.health.check']`               | `[]`                                                                                                                            | GRUF_ROLLBAR_IGNORE_METHODS       |
+| grpc_error_classes | A list of gRPC error classes that will be used for detecting errors (as opposed to validation) | `GRPC::Unknown,GRPC::Internal,GRPC::DataLoss,GRPC::FailedPrecondition,GRPC::Unavailable,GRPC::DeadlineExceeded,GRPC::Cancelled` | GRUF_ROLLBAR_GRPC_ERROR_CLASSES   |
+| default_error_code | The default gRPC error code to use (int value)                                                 | `GRPC::Core::StatusCodes::INTERNAL`                                                                                             | `GRUF_ROLLBAR_DEFAULT_ERROR_CODE` |
+
+### Client Interceptors
+
+To automatically report errors in your Gruf clients, pass the client interceptor to your `Gruf::Client` initializer:
+
+```ruby
+Gruf::Client.new(
+  service: MyService,
+  client_options: {
+    interceptors: [Gruf::Rollbar::ClientInterceptor.new]
+  }
+)
+```
+
+This gem is inspired by https://github.com/bigcommerce/gruf-sentry.

data/gruf-rollbar.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gruf/rollbar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gruf-rollbar'
+  spec.version       = Gruf::Rollbar::VERSION
+  spec.authors       = ['SeaLink']
+  spec.email         = ['john.zhao@kelsian.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{Automatically report gruf failures as rollbar errors}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/sealink/gruf-rollbar'
+
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-rollbar.gemspec']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler-audit', '>= 0.6'
+  spec.add_development_dependency 'rake', '>= 12.3'
+  spec.add_development_dependency 'rubocop', '>= 1.27'
+  spec.add_development_dependency 'pry', '>= 0.14'
+  spec.add_development_dependency 'rspec', '>= 3.8'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
+  spec.add_development_dependency 'simplecov', '>= 0.16'
+
+  spec.add_runtime_dependency 'gruf', '~> 2.5', '>= 2.5.1'
+  spec.add_runtime_dependency 'rollbar'
+  spec.add_runtime_dependency 'zeitwerk', '~> 2'
+end

data/lib/gruf/rollbar/client_interceptor.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Gruf
+  module Rollbar
+    ##
+    # Intercepts outbound calls to provide Rollbar reporting
+    #
+    class ClientInterceptor < Gruf::Interceptors::ClientInterceptor
+      include Gruf::Rollbar::ErrorParser
+
+      ##
+      # @param [Gruf::Outbound::RequestContext]
+      #
+      def call(request_context:)
+        return yield if Gruf::Rollbar.ignore_methods.include?(request_context.method_name)
+
+        begin
+          yield
+        rescue StandardError, GRPC::BadStatus => e
+          if error?(e) # only capture
+            ::Rollbar.scoped({
+                               grpc_method_name: request_context.method_name,
+                               grpc_route_key: request_context.route_key,
+                               grpc_call_type: request_context.type,
+                               grpc_error_code: code_for(e),
+                               grpc_error_class: e.class.name
+                             }) do
+              ::Rollbar.error(e)
+            end
+          end
+          raise # passthrough
+        end
+      end
+    end
+  end
+end

data/lib/gruf/rollbar/configuration.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Gruf
+  module Rollbar
+    ##
+    # Configuration module for gruf-rollbar
+    #
+    module Configuration
+      VALID_CONFIG_KEYS = {
+        grpc_error_classes: ::ENV.fetch(
+          'GRUF_ROLLBAR_GRPC_ERROR_CLASSES',
+          'GRPC::Unknown,GRPC::Internal,GRPC::DataLoss,GRPC::FailedPrecondition,GRPC::Unavailable,GRPC::DeadlineExceeded,GRPC::Cancelled'
+        ).to_s.split(',').map(&:strip),
+        default_error_code: ::ENV.fetch('GRUF_ROLLBAR_DEFAULT_ERROR_CODE', GRPC::Core::StatusCodes::INTERNAL).to_i,
+        ignore_methods: ::ENV.fetch('GRUF_ROLLBAR_IGNORE_METHODS', '').split(',').map(&:strip) || []
+      }.freeze
+
+      attr_accessor *VALID_CONFIG_KEYS.keys
+
+      ##
+      # Whenever this is extended into a class, setup the defaults
+      #
+      def self.extended(base)
+        base.reset
+      end
+
+      ##
+      # Yield self for ruby-style initialization
+      #
+      # @yields [Gruf::Rollbar::Configuration]
+      # @return [Gruf::Rollbar::Configuration]
+      #
+      def configure
+        yield self
+      end
+
+      ##
+      # Return the current configuration options as a Hash
+      #
+      # @return [Hash]
+      #
+      def options
+        opts = {}
+        VALID_CONFIG_KEYS.each_key do |k|
+          opts.merge!(k => send(k))
+        end
+        opts
+      end
+
+      ##
+      # Set the default configuration onto the extended class
+      #
+      # @return [Hash] options The reset options hash
+      #
+      def reset
+        VALID_CONFIG_KEYS.each do |k, v|
+          send("#{k}=".to_sym, v)
+        end
+
+        options
+      end
+    end
+  end
+end

data/lib/gruf/rollbar/error_parser.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Gruf
+  module Rollbar
+    ##
+    # Mixin for error parsing
+    #
+    module ErrorParser
+      ##
+      # @param [StandardError]
+      # @return [Number] that maps to one of the GRPC::Core::StatusCodes or Gruf::Rollbar.default_error_code
+      #
+      def code_for(error)
+        error.respond_to?(:code) ? error.code : Gruf::Rollbar.default_error_code
+      end
+
+      ##
+      # @return [Boolean]
+      #
+      def error?(exception)
+        error_classes.include?(exception.class.to_s)
+      end
+
+      ##
+      # @return [Array]
+      #
+      def error_classes
+        @options.fetch(:error_classes, Gruf::Rollbar.grpc_error_classes)
+      end
+    end
+  end
+end

data/lib/gruf/rollbar/server_interceptor.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Gruf
+  module Rollbar
+    ##
+    # Intercepts inbound calls to provide Rollbar error reporting
+    #
+    class ServerInterceptor < Gruf::Interceptors::ServerInterceptor
+      include Gruf::Rollbar::ErrorParser
+
+      ##
+      # Handle the gruf around hook and capture errors
+      #
+      def call(&_block)
+        return yield if Gruf::Rollbar.ignore_methods.include?(request.method_name)
+
+        begin
+          yield
+        rescue StandardError, GRPC::BadStatus => e
+          if error?(e) # only capture
+            ::Rollbar.scoped({
+                               grpc_method: request.method_key,
+                               grpc_request_class: request.request_class.name,
+                               grpc_service_key: request.service_key,
+                               grpc_error_code: code_for(e),
+                               grpc_error_class: e.class.name
+                             }) do
+              ::Rollbar.error(e)
+            end
+          end
+          raise # passthrough
+        end
+      end
+
+      private
+
+      ##
+      # @return [Hash]
+      #
+      def request_message_params
+        return {} if request.client_streamer? || !request.message.respond_to?(:to_h)
+
+        request.message.to_h
+      end
+    end
+  end
+end

data/lib/gruf/rollbar/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gruf
+  module Rollbar
+    VERSION = '0.0.1'
+  end
+end

data/lib/gruf/rollbar.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'gruf'
+require 'rollbar'
+
+# use Zeitwerk to lazily autoload all the files in the lib directory
+require 'zeitwerk'
+root_path = File.dirname(__dir__)
+loader = ::Zeitwerk::Loader.new
+loader.tag = File.basename(__FILE__, '.rb')
+loader.inflector = ::Zeitwerk::GemInflector.new(__FILE__)
+loader.ignore(File.join(root_path, 'gruf-rollbar.rb'))
+loader.push_dir(root_path)
+loader.setup
+
+module Gruf
+  module Rollbar
+    extend Gruf::Rollbar::Configuration
+  end
+end

data/lib/gruf-rollbar.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'gruf/rollbar'

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: gruf-rollbar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- SeaLink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.27'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: rollbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Automatically report gruf failures as rollbar errors
+email:
+- john.zhao@kelsian.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- gruf-rollbar.gemspec
+- lib/gruf-rollbar.rb
+- lib/gruf/rollbar.rb
+- lib/gruf/rollbar/client_interceptor.rb
+- lib/gruf/rollbar/configuration.rb
+- lib/gruf/rollbar/error_parser.rb
+- lib/gruf/rollbar/server_interceptor.rb
+- lib/gruf/rollbar/version.rb
+homepage: https://github.com/sealink/gruf-rollbar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Automatically report gruf failures as rollbar errors
+test_files: []