elastic-apm 3.9.0 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb0d3e0244586e4fe0b9c89beacd267272c0d6b8467457fcce9fde228b22742e
-  data.tar.gz: e3279992b31d2826b6e53c8c66802c1641d30a8b8134671298280b370fa2f8e1
+  metadata.gz: 0c810b4e9b4f1149873235af4d1ddd6b4a85acf7734c491a42d21777443d57a0
+  data.tar.gz: f63af16c444a3a5499cd9246b1d11bba2cd9a7a31efed58bfd23d5b1c8b3e0d3
 SHA512:
-  metadata.gz: a81c23c3e427e727484854c89072c17704c11fbccca518169ae75a7aa8a45bc04966226044cebcd9c1d36fe7c986053e74e1c1b0456cc6cb23bcd0207204ef9d
-  data.tar.gz: de7d4efea50ee03db830ac3570cadc40277fd67ce630c4388f942cfbca005a8b0af72f81b0712eb38972aa7d38c01971fe4697888a75f55ffeba51b98fc51b6b
+  metadata.gz: ed48f7f3870b346a17ec5e263c90c67f68b1f355a4900c3a79ae998bf689b1b549e6658d7c4165b934091669734bea561acf9991b82446a6ca4164558a488301
+  data.tar.gz: f87f347bf3a72e8d331e95d95ceca640d12754cb049ce4c39097b03b75d022c347f95062d3e311e0fb0cbc90f61050449ed1bd6f39f8682c95e935fccf7509f9

data/CHANGELOG.asciidoc

@@ -35,9 +35,75 @@ endif::[]
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[release-notes-3.12.0]]
+==== 3.12.0 (2020-11-10)
+
+[float]
+===== Added
+
+- Add outcome to transactions and spans {pull}883[#883]
+
+[[release-notes-3.11.1]]
+==== 3.11.1 (2020-11-05)
+
+[float]
+===== Fixed
+
+- Fix reporting from Kubernetes based deploys to APM Server 7.9.x {pull}885[#885]
+
+[[release-notes-3.11.0]]
+==== 3.11.0 (2020-10-27)
+
+[float]
+===== Added
+
+- Add and read sampling info from Tracestate headers {pull}858[#858]
+- Add information about cloud hosting environment if available {pull}871[#871]
+
+[float]
+===== Changed
+
+- Align the default value of `sanitize_field_names` with other agents {pull}867[#867]
+- Ensure max 4 digits of precision for `sample_rate` as per agent spec {pull}880[#880]
+
+[float]
+===== Fixed
+
+- Fix Delayed::Job class names when used through ActiveJob {pull}869[#869]
+- Fix Delayed::Job when run without the agent running {pull}874[#874]
+- Fix Kubernetes related metadata {pull}882[#882]
+
+[[release-notes-3.10.1]]
+==== 3.10.1 (2020-08-26)
+
+[float]
+===== Fixed
+
+- Remove secrets from cookies in errors {pull}863[#863]
+- Silence deprecation warning when setting `ignore_url_patterns` to default {pull}865[#865]
+
+[[release-notes-3.10.0]]
+==== 3.10.0 (2020-08-26)
+
+[float]
+===== Added
+
+- Config option `transaction_ignore_urls` to replace `ignore_url_patterns` {pull}844[#844]
+- Prepend `(?-i)` to patterns to make them case-sensitive {pull}846[#846]
+
+[float]
+===== Fixed
+
+- Reverted {pull}839[#839]
+- Improved Kubernetes pod ID detection {pull}859[#859]
+
 [[release-notes-3.9.0]]
 ==== 3.9.0 (2020-08-04)
 
+[float]
+===== Fixed
+- Scrub request body of illegal UTF-8 characters {pull}832[#832]
+
 [float]
 ===== Added
 

data/Gemfile

@@ -22,14 +22,11 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Tools
-gem 'bootsnap', require: false
 gem 'cucumber', require: false
 gem 'pry'
 gem 'rack-test'
 gem 'rspec', '~> 3'
 gem 'rspec-its'
-gem 'rubocop', require: nil
-gem 'rubocop-performance', require: nil
 gem 'timecop'
 gem 'webmock'
 
@@ -42,6 +39,7 @@ gem 'faraday', require: nil
 gem 'graphql', require: nil
 gem 'google-protobuf', '< 3.12' if !defined?(JRUBY_VERSION) && RUBY_VERSION < '2.5'
 gem 'grpc' if !defined?(JRUBY_VERSION)
+gem 'json'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil

data/docs/api.asciidoc

@@ -433,6 +433,7 @@ end
 - `name`: String
 - `type`: String
 - `result`: String
+- `outcome`: String ('unknown', 'success', 'failure', nil)
 - `trace_id`: String (readonly)
 
 [float]
@@ -457,7 +458,7 @@ If your service generates the HTML page dynamically, initializing the
 JavaScript RUM agent with the value of this method allows analyzing the time
 spent in the browser vs in the backend services.
 
-To enable the JavaScript RUM agent, initilialize the RUM agent with the Ruby
+To enable the JavaScript RUM agent, initialize the RUM agent with the Ruby
 agent's current transaction:
 
 [source,html]

data/docs/configuration.asciidoc

@@ -853,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]]

data/lib/elastic_apm.rb

@@ -183,7 +183,12 @@ module ElasticAPM
             context: context,
             trace_context: trace_context
           )
-        yield transaction
+        result = yield transaction
+        transaction&.outcome ||= Transaction::Outcome::SUCCESS
+        result
+      rescue
+        transaction&.outcome ||= Transaction::Outcome::FAILURE
+        raise
       ensure
         end_transaction
       end
@@ -287,7 +292,14 @@ module ElasticAPM
             parent: parent,
             sync: sync
           )
-        yield span
+        result = yield span
+        span&.outcome =
+          Span::Outcome::SUCCESS unless span&.outcome
+        result
+      rescue
+        span&.outcome =
+          Span::Outcome::FAILURE unless span&.outcome
+        raise
       ensure
         end_span
       end

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'
@@ -45,6 +51,7 @@ module ElasticAPM
     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'
@@ -76,7 +83,8 @@ 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
@@ -87,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
@@ -188,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
@@ -234,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. ' \
@@ -318,7 +344,7 @@ module ElasticAPM
       self.logger ||= ::Rails.logger
 
       self.__root_path = ::Rails.root.to_s
-      self.__view_paths = ::ActionController::Base.view_paths.map(&:to_s)
+      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/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