atatus 1.7.0 → 2.0.0

data/lib/atatus/opentracing.rb

@@ -123,13 +123,15 @@ module Atatus
       end
 
       attr_accessor :trace_context
+
       def_delegators :trace_context, :trace_id, :id, :parent_id
 
       def self.from_header(header)
         return unless header
 
-        trace_context = Atatus::TraceContext.parse(header)
-        return unless trace_context
+        trace_context = TraceContext.new(
+          traceparent: TraceContext::Traceparent.parse(header)
+        )
 
         trace_context.traceparent.id = trace_context.parent_id
         trace_context.traceparent.parent_id = nil
@@ -345,7 +347,7 @@ module Atatus
         context = context_from_child_of(child_of) ||
                   context_from_references(references) ||
                   context_from_active_scope(ignore_active_scope)
-        return context.child if context&.respond_to?(:child)
+        return context.child if context.respond_to?(:child)
 
         context
       end

data/lib/atatus/rails.rb

@@ -51,7 +51,7 @@ module Atatus
     rescue StandardError => e
       if config.disable_start_message?
         config.logger.error format('Failed to start: %s', e.message)
-        config.logger.error "Backtrace:\n" + e.backtrace.join("\n")
+        config.logger.debug "Backtrace:\n" + e.backtrace.join("\n")
       else
         puts format('Failed to start: %s', e.message)
         puts "Backtrace:\n" + e.backtrace.join("\n")

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

@@ -30,7 +30,7 @@ module Atatus
           rows_affected: nil
         )
           @instance = instance
-          @statement = statement
+          @statement = statement&.encode('utf-8', invalid: :replace, undef: :replace)
           @type = type
           @user = user
           @rows_affected = rows_affected

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

@@ -14,7 +14,7 @@
 # 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
@@ -22,47 +22,53 @@ module Atatus
     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
+        include Fields
+
+        field :address
+        field :port
+        field :service
+        field :cloud
+
+        # @api private
+        class Service
+          include Fields
+
+          field :name, default: ''
+          field :type, default: ''
+          field :resource
+        end
+
+        # @api private
+        class Cloud
+          include Fields
+
+          field :region
         end
 
-        attr_reader(
-          :name,
-          :resource,
-          :type,
-          :address,
-          :port
-        )
+        def initialize(service: nil, cloud: nil, **attrs)
+          super(**attrs)
+
+          self.service = build_service(service)
+          self.cloud = build_cloud(cloud)
+        end
 
-        def self.from_uri(uri_or_str, type: 'external', port: nil)
+        def self.from_uri(uri_or_str, type: nil, **attrs)
           uri = normalize(uri_or_str)
 
+          service =
+            case type
+            when 'http' then http_service(uri)
+            else nil
+            end
+
           new(
-            name: only_scheme_and_host(uri),
-            resource: "#{uri.host}:#{uri.port}",
-            type: type,
             address: uri.hostname,
-            port: port || uri.port
+            port: uri.port,
+            service: service,
+            **attrs
           )
         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
 
@@ -70,6 +76,26 @@ module Atatus
             return uri_or_str.dup if uri_or_str.is_a?(URI)
             URI(uri_or_str)
           end
+
+          def http_service(uri)
+            Service.new(resource: "#{uri.host}:#{uri.port}")
+          end
+        end
+
+        private
+
+        def build_cloud(cloud = nil)
+          return Cloud.new unless cloud
+          return cloud if cloud.is_a?(Cloud)
+
+          Cloud.new(**cloud)
+        end
+
+        def build_service(service = nil)
+          return Service.new unless service
+          return service if service.is_a?(Service)
+
+          Service.new(**service)
         end
       end
     end

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

@@ -33,6 +33,8 @@ module Atatus
         private
 
         def sanitize_url(uri_or_str)
+          return unless uri_or_str
+
           uri = uri_or_str.is_a?(URI) ? uri_or_str.dup : URI(uri_or_str)
           uri.password = nil
           uri.to_s

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

@@ -0,0 +1,32 @@
+# 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 Links < Array
+          # @api private
+          class Link < Struct.new(:trace_id, :span_id)
+          end
+        end
+      end
+    end
+  end
+  

data/lib/atatus/{sql.rb → span/context/message.rb}

@@ -18,19 +18,23 @@
 # frozen_string_literal: true
 
 module Atatus
-  # @api private
-  module Sql
-    # This method is only here as a shortcut while the agent ships with
-    # both implementations ~mikker
-    def self.summarizer
-      @summarizer ||=
-        if Atatus.agent&.config&.use_legacy_sql_parser
-          require 'atatus/sql_summarizer'
-          SqlSummarizer.new
-        else
-          require 'atatus/sql/signature'
-          Sql::Signature::Summarizer.new
+  class Span
+    class Context
+      # @api private
+      class Message
+        def initialize(
+          queue_name: nil,
+          age_ms: nil
+        )
+          @queue_name = queue_name
+          @age_ms = age_ms
         end
+
+        attr_reader(
+          :queue_name,
+          :age_ms
+        )
+      end
     end
   end
 end

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

@@ -0,0 +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
+    class Context
+      # @api private
+      class Service
+        include Fields
+
+        field :target
+
+        # @api private
+        class Target
+          include Fields
+
+          field :name, default: ''
+          field :type, default: ''
+        end
+
+        def initialize(target: nil, **attrs)
+          super(**attrs)
+
+          self.target = build_target(target)
+        end
+
+        private
+
+        def build_target(target = nil)
+          return Target.new unless target
+          return target if target.is_a?(Target)
+
+          Target.new(**target)
+        end
+      end
+    end
+  end
+end
+  

data/lib/atatus/span/context.rb

@@ -26,7 +26,10 @@ module Atatus
         destination: nil,
         http: nil,
         labels: {},
-        sync: nil
+        sync: nil,
+        message: nil,
+        service: nil,
+        links: nil
       )
         @sync = sync
         @db = db && Db.new(**db)
@@ -36,16 +39,34 @@ module Atatus
           when Destination then destination
           when Hash then Destination.new(**destination)
           end
+        @message =
+          case message
+          when Message then message
+          when Hash then Message.new(**message)
+          end
         @labels = labels
+        @service =
+          case service
+          when Service then service
+          when Hash then Service.new(**service)
+          end
+        @links =
+          case links
+          when Links then links
+          when Array then Links.new(links)
+          end
       end
 
       attr_reader(
         :db,
-        :destination,
         :http,
         :labels,
-        :sync
+        :sync,
+        :message,
+        :links
       )
+
+      attr_accessor :destination, :service
     end
   end
 end
@@ -53,3 +74,7 @@ end
 require 'atatus/span/context/db'
 require 'atatus/span/context/http'
 require 'atatus/span/context/destination'
+require 'atatus/span/context/message'
+require 'atatus/span/context/service'
+require 'atatus/span/context/links'
+

data/lib/atatus/span.rb

@@ -25,8 +25,18 @@ module Atatus
     extend Forwardable
     include ChildDurations::Methods
 
-    DEFAULT_TYPE = 'Custom'
-    DEFAULT_SUBTYPE = 'Ruby'
+    # @api private
+    class Outcome
+      FAILURE = "failure"
+      SUCCESS = "success"
+      UNKNOWN = "unknown"
+
+      def self.from_http_status(code)
+        code.to_i >= 400 ? FAILURE : SUCCESS
+      end
+    end
+
+    DEFAULT_TYPE = 'custom'
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(
@@ -40,7 +50,7 @@ module Atatus
       context: nil,
       stacktrace_builder: nil,
       sync: nil,
-      sample_rate: nil
+      exit_span: false
     )
       @name = name
 
@@ -48,7 +58,7 @@ module Atatus
         @type, @subtype, @action = type.split('.')
       else
         @type = type || DEFAULT_TYPE
-        @subtype = subtype || DEFAULT_SUBTYPE
+        @subtype = subtype
         @action = action
       end
 
@@ -60,6 +70,8 @@ module Atatus
 
       @context = context || Span::Context.new(sync: sync)
       @stacktrace_builder = stacktrace_builder
+
+      @exit_span = exit_span
     end
     # rubocop:enable Metrics/ParameterLists
 
@@ -67,8 +79,10 @@ module Atatus
 
     attr_accessor(
       :action,
+      :exit_span,
       :name,
       :original_backtrace,
+      :outcome,
       :subtype,
       :trace_context,
       :type
@@ -85,6 +99,8 @@ module Atatus
       :transaction_id
     )
 
+    alias :exit_span? :exit_span
+
     # life cycle
 
     def start(clock_start = Util.monotonic_micros)
@@ -98,6 +114,7 @@ module Atatus
       @duration ||= (clock_end - @clock_start)
       @parent.child_stopped
       @self_time = @duration - child_durations.duration
+
       self
     end
 
@@ -123,12 +140,25 @@ module Atatus
       started? && !stopped?
     end
 
-    # relations
+    def set_destination(address: nil, port: nil, service: nil, cloud: nil)
+      context.destination = Span::Context::Destination.new(
+        address: address,
+        port: port,
+        service: service,
+        cloud: cloud
+      )
+      context.service = Span::Context::Service.new(
+        target: Span::Context::Service::Target.new(name: context.destination.service.name, type: context.destination.service.type )
+      )
+    end
 
     def inspect
       "<Atatus::Span id:#{trace_context&.id}" \
         " name:#{name.inspect}" \
         " type:#{type.inspect}" \
+        " subtype:#{subtype.inspect}" \
+        " action:#{action.inspect}" \
+        " exit_span:#{exit_span.inspect}" \
         '>'
     end
 

data/lib/atatus/span_helpers.rb

@@ -22,42 +22,31 @@ module Atatus
   module SpanHelpers
     # @api private
     module ClassMethods
-      def span_class_method(method, name = nil, type = nil, subtype = nil)
-        __span_method_on(singleton_class, method, name, type, subtype)
+      def span_class_method(method, name = nil, type = nil, **kwargs)
+        __span_method_on(singleton_class, method, name, type, **kwargs)
       end
 
-      def span_method(method, name = nil, type = nil, subtype = nil)
-        __span_method_on(self, method, name, type, subtype)
-      end
-
-      def instrument_class_method(method, name = nil, type = nil, subtype = nil)
-        __span_method_on(singleton_class, method, name, type, subtype)
-      end
-
-      def instrument_method(method, name = nil, type = nil, subtype = nil)
-        __span_method_on(self, method, name, type, subtype)
+      def span_method(method, name = nil, type = nil, **kwargs)
+        __span_method_on(self, method, name, type, **kwargs)
       end
 
       private
 
-      def __span_method_on(klass, method, name = nil, type = nil, subtype = nil)
+      def __span_method_on(klass, method, name = nil, type = nil, **kwargs)
         name ||= method.to_s
         type ||= Span::DEFAULT_TYPE
-        subtype ||= Span::DEFAULT_SUBTYPE
-
-        klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          alias :"__without_apm_#{method}" :"#{method}"
 
-          def #{method}(*args, &block)
+        klass.prepend(Module.new do
+          ruby2_keywords(define_method(method) do |*args, &block|
             unless Atatus.current_transaction
-              return __without_apm_#{method}(*args, &block)
+              return super(*args, &block)
             end
 
-            Atatus.with_span "#{name}", "#{type}", subtype: "#{subtype}" do
-              __without_apm_#{method}(*args, &block)
+            Atatus.with_span name.to_s, type.to_s, **kwargs do
+              super(*args, &block)
             end
-          end
-        RUBY
+          end)
+        end)
       end
     end
 

data/lib/atatus/spies/action_dispatch.rb

@@ -22,22 +22,19 @@ module Atatus
   module Spies
     # @api private
     class ActionDispatchSpy
-      def install
-        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)
-
-              render_exception_without_apm env, exception
-            end
-          end
+      # @api private
+      module Ext
+        def render_exception(env, exception)
+          context = Atatus.build_context(rack_env: env, for_type: :error)
+          Atatus.report(exception, context: context, handled: false)
 
+          super(env, exception)
         end
       end
+
+      def install
+        ::ActionDispatch::ShowExceptions.prepend(Ext)
+      end
     end
 
     register(