elastic-apm 3.15.1 → 4.2.0

data/docs/release-notes.asciidoc

@@ -6,6 +6,7 @@
 All notable changes to this project will be documented here.
 This project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioning].
 
+* <<release-notes-4.x>>
 * <<release-notes-3.x>>
 * <<release-notes-2.x>>
 * <<release-notes-1.x>>

data/docs/upgrading.asciidoc

@@ -16,30 +16,3 @@ We love all our products, but sometimes we must say goodbye to a release so that
 forward on future development and innovation.
 Our https://www.elastic.co/support/eol[End of life policy] defines how long a given release is considered supported,
 as well as how long a release is considered still in active development or maintenance.
-The table below is a simplified description of this policy.
-
-[options="header"]
-|====
-|Agent version |EOL Date |Maintained until
-|3.5.x |2021-07-17 | 3.6
-|3.4.x |2021-07-10 | 3.5
-|3.3.x |2021-06-04 | 3.4
-|3.2.x |2021-05-19 | 3.3
-|3.1.x |2021-04-21 | 3.2
-|3.0.x |2021-04-08 | 3.1
-|2.12.x |2021-04-01 |4.0
-|2.11.x |2021-03-23 |2.12
-|2.10.x |2021-03-03 |2.11
-|2.9.x |2020-12-25 |2.10
-|2.8.x |2020-11-20 |2.9
-|2.7.x |2020-11-07 |2.8
-|2.6.x |2020-09-19 |2.7
-|2.5.x |2020-09-01 |2.6
-|2.4.x |2020-08-27 |2.5
-|2.3.x |2020-07-29 |2.4
-|2.2.x |2020-07-22 |2.3
-|2.1.x |2020-06-04 |2.2
-|2.0.x |2020-05-14 |2.1
-|1.1.x |2020-03-07 |3.0
-|1.0.x |2019-12-29 |1.1
-|====

data/lib/elastic_apm.rb

@@ -32,6 +32,7 @@ require 'elastic_apm/internal_error'
 require 'elastic_apm/logging'
 
 # Core
+require 'elastic_apm/fields'
 require 'elastic_apm/agent'
 require 'elastic_apm/config'
 require 'elastic_apm/context'
@@ -380,6 +381,16 @@ module ElasticAPM
       agent&.set_user(user)
     end
 
+    # Set destination fields on the current span
+    #
+    # @param address [String] Destination address
+    # @param address [String] Destination address
+    # @param address [Hash] Destination service
+    # @param address [Hash] Destination cloud
+    def set_destination(address: nil, port: nil, service: nil, cloud: nil)
+      agent&.set_destination(address: address, port: port, service: service, cloud: cloud)
+    end
+
     # Provide a filter to transform payloads before sending them off
     #
     # @param key [Symbol] Unique filter key
@@ -387,7 +398,7 @@ module ElasticAPM
     # @yield [Hash] A filter. Used if provided. Otherwise using `callback`
     # @return [Bool] true
     def add_filter(key, callback = nil, &block)
-      if callback.nil? && !block_given?
+      if callback.nil? && !block
         raise ArgumentError, '#add_filter needs either `callback\' or a block'
       end
 

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
@@ -227,6 +227,10 @@ module ElasticAPM
       instrumenter.set_user(user)
     end
 
+    def set_destination(address: nil, port: nil, service: nil, cloud: nil)
+      current_span&.set_destination(address: nil, port: nil, service: nil, cloud: nil)
+    end
+
     def build_context(rack_env:, for_type:)
       @context_builder.build(rack_env: rack_env, for_type: for_type)
     end
@@ -276,8 +280,8 @@ module ElasticAPM
     def detect_forking!
       return if @pid == Process.pid
 
-      config.logger.debug "Detected forking,
-        restarting threads in process [PID:#{Process.pid}]"
+      config.logger.debug(
+        "Forked process detected, restarting threads in process [PID:#{Process.pid}]")
 
       central_config.handle_forking!
       transport.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
@@ -119,7 +119,7 @@ module ElasticAPM
       end
 
       if resp.status == 304
-        info 'Received 304 Not Modified'
+        debug 'Received 304 Not Modified'
       else
         if resp.body && !resp.body.empty?
           update = JSON.parse(resp.body.to_s)
@@ -164,11 +164,12 @@ module ElasticAPM
       @server_url ||=
         config.server_url +
         '/config/v1/agents' \
-        "?service.name=#{CGI.escape(config.service_name)}"
+        "?service.name=#{CGI.escape(config.service_name)}" \
+        "&service.environment=#{CGI.escape(config.environment || '')}"
     end
 
     def headers
-      { 'Etag': @etag }
+      { 'If-None-Match': @etag }
     end
 
     def schedule_next_fetch(resp = nil)
@@ -182,7 +183,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.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
@@ -140,6 +133,7 @@ module ElasticAPM
     def available_instrumentations
       %w[
         action_dispatch
+        azure_storage_table
         delayed_job
         dynamo_db
         elasticsearch
@@ -168,11 +162,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 +190,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 +228,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/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/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/fields.rb

@@ -0,0 +1,88 @@
+# 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
+  # An interface for creating simple, value holding objects that correspond to
+  # object fields in the API.
+  #
+  # Example:
+  #   class MyThing
+  #     include Fields
+  #     field :name
+  #     field :address, optional: true
+  #   end
+  #
+  #   MyThing.new(name: 'AJ').to_h
+  #     # => { name: 'AJ' }
+  #   MyThing.new().empty?
+  #     # => true
+  module Fields
+    module InstanceMethods
+      def initialize(**attrs)
+        attrs.each do |key, value|
+          self.send(:"#{key}=", value)
+        end
+
+        super()
+      end
+
+      def empty?
+        self.class.fields.each do |key|
+          next if send(key)
+          next if optionals.include?(key)
+
+          return true
+        end
+
+        false
+      end
+
+      def to_h
+        self.class.fields.each_with_object({}) do |key, fields|
+          fields[key] = send(key)
+        end
+      end
+
+      private
+
+      def optionals
+        self.class.optionals
+      end
+    end
+
+    module ClassMethods
+      def field(key, optional: false)
+        attr_accessor(key)
+
+        fields.push(key)
+        optionals.push(key) if optional
+      end
+
+      attr_reader :fields, :optionals
+    end
+
+    def self.included(cls)
+      cls.extend(ClassMethods)
+      cls.include(InstanceMethods)
+
+      cls.instance_variable_set(:@fields, [])
+      cls.instance_variable_set(:@optionals, [])
+    end
+  end
+end

data/lib/elastic_apm/grpc.rb

@@ -50,11 +50,9 @@ module ElasticAPM
 
         split_peer = URI.split(peer)
         destination = ElasticAPM::Span::Context::Destination.new(
-          type: TYPE,
-          name: SUBTYPE,
-          resource: peer,
           address: split_peer[0],
-          port: split_peer[6]
+          port: split_peer[6],
+          service: { type: TYPE, name: SUBTYPE, resource: peer }
         )
         ElasticAPM::Span::Context.new(destination: destination)
       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/metadata/cloud_info.rb

@@ -57,9 +57,9 @@ module ElasticAPM
         when "gcp"
           fetch_gcp
         when "azure"
-          fetch_azure
+          fetch_azure || read_azure_app_services
         when "auto"
-          fetch_aws || fetch_gcp || fetch_azure
+          fetch_aws || fetch_gcp || fetch_azure || read_azure_app_services
         when "none"
           nil
         else
@@ -76,7 +76,7 @@ module ElasticAPM
         resp = @client.get(AWS_URI)
 
         return unless resp.status == 200
-        return unless (metadata = JSON.parse(resp.body))
+        return unless (metadata = JSON.parse(resp.body.to_s))
 
         self.provider = "aws"
         self.account_id = metadata["accountId"]
@@ -92,7 +92,7 @@ module ElasticAPM
         resp = @client.headers("Metadata-Flavor" => "Google").get(GCP_URI)
 
         return unless resp.status == 200
-        return unless (metadata = JSON.parse(resp.body))
+        return unless (metadata = JSON.parse(resp.body.to_s))
 
         zone = metadata["instance"]["zone"]&.split("/")&.at(-1)
 
@@ -112,7 +112,7 @@ module ElasticAPM
         resp = @client.headers("Metadata" => "true").get(AZURE_URI)
 
         return unless resp.status == 200
-        return unless (metadata = JSON.parse(resp.body))
+        return unless (metadata = JSON.parse(resp.body.to_s))
 
         self.provider = 'azure'
         self.account_id = metadata["subscriptionId"]
@@ -125,6 +125,33 @@ module ElasticAPM
       rescue HTTP::TimeoutError, HTTP::ConnectionError
         nil
       end
+
+      def read_azure_app_services
+        owner_name, instance_id, site_name, resource_group =
+          ENV.values_at(
+            'WEBSITE_OWNER_NAME',
+            'WEBSITE_INSTANCE_ID',
+            'WEBSITE_SITE_NAME',
+            'WEBSITE_RESOURCE_GROUP'
+          )
+
+        return unless owner_name && instance_id && site_name && resource_group
+
+        self.provider = 'azure'
+        self.instance_id = instance_id
+        self.instance_name = site_name
+        self.project_name = resource_group
+        self.account_id, self.region = parse_azure_app_services_owner_name(owner_name)
+      end
+
+      private
+
+      def parse_azure_app_services_owner_name(owner_name)
+        id, rest = owner_name.split('+')
+        *_, region = rest.split('-')
+        region.gsub!(/webspace.*$/, '')
+        [id, region]
+      end
     end
   end
 end