elastic-apm 3.7.0 → 3.11.0

data/lib/elastic_apm/metadata/service_info.rb

@@ -30,14 +30,17 @@ module ElasticAPM
 
         attr_reader :name, :version
       end
+
       class Agent < Versioned; end
       class Framework < Versioned; end
       class Language < Versioned; end
       class Runtime < Versioned; end
+
       def initialize(config)
         @config = config
 
         @name = @config.service_name
+        @node_name = @config.service_node_name
         @environment = @config.environment
         @agent = Agent.new(name: 'ruby', version: VERSION)
         @framework = Framework.new(
@@ -49,8 +52,8 @@ module ElasticAPM
         @version = @config.service_version || Util.git_sha
       end
 
-      attr_reader :name, :environment, :agent, :framework, :language, :runtime,
-        :version
+      attr_reader :name, :node_name, :environment, :agent, :framework, :language,
+        :runtime, :version
 
       private
 

data/lib/elastic_apm/metadata/system_info.rb

@@ -24,7 +24,7 @@ module ElasticAPM
       def initialize(config)
         @config = config
 
-        @hostname = @config.hostname || `hostname`.chomp
+        @hostname = @config.hostname || self.class.system_hostname
         @architecture = gem_platform.cpu
         @platform = gem_platform.os
 
@@ -35,11 +35,13 @@ module ElasticAPM
 
       attr_reader :hostname, :architecture, :platform, :container, :kubernetes
 
-      private
-
       def gem_platform
         @gem_platform ||= Gem::Platform.local
       end
+
+      def self.system_hostname
+        @system_hostname ||= `hostname`.chomp
+      end
     end
   end
 end

data/lib/elastic_apm/metadata/system_info/container_info.rb

@@ -81,8 +81,14 @@ module ElasticAPM
             ENV.fetch('KUBERNETES_POD_UID', kubernetes_pod_uid)
         end
 
-        CONTAINER_ID_REGEX = /^[0-9A-Fa-f]{64}$/.freeze
-        KUBEPODS_REGEX = %r{(?:^/kubepods/[^/]+/pod([^/]+)$)|(?:^/kubepods\.slice/kubepods-[^/]+\.slice/kubepods-[^/]+-pod([^/]+)\.slice$)}.freeze # rubocop:disable Metrics/LineLength
+        CONTAINER_ID_REGEXES = [
+          %r{^[[:xdigit:]]{64}$},
+          %r{^[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4,}$}
+        ]
+        KUBEPODS_REGEXES = [
+          %r{(?:^/kubepods[^\s]*/pod([^/]+)$)},
+          %r{(?:^/kubepods\.slice/kubepods-[^/]+\.slice/kubepods-[^/]+-pod([^/]+)\.slice$)}
+        ]
         SYSTEMD_SCOPE_SUFFIX = '.scope'
 
         # rubocop:disable Metrics/PerceivedComplexity
@@ -118,18 +124,36 @@ module ElasticAPM
               end
             end
 
-            if (kubepods_match = KUBEPODS_REGEX.match(directory))
+            if (kubepods_match = match_kubepods(directory))
               pod_id = kubepods_match[1] || kubepods_match[2]
 
               self.container_id = container_id
               self.kubernetes_pod_uid = pod_id
-            elsif CONTAINER_ID_REGEX.match(container_id)
+            elsif match_container(container_id)
               self.container_id = container_id
             end
           end
         end
         # rubocop:enable Metrics/PerceivedComplexity
         # rubocop:enable Metrics/CyclomaticComplexity
+
+        def match_kubepods(directory)
+          KUBEPODS_REGEXES.each do |r|
+            next unless (match = r.match(directory))
+            return match
+          end
+
+          nil
+        end
+
+        def match_container(container_id)
+          CONTAINER_ID_REGEXES.each do |r|
+            next unless (match = r.match(container_id))
+            return match
+          end
+
+          nil
+        end
       end
     end
   end

data/lib/elastic_apm/middleware.rb

@@ -59,9 +59,15 @@ module ElasticAPM
     end
 
     def path_ignored?(env)
-      config.ignore_url_patterns.any? do |r|
-        env['PATH_INFO'].match r
+      return true if config.ignore_url_patterns.any? do |r|
+        r.match(env['PATH_INFO'])
       end
+
+      return true if config.transaction_ignore_urls.any? do |r|
+        r.match(env['PATH_INFO'])
+      end
+
+      false
     end
 
     def start_transaction(env)

data/lib/elastic_apm/opentracing.rb

@@ -39,7 +39,7 @@ module ElasticAPM
         @span_context
       end
 
-      def set_label(key, val)
+      def set_tag(key, val)
         if elastic_span.is_a?(Transaction)
           case key.to_s
           when 'type'
@@ -54,6 +54,8 @@ module ElasticAPM
         else
           elastic_span.context.labels[key] = val
         end
+
+        self
       end
 
       def set_baggage_item(_key, _value)
@@ -78,18 +80,12 @@ module ElasticAPM
           ElasticAPM.report_message message
         end
       end
-
       # rubocop:enable Lint/UnusedMethodArgument
-      def finish(clock_end: Util.monotonic_micros, end_time: nil)
-        return unless (agent = ElasticAPM.agent)
 
-        if end_time
-          warn '[ElasticAPM] DEPRECATED: Setting a custom end time as a ' \
-            '`Time` is deprecated. Use `clock_end:` and monotonic time instead.'
-          clock_end = end_time
-        end
+      def finish(end_time: Time.now)
+        return unless (agent = ElasticAPM.agent)
 
-        elastic_span.done clock_end: clock_end
+        elastic_span.done clock_end: Util.micros(end_time)
 
         case elastic_span
         when ElasticAPM::Transaction
@@ -114,6 +110,8 @@ module ElasticAPM
 
     # @api private
     class SpanContext
+      extend Forwardable
+
       def initialize(trace_context:, baggage: nil)
         if baggage
           ElasticAPM.agent.config.logger.warn(
@@ -125,10 +123,27 @@ module ElasticAPM
       end
 
       attr_accessor :trace_context
+      def_delegators :trace_context, :trace_id, :id, :parent_id
+
+      def self.from_header(header)
+        return unless header
+
+        trace_context = ElasticAPM::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
@@ -210,7 +225,7 @@ module ElasticAPM
         child_of: nil,
         references: nil,
         start_time: Time.now,
-        labels: {},
+        tags: {},
         ignore_active_scope: false,
         finish_on_close: true,
         **
@@ -220,14 +235,14 @@ module ElasticAPM
           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
@@ -243,7 +258,7 @@ module ElasticAPM
         child_of: nil,
         references: nil,
         start_time: Time.now,
-        labels: {},
+        tags: {},
         ignore_active_scope: false,
         **
       )
@@ -280,7 +295,7 @@ module ElasticAPM
         span_context ||=
           SpanContext.from_trace_context(elastic_span.trace_context)
 
-        labels.each do |key, value|
+        tags.each do |key, value|
           elastic_span.context.labels[key] = value
         end
 
@@ -293,7 +308,7 @@ module ElasticAPM
 
       def inject(span_context, format, carrier)
         case format
-        when ::OpenTracing::FORMAT_RACK
+        when ::OpenTracing::FORMAT_RACK, ::OpenTracing::FORMAT_TEXT_MAP
           carrier['elastic-apm-traceparent'] =
             span_context.traceparent.to_header
         else
@@ -304,10 +319,16 @@ module ElasticAPM
       def extract(format, carrier)
         case format
         when ::OpenTracing::FORMAT_RACK
-          ElasticAPM::TraceContext
-            .parse(carrier['HTTP_ELASTIC_APM_TRACEPARENT'])
+          SpanContext.from_header(
+            carrier['HTTP_ELASTIC_APM_TRACEPARENT']
+          )
+        when ::OpenTracing::FORMAT_TEXT_MAP
+          SpanContext.from_header(
+            carrier['elastic-apm-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 ElasticAPM::TraceContext::InvalidTraceparentHeader
@@ -321,9 +342,12 @@ module ElasticAPM
         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)
@@ -344,7 +368,7 @@ module ElasticAPM
       def context_from_active_scope(ignore_active_scope)
         if ignore_active_scope
           ElasticAPM.agent&.config&.logger&.warn(
-            'ignore_active_scope might lead to unexpeced results'
+            'ignore_active_scope might lead to unexpected results'
           )
           return
         end

data/lib/elastic_apm/span.rb

@@ -38,7 +38,8 @@ module ElasticAPM
       action: nil,
       context: nil,
       stacktrace_builder: nil,
-      sync: nil
+      sync: nil,
+      sample_rate: nil
     )
       @name = name
 
@@ -53,6 +54,7 @@ module ElasticAPM
       @transaction = transaction
       @parent = parent
       @trace_context = trace_context || parent.trace_context.child
+      @sample_rate = transaction.sample_rate
 
       @context = context || Span::Context.new(sync: sync)
       @stacktrace_builder = stacktrace_builder
@@ -73,6 +75,7 @@ module ElasticAPM
       :context,
       :duration,
       :parent,
+      :sample_rate,
       :self_time,
       :stacktrace,
       :timestamp,
@@ -97,11 +100,12 @@ module ElasticAPM
 
     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?

data/lib/elastic_apm/spies.rb

@@ -80,23 +80,25 @@ module ElasticAPM
   end
 end
 
-# @api private
-module Kernel
-  private
+unless ENV['ELASTIC_APM_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
-      ElasticAPM::Spies.hook_into(path)
-    rescue ::Exception => e
-      puts "Failed hooking into '#{path}'. Please report this at " \
-        'github.com/elastic/apm-agent-ruby'
-      puts e.backtrace.join("\n")
-    end
+      begin
+        ElasticAPM::Spies.hook_into(path)
+      rescue ::Exception => e
+        puts "Failed hooking into '#{path}'. Please report this at " \
+          'github.com/elastic/apm-agent-ruby'
+        puts e.backtrace.join("\n")
+      end
 
-    res
+      res
+    end
   end
 end

data/lib/elastic_apm/spies/delayed_job.rb

@@ -41,10 +41,10 @@ module ElasticAPM
         job_name = name_from_payload(job.payload_object)
         transaction = ElasticAPM.start_transaction(job_name, TYPE)
         job.invoke_job_without_apm(*args, &block)
-        transaction.done 'success'
+        transaction&.done 'success'
       rescue ::Exception => e
         ElasticAPM.report(e, handled: false)
-        transaction.done 'error'
+        transaction&.done 'error'
         raise
       ensure
         ElasticAPM.end_transaction
@@ -53,6 +53,8 @@ module ElasticAPM
       def self.name_from_payload(payload_object)
         if payload_object.is_a?(::Delayed::PerformableMethod)
           performable_method_name(payload_object)
+        elsif payload_object.class.name == 'ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper'
+          payload_object.job_data['job_class']
         else
           payload_object.class.name
         end

data/lib/elastic_apm/spies/dynamo_db.rb

@@ -0,0 +1,58 @@
+# 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 ElasticAPM
+  # @api private
+  module Spies
+    # @api private
+    class DynamoDBSpy
+      def self.without_net_http
+        return yield unless defined?(NetHTTPSpy)
+
+        ElasticAPM::Spies::NetHTTPSpy.disable_in do
+          yield
+        end
+      end
+
+      def install
+        ::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 = {}|
+              ElasticAPM.with_span(operation_name, 'db', subtype: 'dynamodb', action: operation_name) do
+                ElasticAPM::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
+
+    register(
+      'Aws::DynamoDB::Client',
+      'aws-sdk-dynamodb',
+      DynamoDBSpy.new
+    )
+  end
+end