atatus 1.3.0 → 1.4.0

data/lib/atatus/span/context/destination.rb

@@ -0,0 +1,77 @@
+# 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
+  class Span
+    class Context
+      # @api private
+      class Destination
+        def initialize(
+          name: nil,
+          resource: nil,
+          type: nil,
+          address: nil,
+          port: nil
+        )
+          @name = name
+          @resource = resource
+          @type = type
+          @address = address
+          @port = port
+        end
+
+        attr_reader(
+          :name,
+          :resource,
+          :type,
+          :address,
+          :port
+        )
+
+        def self.from_uri(uri_or_str, type: 'external', port: nil)
+          uri = normalize(uri_or_str)
+
+          new(
+            name: only_scheme_and_host(uri),
+            resource: "#{uri.host}:#{uri.port}",
+            type: type,
+            address: uri.hostname,
+            port: port || uri.port
+          )
+        end
+
+        def self.only_scheme_and_host(uri_or_str)
+          uri = normalize(uri_or_str)
+          uri.path = ''
+          uri.password = uri.query = uri.fragment = nil
+          uri.to_s
+        end
+
+        class << self
+          private
+
+          def normalize(uri_or_str)
+            return uri_or_str.dup if uri_or_str.is_a?(URI)
+            URI(uri_or_str)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/atatus/span/context/http.rb

@@ -0,0 +1,43 @@
+# 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
+  class Span
+    class Context
+      # @api private
+      class Http
+        def initialize(url: nil, status_code: nil, method: nil)
+          @url = sanitize_url(url)
+          @status_code = status_code
+          @method = method
+        end
+
+        attr_accessor :url, :status_code, :method
+
+        private
+
+        def sanitize_url(uri_or_str)
+          uri = uri_or_str.is_a?(URI) ? uri_or_str.dup : URI(uri_or_str)
+          uri.password = nil
+          uri.to_s
+        end
+      end
+    end
+  end
+end

data/lib/atatus/span_helpers.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
@@ -50,4 +67,4 @@ module Atatus
       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/spies/action_dispatch.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
@@ -6,15 +23,19 @@ module Atatus
     # @api private
     class ActionDispatchSpy
       def install
-        ::ActionDispatch::ShowExceptions.class_eval do
-          alias render_exception_without_apm render_exception
+        if defined?(::ActionDispatch) && defined?(::ActionDispatch::ShowExceptions)
+
+          ::ActionDispatch::ShowExceptions.class_eval do
+            alias render_exception_without_apm render_exception
 
-          def render_exception(env, exception)
-            context = Atatus.build_context(rack_env: env, for_type: :error)
-            Atatus.report(exception, context: context, handled: false)
+            def render_exception(env, exception)
+              context = Atatus.build_context(rack_env: env, for_type: :error)
+              Atatus.report(exception, context: context, handled: false)
 
-            render_exception_without_apm env, exception
+              render_exception_without_apm env, exception
+            end
           end
+
         end
       end
     end

data/lib/atatus/spies/delayed_job.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,13 +27,17 @@ module Atatus
       TYPE = 'Delayed::Job'
 
       def install
-        ::Delayed::Backend::Base.class_eval do
-          alias invoke_job_without_apm invoke_job
+        if defined?(::Delayed) && defined?(::Delayed::Backend) && defined?(::Delayed::Backend::Base)
+
+          ::Delayed::Backend::Base.class_eval do
+            alias invoke_job_without_apm invoke_job
 
-          def invoke_job(*args, &block)
-            ::Atatus::Spies::DelayedJobSpy
-              .invoke_job(self, *args, &block)
+            def invoke_job(*args, &block)
+              ::Atatus::Spies::DelayedJobSpy
+                .invoke_job(self, *args, &block)
+            end
           end
+
         end
       end
 

data/lib/atatus/spies/dynamo_db.rb

@@ -0,0 +1,62 @@
+# 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 DynamoDBSpy
+      def self.without_net_http
+        return yield unless defined?(NetHTTPSpy)
+
+        Atatus::Spies::NetHTTPSpy.disable_in do
+          yield
+        end
+      end
+
+      def install
+        if defined?(::Aws) && defined?(::Aws::DynamoDB) && defined?(::Aws::DynamoDB::Client)
+
+          ::Aws::DynamoDB::Client.class_eval do
+            # Alias all available operations
+            api.operation_names.each do |operation_name|
+              alias :"#{operation_name}_without_apm" :"#{operation_name}"
+
+              define_method(operation_name) do |params = {}, options = {}|
+                Atatus.with_span(operation_name, 'db', subtype: 'dynamodb', action: operation_name) do
+                  Atatus::Spies::DynamoDBSpy.without_net_http do
+                    original_method = method("#{operation_name}_without_apm")
+                    original_method.call(params, options)
+                  end
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+
+    register(
+      'Aws::DynamoDB::Client',
+      'aws-sdk-dynamodb',
+      DynamoDBSpy.new
+    )
+  end
+end

data/lib/atatus/spies/elasticsearch.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
@@ -6,9 +23,13 @@ module Atatus
     # @api private
     class ElasticsearchSpy
       NAME_FORMAT = '%s %s'
-      TYPE = 'db.elasticsearch'
+      TYPE = 'db'
+      SUBTYPE = 'elasticsearch'
+
+      def self.sanitizer
+        @sanitizer ||= Atatus::Transport::Filters::HashSanitizer.new
+      end
 
-      # rubocop:disable Metrics/MethodLength
       def install
         if defined?(::Elasticsearch) &&
             defined?(::Elasticsearch::Transport) &&
@@ -18,18 +39,43 @@ module Atatus
             alias perform_request_without_apm perform_request
 
             def perform_request(method, path, *args, &block)
+              unless Atatus.current_transaction
+                return perform_request_without_apm(method, path, *args, &block)
+              end
+
               name = format(NAME_FORMAT, method, path)
-              statement = args[0].is_a?(String) ? args[0] : args[0].to_json
-              context = Span::Context.new(db: { statement: statement })
+              statement = []
 
-              Atatus.with_span name, TYPE, context: context do
-                perform_request_without_apm(method, path, *args, &block)
+              statement << { params: args&.[](0) }
+
+              if Atatus.agent.config.capture_elasticsearch_queries
+                unless args[1].nil? || args[1].empty?
+                  statement << {
+                    body: Atatus::Spies::ElasticsearchSpy.sanitizer.strip_from!(args[1])
+                  }
+                end
               end
+
+              context = Span::Context.new(
+                db: { statement: statement.reduce({}, :merge).to_json },
+                destination: {
+                  name: SUBTYPE,
+                  resource: SUBTYPE,
+                  type: TYPE
+                }
+              )
+
+              Atatus.with_span(
+                name,
+                TYPE,
+                subtype: SUBTYPE,
+                context: context
+              ) { perform_request_without_apm(method, path, *args, &block) }
             end
           end
+
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
 
     register(