elastic-apm 3.15.1 → 4.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88a5353924a1308c1ab7d5b3701968ccfbe0b03f2ac24372d3d1c4f90b12158c
-  data.tar.gz: 8891407bcdb4b5e8251b580e890d5d9f652e11790d5a9e3e2bb1bb378092511b
+  metadata.gz: d2edbff5770e48799701579f045a0ed3871da1b65037ec0a951ecd106138202c
+  data.tar.gz: 750e7a30a2a69e5c36d35373d842eec64e8e89b5bab66ce6d4c25c69564fb38e
 SHA512:
-  metadata.gz: 5eb9e1fec293b2008d083a3bc53a8458773c04e96efbe37d170591dda5faa33ef10bcadc980d7423053704fba131575c94ff3d410b8f3ab19311f94717acaade
-  data.tar.gz: 037b3327a8b9e2db344301eb001817dc89500a74065f605dc335b1c8ecf51b01a026ea0f4f46ee4326e2fc6eb50202eece5bba64b8c77060c4cd1f62ff69be77
+  metadata.gz: 6add102bc8f803850243de2c7ef517f0be8ab57b8cc89f0d251034b86d83d5073685b3266123b3813496fd1c57fbc7f9c8855df63c5bcf8c35c807a746800803
+  data.tar.gz: fadf416339fa263a2bae03832fa9d46038953f563117c1bfb0623118364bc0bd40d75ca31585cb775d2d69cf708c0848e033c4b7dcae231b2832b6f83da41918

data/.ci/.jenkins_ruby.yml

@@ -4,7 +4,6 @@ RUBY_VERSION:
   - ruby:2.6
   - ruby:2.5
   - ruby:2.4
-  - ruby:2.3
   - jruby:9.2
   - docker.elastic.co/observability-ci/jruby:9.2-13-jdk
   - docker.elastic.co/observability-ci/jruby:9.2-11-jdk

data/.rubocop.yml

@@ -132,10 +132,3 @@ Style/StringConcatenation:
 
 Style/DocumentDynamicEvalDefinition:
   Enabled: false
-
-# Applies to > ruby 2.3, enable when 2.3 support is dropped
-Performance/RegexpMatch:
-  Enabled: false
-
-Style/HashTransformValues:
-  Enabled: false

data/CHANGELOG.asciidoc

@@ -32,17 +32,32 @@ endif::[]
 ==== Unreleased
 ////
 
-[[release-notes-3.x]]
-=== Ruby Agent version 3.x
+[[release-notes-4.x]]
+=== Ruby Agent version 4.x
 
-[[release-notes-3.15.1]]
-==== 3.15.1 (2021-04-06)
+[[release-notes-4.0.0]]
+==== 4.0.0.beta.1
 
 [float]
-===== Fixed
+===== Removed
+
+- Removed support for Ruby 2.3 and JRuby 9.1 {pull}901[#901]
+- Config option `active`, see `enabled` {pull}900[#900]
+- Config option `custom_key_filters`, see `sanitize_field_names` {pull}900[#900]
+- Config option `default_tags`, see `global_labels` {pull}900[#900]
+- Config option `default_labels`, see `global_labels` {pull}900[#900]
+- Config option `ignore_url_patterns`, see `transaction_ignore_urls` {pull}900[#900]
+- Config option `use_legacy_sql_parser`, legacy parser no longer included {pull}900[#900]
 
-- AWS S3 spy accepts symbol bucket names {pull}998[#998]
-- AWS S3 spy passing on blocks {pull}998[#998]
+[float]
+===== Changed
+
+- Integrations (Spies) use Module#prepend over class_eval {pull}890[#890]
+- The secrets filter no longer filters based on values, see `sanitize_field_names` {pull}900[#900]
+- The secrets filter is aligned with other agents, see `sanitize_field_names` {pull}900[#900]
+
+[[release-notes-3.x]]
+=== Ruby Agent version 3.x
 
 [[release-notes-3.15.0]]
 ==== 3.15.0 (2021-03-22)

data/Gemfile

@@ -26,6 +26,8 @@ gem 'cucumber', require: false
 gem 'rack-test'
 gem 'rspec', '~> 3'
 gem 'rspec-its'
+gem 'rubocop', require: false
+gem 'rubocop-performance', require: false
 gem 'timecop'
 gem 'webmock'
 
@@ -91,7 +93,7 @@ frameworks_versions.each do |framework, version|
 end
 
 if frameworks_versions.key?('rails')
-  unless frameworks_versions['rails'] =~ /^(main|6)/
+  unless /^(main|6)/.match?(frameworks_versions['rails'])
     gem 'delayed_job', require: nil
   end
 end

data/bench/report.rb

@@ -18,7 +18,7 @@ end
 meta = {
   executed_at: Time.new.iso8601,
   'git.commit' => git_sha,
-  'git.date' => String(git_date).strip != '' && Time.parse(git_date).iso8601,
+  'git.date' => (String(git_date).strip != '' && Time.parse(git_date).iso8601) || Time.now.iso8601,
   'git.subject' => git_msg,
   hostname: `hostname`.chomp,
   engine: RUBY_ENGINE,

data/docs/configuration.asciidoc

@@ -176,19 +176,6 @@ APM server in version 7.6.
 
 WARNING: Api keys only provide any real security if your APM server uses TLS.
 
-[float]
-[[config-active]]
-==== `active` deprecated:[3.7.0,See <<config-enabled>> instead.]
-|============
-| Environment          | `Config` key | Default
-| `ELASTIC_APM_ACTIVE` | `active`     | `true`
-|============
-
-Whether or not to start the agent.
-If `active` is `false`, `ElasticAPM.start` will do nothing and all calls to the root API will return `nil`.
-
-NOTE: This option is being removed. See <<config-enabled>> instead.
-
 [float]
 [[config-api-buffer-size]]
 ==== `api_buffer_size`
@@ -339,57 +326,6 @@ If set to `"none"`, no cloud metadata will be collected.
 If set to any of `"aws"`, `"gcp"`, or `"azure"`,
 attempts to collect metadata will only be performed from the chosen provider.
 
-[float]
-[[config-custom-key-filters]]
-==== `custom_key_filters` deprecated:[3.5.0,See <<config-sanitize-field-names>> instead.]
-[options="header"]
-|============
-| Environment                      | `Config` key         | Default | Example
-| `ELASTIC_APM_CUSTOM_KEY_FILTERS` | `custom_key_filters` | `[]`    | `['MyAuthHeader']`
-|============
-
-Elastic APM strips
-https://github.com/elastic/apm-agent-ruby/blob/1.x/lib/elastic_apm/filters/secrets_filter.rb[
-what looks like confidential information] from the request/response headers.
-Use this option to add your own custom header keys to the list of filtered keys.
-
-When setting this option via `ENV`, use a comma separated string.
-Eg. `ELASTIC_APM_CUSTOM_KEY_FILTERS="a,b" # => [/a/, /b/]`
-
-NOTE: This option is being removed. See <<config-sanitize-field-names>> instead.
-
-[float]
-[[config-default-tags]]
-==== `default_tags`
-
-[options="header"]
-|============
-| Environment                  | `Config` key     | Default | Example
-| `ELASTIC_APM_DEFAULT_LABELS` | `default_labels` | `{}`    | `region=us1`
-|============
-
-Add default labels to every transaction. Note that this will eventually be deprecated in favor of `global_labels`.
-
-WARNING: Be aware that labels are indexed in Elasticsearch. Using too many unique keys will result in *https://www.elastic.co/blog/found-crash-elasticsearch#mapping-explosion[Mapping explosion]*.
-
-NOTE: `global_labels` are supported as of APM server version 7.2. `default_tags` and `default_labels` will eventually be
-deprecated so please transition to using `global_labels` instead. In the meantime, any `default_labels`
-that are set will override `global_labels`.
-
-[options="header"]
-|============
-| Environment                | `Config` key   | Default | Example
-| `ELASTIC_APM_DEFAULT_TAGS` | `default_tags` | `{}`    | `region=us1`
-|============
-
-Add default tags to add to every transaction. Note that this option has been deprecated in favor of `default_labels`.
-
-WARNING: Be aware that tags are indexed in Elasticsearch. Using too many unique keys will result in *https://www.elastic.co/blog/found-crash-elasticsearch#mapping-explosion[Mapping explosion]*.
-
-NOTE: `global_labels` are supported as of APM server version 7.2. `default_tags` and `default_labels` will eventually be
-deprecated so please transition to using `global_labels` instead. In the meantime, any `default_tags`
-that are set will override `global_labels`.
-
 [float]
 [[config-disable_metrics]]
 ==== `disable_metrics`
@@ -520,9 +456,7 @@ otherwise, the default is `nil`.
 Labels added to all events, with the format key=value[,key=value[,...]].
 
 NOTE: This option requires APM Server 7.2 or greater, and will have no effect when using older
-server versions. `default_tags` will eventually be deprecated but in the meantime, their value
-will override any `global_labels`. Please transition to using `global_labels` instead of
-`default_tags` in light of this deprecation.
+server versions.
 
 [float]
 [[config-hostname]]
@@ -701,8 +635,8 @@ when this option is false.
 
 [options="header"]
 |============
-| Environment                        | `Config` key           | Default | Example
-| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `[]`    | `Auth*tion,abc*,*xyz`
+| Environment                        | `Config` key           | Default                                                                                        | Example
+| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `"password,passwd,pwd,secret,*key,*token*,*session*,*credit*,*card*,authorization,set-cookie"` | `Auth*tion,abc*,*xyz`
 |============
 
 Sometimes it is necessary to sanitize the data sent to Elastic APM, e.g. remove sensitive data.
@@ -872,17 +806,6 @@ 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]]
-==== `use_legacy_sql_parser`
-|============
-| Environment                         | `Config` key            | Default
-| `ELASTIC_APM_USE_LEGACY_SQL_PARSER` | `use_legacy_sql_parser` | `false`
-|============
-
-Use the older, less precise approach to generating summaries of your app's SQL statements.
-Try this if you're experiencing trouble using the new default.
-
 [float]
 [[config-verify-server-cert]]
 ==== `verify_server_cert`

data/lib/elastic_apm/agent.rb

@@ -127,7 +127,7 @@ module ElasticAPM
     end
 
     def stop
-      debug 'Stopping agent'
+      info 'Stopping agent'
 
       central_config.stop
       metrics.stop
@@ -276,7 +276,7 @@ module ElasticAPM
     def detect_forking!
       return if @pid == Process.pid
 
-      config.logger.debug "Detected forking,
+      config.logger.debug "Forked process detected,
         restarting threads in process [PID:#{Process.pid}]"
 
       central_config.handle_forking!

data/lib/elastic_apm/central_config.rb

@@ -66,9 +66,9 @@ module ElasticAPM
     def fetch_and_apply_config
       @promise =
         Concurrent::Promise
-        .execute(&method(:fetch_config))
-        .on_success(&method(:handle_success))
-        .rescue(&method(:handle_error))
+        .execute { fetch_config }
+        .on_success { |resp| handle_success(resp) }
+        .rescue { |err| handle_error(err) }
     end
 
     def fetch_config
@@ -182,7 +182,7 @@ module ElasticAPM
 
       @scheduled_task =
         Concurrent::ScheduledTask
-        .execute(seconds, &method(:fetch_and_apply_config))
+        .execute(seconds) { fetch_and_apply_config }
     end
   end
 end

data/lib/elastic_apm/config/regexp_list.rb

@@ -23,7 +23,7 @@ module ElasticAPM
     class RegexpList
       def call(value)
         value = value.is_a?(String) ? value.split(',') : Array(value)
-        value.map(&Regexp.method(:new))
+        value.map { |p| Regexp.new(p) }
       end
     end
   end

data/lib/elastic_apm/config/wildcard_pattern_list.rb

@@ -59,7 +59,7 @@ module ElasticAPM
 
       def call(value)
         value = value.is_a?(String) ? value.split(',') : Array(value)
-        value.map(&WildcardPattern.method(:new))
+        value.map { |p| WildcardPattern.new(p) }
       end
     end
   end

data/lib/elastic_apm/config.rb

@@ -30,14 +30,8 @@ module ElasticAPM
   class Config
     extend Options
 
-    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*].freeze
+      %w[password passwd pwd secret *key *token* *session* *credit* *card* authorization set-cookie].freeze
 
     # rubocop:disable Layout/LineLength, Layout/ExtraSpacing
     option :config_file,                       type: :string, default: 'config/elastic_apm.yml'
@@ -101,7 +95,6 @@ module ElasticAPM
     option :transaction_max_spans,             type: :int,    default: 500
     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
 
     # rubocop:enable Layout/LineLength, Layout/ExtraSpacing
@@ -168,11 +161,6 @@ module ElasticAPM
       available_instrumentations - disable_instrumentations
     end
 
-    def method_missing(name, *args)
-      return super unless DEPRECATED_OPTIONS.include?(name)
-      warn "The option `#{name}' has been removed."
-    end
-
     def replace_options(new_options)
       return if new_options.nil? || new_options.empty?
       options_copy = @options.dup
@@ -201,15 +189,6 @@ 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)
-      # use regex pattern for comparisons
-      get(:sanitize_field_names).value =
-        defaults.concat(list).uniq(&:pattern)
-    end
-
     def span_frames_min_duration?
       span_frames_min_duration != 0
     end
@@ -248,72 +227,6 @@ module ElasticAPM
       super.split.first + '>'
     end
 
-    # Deprecations
-
-    def default_tags=(value)
-      warn '[DEPRECATED] The option default_tags has been renamed to ' \
-        'default_labels.'
-      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. ' \
-          'See sanitize_field_names for an alternative.'
-      end
-
-      set(:custom_key_filters, value)
-    end
-
-    def disabled_instrumentations
-      disable_instrumentations
-    end
-
-    def active
-      enabled
-    end
-    alias active? active
-
-    def server_ca_cert
-      server_ca_cert_file
-    end
-
-    def disabled_instrumentations=(value)
-      warn '[DEPRECATED] The option disabled_instrumentations has been ' \
-        'renamed to disable_instrumentations to align with other agents.'
-      self.disable_instrumentations = value
-    end
-
-    def use_experimental_sql_parser=(_value)
-      warn '[DEPRECATED] The new SQL parser is now the default. To use the ' \
-           'old one, use use_legacy_sql_parser and please report why you ' \
-           'wish to do so.'
-    end
-
-    def active=(value)
-      warn '[DEPRECATED] The option active has been renamed to enabled ' \
-        'to align with other agents and with the remote config.'
-      self.enabled = value
-    end
-
-    def server_ca_cert=(value)
-      unless value == self.class.schema[:server_ca_cert_file][:default]
-        warn '[DEPRECATED] The option server_ca_cert has been ' \
-          'renamed to server_ca_cert_file to align with other agents.'
-      end
-
-      self.server_ca_cert_file = value
-    end
-
     private
 
     def load_config_file

data/lib/elastic_apm/context/response.rb

@@ -38,9 +38,7 @@ module ElasticAPM
       attr_reader :headers
 
       def headers=(headers)
-        @headers = headers&.each_with_object({}) do |(k, v), hsh|
-          hsh[k] = v.to_s
-        end
+        @headers = headers&.transform_values { |v| v.to_s }
       end
     end
   end

data/lib/elastic_apm/instrumenter.rb

@@ -89,7 +89,7 @@ module ElasticAPM
     end
 
     def subscriber=(subscriber)
-      debug 'Registering subscriber'
+      debug 'Registering ActiveSupport::Notifications subscriber'
       @subscriber = subscriber
       @subscriber.register!
     end

data/lib/elastic_apm/metrics/cpu_mem_set.rb

@@ -79,7 +79,7 @@ module ElasticAPM
         case platform
         when :linux then Linux.new
         else
-          warn "Unsupported platform '#{platform}' - Disabling system metrics"
+          warn "Disabling system metrics, unsupported platform '#{platform}'"
           disable!
           nil
         end

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

@@ -17,7 +17,7 @@
 
 # frozen_string_literal: true
 
-require 'elastic_apm/sql'
+require 'elastic_apm/sql/signature'
 
 module ElasticAPM
   module Normalizers
@@ -34,7 +34,7 @@ module ElasticAPM
         def initialize(*args)
           super
 
-          @summarizer = Sql.summarizer
+          @summarizer = Sql::Signature::Summarizer.new
 
           @adapters = {}
         end

data/lib/elastic_apm/normalizers.rb

@@ -39,8 +39,8 @@ module ElasticAPM # :nodoc:
     end
 
     def self.build(config)
-      normalizers = @registered.each_with_object({}) do |(name, klass), built|
-        built[name] = klass.new(config)
+      normalizers = @registered.transform_values do |klass|
+        klass.new(config)
       end
 
       Collection.new(normalizers)

data/lib/elastic_apm/opentracing.rb

@@ -129,8 +129,9 @@ module ElasticAPM
       def self.from_header(header)
         return unless header
 
-        trace_context = ElasticAPM::TraceContext.parse(header)
-        return unless trace_context
+        trace_context = TraceContext.new(
+          traceparent: TraceContext::Traceparent.parse(header)
+        )
 
         trace_context.traceparent.id = trace_context.parent_id
         trace_context.traceparent.parent_id = nil

data/lib/elastic_apm/span_helpers.rb

@@ -36,19 +36,17 @@ module ElasticAPM
         name ||= method.to_s
         type ||= Span::DEFAULT_TYPE
 
-        klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          alias :"__without_apm_#{method}" :"#{method}"
-
-          def #{method}(*args, &block)
+        klass.prepend(Module.new do
+          define_method(method) do |*args|
             unless ElasticAPM.current_transaction
-              return __without_apm_#{method}(*args, &block)
+              return super(*args)
             end
 
-            ElasticAPM.with_span "#{name}", "#{type}" do
-              __without_apm_#{method}(*args, &block)
+            ElasticAPM.with_span name.to_s, type.to_s do
+              super(*args)
             end
           end
-        RUBY
+        end)
       end
     end
 

data/lib/elastic_apm/spies/action_dispatch.rb

@@ -22,18 +22,19 @@ module ElasticAPM
   module Spies
     # @api private
     class ActionDispatchSpy
-      def install
-        ::ActionDispatch::ShowExceptions.class_eval do
-          alias render_exception_without_apm render_exception
-
-          def render_exception(env, exception)
-            context = ElasticAPM.build_context(rack_env: env, for_type: :error)
-            ElasticAPM.report(exception, context: context, handled: false)
+      # @api private
+      module Ext
+        def render_exception(env, exception)
+          context = ElasticAPM.build_context(rack_env: env, for_type: :error)
+          ElasticAPM.report(exception, context: context, handled: false)
 
-            render_exception_without_apm env, exception
-          end
+          super(env, exception)
         end
       end
+
+      def install
+        ::ActionDispatch::ShowExceptions.prepend(Ext)
+      end
     end
 
     register(

data/lib/elastic_apm/spies/dynamo_db.rb

@@ -49,12 +49,11 @@ module ElasticAPM
         end
       end
 
-      def install
-        ::Aws::DynamoDB::Client.class_eval do
+      # @api private
+      module Ext
+        def self.prepended(mod)
           # Alias all available operations
-          api.operation_names.each do |operation_name|
-            alias :"#{operation_name}_without_apm" :"#{operation_name}"
-
+          mod.api.operation_names.each do |operation_name|
             define_method(operation_name) do |params = {}, options = {}|
               cloud = ElasticAPM::Span::Context::Destination::Cloud.new(region: config.region)
 
@@ -79,14 +78,17 @@ module ElasticAPM
                 context: context
               ) do
                 ElasticAPM::Spies::DynamoDBSpy.without_net_http do
-                  original_method = method("#{operation_name}_without_apm")
-                  original_method.call(params, options)
+                  super(params, options)
                 end
               end
             end
           end
         end
       end
+
+      def install
+        ::Aws::DynamoDB::Client.prepend(Ext)
+      end
     end
 
     register(

data/lib/elastic_apm/spies/elasticsearch.rb

@@ -37,47 +37,48 @@ module ElasticAPM
           end
       end
 
-      def install
-        ::Elasticsearch::Transport::Client.class_eval do
-          alias perform_request_without_apm perform_request
-
-          def perform_request(method, path, *args, &block)
-            unless ElasticAPM.current_transaction
-              return perform_request_without_apm(method, path, *args, &block)
-            end
+      # @api private
+      module Ext
+        def perform_request(method, path, *args, &block)
+          unless ElasticAPM.current_transaction
+            return super(method, path, *args, &block)
+          end
 
-            name = format(NAME_FORMAT, method, path)
-            statement = []
+          name = format(NAME_FORMAT, method, path)
+          statement = []
 
-            statement << { params: args&.[](0) }
+          statement << { params: args&.[](0) }
 
-            if ElasticAPM.agent.config.capture_elasticsearch_queries
-              unless args[1].nil? || args[1].empty?
-                statement << {
-                  body: ElasticAPM::Spies::ElasticsearchSpy
-                             .sanitizer.strip_from(args[1])
-                }
-              end
+          if ElasticAPM.agent.config.capture_elasticsearch_queries
+            unless args[1].nil? || args[1].empty?
+              body =
+                ElasticAPM::Spies::ElasticsearchSpy
+                .sanitizer.strip_from(args[1])
+              statement << { body: body }
             end
+          end
 
-            context = Span::Context.new(
-              db: { statement: statement.reduce({}, :merge).to_json },
-              destination: {
-                name: SUBTYPE,
-                resource: SUBTYPE,
-                type: TYPE
-              }
-            )
+          context = Span::Context.new(
+            db: { statement: statement.reduce({}, :merge).to_json },
+            destination: {
+              name: SUBTYPE,
+              resource: SUBTYPE,
+              type: TYPE
+            }
+          )
 
-            ElasticAPM.with_span(
-              name,
-              TYPE,
-              subtype: SUBTYPE,
-              context: context
-            ) { perform_request_without_apm(method, path, *args, &block) }
-          end
+          ElasticAPM.with_span(
+            name,
+            TYPE,
+            subtype: SUBTYPE,
+            context: context
+          ) { super(method, path, *args, &block) }
         end
       end
+
+      def install
+        ::Elasticsearch::Transport::Client.prepend(Ext)
+      end
     end
 
     register(