atatus 1.3.0 → 1.6.1

data/lib/atatus/opentracing.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'
@@ -22,8 +39,7 @@ module Atatus
         @span_context
       end
 
-      # rubocop:disable Metrics/MethodLength
-      def set_label(key, val)
+      def set_tag(key, val)
         if atatus_span.is_a?(Transaction)
           case key.to_s
           when 'type'
@@ -38,8 +54,9 @@ module Atatus
         else
           atatus_span.context.labels[key] = val
         end
+
+        self
       end
-      # rubocop:enable Metrics/MethodLength
 
       def set_baggage_item(_key, _value)
         Atatus.agent.config.logger.warn(
@@ -65,28 +82,20 @@ module Atatus
       end
       # rubocop:enable Lint/UnusedMethodArgument
 
-      # rubocop:disable Metrics/MethodLength
-      def finish(clock_end: Util.monotonic_micros, end_time: nil)
-        return unless (instrumenter = Atatus.agent&.instrumenter)
+      def finish(end_time: Time.now)
+        return unless (agent = Atatus.agent)
 
-        if end_time
-          warn '[Atatus] DEPRECATED: Setting a custom end time as a ' \
-            '`Time` is deprecated. Use `clock_end:` and monotonic time instead.'
-          clock_end = end_time
-        end
-
-        atatus_span.done clock_end: clock_end
+        atatus_span.done clock_end: Util.micros(end_time)
 
         case atatus_span
         when Atatus::Transaction
-          instrumenter.current_transaction = nil
+          agent.instrumenter.current_transaction = nil
         when Atatus::Span
-          instrumenter.current_spans.delete(atatus_span)
+          agent.instrumenter.current_spans.delete(atatus_span)
         end
 
-        instrumenter.enqueue.call atatus_span
+        agent.enqueue atatus_span
       end
-      # rubocop:enable Metrics/MethodLength
 
       private
 
@@ -101,6 +110,8 @@ module Atatus
 
     # @api private
     class SpanContext
+      extend Forwardable
+
       def initialize(trace_context:, baggage: nil)
         if baggage
           Atatus.agent.config.logger.warn(
@@ -112,10 +123,27 @@ 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.traceparent.id = trace_context.parent_id
+        trace_context.traceparent.parent_id = nil
+
+        from_trace_context(trace_context)
+      end
 
       def self.from_trace_context(trace_context)
         new(trace_context: trace_context)
       end
+
+      def child
+        self.class.from_trace_context(trace_context.child)
+      end
     end
 
     # @api private
@@ -179,8 +207,6 @@ module Atatus
         @scope_stack.last
       end
     end
-
-    # rubocop:disable Metrics/ClassLength
     # A custom tracer to use the OpenTracing API with Atatus
     class Tracer
       def initialize
@@ -193,13 +219,13 @@ module Atatus
         scope_manager.active&.span
       end
 
-      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+      # rubocop:disable Metrics/ParameterLists
       def start_active_span(
         operation_name,
         child_of: nil,
         references: nil,
         start_time: Time.now,
-        labels: {},
+        tags: {},
         ignore_active_scope: false,
         finish_on_close: true,
         **
@@ -209,14 +235,14 @@ module Atatus
           child_of: child_of,
           references: references,
           start_time: start_time,
-          labels: labels,
+          tags: tags,
           ignore_active_scope: ignore_active_scope
         )
         scope = scope_manager.activate(span, finish_on_close: finish_on_close)
 
         if block_given?
           begin
-            yield scope
+            return yield scope
           ensure
             scope.close
           end
@@ -224,16 +250,15 @@ module Atatus
 
         scope
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+      # rubocop:enable Metrics/ParameterLists
 
-      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
-      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/ParameterLists
       def start_span(
         operation_name,
         child_of: nil,
         references: nil,
         start_time: Time.now,
-        labels: {},
+        tags: {},
         ignore_active_scope: false,
         **
       )
@@ -245,7 +270,6 @@ module Atatus
 
         if span_context
           trace_context =
-            span_context &&
             span_context.respond_to?(:trace_context) &&
             span_context.trace_context
         end
@@ -263,7 +287,7 @@ module Atatus
             )
           end
 
-        # if no Atatus APM agent is running or transaction not sampled
+        # if no Atatus agent is running or transaction not sampled
         unless atatus_span
           return ::OpenTracing::Span::NOOP_INSTANCE
         end
@@ -271,7 +295,7 @@ module Atatus
         span_context ||=
           SpanContext.from_trace_context(atatus_span.trace_context)
 
-        labels.each do |key, value|
+        tags.each do |key, value|
           atatus_span.context.labels[key] = value
         end
 
@@ -279,13 +303,14 @@ module Atatus
 
         Span.new(atatus_span, span_context)
       end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+
+      # rubocop:enable Metrics/ParameterLists
 
       def inject(span_context, format, carrier)
         case format
-        when ::OpenTracing::FORMAT_RACK
-          carrier['atatus-traceparent'] = span_context.to_header
+        when ::OpenTracing::FORMAT_RACK, ::OpenTracing::FORMAT_TEXT_MAP
+          carrier['atatus-traceparent'] =
+            span_context.traceparent.to_header
         else
           warn 'Only injection via HTTP headers and Rack is available'
         end
@@ -294,10 +319,16 @@ module Atatus
       def extract(format, carrier)
         case format
         when ::OpenTracing::FORMAT_RACK
-          Atatus::TraceContext
-            .parse(carrier['HTTP_ATATUS_APM_TRACEPARENT'])
+          SpanContext.from_header(
+            carrier['HTTP_ATATUS_TRACEPARENT']
+          )
+        when ::OpenTracing::FORMAT_TEXT_MAP
+          SpanContext.from_header(
+            carrier['atatus-traceparent']
+          )
         else
-          warn 'Only extraction from HTTP headers via Rack is available'
+          warn 'Only extraction from HTTP headers via Rack or in ' \
+            'text map format are available'
           nil
         end
       rescue Atatus::TraceContext::InvalidTraceparentHeader
@@ -311,9 +342,12 @@ module Atatus
         references:,
         ignore_active_scope:
       )
-        context_from_child_of(child_of) ||
-          context_from_references(references) ||
-          context_from_active_scope(ignore_active_scope)
+        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)
+
+        context
       end
 
       def context_from_child_of(child_of)
@@ -334,13 +368,12 @@ module Atatus
       def context_from_active_scope(ignore_active_scope)
         if ignore_active_scope
           Atatus.agent&.config&.logger&.warn(
-            'ignore_active_scope might lead to unexpeced results'
+            'ignore_active_scope might lead to unexpected results'
           )
           return
         end
         @scope_manager.active&.span&.context
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/atatus/rails.rb

@@ -1,14 +1,31 @@
+# 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/railtie'
 require 'atatus/subscriber'
+require 'atatus/normalizers/rails'
 
 module Atatus
   # Module for explicitly starting the Atatus agent and hooking into Rails.
   # It is recommended to use the Railtie instead.
   module Rails
     extend self
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
     # Start the Atatus agent and hook into Rails.
     # Note that the agent won't be started if the Rails console is being used.
     #
@@ -16,11 +33,13 @@ module Atatus
     # @return [true, nil] true if the agent was started, nil otherwise.
     def start(config)
       config = Config.new(config) unless config.is_a?(Config)
+
       if (reason = should_skip?(config))
         unless config.disable_start_message?
           config.logger.info "Skipping because: #{reason}. " \
             "Start manually with `Atatus.start'"
         end
+
         return
       end
 
@@ -28,24 +47,21 @@ module Atatus
         attach_subscriber(agent)
       end
 
-      if Atatus.running? &&
-         !Atatus.agent.config.disabled_instrumentations.include?(
-           'action_dispatch'
-         )
-        require 'atatus/spies/action_dispatch'
-      end
       Atatus.running?
     rescue StandardError => e
-      config.logger.error format('Failed to start: %s', e.message)
-      config.logger.error "Backtrace:\n" + e.backtrace.join("\n")
+      if config.disable_start_message?
+        config.logger.error format('Failed to start: %s', e.message)
+        config.logger.error "Backtrace:\n" + e.backtrace.join("\n")
+      else
+        puts format('Failed to start: %s', e.message)
+        puts "Backtrace:\n" + e.backtrace.join("\n")
+      end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     private
 
     def should_skip?(_config)
-      if ::Rails.const_defined? 'Rails::Console'
+      if ::Rails.const_defined?('Console', false)
         return 'Rails console'
       end
 

data/lib/atatus/railtie.rb

@@ -1,6 +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 'atatus/rails'
+# frozen_string_literal: true
 
 module Atatus
   # @api private
@@ -9,13 +24,11 @@ module Atatus
 
     Config.schema.each do |key, args|
       next unless args.length > 1
-      config.atatus[key] = args.last[:default]
+      config.atatus[key] = args[:default]
     end
 
     initializer 'atatus.initialize' do |app|
-      config = Config.new(app.config.atatus).tap do |c|
-        c.app = app
-
+      config = Config.new(app.config.atatus.merge(app: app)).tap do |c|
         # Prepend Rails.root to log_path if present
         if c.log_path && !c.log_path.start_with?('/')
           c.log_path = ::Rails.root.join(c.log_path)

data/lib/atatus/resque.rb

@@ -0,0 +1,29 @@
+# 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
+  # Defines a before_first_fork hook for starting the Atatus agent
+  # with Resque.
+  module Resque
+    ::Resque.before_first_fork do
+      ::Resque.logger.debug('Starting Atatus agent')
+      Atatus.start
+    end
+  end
+end

data/lib/atatus/sinatra.rb

@@ -0,0 +1,53 @@
+# 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
+  # Module for starting the Atatus agent and hooking into Sinatra.
+  module Sinatra
+    extend self
+    # Start the Atatus agent and hook into Sinatra.
+    #
+    # @param app [Sinatra::Base] A Sinatra app.
+    # @param config [Config, Hash] An instance of Config or a Hash config.
+    # @return [true, nil] true if the agent was started, nil otherwise.
+    def start(app, config = {})
+      config = Config.new(config) unless config.is_a?(Config)
+      configure_app(app, config)
+
+      Atatus.start(config)
+      Atatus.running?
+    rescue StandardError => e
+      config.logger.error format('Failed to start: %s', e.message)
+      config.logger.debug "Backtrace:\n" + e.backtrace.join("\n")
+    end
+
+    private
+
+    def configure_app(app, config)
+      config.service_name ||= format_name(app.to_s)
+      config.framework_name ||= 'Sinatra'
+      config.framework_version ||= ::Sinatra::VERSION
+      config.__root_path ||= Dir.pwd
+    end
+
+    def format_name(str)
+      str&.gsub('::', '_')
+    end
+  end
+end

data/lib/atatus/span/context/db.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 Db
+        def initialize(
+          instance: nil,
+          statement: nil,
+          type: nil,
+          user: nil,
+          rows_affected: nil
+        )
+          @instance = instance
+          @statement = statement
+          @type = type
+          @user = user
+          @rows_affected = rows_affected
+        end
+
+        attr_accessor :instance, :statement, :type, :user, :rows_affected
+      end
+    end
+  end
+end

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