atatus 1.3.0 → 1.6.1

data/lib/atatus/span/context.rb

@@ -1,40 +1,55 @@
+# 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
     # @api private
     class Context
-      def initialize(db: nil, http: nil, labels: {})
-        @sync = true
-        @db = db && Db.new(db)
-        @http = http && Http.new(http)
+      def initialize(
+        db: nil,
+        destination: nil,
+        http: nil,
+        labels: {},
+        sync: nil
+      )
+        @sync = sync
+        @db = db && Db.new(**db)
+        @http = http && Http.new(**http)
+        @destination =
+          case destination
+          when Destination then destination
+          when Hash then Destination.new(**destination)
+          end
         @labels = labels
       end
 
-      attr_accessor :sync, :db, :http, :labels
-
-      # @api private
-      class Db
-        def initialize(instance: nil, statement: nil, type: nil, user: nil)
-          @instance = instance
-          @statement = statement
-          @type = type
-          @user = user
-        end
-
-        attr_accessor :instance, :statement, :type, :user
-      end
-
-      # @api private
-      class Http
-        def initialize(url: nil, status_code: nil, method: nil)
-          @url = url
-          @status_code = status_code
-          @method = method
-        end
-
-        attr_accessor :url, :status_code, :method
-      end
+      attr_reader(
+        :db,
+        :destination,
+        :http,
+        :labels,
+        :sync
+      )
     end
   end
 end
+
+require 'atatus/span/context/db'
+require 'atatus/span/context/http'
+require 'atatus/span/context/destination'

data/lib/atatus/span.rb

@@ -1,7 +1,21 @@
-# frozen_string_literal: true
+# 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.
 
-require 'securerandom'
-require 'forwardable'
+# frozen_string_literal: true
 
 require 'atatus/span/context'
 
@@ -9,22 +23,24 @@ module Atatus
   # @api private
   class Span
     extend Forwardable
-
-    def_delegators :@trace_context, :trace_id, :parent_id, :id
+    include ChildDurations::Methods
 
     DEFAULT_TYPE = 'Custom'
     DEFAULT_SUBTYPE = 'Ruby'
 
-    # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+    # rubocop:disable Metrics/ParameterLists
     def initialize(
       name:,
-      transaction_id:,
+      transaction:,
       trace_context:,
+      parent:,
       type: nil,
       subtype: nil,
       action: nil,
       context: nil,
-      stacktrace_builder: nil
+      stacktrace_builder: nil,
+      sync: nil,
+      sample_rate: nil
     )
       @name = name
 
@@ -36,13 +52,18 @@ module Atatus
         @action = action
       end
 
-      @transaction_id = transaction_id
-      @trace_context = trace_context
+      @transaction = transaction
+      @transaction_id = transaction.id
+      @parent = parent
+      @trace_context = trace_context || parent.trace_context.child
+      @sample_rate = transaction.sample_rate
 
-      @context = context || Span::Context.new
+      @context = context || Span::Context.new(sync: sync)
       @stacktrace_builder = stacktrace_builder
     end
-    # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
+    # rubocop:enable Metrics/ParameterLists
+
+    def_delegators :@trace_context, :trace_id, :parent_id, :id
 
     attr_accessor(
       :action,
@@ -55,8 +76,12 @@ module Atatus
     attr_reader(
       :context,
       :duration,
+      :parent,
+      :sample_rate,
+      :self_time,
       :stacktrace,
       :timestamp,
+      :transaction,
       :transaction_id
     )
 
@@ -65,21 +90,25 @@ module Atatus
     def start(clock_start = Util.monotonic_micros)
       @timestamp = Util.micros
       @clock_start = clock_start
+      @parent.child_started
       self
     end
 
     def stop(clock_end = Util.monotonic_micros)
       @duration ||= (clock_end - @clock_start)
+      @parent.child_stopped
+      @self_time = @duration - child_durations.duration
       self
     end
 
     def done(clock_end: Util.monotonic_micros)
       stop clock_end
+      self
+    end
 
+    def prepare_for_serialization!
       # build_stacktrace! if should_build_stacktrace?
       self.original_backtrace = nil # release original
-
-      self
     end
 
     def stopped?
@@ -97,7 +126,7 @@ module Atatus
     # relations
 
     def inspect
-      "<Atatus::Span id:#{id}" \
+      "<Atatus::Span id:#{trace_context&.id}" \
         " name:#{name.inspect}" \
         " type:#{type.inspect}" \
         '>'

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/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(

data/lib/atatus/spies/faraday.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
@@ -16,8 +33,6 @@ module Atatus
         end
       end
 
-      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      # rubocop:disable Metrics/BlockLength, Metrics/PerceivedComplexity
       # rubocop:disable Metrics/CyclomaticComplexity
       def install
         if defined?(::Faraday) && defined?(::Faraday::Connection)
@@ -30,42 +45,61 @@ module Atatus
                 return run_request_without_apm(method, url, body, headers, &block)
               end
 
-              host = if url_prefix.is_a?(URI) && url_prefix.host
-                       url_prefix.host
-                     elsif url.nil?
-                       tmp_request = build_request(method) do |req|
-                         yield(req) if block_given?
-                       end
-                       URI(tmp_request.path).host
-                     else
-                       URI(url).host
-                     end
+              uri = URI(build_url(url))
+
+              # If url is set inside block it isn't available until yield,
+              # so we temporarily build the request to yield. This could be a
+              # problem if the block has side effects as it will be yielded twice
+              # ~mikker
+              unless uri.host
+                tmp_request = build_request(method) do |req|
+                  yield(req) if block_given?
+                end
+                uri = URI(tmp_request.path)
+              end
+
+              host = uri.host
 
-              name = "#{method.upcase} #{host}"
+              upcased_method = method.to_s.upcase
+
+              destination = Atatus::Span::Context::Destination.from_uri(uri)
+
+              context =
+                Atatus::Span::Context.new(
+                  http: { url: uri, method: upcased_method },
+                  destination: destination
+                )
 
               Atatus.with_span(
-                name,
+                "#{upcased_method} #{host}",
                 TYPE,
                 subtype: SUBTYPE,
-                action: method.to_s
+                action: upcased_method,
+                context: context
               ) do |span|
                 Atatus::Spies::FaradaySpy.without_net_http do
                   trace_context = span&.trace_context || transaction.trace_context
 
-                  run_request_without_apm(method, url, body, headers) do |req|
-                    req['Atatus-Apm-Traceparent'] = trace_context.to_header
+                  result =
+                    run_request_without_apm(method, url, body, headers) do |req|
+                      trace_context.apply_headers { |k, v| req[k] = v }
+
+                      yield req if block_given?
+                    end
 
-                    yield req if block_given?
+                  if (http = span&.context&.http)
+                    http.status_code = result.status.to_s
                   end
+
+                  result
                 end
               end
             end
           end
+
         end
       end
       # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/BlockLength, Metrics/PerceivedComplexity
-      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
     end
 
     register 'Faraday', 'faraday', FaradaySpy.new

data/lib/atatus/spies/http.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
@@ -7,8 +24,6 @@ module Atatus
     class HTTPSpy
       TYPE = 'ext'
       SUBTYPE = 'http_rb'
-
-      # rubocop:disable Metrics/MethodLength
       def install
         if defined?(::HTTP) && defined?(::HTTP::Client)
 
@@ -23,23 +38,38 @@ module Atatus
               method = req.verb.to_s.upcase
               host = req.uri.host
 
+              destination =
+                Atatus::Span::Context::Destination.from_uri(req.uri)
+              context = Atatus::Span::Context.new(
+                http: { url: req.uri, method: method },
+                destination: destination
+              )
+
               name = "#{method} #{host}"
 
               Atatus.with_span(
                 name,
                 TYPE,
                 subtype: SUBTYPE,
-                action: method
+                action: method,
+                context: context
               ) do |span|
                 trace_context = span&.trace_context || transaction.trace_context
-                req['Atatus-Apm-Traceparent'] = trace_context.to_header
-                perform_without_apm(req, options)
+                trace_context.apply_headers { |key, value| req[key] = value }
+
+                result = perform_without_apm(req, options)
+
+                if (http = span&.context&.http)
+                  http.status_code = result.status.to_s
+                end
+
+                result
               end
             end
           end
+
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
 
     register 'HTTP', 'http', HTTPSpy.new

data/lib/atatus/spies/json.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
 
 require 'atatus/span_helpers'
@@ -16,6 +33,7 @@ module Atatus
             span_class_method :parse!, 'JSON#parse!', 'json.parse'
             span_class_method :generate, 'JSON#generate', 'json.generate'
           end
+
         end
       end
     end