elastic-apm 3.7.0 → 3.11.0

data/bin/run-tests

@@ -8,7 +8,10 @@ runRspec(){
   if [ -n "${case}" ]; then
     bn="$(basename ${case} _spec.rb)/"
   fi
-  bundle exec rspec -f progress -f JUnit -o spec/junit-reports/${bn}ruby-agent-junit.xml ${case}
+  bundle exec rspec \
+    -f progress \
+    -r yarjuf -f JUnit -o spec/junit-reports/${bn}ruby-agent-junit.xml \
+    ${case}
 }
 specific_spec=$1
 

data/docker-compose.yml

@@ -26,11 +26,13 @@ services:
       - /tmp:exec,mode=1777
     depends_on:
       - mongodb
+    user: ${USER_ID}
 
   ruby_rspec:
     image: apm-agent-ruby:${RUBY_VERSION}
     environment:
       MONGODB_URL: 'mongodb:27017'
+    user: ${USER_ID}
 
 volumes:
   vendor:

data/docs/configuration.asciidoc

@@ -287,6 +287,16 @@ If your service handles data like this, we advise to only enable this feature wi
 
 Whether or not to attach the request headers to transactions and errors.
 
+[float]
+[[config-capture-elasticsearch-queries]]
+==== `capture_elasticsearch_queries`
+|============
+| Environment                                 | `Config` key                    | Default
+| `ELASTIC_APM_CAPTURE_ELASTICSEARCH_QUERIES` | `capture_elasticsearch_queries` | `false`
+|============
+
+Whether or not to capture the body from requests in Elasticsearch.
+
 [float]
 [[config-capture-env]]
 ==== `capture_env`
@@ -707,6 +717,23 @@ NOTE: The service name must conform to this regular expression: `^[a-zA-Z0-9 _-]
 In layman's terms: Your service name must only contain characters from the ASCII
 alphabet, numbers, dashes, underscores and spaces.
 
+[float]
+[[config-service-node-name]]
+==== `service_node_name`
+
+ [options="header"]
+|============
+| Environment                     | `Config` key        | Default | Example
+| `ELASTIC_APM_SERVICE_NODE_NAME` | `service_node_name` | `nil`   | `"my-app-1"`
+|============
+
+The name of the given service node. This is optional, and if omitted, the APM
+Server will fall back on `system.container.id` if available, and finally
+`host.name` if necessary.
+
+This option allows you to set the node name manually to ensure uniqueness and
+meaningfulness.
+
 [float]
 [[config-service-version]]
 ==== `service_version`
@@ -826,6 +853,7 @@ To reduce overhead and storage requirements, you can set the sample rate to a va
 between `0.0` and `1.0`.
 We still record overall time and the result for unsampled transactions, but no
 context information, tags, or spans.
+Note that the sample rate will be rounded to 4 digits of precision.
 
 [float]
 [[config-use-experimental-sql-parser]]
@@ -890,3 +918,13 @@ The unit is provided as suffix directly after the number, without any separation
  * `gb` (gigabytes)
 
 NOTE: we use the power-of-two sizing convention, e.g. `1 kilobyte == 1024 bytes`
+
+[float]
+[[special-configuration]]
+=== Special configuration
+
+Elastic APM patches `Kernel#require` to auto-detect and instrument supported third party libraries. It does so with the utmost care but in rare cases it can conflict with some libraries.
+
+To get around this patch, set the environment variable `ELASTIC_APM_SKIP_REQUIRE_PATCH` to `"1"`.
+
+If you choose to do so, the agent might need some additional tweaking to make sure the third party libraries are picked up and instrumented. Make sure you require the agent _after_ you require your other dependencies.

data/docs/debugging.asciidoc

@@ -28,3 +28,17 @@ Things to consider:
   - Experiencing high load? The agent can spawn multiple instances of its Workers that pick off the queue by changing the option `pool_size` (default is `1`).
   - If you have high load you may also consider setting `transaction_sample_rate` to something smaller than `1.0`. This determines whether to include _spans_ for every _transaction_. If you have enough traffic, skipping some (probably) identical spans won't have a noticeable effect on your data.
 
+[float]
+[[disable-agent]]
+=== Disable the Agent
+
+In the unlikely event the agent causes disruptions to a production application,
+you can disable the agent while you troubleshoot.
+
+If you have access to <<dynamic-configuration,dynamic configuration>>,
+you can disable the recording of events by setting <<config-recording,`recording`>> to `false`.
+When changed at runtime from a supported source, there's no need to restart your application.
+
+If that doesn't work, or you don't have access to dynamic configuration, you can disable the agent by setting
+<<config-enabled,`enabled`>> to `false`.
+You'll need to restart your application for the changes to apply.

data/docs/supported-technologies.asciidoc

@@ -60,6 +60,7 @@ See <<getting-started-grape>>.
 We automatically instrument database actions using:
 
 - ActiveRecord (v4.2+)
+- DynamoDB (v1.0+)
 - Elasticsearch (v0.9+)
 - Mongo (v2.1+)
 - Redis (v3.1+)
@@ -151,4 +152,4 @@ To instrument a server, add the `ElasticAPM::GRPC::ServerInterceptor`.
 [source,ruby]
 ----
 GRPC::RpcServer.new(interceptors: [ElasticAPM::GRPC::ServerInterceptor.new])
-----
+----

data/lib/elastic_apm/config.rb

@@ -17,9 +17,10 @@
 
 # frozen_string_literal: true
 
-require 'elastic_apm/config/options'
-require 'elastic_apm/config/duration'
 require 'elastic_apm/config/bytes'
+require 'elastic_apm/config/duration'
+require 'elastic_apm/config/options'
+require 'elastic_apm/config/round_float'
 require 'elastic_apm/config/regexp_list'
 require 'elastic_apm/config/wildcard_pattern_list'
 
@@ -30,6 +31,11 @@ module ElasticAPM
 
     DEPRECATED_OPTIONS = %i[].freeze
 
+    # DEPRECATED: To align with other agents, change on next major bump to:
+    # "password, passwd, pwd, secret, *key, *token*, *session*, *credit*, *card*, authorization, set-cookie"
+    SANITIZE_FIELD_NAMES_DEFAULT =
+      %w[*password* *passwd* *pwd* *secret* *key* *token* *session* *credit* *card* *authorization* *set-cookie*]
+
     # rubocop:disable Metrics/LineLength, Layout/ExtraSpacing
     option :config_file,                       type: :string, default: 'config/elastic_apm.yml'
     option :server_url,                        type: :url,    default: 'http://localhost:8200'
@@ -42,8 +48,10 @@ module ElasticAPM
     option :breakdown_metrics,                 type: :bool,   default: true
     option :capture_body,                      type: :string, default: 'off'
     option :capture_headers,                   type: :bool,   default: true
+    option :capture_elasticsearch_queries,     type: :bool,   default: false
     option :capture_env,                       type: :bool,   default: true
     option :central_config,                    type: :bool,   default: true
+    option :cloud_provider,                    type: :string, default: 'auto'
     option :current_user_email_method,         type: :string, default: 'email'
     option :current_user_id_method,            type: :string, default: 'id'
     option :current_user_username_method,      type: :string, default: 'username'
@@ -75,9 +83,11 @@ module ElasticAPM
     option :proxy_port,                        type: :int
     option :proxy_username,                    type: :string
     option :recording,                         type: :bool,   default: true
-    option :sanitize_field_names,              type: :list,   default: [],      converter: WildcardPatternList.new
+    option :sanitize_field_names,              type: :list,
+      default: SANITIZE_FIELD_NAMES_DEFAULT, converter: WildcardPatternList.new
     option :server_ca_cert,                    type: :string
     option :service_name,                      type: :string
+    option :service_node_name,                 type: :string
     option :service_version,                   type: :string
     option :source_lines_error_app_frames,     type: :int,    default: 5
     option :source_lines_error_library_frames, type: :int,    default: 0
@@ -85,8 +95,9 @@ module ElasticAPM
     option :source_lines_span_library_frames,  type: :int,    default: 0
     option :span_frames_min_duration,          type: :float,  default: '5ms',   converter: Duration.new(default_unit: 'ms')
     option :stack_trace_limit,                 type: :int,    default: 999_999
+    option :transaction_ignore_urls,           type: :list,   default: [],      converter: WildcardPatternList.new
     option :transaction_max_spans,             type: :int,    default: 500
-    option :transaction_sample_rate,           type: :float,  default: 1.0
+    option :transaction_sample_rate,           type: :float,  default: 1.0,     converter: RoundFloat.new
     option :use_elastic_traceparent_header,    type: :bool,   default: true
     option :use_legacy_sql_parser,             type: :bool,   default: false
     option :verify_server_cert,                type: :bool,   default: true
@@ -129,6 +140,7 @@ module ElasticAPM
       %w[
         action_dispatch
         delayed_job
+        dynamo_db
         elasticsearch
         faraday
         http
@@ -158,13 +170,12 @@ module ElasticAPM
     end
 
     def replace_options(new_options)
-      return unless new_options
+      return if new_options.nil? || new_options.empty?
       options_copy = @options.dup
       new_options.each do |key, value|
         options_copy.fetch(key.to_sym).set(value)
       end
       @options = options_copy
-      set_log_level(logger)
     end
 
     def app=(app)
@@ -186,6 +197,14 @@ module ElasticAPM
       metrics_interval > 0
     end
 
+    # DEPRECATED: Remove this in next major version
+    def sanitize_field_names=(value)
+      list = WildcardPatternList.new.call(value)
+      defaults = WildcardPatternList.new.call(SANITIZE_FIELD_NAMES_DEFAULT)
+      get(:sanitize_field_names).value =
+        defaults.concat(list).uniq(&:pattern) # use regex pattern for comparisons
+    end
+
     def span_frames_min_duration?
       span_frames_min_duration != 0
     end
@@ -232,6 +251,15 @@ module ElasticAPM
       self.default_labels = value
     end
 
+    def ignore_url_patterns=(value)
+      unless value == self.class.schema[:ignore_url_patterns][:default]
+        warn '[DEPRECATED] The option ignore_url_patterns is being removed. ' \
+          'Consider using transaction_ignore_urls instead.'
+      end
+
+      set(:ignore_url_patterns, value)
+    end
+
     def custom_key_filters=(value)
       unless value == self.class.schema[:custom_key_filters][:default]
         warn '[DEPRECATED] The option custom_key_filters is being removed. ' \
@@ -286,15 +314,10 @@ module ElasticAPM
 
     def build_logger
       Logger.new(log_path == '-' ? STDOUT : log_path).tap do |logger|
-        set_log_level(logger)
+        logger.level = log_level
       end
     end
 
-    def set_log_level(logger)
-      return unless logger
-      logger.level = log_level
-    end
-
     def app_type?(app)
       if defined?(::Rails::Application) && app.is_a?(::Rails::Application)
         return :rails
@@ -321,7 +344,7 @@ module ElasticAPM
       self.logger ||= ::Rails.logger
 
       self.__root_path = ::Rails.root.to_s
-      self.__view_paths = app.config.paths['app/views'].existent
+      self.__view_paths = app.config.paths['app/views'].existent + [::Rails.root.to_s]
     end
 
     def rails_app_name(app)

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
@@ -36,12 +38,22 @@ module ElasticAPM
         private
 
         def convert(str)
+          case_sensitive = false
+
+          if str.start_with?('(?-i)')
+            str = str.gsub(/^\(\?-\i\)/, '')
+            case_sensitive = true
+          end
+
           parts =
             str.chars.each_with_object([]) do |char, arr|
               arr << (char == '*' ? '.*' : Regexp.escape(char))
             end
 
-          Regexp.new('\A' + parts.join + '\Z', Regexp::IGNORECASE)
+          Regexp.new(
+            '\A' + parts.join + '\Z',
+            case_sensitive ? nil : Regexp::IGNORECASE
+          )
         end
       end
 

data/lib/elastic_apm/context_builder.rb

@@ -76,7 +76,7 @@ module ElasticAPM
       else
         body = req.body.read
         req.body.rewind
-        body.byteslice(0, MAX_BODY_LENGTH).force_encoding('utf-8')
+        body.byteslice(0, MAX_BODY_LENGTH).force_encoding('utf-8').scrub
       end
     end
 

data/lib/elastic_apm/grpc.rb

@@ -71,7 +71,7 @@ module ElasticAPM
         transaction.done 'success'
       rescue ::Exception => e
         ElasticAPM.report(e, handled: false)
-        transaction.done 'error'
+        transaction.done 'error' if transaction
         raise
       ensure
         ElasticAPM.end_transaction
@@ -91,7 +91,7 @@ module ElasticAPM
       def trace_context(call)
         TraceContext.parse(metadata: call.metadata)
       rescue TraceContext::InvalidTraceparentHeader
-        warn "Couldn't parse invalid trace context header: #{header.inspect}"
+        warn "Couldn't parse invalid trace context header: #{call.metadata}"
         nil
       end
     end

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
         )
 
@@ -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,128 @@
+# 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(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
+      )
+
+      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
+
+      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