elastic-apm 3.10.1 → 3.13.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/config/options.rb

@@ -38,7 +38,8 @@ module ElasticAPM
           set(value || default)
         end
 
-        attr_reader :key, :value, :default, :type
+        attr_reader :key, :default, :type, :converter
+        attr_accessor :value
 
         def set(value)
           @value = normalize(value)

data/lib/elastic_apm/config/round_float.rb

@@ -0,0 +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 'elastic_apm/util/precision_validator'
+
+module ElasticAPM
+  class Config
+    # @api private
+    class RoundFloat
+      def call(value)
+        Util::PrecisionValidator.validate(value, precision: 4, minimum: 0.0001)
+      end
+    end
+  end
+end

data/lib/elastic_apm/config/wildcard_pattern_list.rb

@@ -27,6 +27,8 @@ module ElasticAPM
           @pattern = convert(str)
         end
 
+        attr_reader :pattern
+
         def match?(other)
           !!@pattern.match(other)
         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

@@ -119,7 +119,13 @@ module ElasticAPM
           "Already inside #{transaction.inspect}"
       end
 
-      sampled = trace_context ? trace_context.recorded? : random_sample?(config)
+      if trace_context
+        sampled = trace_context.recorded?
+        sample_rate = trace_context.tracestate.sample_rate
+      else
+        sampled = random_sample?(config)
+        sample_rate = config.transaction_sample_rate
+      end
 
       transaction =
         Transaction.new(
@@ -128,6 +134,7 @@ module ElasticAPM
           context: context,
           trace_context: trace_context,
           sampled: sampled,
+          sample_rate: sample_rate,
           config: config
         )
 
@@ -232,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
 
@@ -259,7 +266,7 @@ module ElasticAPM
     end
 
     def update_transaction_metrics(transaction)
-      return unless transaction.collect_metrics
+      return unless transaction.collect_metrics?
 
       tags = {
         'transaction.name': transaction.name,
@@ -298,7 +305,7 @@ module ElasticAPM
     end
 
     def update_span_metrics(span)
-      return unless span.transaction.breakdown_metrics
+      return unless span.transaction.collect_metrics?
 
       tags = {
         'span.type': span.type,

data/lib/elastic_apm/metadata.rb

@@ -25,12 +25,14 @@ module ElasticAPM
       @process = ProcessInfo.new(config)
       @system = SystemInfo.new(config)
       @labels = config.global_labels
+      @cloud = CloudInfo.new(config).fetch!
     end
 
-    attr_reader :service, :process, :system, :labels
+    attr_reader :service, :process, :system, :cloud, :labels
   end
 end
 
 require 'elastic_apm/metadata/service_info'
 require 'elastic_apm/metadata/system_info'
 require 'elastic_apm/metadata/process_info'
+require 'elastic_apm/metadata/cloud_info'

data/lib/elastic_apm/metadata/cloud_info.rb

@@ -0,0 +1,130 @@
+# 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 "http"
+
+module ElasticAPM
+  class Metadata
+    # @api private
+    class CloudInfo
+      include Logging
+
+      AWS_URI = "http://169.254.169.254/latest/dynamic/instance-identity/document"
+      GCP_URI = "http://metadata.google.internal/computeMetadata/v1/?recursive=true"
+      AZURE_URI = "http://169.254.169.254/metadata/instance/compute?api-version=2019-08-15"
+
+      def initialize(config)
+        @config = config
+        @client = HTTP.timeout(connect: 0.1, read: 0.1)
+      end
+
+      attr_reader :config
+
+      attr_accessor(
+        :account_id,
+        :account_name,
+        :instance_id,
+        :instance_name,
+        :machine_type,
+        :project_id,
+        :project_name,
+        :availability_zone,
+        :provider,
+        :region
+      )
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def fetch!
+        case config.cloud_provider
+        when "aws"
+          fetch_aws
+        when "gcp"
+          fetch_gcp
+        when "azure"
+          fetch_azure
+        when "auto"
+          fetch_aws || fetch_gcp || fetch_azure
+        when "none"
+          nil
+        else
+          error("Unknown setting for cloud_provider '#{config.cloud_provider}'")
+        end
+
+        self
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      private
+
+      def fetch_aws
+        resp = @client.get(AWS_URI)
+
+        return unless resp.status == 200
+        return unless (metadata = JSON.parse(resp.body))
+
+        self.provider = "aws"
+        self.account_id = metadata["accountId"]
+        self.instance_id = metadata["instanceId"]
+        self.availability_zone = metadata["availabilityZone"]
+        self.machine_type = metadata["instanceType"]
+        self.region = metadata["region"]
+      rescue HTTP::TimeoutError, HTTP::ConnectionError
+        nil
+      end
+
+      def fetch_gcp
+        resp = @client.headers("Metadata-Flavor" => "Google").get(GCP_URI)
+
+        return unless resp.status == 200
+        return unless (metadata = JSON.parse(resp.body))
+
+        zone = metadata["instance"]["zone"]&.split("/")&.at(-1)
+
+        self.provider = "gcp"
+        self.instance_id = metadata["instance"]["id"]
+        self.instance_name = metadata["instance"]["name"]
+        self.project_id = metadata["project"]["numericProjectId"]
+        self.project_name = metadata["project"]["projectId"]
+        self.availability_zone = zone
+        self.region = zone.split("-")[0..-2].join("-")
+        self.machine_type = metadata["instance"]["machineType"]
+      rescue HTTP::TimeoutError, HTTP::ConnectionError
+        nil
+      end
+
+      def fetch_azure
+        resp = @client.headers("Metadata" => "true").get(AZURE_URI)
+
+        return unless resp.status == 200
+        return unless (metadata = JSON.parse(resp.body))
+
+        self.provider = 'azure'
+        self.account_id = metadata["subscriptionId"]
+        self.instance_id = metadata["vmId"]
+        self.instance_name = metadata["name"]
+        self.project_name = metadata["resourceGroupName"]
+        self.availability_zone = metadata["zone"]
+        self.machine_type = metadata["vmSize"]
+        self.region = metadata["location"]
+      rescue HTTP::TimeoutError, HTTP::ConnectionError
+        nil
+      end
+    end
+  end
+end

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)