atatus 1.3.0 → 1.6.1

data/lib/atatus/spies/sinatra.rb

@@ -1,3 +1,20 @@
+# 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
@@ -5,11 +22,10 @@ module Atatus
   module Spies
     # @api private
     class SinatraSpy
-      # rubocop:disable Metrics/MethodLength
       def install
-        if defined?(::Sinatra) && 
+        if defined?(::Sinatra) &&
             defined?(::Sinatra::Base) &&
-            ::Sinatra::Base.private_method_defined?(:dispatch!) && 
+            ::Sinatra::Base.private_method_defined?(:dispatch!) &&
             ::Sinatra::Base.private_method_defined?(:compile_template)
 
           ::Sinatra::Base.class_eval do
@@ -35,9 +51,9 @@ module Atatus
               compile_template_without_apm(engine, data, opts, *args, &block)
             end
           end
+
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
 
     register 'Sinatra::Base', 'sinatra/base', SinatraSpy.new

data/lib/atatus/spies/sneakers.rb

@@ -0,0 +1,74 @@
+# 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 SneakersSpy
+      include Logging
+
+      def self.supported_version?
+        Gem.loaded_specs['sneakers'].version >= Gem::Version.create('2.12.0')
+      end
+
+      def install
+        unless SneakersSpy.supported_version?
+          warn(
+            'Sneakers version is below 2.12.0. Sneakers spy installation failed'
+          )
+          return
+        end
+
+        Sneakers.middleware.use(Middleware, nil)
+      end
+
+      # @api private
+      class Middleware
+        def initialize(app, *args)
+          @app = app
+          @args = args
+        end
+
+        def call(deserialized_msg, delivery_info, metadata, handler)
+          transaction =
+            Atatus.start_transaction(
+              delivery_info.consumer.queue.name,
+              'Sneakers'
+            )
+
+          Atatus.set_label(:routing_key, delivery_info.routing_key)
+
+          res = @app.call(deserialized_msg, delivery_info, metadata, handler)
+          transaction&.done(:success)
+
+          res
+        rescue ::Exception => e
+          Atatus.report(e, handled: false)
+          transaction&.done(:error)
+          raise
+        ensure
+          Atatus.end_transaction
+        end
+      end
+    end
+
+    register 'Sneakers', 'sneakers', SneakersSpy.new
+  end
+end

data/lib/atatus/spies/sucker_punch.rb

@@ -0,0 +1,58 @@
+# 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 SuckerPunchSpy
+      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
+
+            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
+          end
+
+        end
+      end
+    end
+
+    register 'SuckerPunch', 'sucker_punch', SuckerPunchSpy.new
+  end
+end

data/lib/atatus/spies/tilt.rb

@@ -1,3 +1,20 @@
+# 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
@@ -8,7 +25,8 @@ module Atatus
       TYPE = 'template.tilt'
 
       def install
-        if defined?(::Tilt) && defined?(::Tilt::Template) 
+        if defined?(::Tilt) && defined?(::Tilt::Template)
+
           ::Tilt::Template.class_eval do
             alias render_without_apm render
 
@@ -20,6 +38,7 @@ module Atatus
               end
             end
           end
+
         end
       end
     end

data/lib/atatus/spies.rb

@@ -1,6 +1,22 @@
+# 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
 
-require 'forwardable'
 require 'atatus/util/inflector'
 
 module Atatus
@@ -64,23 +80,25 @@ module Atatus
   end
 end
 
-# @api private
-module Kernel
-  private
+unless ENV['ATATUS_SKIP_REQUIRE_PATCH'] == '1'
+  # @api private
+  module Kernel
+    private
 
-  alias require_without_apm require
+    alias require_without_apm require
 
-  def require(path)
-    res = require_without_apm(path)
+    def require(path)
+      res = require_without_apm(path)
 
-    begin
-      Atatus::Spies.hook_into(path)
-    rescue ::Exception => e
-      puts "Failed hooking into '#{path}'. Please report this at " \
-        'success@atatus.com'
-      puts e.backtrace.join("\n")
-    end
+      begin
+        Atatus::Spies.hook_into(path)
+      rescue ::Exception => e
+        puts "Failed hooking into '#{path}'. Please report this at " \
+          'success@atatus.com'
+        puts e.backtrace.join("\n")
+      end
 
-    res
+      res
+    end
   end
 end

data/lib/atatus/sql/signature.rb

@@ -0,0 +1,169 @@
+# 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
+
+require 'atatus/sql/tokenizer'
+
+module Atatus
+  module Sql
+    # @api private
+    class Signature
+      include Tokens
+
+      # Mostly here to provide a similar API to new SqlSummarizer for easier
+      # swapping out
+      #
+      # @api private
+      class Summarizer
+        def summarize(sql)
+          Signature.parse(sql)
+        end
+      end
+
+      def initialize(sql)
+        @sql = sql
+        @tokenizer = Tokenizer.new(sql)
+      end
+
+      def parse
+        @tokenizer.scan # until tokenizer.token != COMMENT
+
+        parsed = parse_tokens
+        return parsed if parsed
+
+        # If all else fails, just return the first token of the query.
+        parts = @sql.split
+        return '' unless parts.any?
+
+        parts.first.upcase
+      end
+
+      def self.parse(sql)
+        new(sql).parse
+      end
+
+      private
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def parse_tokens
+        t = @tokenizer
+
+        case t.token
+
+        when CALL
+          return unless scan_until IDENT
+          "CALL #{t.text}"
+
+        when DELETE
+          return unless scan_until FROM
+          return unless scan_token IDENT
+          table = scan_dotted_identifier
+          "DELETE FROM #{table}"
+
+        when INSERT, REPLACE
+          action = t.text
+          return unless scan_until INTO
+          return unless scan_token IDENT
+          table = scan_dotted_identifier
+          "#{action} INTO #{table}"
+
+        when SELECT
+          level = 0
+          while t.scan
+            case t.token
+            when LPAREN then level += 1
+            when RPAREN then level -= 1
+            when FROM
+              next unless level == 0
+              break unless scan_token IDENT
+              table = scan_dotted_identifier
+              return "SELECT FROM #{table}"
+            end
+          end
+
+        when UPDATE
+          # Scan for the table name. Some dialects allow option keywords before
+          # the table name.
+          return 'UPDATE' unless scan_token IDENT
+
+          table = t.text
+
+          period = false
+          first_period = false
+
+          while t.scan
+            case t.token
+            when IDENT
+              if period
+                table += t.text
+                period = false
+              end
+
+              unless first_period
+                table = t.text
+              end
+
+              # Two adjacent identifiers found after the first period. Ignore
+              # the secondary ones, in case they are unknown keywords.
+            when PERIOD
+              period = true
+              first_period = true
+              table += '.'
+            else
+              return "UPDATE #{table}"
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      # Scans until finding token of `kind`
+      def scan_until(kind)
+        while @tokenizer.scan
+          break true if @tokenizer.token == kind
+          false
+        end
+      end
+
+      # Scans next token, ignoring comments
+      # Returns whether next token is of `kind`
+      def scan_token(kind)
+        while @tokenizer.scan
+          next if @tokenizer.token == COMMENT
+          break
+        end
+
+        return true if @tokenizer.token == kind
+
+        false
+      end
+
+      def scan_dotted_identifier
+        table = @tokenizer.text
+
+        while scan_token(PERIOD) && scan_token(IDENT)
+          table += ".#{@tokenizer.text}"
+        end
+
+        table
+      end
+    end
+  end
+end