atatus 1.3.0 → 1.4.0

data/lib/atatus/spies/redis.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

data/lib/atatus/spies/resque.rb

@@ -0,0 +1,57 @@
+# 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 ResqueSpy
+      TYPE = 'Resque'
+
+      def install
+        install_perform_spy
+      end
+
+      def install_perform_spy
+        if defined?(::Resque) && defined?(::Resque::Job)
+
+          ::Resque::Job.class_eval do
+            alias :perform_without_atatus :perform
+
+            def perform
+              name = @payload && @payload['class']&.to_s
+              transaction = Atatus.start_transaction(name, TYPE)
+              perform_without_atatus
+              transaction.done 'success'
+            rescue ::Exception => e
+              Atatus.report(e, handled: false)
+              transaction.done 'error' if transaction
+              raise
+            ensure
+              Atatus.end_transaction
+            end
+          end
+
+        end
+      end
+    end
+
+    register 'Resque', 'resque', ResqueSpy.new
+  end
+end

data/lib/atatus/spies/sequel.rb

@@ -1,47 +1,84 @@
+# 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_summarizer'
+require 'atatus/sql'
 
 module Atatus
   # @api private
   module Spies
     # @api private
     class SequelSpy
-      TYPE = 'db.sequel.sql'
+      TYPE = 'db'
+      ACTION = 'query'
 
       def self.summarizer
-        @summarizer ||= SqlSummarizer.new
-      end
-
-      def self.build_context(sql, opts)
-        Span::Context.new(
-          db: { statement: sql, type: 'sql', user: opts[:user] }
-        )
+        @summarizer ||= Sql.summarizer
       end
 
-      # rubocop:disable Metrics/MethodLength
       def install
         require 'sequel/database/logging'
 
         if defined?(::Sequel) && defined?(::Sequel::Database)
+
           ::Sequel::Database.class_eval do
             alias log_connection_yield_without_apm log_connection_yield
 
-            def log_connection_yield(sql, *args, &block)
+            def log_connection_yield(sql, connection, args = nil, &block)
               unless Atatus.current_transaction
-                return log_connection_yield_without_apm(sql, *args, &block)
+                return log_connection_yield_without_apm(
+                  sql, connection, args, &block
+                )
               end
 
-              summarizer = Atatus::Spies::SequelSpy.summarizer
-              name = summarizer.summarize sql
-              context = Atatus::Spies::SequelSpy.build_context(sql, opts)
+              subtype = database_type.to_s
 
-              Atatus.with_span(name, TYPE, context: context, &block)
+              name =
+                Atatus::Spies::SequelSpy.summarizer.summarize sql
+
+              context = Atatus::Span::Context.new(
+                db: { statement: sql, type: 'sql', user: opts[:user] },
+                destination: { name: subtype, resource: subtype, type: TYPE }
+              )
+
+              span = Atatus.start_span(
+                name,
+                TYPE,
+                subtype: subtype,
+                action: ACTION,
+                context: context
+              )
+              yield.tap do |result|
+                if name =~ /^(UPDATE|DELETE)/
+                  if connection.respond_to?(:changes)
+                    span.context.db.rows_affected = connection.changes
+                  elsif result.is_a?(Integer)
+                    span.context.db.rows_affected = result
+                  end
+                end
+              end
+            ensure
+              Atatus.end_span
             end
           end
+
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
 
     register 'Sequel', 'sequel', SequelSpy.new

data/lib/atatus/spies/shoryuken.rb

@@ -0,0 +1,69 @@
+# 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 ShoryukenSpy
+      # @api private
+      class Middleware
+        def call(worker_instance, queue, sqs_msg, body)
+          transaction =
+            Atatus.start_transaction(
+              job_class(worker_instance, body),
+              'shoryuken.job'
+            )
+
+          Atatus.set_label('shoryuken.id', sqs_msg.message_id)
+          Atatus.set_label('shoryuken.queue', queue)
+
+          yield
+
+          transaction&.done :success
+        rescue ::Exception => e
+          Atatus.report(e, handled: false)
+          transaction&.done :error
+          raise
+        ensure
+          Atatus.end_transaction
+        end
+
+        private
+
+        def job_class(worker_instance, body)
+          klass = body['job_class'] if body.is_a?(Hash)
+          klass || worker_instance.class.name
+        end
+      end
+
+      def install
+        if defined?(::Shoryuken)
+
+          ::Shoryuken.server_middleware do |chain|
+            chain.add Middleware
+          end
+
+        end
+      end
+    end
+
+    register 'Shoryuken', 'shoryuken', ShoryukenSpy.new
+  end
+end

data/lib/atatus/spies/sidekiq.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
@@ -10,7 +27,6 @@ module Atatus
 
       # @api private
       class Middleware
-        # rubocop:disable Metrics/MethodLength
         def call(_worker, job, queue)
           name = SidekiqSpy.name_for(job)
           transaction = Atatus.start_transaction(name, 'Sidekiq')
@@ -18,15 +34,14 @@ module Atatus
 
           yield
 
-          transaction.done :success if transaction
+          transaction&.done :success
         rescue ::Exception => e
           Atatus.report(e, handled: false)
-          transaction.done :error if transaction
+          transaction&.done :error
           raise
         ensure
           Atatus.end_transaction
         end
-        # rubocop:enable Metrics/MethodLength
       end
 
       def self.name_for(job)
@@ -41,42 +56,48 @@ module Atatus
       end
 
       def install_middleware
-        Sidekiq.configure_server do |config|
-          config.server_middleware do |chain|
-            chain.add Middleware
+        if defined?(::Sidekiq)
+
+          Sidekiq.configure_server do |config|
+            config.server_middleware do |chain|
+              chain.add Middleware
+            end
           end
+
         end
       end
 
-      # rubocop:disable Metrics/MethodLength
       def install_processor
         require 'sidekiq/processor'
 
-        Sidekiq::Processor.class_eval do
-          alias start_without_apm start
-          alias terminate_without_apm terminate
+        if defined?(::Sidekiq) && defined?(::Sidekiq::Processor)
 
-          def start
-            result = start_without_apm
+          Sidekiq::Processor.class_eval do
+            alias start_without_apm start
+            alias terminate_without_apm terminate
 
-            # Already running from Railtie if Rails
-            if Atatus.running?
-              Atatus.agent.config.logger = Sidekiq.logger
-            else
-              Atatus.start
-            end
+            def start
+              result = start_without_apm
 
-            result
-          end
+              # 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
+            def terminate
+              terminate_without_apm
 
-            Atatus.stop
+              Atatus.stop
+            end
           end
+
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       def install
         install_processor

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