elastic-apm 3.10.1 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6db74de4a0201f5b5dd7e9f96b7ec383ce3276a56d7f9d57e64617dd7cf1a28
-  data.tar.gz: '0319a664e07b2411428134e24ed58f21049acf856cf163c6434fb66934e4cd1f'
+  metadata.gz: 49c0c5abfddc19b97d5a0a25f7adeff62bd8ed99a1bdcb97d94ca9b3ff09134f
+  data.tar.gz: 4e7a68808d904181b3649cc766c075e5b575633b55a370047cd85c4eff53c5ef
 SHA512:
-  metadata.gz: 7bc1dfb374ea6107f07f690d764205f44c00a588eed767d7621b42640bf00f322d5e8b7c6a3d4958b0753b4755722836a05577fcee5b1a15207a355860a1f71b
-  data.tar.gz: 780227ecdd4592d5f3aaa87b54824b4ed36dc9686052b51314815ebbf3152855dc5ff186c69deb88b86f2eab1d7aa9e4170bfd1454b2fdca3ab82d513eb0280a
+  metadata.gz: 94af89d9a12520b2344f941b85eefdd6d0bd447dc75ac75b220b491611e0b16a47722cce78badf8f065f78cd09496d7a63d5a0e392af3ee939ed86ecef43599b
+  data.tar.gz: '0790d669dede1e490e290960129488264dc9661224ccb011094c1a3a5a48419ad628f5b7e83ba11ad273c8af1698e9d935cb2d6f3a823197793931f2ec27e7de'

data/.github/labeler-config.yml

@@ -0,0 +1,3 @@
+# add 'agent-ruby' label to all new issues
+agent-ruby:
+  - '.*'

data/.github/workflows/labeler.yml

@@ -0,0 +1,16 @@
+name: "Issue Labeler"
+on:
+  issues:
+    types: [opened]
+  pull_request_target:
+    types: [opened]
+
+jobs:
+  triage:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: AlexanderWert/issue-labeler@v2.3
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+        configuration-path: .github/labeler-config.yml
+        enable-versioned-regex: 0

data/.rubocop.yml

@@ -1,11 +1,13 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
+  NewCops: enable
   Exclude:
     - 'elastic-apm.gemspec'
     - 'vendor/**/*'
     - 'bench/*'
     - 'spec/support/helloworld_pb.rb'
     - 'spec/support/helloworld_services_pb.rb'
+    - 'features/step_definitions/stepdefs.rb'
 
 require:
   - rubocop-performance
@@ -32,6 +34,15 @@ Lint/RescueException:
 Lint/SuppressedException:
   Enabled: false
 
+Lint/ConstantDefinitionInBlock: # So we can define a class in an rspec block
+  Enabled: false
+
+Lint/EmptyClass:
+  Enabled: false
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: false
+
 # Metrics /
 
 Metrics/AbcSize:
@@ -104,9 +115,27 @@ Style/HashEachMethods:
 Style/HashTransformKeys:
   Enabled: true
 
-Style/HashTransformValues:
-  Enabled: true
-
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/StringLiterals:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/SoleNestedConditional:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+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

@@ -35,6 +35,72 @@ endif::[]
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[release-notes-3.13.0]]
+==== 3.13.0 (2020-12-22)
+
+[float]
+===== Fixed
+
+- Handle invalid utf-8 byte sequences in sql summarizer and DB statement {pull}896[#896]
+- Expand Kubernetes metadata discovery {pull}916[#916]
+- Fix fetching cloud info on Http.rb 3.x versions {pull}919[#919]
+
+[float]
+===== Added
+
+- Support both integer and string log levels, and extra central config values {pull}902[#902]
+
+[float]
+===== Changed
+
+- Rename server_ca_cert to server_ca_cert_file {pull}908[#908]
+
+[[release-notes-3.12.1]]
+==== 3.12.1 (2020-11-16)
+
+[float]
+===== Fixed
+
+- `capture_elasticsearch_queries` no longer modifies the original query {pull}894[#894]
+
+[[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)
 
@@ -42,6 +108,7 @@ endif::[]
 ===== 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)

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'
 
@@ -40,8 +37,10 @@ gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 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)
+if !defined?(JRUBY_VERSION) && RUBY_VERSION < '2.5'
+  gem 'google-protobuf', '< 3.12'
+end
+gem 'grpc' unless defined?(JRUBY_VERSION)
 gem 'json'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
@@ -96,7 +95,7 @@ if RUBY_PLATFORM == 'java'
 elsif frameworks_versions['rails'] =~ /^(4|5)/
   gem 'sqlite3', '~> 1.3.6'
 else
-  gem 'sqlite3' # rubocop:disable Bundler/DuplicatedGem
+  gem 'sqlite3'
 end
 
 group :bench do

data/Rakefile

@@ -19,9 +19,9 @@
 
 require 'bundler/gem_tasks'
 
-desc """Post release action:
-Update `3.x` branch to be at released commit and push it to GitHub.
-"""
+desc 'Post release action:'\
+'Update `3.x` branch to be at released commit and push it to GitHub.'
+
 namespace :release do
   task :update_branch do
     `git checkout 3.x &&
@@ -41,11 +41,11 @@ task docs: :yard
 task default: :spec
 
 namespace :coverage do
-    desc "Collates all result sets generated by the different test runners"
-    task :report do
-      require 'simplecov'
-      require 'simplecov-cobertura'
-      SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
-      SimpleCov.collate Dir["coverage/matrix_results/**/.resultset.json"]
-    end
+  desc "Collates all result sets generated by the different test runners"
+  task :report do
+    require 'simplecov'
+    require 'simplecov-cobertura'
+    SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+    SimpleCov.collate Dir["coverage/matrix_results/**/.resultset.json"]
   end
+end

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

@@ -798,12 +798,12 @@ It has to be provided in *<<config-format-duration, duration format>>*.
 
 [float]
 [[config-ssl-ca-cert]]
-==== `server_ca_cert`
+==== `server_ca_cert_file`
 
 [options="header"]
 |============
-| Environment                  | `Config` key     | Default | Example
-| `ELASTIC_APM_SERVER_CA_CERT` | `server_ca_cert` | `nil`   | `'/path/to/ca.pem'`
+| Environment                       | `Config` key     | Default | Example
+| `ELASTIC_APM_SERVER_CA_CERT_FILE` | `server_ca_cert_file` | `nil`   | `'/path/to/ca.pem'`
 |============
 
 The path to a custom CA certificate for connecting to APM Server.
@@ -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

@@ -106,6 +106,7 @@ module ElasticAPM
     # @yield [String|nil, String|nil, String|nil] The transaction, span,
     # and trace ids.
     # @return [String] Unless block given
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def log_ids
       trace_id = (current_transaction || current_span)&.trace_id
       if block_given?
@@ -118,6 +119,7 @@ module ElasticAPM
       ids << "trace.id=#{trace_id}" if trace_id
       ids.join(' ')
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # Start a new transaction
     #
@@ -183,7 +185,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 +294,12 @@ module ElasticAPM
             parent: parent,
             sync: sync
           )
-        yield span
+        result = yield span
+        span&.outcome ||= Span::Outcome::SUCCESS
+        result
+      rescue
+        span&.outcome ||= Span::Outcome::FAILURE
+        raise
       ensure
         end_span
       end

data/lib/elastic_apm/central_config.rb

@@ -19,6 +19,7 @@
 
 require 'elastic_apm/central_config/cache_control'
 
+# rubocop:disable Style/AccessorGrouping
 module ElasticAPM
   # @api private
   class CentralConfig
@@ -27,6 +28,7 @@ module ElasticAPM
     # @api private
     class ResponseError < InternalError
       def initialize(response)
+        super
         @response = response
       end
 
@@ -72,6 +74,7 @@ module ElasticAPM
     def fetch_config
       resp = perform_request
 
+      # rubocop:disable Lint/DuplicateBranch
       case resp.status
       when 200..299
         resp
@@ -82,6 +85,7 @@ module ElasticAPM
       when 500..599
         raise ServerError, resp
       end
+      # rubocop:enable Lint/DuplicateBranch
     end
 
     def assign(update)
@@ -122,7 +126,7 @@ module ElasticAPM
           assign(update)
         end
 
-        if update && update.any?
+        if update&.any?
           info 'Updated config from Kibana'
           debug 'Modified: %s', update.inspect
           debug 'Modified original options: %s', @modified_options.inspect
@@ -160,7 +164,7 @@ module ElasticAPM
       @server_url ||=
         config.server_url +
         '/config/v1/agents' \
-        "?service.name=#{config.service_name}"
+        "?service.name=#{CGI.escape(config.service_name)}"
     end
 
     def headers
@@ -182,3 +186,4 @@ module ElasticAPM
     end
   end
 end
+# rubocop:enable Style/AccessorGrouping

data/lib/elastic_apm/config.rb

@@ -17,9 +17,11 @@
 
 # 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/log_level_map'
+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,7 +32,14 @@ module ElasticAPM
 
     DEPRECATED_OPTIONS = %i[].freeze
 
-    # rubocop:disable Metrics/LineLength, Layout/ExtraSpacing
+    # 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
+
+    # rubocop:disable Layout/LineLength, Layout/ExtraSpacing
     option :config_file,                       type: :string, default: 'config/elastic_apm.yml'
     option :server_url,                        type: :url,    default: 'http://localhost:8200'
     option :secret_token,                      type: :string
@@ -45,6 +54,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'
@@ -66,7 +76,7 @@ module ElasticAPM
     option :ignore_url_patterns,               type: :list,   default: [],      converter: RegexpList.new
     option :instrument,                        type: :bool,   default: true
     option :instrumented_rake_tasks,           type: :list,   default: []
-    option :log_level,                         type: :int,    default: Logger::INFO
+    option :log_level,                         type: :int,    default: Logger::INFO, converter: LogLevelMap.new
     option :log_path,                          type: :string
     option :metrics_interval,                  type: :int,    default: '30s',   converter: Duration.new
     option :pool_size,                         type: :int,    default: 1
@@ -76,8 +86,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 :server_ca_cert,                    type: :string
+    option :sanitize_field_names,              type: :list,   default: SANITIZE_FIELD_NAMES_DEFAULT, converter: WildcardPatternList.new
+    option :server_ca_cert_file,               type: :string
     option :service_name,                      type: :string
     option :service_node_name,                 type: :string
     option :service_version,                   type: :string
@@ -89,12 +99,12 @@ module ElasticAPM
     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
 
-    # rubocop:enable Metrics/LineLength, Layout/ExtraSpacing
+    # rubocop:enable Layout/LineLength, Layout/ExtraSpacing
     def initialize(options = {})
       @options = load_schema
 
@@ -118,8 +128,7 @@ module ElasticAPM
       @__root_path ||= Dir.pwd
     end
 
-    attr_accessor :__view_paths, :__root_path
-    attr_accessor :logger
+    attr_accessor :__view_paths, :__root_path, :logger
 
     attr_reader :options
 
@@ -189,6 +198,15 @@ 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
@@ -207,8 +225,8 @@ module ElasticAPM
 
       @ssl_context ||=
         OpenSSL::SSL::SSLContext.new.tap do |context|
-          if server_ca_cert
-            context.ca_file = server_ca_cert
+          if server_ca_cert_file
+            context.ca_file = server_ca_cert_file
           else
             context.cert_store =
               OpenSSL::X509::Store.new.tap(&:set_default_paths)
@@ -236,8 +254,10 @@ module ElasticAPM
     end
 
     def ignore_url_patterns=(value)
-      warn '[DEPRECATED] The option ignore_url_patterns is being removed. ' \
-        'Consider using transaction_ignore_urls instead.'
+      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
@@ -260,15 +280,20 @@ module ElasticAPM
     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.'
+    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)
@@ -277,6 +302,12 @@ module ElasticAPM
       self.enabled = value
     end
 
+    def server_ca_cert=(value)
+      warn '[DEPRECATED] The option server_ca_cert has been ' \
+        'renamed to server_ca_cert_file to align with other agents.'
+      self.server_ca_cert_file = value
+    end
+
     private
 
     def load_config_file
@@ -295,7 +326,7 @@ module ElasticAPM
     end
 
     def build_logger
-      Logger.new(log_path == '-' ? STDOUT : log_path).tap do |logger|
+      Logger.new(log_path == '-' ? $stdout : log_path).tap do |logger|
         logger.level = log_level
       end
     end
@@ -326,7 +357,8 @@ module ElasticAPM
       self.logger ||= ::Rails.logger
 
       self.__root_path = ::Rails.root.to_s
-      self.__view_paths = app.config.paths['app/views'].existent + [::Rails.root.to_s]
+      self.__view_paths = app.config.paths['app/views'].existent +
+                          [::Rails.root.to_s]
     end
 
     def rails_app_name(app)