elastic-apm 3.11.0 → 3.14.0

data/lib/elastic_apm/config/log_level_map.rb

@@ -0,0 +1,47 @@
+# 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
+  class Config
+    # @api private
+    class LogLevelMap
+      LEVELS = {
+        debug: Logger::DEBUG,
+        info: Logger::INFO,
+        warn: Logger::WARN,
+        error: Logger::ERROR,
+        fatal: Logger::FATAL,
+        trace: Logger::DEBUG,
+        warning: Logger::WARN,
+        critical: Logger::FATAL,
+        off: Logger::FATAL
+      }.freeze
+
+      DEFAULT = Logger::INFO
+
+      def call(value)
+        if value.is_a?(Integer)
+          LEVELS.value?(value) ? value : DEFAULT
+        else
+          LEVELS.fetch(value.to_sym, DEFAULT)
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/context.rb

@@ -36,14 +36,9 @@ module ElasticAPM
     Service = Struct.new(:framework)
     Framework = Struct.new(:name, :version)
 
-    attr_accessor :request
-    attr_accessor :response
-    attr_accessor :user
-    attr_reader :custom
-    attr_reader :labels
-    attr_reader :service
+    attr_accessor :request, :response, :user
+    attr_reader :custom, :labels, :service
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def empty?
       return false if labels.any?
       return false if custom.any?
@@ -53,7 +48,6 @@ module ElasticAPM
 
       true
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def set_service(framework_name: nil, framework_version: nil)
       @service = Service.new(

data/lib/elastic_apm/graphql.rb

@@ -48,6 +48,7 @@ module ElasticAPM
       # "authorized" => "graphql.authorized",
     }.freeze
 
+    # rubocop:disable Style/ExplicitBlockArgument
     def self.trace(key, data)
       return yield unless KEYS_TO_NAME.key?(key)
       return yield unless (transaction = ElasticAPM.current_transaction)
@@ -69,6 +70,7 @@ module ElasticAPM
 
       results
     end
+    # rubocop:enable Style/ExplicitBlockArgument
 
     class << self
       private

data/lib/elastic_apm/grpc.rb

@@ -25,7 +25,7 @@ module ElasticAPM
       TYPE = 'external'
       SUBTYPE = 'grpc'
 
-      # rubocop:disable Lint/UnusedMethodArgument
+      # rubocop:disable Lint/UnusedMethodArgument, Style/ExplicitBlockArgument
       def request_response(request:, call:, method:, metadata:)
         return yield unless (transaction = ElasticAPM.current_transaction)
         if (trace_context = transaction.trace_context)
@@ -40,7 +40,7 @@ module ElasticAPM
           yield
         end
       end
-      # rubocop:enable Lint/UnusedMethodArgument
+      # rubocop:enable Lint/UnusedMethodArgument, Style/ExplicitBlockArgument
 
       private
 
@@ -71,7 +71,7 @@ module ElasticAPM
         transaction.done 'success'
       rescue ::Exception => e
         ElasticAPM.report(e, handled: false)
-        transaction.done 'error' if transaction
+        transaction&.done 'error'
         raise
       ensure
         ElasticAPM.end_transaction

data/lib/elastic_apm/instrumenter.rb

@@ -239,7 +239,7 @@ module ElasticAPM
     def set_label(key, value)
       return unless current_transaction
 
-      key = key.to_s.gsub(/[\."\*]/, '_').to_sym
+      key = key.to_s.gsub(/[."*]/, '_').to_sym
       current_transaction.context.labels[key] = value
     end
 

data/lib/elastic_apm/metadata/cloud_info.rb

@@ -31,7 +31,7 @@ module ElasticAPM
 
       def initialize(config)
         @config = config
-        @client = HTTP.timeout(0.1)
+        @client = HTTP.timeout(connect: 0.1, read: 0.1)
       end
 
       attr_reader :config
@@ -49,6 +49,7 @@ module ElasticAPM
         :region
       )
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       def fetch!
         case config.cloud_provider
         when "aws"
@@ -67,13 +68,14 @@ module ElasticAPM
 
         self
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       private
 
       def fetch_aws
         resp = @client.get(AWS_URI)
 
-        return unless resp.status === 200
+        return unless resp.status == 200
         return unless (metadata = JSON.parse(resp.body))
 
         self.provider = "aws"
@@ -89,7 +91,7 @@ module ElasticAPM
       def fetch_gcp
         resp = @client.headers("Metadata-Flavor" => "Google").get(GCP_URI)
 
-        return unless resp.status === 200
+        return unless resp.status == 200
         return unless (metadata = JSON.parse(resp.body))
 
         zone = metadata["instance"]["zone"]&.split("/")&.at(-1)
@@ -109,7 +111,7 @@ module ElasticAPM
       def fetch_azure
         resp = @client.headers("Metadata" => "true").get(AZURE_URI)
 
-        return unless resp.status === 200
+        return unless resp.status == 200
         return unless (metadata = JSON.parse(resp.body))
 
         self.provider = 'azure'

data/lib/elastic_apm/metadata/service_info.rb

@@ -52,8 +52,8 @@ module ElasticAPM
         @version = @config.service_version || Util.git_sha
       end
 
-      attr_reader :name, :node_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/container_info.rb

@@ -81,15 +81,23 @@ module ElasticAPM
             ENV.fetch('KUBERNETES_POD_UID', kubernetes_pod_uid)
         end
 
+        # rubocop:disable Style/RegexpLiteral
         CONTAINER_ID_REGEXES = [
           %r{^[[:xdigit:]]{64}$},
-          %r{^[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{4,}$}
-        ]
+          %r{
+            ^[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit:]]
+            {4}-[[:xdigit:]]{4}-[[:xdigit:]]{4,}$
+          }x
+        ].freeze
         KUBEPODS_REGEXES = [
           %r{(?:^/kubepods[^\s]*/pod([^/]+)$)},
-          %r{(?:^/kubepods\.slice/kubepods-[^/]+\.slice/kubepods-[^/]+-pod([^/]+)\.slice$)}
-        ]
+          %r{
+            (?:^/kubepods\.slice/(kubepods-[^/]+\.slice/)?
+             kubepods[^/]*-pod([^/]+)\.slice$)
+          }x
+        ].freeze
         SYSTEMD_SCOPE_SUFFIX = '.scope'
+        # rubocop:enable Style/RegexpLiteral
 
         # rubocop:disable Metrics/PerceivedComplexity
         # rubocop:disable Metrics/CyclomaticComplexity
@@ -125,7 +133,10 @@ module ElasticAPM
             end
 
             if (kubepods_match = match_kubepods(directory))
-              pod_id = kubepods_match[1] || kubepods_match[2]
+              unless (pod_id = kubepods_match[1])
+                pod_id = kubepods_match[2]
+                pod_id&.tr!('_', '-')
+              end
 
               self.container_id = container_id
               self.kubernetes_pod_uid = pod_id

data/lib/elastic_apm/metrics.rb

@@ -40,6 +40,7 @@ module ElasticAPM
       end
 
       attr_reader :config, :sets, :callback
+
       def start
         unless config.collect_metrics?
           debug 'Skipping metrics'

data/lib/elastic_apm/metrics/cpu_mem_set.rb

@@ -214,6 +214,7 @@ module ElasticAPM
         # @api private
         class Meminfo
           attr_reader :total, :available, :page_size
+
           # rubocop:disable Metrics/PerceivedComplexity
           # rubocop:disable Metrics/CyclomaticComplexity
           def read!

data/lib/elastic_apm/middleware.rb

@@ -41,9 +41,14 @@ module ElasticAPM
         ElasticAPM.report(e, context: context, handled: false)
         raise
       ensure
-        if resp && transaction
-          status, headers, _body = resp
-          transaction.add_response(status, headers: headers.dup)
+        if transaction
+          if resp
+            status, headers, _body = resp
+            transaction.add_response(status, headers: headers.dup)
+            transaction&.outcome = Transaction::Outcome.from_http_status(status)
+          else
+            transaction&.outcome = Transaction::Outcome::FAILURE
+          end
         end
 
         ElasticAPM.end_transaction http_result(status)

data/lib/elastic_apm/normalizers/rails/active_record.rb

@@ -57,10 +57,17 @@ module ElasticAPM
         private
 
         def subtype_for(payload)
-          cached_adapter_name(
-            payload[:connection]&.adapter_name ||
-              ::ActiveRecord::Base.connection_config[:adapter]
-          )
+          return cached_adapter_name(payload[:connection].adapter_name) if payload[:connection]
+
+          if can_attempt_connection_id_lookup?(payload)
+            begin
+              loaded_object = ObjectSpace._id2ref(payload[:connection_id])
+              return cached_adapter_name(loaded_object.adapter_name) if loaded_object.respond_to?(:adapter_name)
+            rescue RangeError # if connection object has somehow been garbage collected
+            end
+          end
+
+          cached_adapter_name(::ActiveRecord::Base.connection_config[:adapter])
         end
 
         def summarize(sql)
@@ -69,11 +76,16 @@ module ElasticAPM
 
         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
+
+        def can_attempt_connection_id_lookup?(payload)
+          RUBY_ENGINE == "ruby" && payload[:connection_id] && ObjectSpace.respond_to?(:_id2ref)
+        end
       end
     end
   end

data/lib/elastic_apm/opentracing.rb

@@ -123,6 +123,7 @@ module ElasticAPM
       end
 
       attr_accessor :trace_context
+
       def_delegators :trace_context, :trace_id, :id, :parent_id
 
       def self.from_header(header)
@@ -345,7 +346,7 @@ module ElasticAPM
         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/elastic_apm/span.rb

@@ -25,6 +25,17 @@ module ElasticAPM
     extend Forwardable
     include ChildDurations::Methods
 
+    # @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
@@ -38,8 +49,7 @@ module ElasticAPM
       action: nil,
       context: nil,
       stacktrace_builder: nil,
-      sync: nil,
-      sample_rate: nil
+      sync: nil
     )
       @name = name
 
@@ -67,6 +77,7 @@ module ElasticAPM
       :action,
       :name,
       :original_backtrace,
+      :outcome,
       :subtype,
       :trace_context,
       :type

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

@@ -30,7 +30,7 @@ module ElasticAPM
           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/elastic_apm/span/context/http.rb

@@ -33,6 +33,8 @@ module ElasticAPM
         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/elastic_apm/spies/delayed_job.rb

@@ -38,26 +38,34 @@ module ElasticAPM
       end
 
       def self.invoke_job(job, *args, &block)
-        job_name = name_from_payload(job.payload_object)
+        job_name = job_name(job)
         transaction = ElasticAPM.start_transaction(job_name, TYPE)
         job.invoke_job_without_apm(*args, &block)
         transaction&.done 'success'
+        transaction&.outcome = Transaction::Outcome::SUCCESS
       rescue ::Exception => e
         ElasticAPM.report(e, handled: false)
         transaction&.done 'error'
+        transaction&.outcome = Transaction::Outcome::FAILURE
         raise
       ensure
         ElasticAPM.end_transaction
       end
 
-      def self.name_from_payload(payload_object)
+      def self.job_name(job)
+        payload_object = job.payload_object
+
         if payload_object.is_a?(::Delayed::PerformableMethod)
           performable_method_name(payload_object)
-        elsif payload_object.class.name == 'ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper'
+        elsif payload_object.instance_of?(
+          ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper
+        )
           payload_object.job_data['job_class']
         else
           payload_object.class.name
         end
+      rescue
+        job.name
       end
 
       def self.performable_method_name(payload_object)

data/lib/elastic_apm/spies/dynamo_db.rb

@@ -25,9 +25,11 @@ module ElasticAPM
       def self.without_net_http
         return yield unless defined?(NetHTTPSpy)
 
+        # rubocop:disable Style/ExplicitBlockArgument
         ElasticAPM::Spies::NetHTTPSpy.disable_in do
           yield
         end
+        # rubocop:enable Style/ExplicitBlockArgument
       end
 
       def install
@@ -37,7 +39,12 @@ module ElasticAPM
             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.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)