elastic-apm 3.12.0 → 3.15.1

data/CHANGELOG.asciidoc

@@ -35,6 +35,74 @@ endif::[]
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[release-notes-3.15.1]]
+==== 3.15.1 (2021-04-06)
+
+[float]
+===== Fixed
+
+- AWS S3 spy accepts symbol bucket names {pull}998[#998]
+- AWS S3 spy passing on blocks {pull}998[#998]
+
+[[release-notes-3.15.0]]
+==== 3.15.0 (2021-03-22)
+
+[float]
+===== Changed
+
+- Changed DynamoDB instrumentation to match spec. Span names now follow the format `DynamoDB
+  Operation [table]` {pull}976[#976]
+
+[float]
+===== Added
+- Support for AWS S3 {pull}977[#977]
+- Support for AWS SQS {pull}978[#978]
+- Support for AWS SNS {pull}978[#978]
+
+[[release-notes-3.14.0]]
+==== 3.14.0 (2021-03-17)
+
+[float]
+===== Added
+
+- Expanded support for extracting ActiveRecord adapter name from notification payload when using
+  ActiveRecord versions before 6.0 {pull}953[#953]
+
+[float]
+===== Fixed
+
+- Fixed setting outcome in Mongo spy when not traced {pull}937[#937]
+- Fixed missing container metadata in payloads {pull}942[#942]
+- Fixed outgoing HTTP request spans with no Host {pull}962[#962]
+
+[[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)
 

data/Gemfile

@@ -23,7 +23,6 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Tools
 gem 'cucumber', require: false
-gem 'pry'
 gem 'rack-test'
 gem 'rspec', '~> 3'
 gem 'rspec-its'
@@ -32,13 +31,17 @@ gem 'webmock'
 
 # Integrations
 gem 'aws-sdk-dynamodb', require: nil
+gem 'aws-sdk-s3', require: nil
 gem 'aws-sdk-sqs', require: nil
+gem 'aws-sdk-sns', require: nil
 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' if !defined?(JRUBY_VERSION) && RUBY_VERSION < '3.0'
 gem 'json'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
@@ -55,6 +58,10 @@ gem 'sucker_punch', '~> 2.0', require: nil
 gem 'yard', require: nil
 gem 'yarjuf'
 
+# See issue #6547 in the JRuby repo. When that bug is fixed,
+# we can use the latest version of the i18n gem.
+gem 'i18n', '< 1.8.8'
+
 ## Install Framework
 GITHUB_REPOS = {
   'grape' => 'ruby-grape/grape',
@@ -72,8 +79,10 @@ end
 
 frameworks_versions.each do |framework, version|
   case version
-  when 'master'
+  when 'master' # sinatra, grape
     gem framework, github: GITHUB_REPOS.fetch(framework)
+  when 'main' # rails
+    gem framework, github: GITHUB_REPOS.fetch(framework), branch: 'main'
   when /.+/
     gem framework, "~> #{version}.0"
   else
@@ -82,18 +91,26 @@ frameworks_versions.each do |framework, version|
 end
 
 if frameworks_versions.key?('rails')
-  unless frameworks_versions['rails'] =~ /^(master|6)/
+  unless frameworks_versions['rails'] =~ /^(main|6)/
     gem 'delayed_job', require: nil
   end
 end
 
 if RUBY_PLATFORM == 'java'
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'jdbc-sqlite3'
+  case rails = frameworks_versions['rails']
+  when 'main'
+    gem 'activerecord-jdbcsqlite3-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', glob: 'activerecord-jdbcsqlite3-adapter/*.gemspec'
+  when ''
+    gem 'activerecord-jdbcsqlite3-adapter', "~> 61.0"
+  when nil
+    gem 'jdbc-sqlite3'
+  else
+    gem 'activerecord-jdbcsqlite3-adapter', "~> #{rails.tr('.', '')}.0"
+  end
 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/configuration.asciidoc

@@ -322,6 +322,23 @@ Usually APM Server determines how often to poll, but if not the default interval
 
 NOTE: This feature requires APM Server v7.3 or later and that the APM Server is configured with `kibana.enabled: true`.
 
+[float]
+[[config-cloud-provider]]
+==== `cloud_provider`
+|============
+| Environment                  | `Config` key     | Default
+| `ELASTIC_APM_CLOUD_PROVIDER` | `cloud_provider` | `"auto"`
+|============
+
+Specify the cloud provider for metadata collection.
+Defaults to `"auto"`, which means the agent uses trial and
+error to collect metadata from all supported cloud providers.
+
+Valid options are `"auto"`, `"aws"`, `"gcp"`, `"azure"`, and `"none"`.
+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.]
@@ -798,12 +815,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.

data/docs/supported-technologies.asciidoc

@@ -77,6 +77,8 @@ requests using these libraries:
 - Http.rb (v0.6+)
 - Faraday (v0.2.1+)
 
+*Note:* These libraries usually assume `localhost` if no `Host` is specified, so the agent does as well. 
+
 [float]
 [[supported-technologies-backgroud-processing]]
 === Background Processing

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
     #
@@ -293,12 +295,10 @@ module ElasticAPM
             sync: sync
           )
         result = yield span
-        span&.outcome =
-          Span::Outcome::SUCCESS unless span&.outcome
+        span&.outcome ||= Span::Outcome::SUCCESS
         result
       rescue
-        span&.outcome =
-          Span::Outcome::FAILURE unless span&.outcome
+        span&.outcome ||= Span::Outcome::FAILURE
         raise
       ensure
         end_span

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

@@ -19,6 +19,7 @@
 
 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'
@@ -32,11 +33,13 @@ 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"
+    # "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*]
+      %w[*password* *passwd* *pwd* *secret* *key* *token* *session*
+         *credit* *card* *authorization* *set-cookie*].freeze
 
-    # rubocop:disable Metrics/LineLength, Layout/ExtraSpacing
+    # 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
@@ -73,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
@@ -83,9 +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: SANITIZE_FIELD_NAMES_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
@@ -102,7 +104,7 @@ module ElasticAPM
     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
 
@@ -126,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
 
@@ -150,11 +151,14 @@ module ElasticAPM
         rake
         redis
         resque
+        s3
         sequel
         shoryuken
         sidekiq
         sinatra
         sneakers
+        sns
+        sqs
         sucker_punch
         tilt
       ]
@@ -201,8 +205,9 @@ module ElasticAPM
     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) # use regex pattern for comparisons
+        defaults.concat(list).uniq(&:pattern)
     end
 
     def span_frames_min_duration?
@@ -223,8 +228,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)
@@ -278,15 +283,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)
@@ -295,6 +305,15 @@ module ElasticAPM
       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
@@ -313,7 +332,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
@@ -344,7 +363,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)