upfluence-utils 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9013ce0511178b0b0f2bbfd16704d016e41ef8126c0632fdc8289a6f2928dabd
-  data.tar.gz: '09dc43555bf935fe12be76168692d24b72b4ae064f7a7edc27a1e52b0e0acdcb'
+  metadata.gz: f2c9dcbd049e1e8c27d2ec9f7075cccacb7f4814d23ea04def031a0f9f00957f
+  data.tar.gz: 1f6b5c5812beaccfbf78123004f503f9135c96aedef1097cede9df3f007c6e92
 SHA512:
-  metadata.gz: 0bf6d2d6b2ea5398ebed18ed22e21951414a35f67a7bc4c8b8461b55600337c0e7e88ace3cc040c7e3c4affafbe7f0c702cfadd490b317dd63f3747081ed9d4e
-  data.tar.gz: ac825fd4f3bcb4bd5e8dd33b512bd53c7e61f8cd5049ef427a53960f8f4dc9108f66fe70e80e768aa2c58f02a0fc1d4854e9f42a290803e7455a4d77c4a7609a
+  metadata.gz: 7c9e85e446a91a43b0d71d855a3b5c8c601f84f77582b6f3f32c725eadc96682bed636d6987dbab210b98b64c437a92412df89e6ef4494a6b1b01d49e9aa4a79
+  data.tar.gz: 10f73661eccb80401be50c860b660b0be5707f60b9d864bbe6e49cd1e0e93a91ee1dc1fbcbdf99adb0f59936dcdd2115424657edb76d8345ab46c1dd95811232

data/lib/upfluence/error_logger/null.rb

@@ -18,7 +18,7 @@ module Upfluence
         end
       end
 
-      def notify(error, _method, *_args)
+      def notify(error, *_args)
         Upfluence.logger.error(error.inspect)
       end
 

data/lib/upfluence/error_logger/sentry.rb

@@ -1,66 +1,116 @@
-require 'raven'
+require 'sentry-ruby'
 
 module Upfluence
   module ErrorLogger
     class Sentry
-      EXCLUDED_ERRORS = (Raven::Configuration::IGNORE_DEFAULT + ['Identity::Thrift::Forbidden'])
+      EXCLUDED_ERRORS = (::Sentry::Configuration::IGNORE_DEFAULT + ['Identity::Thrift::Forbidden'])
+      MAX_TAG_SIZE = 8 * 1024
 
       def initialize
-        ::Raven.configure do |config|
-          config.dsn = ENV['SENTRY_DSN']
-          config.current_environment = Upfluence.env
+        @tag_extractors = []
+
+        ::Sentry.init do |config|
+          config.send_default_pii = true
+          config.dsn = ENV.fetch('SENTRY_DSN', nil)
+          config.environment = Upfluence.env
           config.excluded_exceptions = EXCLUDED_ERRORS
           config.logger = Upfluence.logger
-          config.release = "#{ENV['PROJECT_NAME']}-#{ENV['SEMVER_VERSION']}"
-          config.tags = {
-            unit_name: unit_name,
-            unit_type: unit_type
-          }.select { |_, v| !v.nil? }
+          config.release = "#{ENV.fetch('PROJECT_NAME', nil)}-#{ENV.fetch('SEMVER_VERSION', nil)}"
+          config.enable_tracing = false
+          config.auto_session_tracking = false
+        end
+
+        ::Sentry.set_tags(
+          { unit_name: unit_name, unit_type: unit_type }.select { |_, v| v }
+        )
+
+        ::Sentry.with_scope do |scope|
+          scope.add_event_processor do |event, hint|
+            tags = @tag_extractors.map(&:extract).compact.reduce({}, &:merge)
+
+            exc = hint[:exception]
+
+            tags.merge!(exc.tags) if exc.respond_to? :tags
+
+            tx_name = transaction_name(tags)
+
+            event.transaction = tx_name if tx_name
+            event.extra.merge!(prepare_extra(tags))
+
+            event
+          end
         end
       end
 
-      def notify(error, method, *args)
-        begin
-          Raven.capture_exception(
-            error,
-            extra: { method: method, arguments: args.map(&:inspect) },
-            tags: { method: method }
-          )
-        rescue Raven::Error => e
-          Upfluence.logger.error e.message
+      def append_tag_extractors(klass)
+        @tag_extractors << klass
+      end
+
+      def notify(error, *args)
+        ::Sentry.with_scope do |scope|
+          context = args.reduce({}) do |acc, arg|
+            v = if arg.is_a?(Hash)
+                  arg
+                else
+                  key = acc.empty? ? 'method' : "arg_#{acc.length}"
+                  { key => arg.inspect }
+                end
+
+            acc.merge(v)
+          end
+
+          scope.set_extras(prepare_extra(context))
+
+          ::Sentry.capture_exception(error)
         end
+      rescue ::Sentry::Error => e
+        Upfluence.logger.warning e.message
       end
 
       def user=(user)
-        Raven.user_context(id: user.id, email: user.email)
+        ::Sentry.set_user(id: user.id, email: user.email)
       end
 
       def middleware
-        ::Raven::Rack
+        ::Sentry::Rack::CaptureExceptions
       end
 
       def ignore_exception(*klss)
         klss.each do |kls|
-          puts kls
           case kls.class
           when Class
-            Raven.configuration.excluded_exceptions << kls.name
+            ::Sentry.configuration.excluded_exceptions << kls.name
           when String
-            Raven.configuration.excluded_exceptions << kls
+            ::Sentry.configuration.excluded_exceptions << kls
           else
-            Upfluence.logger.warn e.message
+            Upfluence.logger.warn "Unexcepted argument for ignore_exception #{kls}"
           end
         end
       end
 
       private
 
+      def prepare_extra(tags)
+        tags.select { |_k, v| v.respond_to?(:size) && v.size < MAX_TAG_SIZE }
+      end
+
+      def transaction_name(tags)
+        return tags['transaction'] if tags['transaction']
+
+        svc = tags['thrift.request.service']
+        mth = tags['thrift.request.method']
+
+        return "#{svc}##{mth}" if svc && mth
+
+        nil
+      end
+
       def unit_name
-        ENV['UNIT_NAME'].split('.').first if ENV['UNIT_NAME']
+        ENV['UNIT_NAME']&.split('.')&.first
       end
 
       def unit_type
-        unit_name.split('@').first if unit_name
+        unit_name&.split('@')&.first
       end
     end
   end

data/lib/upfluence/http/middleware/request_stapler.rb

@@ -0,0 +1,16 @@
+module Upfluence
+  module HTTP
+    module Middleware
+      class RequestStapler
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          Server.request = Rack::Request.new(env)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/upfluence/http/server.rb

@@ -14,23 +14,26 @@ require 'upfluence/http/middleware/application_headers'
 require 'upfluence/http/middleware/handle_exception'
 require 'upfluence/http/middleware/prometheus'
 require 'upfluence/http/middleware/cors'
+require 'upfluence/http/middleware/request_stapler'
 
 module Upfluence
   module HTTP
     class Server
+      REQUEST_CONTEXT_KEY = :uhtt_request_context
+      DEFAULT_MIDDLEWARES = []
       DEFAULT_OPTIONS = {
-        server: :puma,
-        Port: ENV['PORT'] || 8080,
-        Host: '0.0.0.0',
-        threaded: true,
-        interfaces: [],
-        push_gateway_url: ENV['PUSH_GATEWAY_URL'],
+        server:                :puma,
+        Port:                  ENV.fetch('PORT', 8080),
+        Host:                  '0.0.0.0',
+        threaded:              true,
+        interfaces:            [],
+        push_gateway_url:      ENV.fetch('PUSH_GATEWAY_URL', nil),
         push_gateway_interval: 15, # sec
-        app_name: ENV['APP_NAME'] || 'uhttp-rb-server',
-        unit_name: ENV['UNIT_NAME'] || 'uhttp-rb-server-anonymous',
-        base_processor_klass: nil,
-        base_handler_klass: nil,
-        debug: ENV['DEBUG']
+        app_name:              ENV.fetch('APP_NAME', 'uhttp-rb-server'),
+        unit_name:             ENV.fetch('UNIT_NAME','uhttp-rb-server-anonymous'),
+        base_processor_klass:  nil,
+        base_handler_klass:    nil,
+        debug:                 ENV.fetch('DEBUG', nil)
       }
 
       def initialize(options = {}, &block)
@@ -43,6 +46,7 @@ module Upfluence
         end
 
         @builder = Builder.new do
+          use Middleware::RequestStapler
           use Middleware::Logger
           use Middleware::Prometheus
           use Middleware::ApplicationHeaders, base_handler
@@ -55,6 +59,11 @@ module Upfluence
           use Rack::ETag
           use Middleware::CORS if Upfluence.env.development?
 
+          DEFAULT_MIDDLEWARES.each do |m|
+            m = [m] unless m.is_a?(Array)
+            use(*m)
+          end
+
           map '/healthcheck' do
             run(opts[:healthcheck_endpoint] || Endpoint::Healthcheck.new)
           end
@@ -87,6 +96,16 @@ module Upfluence
         end
       end
 
+      class << self
+        def request
+          Thread.current[REQUEST_CONTEXT_KEY]
+        end
+
+        def request=(req)
+          Thread.current[REQUEST_CONTEXT_KEY] = req
+        end
+      end
+
       private
 
       def run_prometheus_exporter
@@ -101,7 +120,7 @@ module Upfluence
 
           begin
             push.replace Prometheus::Client.registry
-          rescue => e
+          rescue StandardError => e
             Upfluence.error_logger.notify(e)
           end
         end

data/lib/upfluence/utils/version.rb

@@ -1,5 +1,5 @@
 module Upfluence
   module Utils
-    VERSION = '0.11.3'.freeze
+    VERSION = '0.12.0'.freeze
   end
 end

data/rbutils.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'upfluence-thrift'
   spec.add_runtime_dependency 'sinatra'
   spec.add_runtime_dependency 'redis'
-  spec.add_runtime_dependency 'sentry-raven'
+  spec.add_runtime_dependency 'sentry-ruby'
   spec.add_runtime_dependency 'sinatra-contrib'
   spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'puma'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upfluence-utils
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - Upfluence
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sentry-raven
+  name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -267,6 +267,7 @@ files:
 - lib/upfluence/http/middleware/handle_exception.rb
 - lib/upfluence/http/middleware/logger.rb
 - lib/upfluence/http/middleware/prometheus.rb
+- lib/upfluence/http/middleware/request_stapler.rb
 - lib/upfluence/http/server.rb
 - lib/upfluence/logger.rb
 - lib/upfluence/mixin/html_scrubbing.rb