atatus 1.3.0 → 1.4.0

data/lib/atatus/normalizers/rails/action_controller.rb

@@ -0,0 +1,44 @@
+# 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 Normalizers
+    module ActionController
+      # @api private
+      class ProcessActionNormalizer < Normalizer
+        register 'process_action.action_controller'
+
+        TYPE = 'app'
+        SUBTYPE = 'controller'
+        ACTION = 'action'
+
+        def normalize(transaction, _name, payload)
+          transaction.name = endpoint(payload)
+          [transaction.name, TYPE, SUBTYPE, ACTION, nil]
+        end
+
+        private
+
+        def endpoint(payload)
+          "#{payload[:controller]}##{payload[:action]}"
+        end
+      end
+    end
+  end
+end

data/lib/atatus/normalizers/rails/action_mailer.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
+  module Normalizers
+    module ActionMailer
+      # @api private
+      class ProcessActionNormalizer < Normalizer
+        register 'process.action_mailer'
+
+        TYPE = 'app'
+        SUBTYPE = 'mailer'
+        ACTION = 'action'
+
+        def normalize(_transaction, _name, payload)
+          [endpoint(payload), TYPE, SUBTYPE, ACTION, nil]
+        end
+
+        private
+
+        def endpoint(payload)
+          "#{payload[:mailer]}##{payload[:action]}"
+        end
+      end
+    end
+  end
+end

data/lib/atatus/normalizers/{action_view.rb → rails/action_view.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/normalizers/rails/active_record.rb

@@ -0,0 +1,80 @@
+# 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'
+
+module Atatus
+  module Normalizers
+    module ActiveRecord
+      # @api private
+      class SqlNormalizer < Normalizer
+        register 'sql.active_record'
+
+        TYPE = 'db'
+        ACTION = 'sql'
+        SKIP_NAMES = %w[SCHEMA CACHE].freeze
+        UNKNOWN = 'unknown'
+
+        def initialize(*args)
+          super
+
+          @summarizer = Sql.summarizer
+
+          @adapters = {}
+        end
+
+        def normalize(_transaction, _name, payload)
+          return :skip if SKIP_NAMES.include?(payload[:name])
+
+          name = summarize(payload[:sql]) || payload[:name]
+          subtype = subtype_for(payload)
+
+          context =
+            Span::Context.new(
+              db: { statement: payload[:sql], type: 'sql' },
+              destination: { name: subtype, resource: subtype, type: TYPE }
+            )
+
+          [name, TYPE, subtype, ACTION, context]
+        end
+
+        private
+
+        def subtype_for(payload)
+          cached_adapter_name(
+            payload[:connection]&.adapter_name ||
+              ::ActiveRecord::Base.connection_config[:adapter]
+          )
+        end
+
+        def summarize(sql)
+          @summarizer.summarize(sql)
+        end
+
+        def cached_adapter_name(adapter_name)
+          return UNKNOWN if adapter_name.nil? || adapter_name.empty?
+          @adapters[adapter_name] ||
+            (@adapters[adapter_name] = adapter_name.downcase)
+        rescue StandardError
+          nil
+        end
+      end
+    end
+  end
+end

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