atatus 1.7.0 → 2.0.0

data/lib/atatus/spies/sidekiq.rb

@@ -35,9 +35,11 @@ module Atatus
           yield
 
           transaction&.done :success
+          transaction&.outcome = Transaction::Outcome::SUCCESS
         rescue ::Exception => e
           Atatus.report(e, handled: false)
           transaction&.done :error
+          transaction&.outcome = Transaction::Outcome::FAILURE
           raise
         ensure
           Atatus.end_transaction
@@ -56,47 +58,37 @@ module Atatus
       end
 
       def install_middleware
-        if defined?(::Sidekiq)
+        Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add Middleware
+          end
+        end
+      end
 
-          Sidekiq.configure_server do |config|
-            config.server_middleware do |chain|
-              chain.add Middleware
+      # @api private
+      module Ext
+        def start
+          super.tap do
+            # Already running from Railtie if Rails
+            if Atatus.running?
+              Atatus.agent.config.logger = Sidekiq.logger
+            else
+              Atatus.start
             end
           end
+        end
 
+        def terminate
+          super.tap do
+            Atatus.stop
+          end
         end
       end
 
       def install_processor
         require 'sidekiq/processor'
 
-        if defined?(::Sidekiq) && defined?(::Sidekiq::Processor)
-
-          Sidekiq::Processor.class_eval do
-            alias start_without_apm start
-            alias terminate_without_apm terminate
-
-            def start
-              result = start_without_apm
-
-              # Already running from Railtie if Rails
-              if Atatus.running?
-                Atatus.agent.config.logger = Sidekiq.logger
-              else
-                Atatus.start
-              end
-
-              result
-            end
-
-            def terminate
-              terminate_without_apm
-
-              Atatus.stop
-            end
-          end
-
-        end
+        Sidekiq::Processor.prepend(Ext)
       end
 
       def install

data/lib/atatus/spies/sinatra.rb

@@ -22,42 +22,34 @@ module Atatus
   module Spies
     # @api private
     class SinatraSpy
-      def install
-        if defined?(::Sinatra) &&
-            defined?(::Sinatra::Base) &&
-            ::Sinatra::Base.private_method_defined?(:dispatch!) &&
-            ::Sinatra::Base.private_method_defined?(:compile_template)
-
-          ::Sinatra::Base.class_eval do
-            alias dispatch_without_apm! dispatch!
-            alias compile_template_without_apm compile_template
-
-            def dispatch!(*args, &block)
-              dispatch_without_apm!(*args, &block).tap do
-                next unless (transaction = Atatus.current_transaction)
-                next unless (route = env['sinatra.route'])
-
-                transaction.name = route
-              end
-            end
-
-            def compile_template(engine, data, opts, *args, &block)
-              opts[:__atatus_template_name] =
-                case data
-                when Symbol then data.to_s
-                else format('Inline %s', engine)
-                end
+      # @api private
+      module Ext
+        def dispatch!(*args, &block)
+          super(*args, &block).tap do
+            next unless (transaction = Atatus.current_transaction)
+            next unless (route = env['sinatra.route'])
+
+            transaction.name = route
+          end
+        end
 
-              compile_template_without_apm(engine, data, opts, *args, &block)
+        def compile_template(engine, data, opts, *args, &block)
+          opts[:__atatus_template_name] =
+            case data
+            when Symbol then data.to_s
+            else format('Inline %s', engine)
             end
-          end
 
+          super(engine, data, opts, *args, &block)
         end
       end
+
+      def install
+        ::Sinatra::Base.prepend(Ext)
+      end
     end
 
     register 'Sinatra::Base', 'sinatra/base', SinatraSpy.new
-
     require 'atatus/spies/tilt'
   end
 end

data/lib/atatus/spies/sneakers.rb

@@ -57,11 +57,13 @@ module Atatus
 
           res = @app.call(deserialized_msg, delivery_info, metadata, handler)
           transaction&.done(:success)
+          transaction&.outcome = Transaction::Outcome::SUCCESS
 
           res
         rescue ::Exception => e
           Atatus.report(e, handled: false)
           transaction&.done(:error)
+          transaction&.outcome = Transaction::Outcome::FAILURE
           raise
         ensure
           Atatus.end_transaction

data/lib/atatus/spies/sns.rb

@@ -0,0 +1,126 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  # @api private
+  module Spies
+    # @api private
+    class SNSSpy
+      TYPE = 'messaging'
+      SUBTYPE = 'sns'
+      AP_REGEX = /:accesspoint[\/:].*/
+      AP_REGION_REGEX = /^(?:[^:]+:){3}([^:]+).*/
+
+      def self.without_net_http
+        return yield unless defined?(NetHTTPSpy)
+
+        # rubocop:disable Style/ExplicitBlockArgument
+        Atatus::Spies::NetHTTPSpy.disable_in do
+          yield
+        end
+        # rubocop:enable Style/ExplicitBlockArgument
+      end
+
+      def self.get_topic(params)
+        return '[PHONENUMBER]' if params[:phone_number]
+
+        last_after_slash_or_colon(
+          params[:topic_arn] || params[:target_arn]
+        )
+      end
+
+      def self.last_after_slash_or_colon(arn)
+        if index = arn.rindex(AP_REGEX)
+          return arn[index+1..-1]
+        end
+
+        if arn.include?('/')
+          arn.split('/')[-1]
+        else
+          arn.split(':')[-1]
+        end
+      end
+
+      def self.arn_region(arn)
+        if arn && (match = AP_REGION_REGEX.match(arn))
+          match[1]
+        end
+      end
+
+      def self.span_context(topic, region)
+        Atatus::Span::Context.new(
+          message: { queue_name: topic },
+          destination: {
+            service: { resource: "#{SUBTYPE}/#{topic}" },
+            cloud: { region: region }
+          }
+        )
+      end
+
+      # @api private
+      module Ext
+        def publish(params = {}, options = {})
+          unless (transaction = Atatus.current_transaction)
+            return super(params, options)
+          end
+
+          topic = Atatus::Spies::SNSSpy.get_topic(params)
+          span_name = topic ? "SNS PUBLISH to #{topic}" : 'SNS PUBLISH'
+          region = Atatus::Spies::SNSSpy.arn_region(
+            params[:topic_arn] || params[:target_arn]
+          )
+          context = Atatus::Spies::SNSSpy.span_context(
+            topic,
+            region || config.region
+          )
+
+          Atatus.with_span(
+            span_name,
+            TYPE,
+            subtype: SUBTYPE,
+            action: 'publish',
+            context: context
+          ) do |span|
+            trace_context = span&.trace_context || transaction.trace_context
+            trace_context.apply_headers do |key, value|
+              params[:message_attributes] ||= {}
+              params[:message_attributes][key] ||= {}
+              params[:message_attributes][key][:string_value] = value
+              params[:message_attributes][key][:data_type] = 'String'
+            end
+
+            Atatus::Spies::SNSSpy.without_net_http do
+              super(params, options)
+            end
+          end
+        end
+      end
+
+      def install
+        ::Aws::SNS::Client.prepend(Ext)
+      end
+    end
+
+    register(
+      'Aws::SNS::Client',
+      'aws-sdk-sns',
+      SNSSpy.new
+    )
+  end
+end

data/lib/atatus/spies/sqs.rb

@@ -0,0 +1,231 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  # @api private
+  module Spies
+    # @api private
+    class SQSSpy
+      TYPE = 'messaging'
+      SUBTYPE = 'sqs'
+
+      REGION_REGEXP = %r{https://sqs\.([a-z0-9-]+)\.amazonaws}
+
+      def self.without_net_http
+        return yield unless defined?(NetHTTPSpy)
+
+        # rubocop:disable Style/ExplicitBlockArgument
+        Atatus::Spies::NetHTTPSpy.disable_in do
+          yield
+        end
+        # rubocop:enable Style/ExplicitBlockArgument
+      end
+
+      def self.queue_name(params)
+        if params[:queue_url]
+          params[:queue_url].split('/')[-1]
+        end
+      end
+
+      def self.region_from_url(url)
+        if match = REGION_REGEXP.match(url)
+          match[1]
+        end
+      end
+
+      def self.span_context(queue_name, region)
+        Atatus::Span::Context.new(
+          message: { queue_name: queue_name },
+          destination: {
+            service: { resource: "#{SUBTYPE}/#{queue_name}" },
+            cloud: { region: region }
+          }
+          # span links added here?
+        )
+      end
+
+      # @api private
+      module Ext
+        def self.prepended(mod)
+          def send_message(params = {}, options = {})
+            unless (transaction = Atatus.current_transaction)
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name = queue_name ? "SQS SEND to #{queue_name}" : 'SQS SEND'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'send',
+              context: context
+            ) do |span|
+              trace_context = span&.trace_context || transaction.trace_context
+              trace_context.apply_headers do |key, value|
+                params[:message_attributes] ||= {}
+                params[:message_attributes][key] ||= {}
+                params[:message_attributes][key][:string_value] = value
+                params[:message_attributes][key][:data_type] = 'String'
+              end
+
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+
+          def send_message_batch(params = {}, options = {})
+            unless (transaction = Atatus.current_transaction)
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name =
+              queue_name ? "SQS SEND_BATCH to #{queue_name}" : 'SQS SEND_BATCH'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'send_batch',
+              context: context
+            ) do |span|
+              trace_context = span&.trace_context || transaction.trace_context
+
+              trace_context.apply_headers do |key, value|
+                params[:entries].each do |message|
+                  message[:message_attributes] ||= {}
+                  message[:message_attributes][key] ||= {}
+                  message[:message_attributes][key][:string_value] = value
+                  message[:message_attributes][key][:data_type] = 'String'
+                end
+              end
+
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+
+          def receive_message(params = {}, options = {})
+            unless Atatus.current_transaction
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name =
+              queue_name ? "SQS RECEIVE from #{queue_name}" : 'SQS RECEIVE'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'receive',
+              context: context
+            ) do
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+
+          def delete_message(params = {}, options = {})
+            unless Atatus.current_transaction
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name = queue_name ? "SQS DELETE from #{queue_name}" : 'SQS DELETE'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'delete',
+              context: context
+            ) do
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+
+          def delete_message_batch(params = {}, options = {})
+            unless Atatus.current_transaction
+              return super(params, options)
+            end
+
+            queue_name = Atatus::Spies::SQSSpy.queue_name(params)
+            span_name =
+              queue_name ? "SQS DELETE_BATCH from #{queue_name}" : 'SQS DELETE_BATCH'
+            region = Atatus::Spies::SQSSpy.region_from_url(params[:queue_url])
+            context = Atatus::Spies::SQSSpy.span_context(
+              queue_name,
+              region || config.region
+            )
+
+            Atatus.with_span(
+              span_name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: 'delete_batch',
+              context: context
+            ) do
+              Atatus::Spies::SQSSpy.without_net_http do
+                super(params, options)
+              end
+            end
+          end
+        end
+      end
+
+      def install
+        ::Aws::SQS::Client.prepend(Ext)
+      end
+    end
+
+    register(
+      'Aws::SQS::Client',
+      'aws-sdk-sqs',
+      SQSSpy.new
+    )
+  end
+end

data/lib/atatus/spies/sucker_punch.rb

@@ -25,30 +25,28 @@ module Atatus
       TYPE = 'sucker_punch'
 
       def install
-        if defined?(::SuckerPunch) && defined?(::SuckerPunch::Job) && defined?(::SuckerPunch::Job::ClassMethods)
+        ::SuckerPunch::Job::ClassMethods.class_eval do
+          alias :__run_perform_without_atatus :__run_perform
 
-          ::SuckerPunch::Job::ClassMethods.class_eval do
-            alias :__run_perform_without_atatus :__run_perform
-
-            def __run_perform(*args)
-              # This method is reached via JobClass#async_perform
-              # or JobClass#perform_in.
-              name = to_s
-              transaction = Atatus.start_transaction(name, TYPE)
-              __run_perform_without_atatus(*args)
-              transaction.done 'success'
-            rescue ::Exception => e
-              # Note that SuckerPunch by default doesn't raise the errors from
-              # the user-defined JobClass#perform method as it uses an error
-              # handler, accessed via `SuckerPunch.exception_handler`.
-              Atatus.report(e, handled: false)
-              transaction.done 'error'
-              raise
-            ensure
-              Atatus.end_transaction
-            end
+          def __run_perform(*args)
+            # This method is reached via JobClass#async_perform
+            # or JobClass#perform_in.
+            name = to_s
+            transaction = Atatus.start_transaction(name, TYPE)
+            __run_perform_without_atatus(*args)
+            transaction.done 'success'
+            transaction&.outcome = Transaction::Outcome::SUCCESS
+          rescue ::Exception => e
+            # Note that SuckerPunch by default doesn't raise the errors from
+            # the user-defined JobClass#perform method as it uses an error
+            # handler, accessed via `SuckerPunch.exception_handler`.
+            Atatus.report(e, handled: false)
+            transaction.done 'error'
+            transaction&.outcome = Transaction::Outcome::FAILURE
+            raise
+          ensure
+            Atatus.end_transaction
           end
-
         end
       end
     end

data/lib/atatus/spies/tilt.rb

@@ -24,23 +24,20 @@ module Atatus
     class TiltSpy
       TYPE = 'template.tilt'
 
-      def install
-        if defined?(::Tilt) && defined?(::Tilt::Template)
-
-          ::Tilt::Template.class_eval do
-            alias render_without_apm render
+      # @api private
+      module Ext
+        def render(*args, &block)
+          name = options[:__atatus_template_name] || 'Unknown template'
 
-            def render(*args, &block)
-              name = options[:__atatus_template_name] || 'Unknown template'
-
-              Atatus.with_span name, TYPE do
-                render_without_apm(*args, &block)
-              end
-            end
+          Atatus.with_span name, TYPE do
+            super(*args, &block)
           end
-
         end
       end
+
+      def install
+        ::Tilt::Template.prepend(Ext)
+      end
     end
 
     register 'Tilt::Template', 'tilt/template', TiltSpy.new

data/lib/atatus/spies.rb

@@ -56,6 +56,26 @@ module Atatus
       end
     end
 
+    def self.without_faraday
+      return yield unless defined?(FaradaySpy)
+
+      # rubocop:disable Style/ExplicitBlockArgument
+      Atatus::Spies::FaradaySpy.disable_in do
+        yield
+      end
+      # rubocop:enable Style/ExplicitBlockArgument
+    end
+
+    def self.without_net_http
+      return yield unless defined?(NetHTTPSpy)
+
+      # rubocop:disable Style/ExplicitBlockArgument
+      Atatus::Spies::NetHTTPSpy.disable_in do
+        yield
+      end
+      # rubocop:enable Style/ExplicitBlockArgument
+    end
+
     def self.register_require_hook(registration)
       registration.require_paths.each do |path|
         require_hooks[path] = registration

data/lib/atatus/sql/signature.rb

@@ -36,8 +36,8 @@ module Atatus
       end
 
       def initialize(sql)
-        @sql = sql
-        @tokenizer = Tokenizer.new(sql)
+        @sql = sql.encode('utf-8', invalid: :replace, undef: :replace)
+        @tokenizer = Tokenizer.new(@sql)
       end
 
       def parse
@@ -158,9 +158,11 @@ module Atatus
       def scan_dotted_identifier
         table = @tokenizer.text
 
+        # rubocop:disable Style/WhileUntilModifier
         while scan_token(PERIOD) && scan_token(IDENT)
           table += ".#{@tokenizer.text}"
         end
+        # rubocop:enable Style/WhileUntilModifier
 
         table
       end