elastic-apm 3.2.0 → 3.3.0

data/docs/configuration.asciidoc

@@ -318,6 +318,17 @@ NOTE: `global_labels` are supported as of APM server version 7.2. `default_tags`
 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`
+|============
+| Environment                   | `Config` key      | Default | Example
+| `ELASTIC_APM_DISABLE_METRICS` | `disable_metrics` | []      | `"*.cpu.*,system.memory.total"`
+|============
+
+A comma-separated list of dotted metrics names that should not be sent to the APM Server.
+You can use `*` to match multiple metrics.
+
 [float]
 [[config-disable-send]]
 ==== `disable_send`

data/docs/context.asciidoc

@@ -19,14 +19,14 @@ end
 ----
 
 [float]
-==== Adding tags
+==== Adding labels
 
-Tags are special in that they are indexed in your Elasticsearch database and
-therefore searchable.
+Labels are special in that they are indexed in your Elasticsearch database and
+therefore queryable.
 
 [source,ruby]
 ----
-ElasticAPM.set_tag(:company_name, 'Acme, Inc.')
+ElasticAPM.set_label(:company_name, 'Acme, Inc.')
 ----
 
 Note that `.`, `*` and `"` in keys are converted to `_`.

data/lib/elastic_apm.rb

@@ -28,7 +28,7 @@ require 'elastic_apm/sinatra' if defined?(::Sinatra)
 require 'elastic_apm/grape' if defined?(::Grape)
 
 # ElasticAPM
-module ElasticAPM # rubocop:disable Metrics/ModuleLength
+module ElasticAPM
   class << self
     ### Life cycle
 
@@ -71,7 +71,6 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
       agent&.current_span
     end
 
-    # rubocop:disable Metrics/AbcSize
     # Get a formatted string containing transaction, span, and trace ids.
     # If a block is provided, the ids are yielded.
     #
@@ -90,7 +89,6 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
       ids << "trace.id=#{trace_id}" if trace_id
       ids.join(' ')
     end
-    # rubocop:enable Metrics/AbcSize
 
     # Start a new transaction
     #
@@ -122,7 +120,6 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
       agent&.end_transaction(result)
     end
 
-    # rubocop:disable Metrics/MethodLength
     # Wrap a block in a Transaction, ending it after the block
     #
     # @param name [String] A description of the transaction, eg
@@ -158,9 +155,8 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
         end_transaction
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
-    # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+    # rubocop:disable Metrics/ParameterLists
     # Start a new span
     #
     # @param name [String] A description of the span, eq `SELECT FROM "users"`
@@ -193,7 +189,7 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
         span.original_backtrace ||= caller
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+    # rubocop:enable Metrics/ParameterLists
 
     # Ends the current span
     #
@@ -202,7 +198,7 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
       agent&.end_span
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+    # rubocop:disable Metrics/ParameterLists
     # Wrap a block in a Span, ending it after the block
     #
     # @param name [String] A description of the span, eq `SELECT FROM "users"`
@@ -243,7 +239,7 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
         end_span
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+    # rubocop:enable Metrics/ParameterLists
 
     # Build a [Context] from a Rack `env`. The context may include information
     # about the request, response, current user and more

data/lib/elastic_apm/agent.rb

@@ -13,7 +13,6 @@ require 'elastic_apm/metrics'
 require 'elastic_apm/spies'
 
 module ElasticAPM
-  # rubocop:disable Metrics/ClassLength
   # @api private
   class Agent
     include Logging
@@ -27,7 +26,6 @@ module ElasticAPM
       @instance
     end
 
-    # rubocop:disable Metrics/MethodLength
     def self.start(config)
       return @instance if @instance
 
@@ -47,7 +45,6 @@ module ElasticAPM
         @instance = new(config).start
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def self.stop
       LOCK.synchronize do
@@ -62,7 +59,6 @@ module ElasticAPM
       !!@instance
     end
 
-    # rubocop:disable Metrics/MethodLength
     def initialize(config)
       @stacktrace_builder = StacktraceBuilder.new(config)
       @context_builder = ContextBuilder.new(config)
@@ -77,7 +73,6 @@ module ElasticAPM
         stacktrace_builder: stacktrace_builder
       ) { |event| enqueue event }
     end
-    # rubocop:enable Metrics/MethodLength
 
     attr_reader(
       :central_config,
@@ -91,8 +86,6 @@ module ElasticAPM
     )
 
     def_delegator :@central_config, :config
-
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def start
       unless config.disable_start_message?
         config.logger.info format(
@@ -113,7 +106,6 @@ module ElasticAPM
 
       self
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def stop
       debug 'Stopping agent'
@@ -244,5 +236,4 @@ module ElasticAPM
       super.split.first + '>'
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/elastic_apm/central_config.rb

@@ -4,7 +4,7 @@ require 'elastic_apm/central_config/cache_control'
 
 module ElasticAPM
   # @api private
-  class CentralConfig # rubocop:disable Metrics/ClassLength
+  class CentralConfig
     include Logging
 
     # @api private
@@ -52,7 +52,6 @@ module ElasticAPM
         .rescue(&method(:handle_error))
     end
 
-    # rubocop:disable Metrics/MethodLength
     def fetch_config
       resp = perform_request
 
@@ -67,7 +66,6 @@ module ElasticAPM
         raise ServerError, resp
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def assign(update)
       # For each updated option, store the original value,
@@ -92,7 +90,6 @@ module ElasticAPM
       @config = config.dup.tap { |new_config| new_config.assign(new_options) }
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def handle_success(resp)
       if (etag = resp.headers['Etag'])
@@ -121,17 +118,19 @@ module ElasticAPM
       debug { e.backtrace.join('\n') }
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def handle_error(error)
+      # For tests, WebMock failures don't have real responses
+      response = error.response if error.respond_to?(:response)
+
       debug(
         'Failed fetching config: %s, trying again in %d seconds',
-        error.response.body, DEFAULT_MAX_AGE
+        response&.body, DEFAULT_MAX_AGE
       )
 
       assign({})
 
-      schedule_next_fetch(error.response)
+      schedule_next_fetch(response)
     end
 
     def perform_request
@@ -149,10 +148,11 @@ module ElasticAPM
       { 'Etag': @etag }
     end
 
-    def schedule_next_fetch(resp)
+    def schedule_next_fetch(resp = nil)
+      headers = resp&.headers
       seconds =
-        if (cache_header = resp.headers['Cache-Control'])
-          CacheControl.new(cache_header).max_age
+        if headers['Cache-Control']
+          CacheControl.new(headers['Cache-Control']).max_age
         else
           DEFAULT_MAX_AGE
         end

data/lib/elastic_apm/central_config/cache_control.rb

@@ -26,7 +26,7 @@ module ElasticAPM
       def parse!(value)
         value.split(',').each do |token|
           k, v = token.split('=').map(&:strip)
-          instance_variable_set(:"@#{k.gsub('-', '_')}", v ? v.to_i : true)
+          instance_variable_set(:"@#{k.tr('-', '_')}", v ? v.to_i : true)
         end
       end
     end

data/lib/elastic_apm/config.rb

@@ -4,9 +4,9 @@ require 'elastic_apm/config/options'
 require 'elastic_apm/config/duration'
 require 'elastic_apm/config/bytes'
 require 'elastic_apm/config/regexp_list'
+require 'elastic_apm/config/wildcard_pattern_list'
 
 module ElasticAPM
-  # rubocop:disable Metrics/ClassLength
   # @api private
   class Config
     extend Options
@@ -33,6 +33,7 @@ module ElasticAPM
     option :custom_key_filters,                type: :list,   default: [],      converter: RegexpList.new
     option :default_tags,                      type: :dict,   default: {}
     option :default_labels,                    type: :dict,   default: {}
+    option :disable_metrics,                   type: :list,   default: [],      converter: WildcardPatternList.new
     option :disable_send,                      type: :bool,   default: false
     option :disable_start_message,             type: :bool,   default: false
     option :disabled_instrumentations,         type: :list,   default: %w[json]
@@ -69,8 +70,6 @@ module ElasticAPM
     option :transaction_sample_rate,           type: :float,  default: 1.0
     option :verify_server_cert,                type: :bool,   default: true
     # rubocop:enable Metrics/LineLength, Layout/ExtraSpacing
-
-    # rubocop:disable Metrics/MethodLength
     def initialize(options = {})
       @options = load_schema
 
@@ -93,7 +92,6 @@ module ElasticAPM
       @__view_paths ||= []
       @__root_path ||= Dir.pwd
     end
-    # rubocop:enable Metrics/MethodLength
 
     attr_accessor :__view_paths, :__root_path
     attr_accessor :logger
@@ -105,7 +103,6 @@ module ElasticAPM
       update.each { |key, value| send(:"#{key}=", value) }
     end
 
-    # rubocop:disable Metrics/MethodLength
     def available_instrumentations
       %w[
         delayed_job
@@ -123,7 +120,6 @@ module ElasticAPM
         rake
       ]
     end
-    # rubocop:enable Metrics/MethodLength
 
     def enabled_instrumentations
       available_instrumentations - disabled_instrumentations
@@ -166,7 +162,6 @@ module ElasticAPM
       @span_frames_min_duration_us ||= span_frames_min_duration * 1_000_000
     end
 
-    # rubocop:disable Metrics/MethodLength
     def ssl_context
       return unless use_ssl?
 
@@ -187,7 +182,6 @@ module ElasticAPM
             end
         end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def inspect
       super.split.first + '>'
@@ -235,7 +229,7 @@ module ElasticAPM
       self.__root_path = Dir.pwd
     end
 
-    def set_rails(app) # rubocop:disable Metrics/AbcSize
+    def set_rails(app)
       self.service_name ||= format_name(service_name || rails_app_name(app))
       self.framework_name ||= 'Ruby on Rails'
       self.framework_version ||= ::Rails::VERSION::STRING
@@ -254,8 +248,7 @@ module ElasticAPM
     end
 
     def format_name(str)
-      str && str.gsub('::', '_')
+      str&.gsub('::', '_')
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/elastic_apm/config/options.rb

@@ -33,7 +33,7 @@ module ElasticAPM
 
         private
 
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        # rubocop:disable Metrics/CyclomaticComplexity
         def normalize(val)
           return unless val
 
@@ -54,7 +54,7 @@ module ElasticAPM
             val
           end
         end
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         def normalize_bool(val)
           return val unless val.is_a?(String)
@@ -97,7 +97,6 @@ module ElasticAPM
           end]
         end
 
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         def method_missing(name, *value)
           name_str = name.to_s
 
@@ -116,7 +115,6 @@ module ElasticAPM
             super
           end
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
         def [](key)
           options[key]

data/lib/elastic_apm/config/wildcard_pattern_list.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  class Config
+    # @api private
+    class WildcardPatternList
+      # @api private
+      class WildcardPattern
+        def initialize(str)
+          @pattern = convert(str)
+        end
+
+        def match?(other)
+          !!@pattern.match(other)
+        end
+
+        private
+
+        def convert(str)
+          parts =
+            str.chars.each_with_object([]) do |char, arr|
+              arr << (char == '*' ? '.*' : Regexp.escape(char))
+            end
+
+          Regexp.new('\A' + parts.join + '\Z')
+        end
+      end
+
+      def call(value)
+        value = value.is_a?(String) ? value.split(',') : Array(value)
+        value.map(&WildcardPattern.method(:new))
+      end
+    end
+  end
+end

data/lib/elastic_apm/context_builder.rb

@@ -20,7 +20,6 @@ module ElasticAPM
 
     private
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def apply_to_request(context, rack_env:, for_type:)
       req = rails_req?(rack_env) ? rack_env : Rack::Request.new(rack_env)
 
@@ -42,7 +41,6 @@ module ElasticAPM
 
       context
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def should_capture_body?(for_type)
       option = config.capture_body

data/lib/elastic_apm/error.rb

@@ -26,7 +26,7 @@ module ElasticAPM
         " transaction_id:#{transaction_id}" \
         " trace_id:#{trace_id}" \
         " exception:#{exception.inspect}" \
-        ">"
+        '>'
     end
   end
 end

data/lib/elastic_apm/error/exception.rb

@@ -35,10 +35,10 @@ module ElasticAPM
       )
 
       def inspect
-        "<ElasticAPM::Error::Exception" \
+        '<ElasticAPM::Error::Exception' \
           " type:#{type}" \
           " message:#{message}" \
-          ">"
+          '>'
       end
 
       class << self

data/lib/elastic_apm/error_builder.rb

@@ -53,7 +53,6 @@ module ElasticAPM
       error.culprit = stacktrace.frames.first&.function
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def add_current_transaction_fields(error, transaction)
       return unless transaction
 
@@ -70,6 +69,5 @@ module ElasticAPM
       Util.reverse_merge!(error.context.labels, transaction.context.labels)
       Util.reverse_merge!(error.context.custom, transaction.context.custom)
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
   end
 end