elastic-apm 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c396bc981217532f2d6775de89e9a2aa7a1bcd501100588bbd700d0f4f2eb590
-  data.tar.gz: 94f859585a09fc99f02a4bbd261193e0ed1f74bdb9463968692a16f277b1e4f0
+  metadata.gz: edae30dc148307b137e402a81ffed731cbe738ca7924f31c9440a9a6ea9a8eb4
+  data.tar.gz: ef860d2d783fd9351b0eea3106e96eafbadef339fa72a4b5979fbc38d4e3d46a
 SHA512:
-  metadata.gz: ae66a68c4651f695361b2028bf76132e8bc257fc141d3ad2872786bbab10b8e19bc3609a84478de53e56ad0c15695ad7debbcf62c4af8997833d0cf7cc7f6d23
-  data.tar.gz: c6b9fd6f80de4139cac0dd040e45d56f869eb2ff8b3db38df376e898490b8c2a5523a9bb3f1ba73a8583356ae5647ec67835b994597dc3db8d72c62ee506794f
+  metadata.gz: 8e1543b7f39d5ba73eb30e34777ba07a8ae940ddd1aee2d84afc445642319304bd26036a9eb5b5e6d4d9c11bbc0323c7c17aa2bd18101bbfcfed1cdcf6bdc635
+  data.tar.gz: 971963f1d06a398c2af8f988e4386004b7fb176e67d6d8c35b9be8a781b8561fd8236395d89f51ef87e3cad4375f9c91c4105e550dc7f7b1e7b1142e1d0f7c17

data/.ci/.jenkins_exclude.yml

@@ -1,27 +1,31 @@
 exclude:
-  # Ruby 2.3
-  # Only includes rails-5.2, sinatra-2.0
-  - RUBY_VERSION: ruby:2.3
+  # Ruby 2.4
+  # Only test on rails-5.2, sinatra-1.4
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-6.1
-  - RUBY_VERSION: ruby:2.3
+  - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-6.0
-  - RUBY_VERSION: ruby:2.3
+  - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-4.2
-  - RUBY_VERSION: ruby:2.3
-    FRAMEWORK: sinatra-1.4
-  - RUBY_VERSION: ruby:2.3
-    FRAMEWORK: grape-1.5
-  - RUBY_VERSION: ruby:2.3
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.0
-  - RUBY_VERSION: ruby:2.3
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: sinatra-2.2
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: grape-1.6
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.0
+  - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-main
-  - RUBY_VERSION: ruby:2.3
+  - RUBY_VERSION: ruby:2.4
     FRAMEWORK: sinatra-master
-  - RUBY_VERSION: ruby:2.3
+  - RUBY_VERSION: ruby:2.4
     FRAMEWORK: grape-master
 
   # rails-4.2 exclusions
-  # Only test on ruby 2.6, 2.5, 2.4, 2.3
+  # Only test on ruby 2.6, 2.5, 2.4
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: rails-4.2
   - RUBY_VERSION: ruby:3.0
     FRAMEWORK: rails-4.2
   - RUBY_VERSION: ruby:2.7
@@ -35,6 +39,8 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
     FRAMEWORK: rails-4.2
   # sinatra-1.4 exclusions
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: sinatra-1.4
   - RUBY_VERSION: ruby:3.0
     FRAMEWORK: sinatra-1.4
   - RUBY_VERSION: ruby:2.7
@@ -55,7 +61,11 @@ exclude:
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-6.0
 
-  # Only test rails master on ruby 2.7 and ruby 3.0
+  # Only test rails master on ruby 3.1
+  - RUBY_VERSION: ruby:3.0
+    FRAMEWORK: rails-main
+  - RUBY_VERSION: ruby:2.7
+    FRAMEWORK: rails-main
   - RUBY_VERSION: ruby:2.6
     FRAMEWORK: rails-main
   - RUBY_VERSION: ruby:2.5
@@ -71,7 +81,25 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
     FRAMEWORK: rails-main
 
-  # Only test sinatra master on ruby 2.7 and ruby 3.0
+  # Only test rails 7.0 on ruby >= 2.7
+  - RUBY_VERSION: ruby:2.6
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: ruby:2.5
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: jruby:9.2
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: rails-7.0
+
+  # Only test sinatra master on ruby 2.7 and ruby 3.1
+  - RUBY_VERSION: ruby:3.0
+    FRAMEWORK: sinatra-master
   - RUBY_VERSION: ruby:2.6
     FRAMEWORK: sinatra-master
   - RUBY_VERSION: ruby:2.5
@@ -104,31 +132,60 @@ exclude:
     FRAMEWORK: grape-master
 
   # grape 1.5 doesn't support ruby 3.0
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: ruby:3.0
-    FRAMEWORK: grape-1.5
+    FRAMEWORK: grape-1.6
   - RUBY_VERSION: ruby:3.0
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
 
-  # only test ruby 3.0 with rails 6.0 and rails 6.1
+  # only test ruby >= 3.0 with rails 6.0 and rails 6.1
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: rails-5.2
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: rails-5.1
   - RUBY_VERSION: ruby:3.0
     FRAMEWORK: rails-5.2
   - RUBY_VERSION: ruby:3.0
     FRAMEWORK: rails-5.1
 
   # Unsupported
+  # Ruby 2.6
+  - RUBY_VERSION: ruby:2.6
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: ruby:2.6
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # Ruby 2.5
   - RUBY_VERSION: ruby:2.5
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - RUBY_VERSION: ruby:2.5
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # Ruby 2.4
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: ruby:2.4
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
-  - RUBY_VERSION: ruby:2.3
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2
   - RUBY_VERSION: jruby:9.2
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - RUBY_VERSION: jruby:9.2
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2-13-jdk
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2-11-jdk
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2-8-jdk
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0

data/.ci/.jenkins_framework.yml

@@ -1,12 +1,13 @@
 FRAMEWORK:
+  - rails-7.0
   - rails-6.1
   - rails-6.0
   - rails-5.2
   - rails-4.2
 
-  - sinatra-2.0
+  - sinatra-2.2
   - sinatra-1.4
 
-  - grape-1.5
+  - grape-1.6
 
-  - grape-1.5,sinatra-2.0,rails-6.1
+  - grape-1.6,sinatra-2.2,rails-6.1

data/.ci/.jenkins_ruby.yml

@@ -1,8 +1,8 @@
 RUBY_VERSION:
+  - ruby:3.1
   - ruby:3.0
   - ruby:2.7
   - ruby:2.6
-  - ruby:2.5
   - ruby:2.4
   - jruby:9.2
   - docker.elastic.co/observability-ci/jruby:9.2-13-jdk

data/.ci/.jenkins_ruby_benchmarks.yml

@@ -0,0 +1,6 @@
+RUBY_VERSION:
+  - ruby:3.1
+  - ruby:3.0
+  - ruby:2.7
+  - ruby:2.6
+  - jruby:9.2

data/.ci/Jenkinsfile

@@ -21,8 +21,6 @@ pipeline {
     CODECOV_SECRET = 'secret/apm-team/ci/apm-agent-ruby-codecov'
     DOCKER_REGISTRY = 'docker.elastic.co'
     DOCKER_SECRET = 'secret/apm-team/ci/docker-registry/prod'
-    GITHUB_CHECK_ITS_NAME = 'Integration Tests'
-    ITS_PIPELINE = 'apm-integration-tests-selector-mbp/master'
     RELEASE_SECRET = 'secret/apm-team/ci/apm-agent-ruby-rubygems-release'
     OPBEANS_REPO = 'opbeans-ruby'
     REFERENCE_REPO = '/var/lib/jenkins/.git-references/apm-agent-ruby.git'
@@ -42,7 +40,7 @@ pipeline {
     issueCommentTrigger("(${obltGitHubComments()}|^run benchmark tests)")
   }
   parameters {
-    booleanParam(name: 'Run_As_Master_Branch', defaultValue: false, description: 'Allow to run any steps on a PR, some steps normally only run on master branch.')
+    booleanParam(name: 'Run_As_Main_Branch', defaultValue: false, description: 'Allow to run any steps on a PR, some steps normally only run on main branch.')
     booleanParam(name: 'bench_ci', defaultValue: true, description: 'Enable run benchmarks.')
   }
   stages {
@@ -71,7 +69,7 @@ pipeline {
           expression { return env.ONLY_DOCS == "false" }
           anyOf {
             not { changeRequest() }
-            expression { return params.Run_As_Master_Branch }
+            expression { return params.Run_As_Main_Branch }
           }
         }
       }
@@ -115,33 +113,14 @@ pipeline {
             }
           }
         }
-        stage('Master Tests frameworks') {
+        stage('Main Tests frameworks') {
           options { skipDefaultCheckout() }
           steps {
-            catchError(buildResult: 'SUCCESS', stageResult: 'UNSTABLE', message: "The tests for the master framework have failed. Let's warn instead.") {
-              runTests('.ci/.jenkins_master_framework.yml')
+            catchError(buildResult: 'SUCCESS', stageResult: 'UNSTABLE', message: "The tests for the main framework have failed. Let's warn instead.") {
+              runTests('.ci/.jenkins_main_framework.yml')
             }
           }
         }
-        stage('Integration Tests') {
-          agent none
-          when {
-            beforeAgent true
-            anyOf {
-              changeRequest()
-              expression { return !params.Run_As_Master_Branch }
-            }
-          }
-          steps {
-            githubNotify(context: "${env.GITHUB_CHECK_ITS_NAME}", description: "${env.GITHUB_CHECK_ITS_NAME} ...", status: 'PENDING', targetUrl: "${env.JENKINS_URL}search/?q=${env.ITS_PIPELINE.replaceAll('/','+')}")
-            build(job: env.ITS_PIPELINE, propagate: false, wait: true,
-                  parameters: [ string(name: 'INTEGRATION_TEST', value: 'Ruby'),
-                                string(name: 'BUILD_OPTS', value: "--ruby-agent-version ${env.GIT_BASE_COMMIT} --ruby-agent-version-state ${env.GIT_BUILD_CAUSE} --ruby-agent-repo ${env.CHANGE_FORK?.trim() ?: 'elastic'}/${env.REPO} --opbeans-ruby-agent-branch ${env.GIT_BASE_COMMIT}"),
-                                string(name: 'GITHUB_CHECK_NAME', value: env.GITHUB_CHECK_ITS_NAME),
-                                string(name: 'GITHUB_CHECK_REPO', value: env.REPO),
-                                string(name: 'GITHUB_CHECK_SHA1', value: env.GIT_BASE_COMMIT) ])
-          }
-        }
       }
     }
     stage('Benchmarks') {
@@ -150,11 +129,11 @@ pipeline {
         beforeAgent true
         allOf {
           anyOf {
-            branch 'master'
+            branch 'main'
             branch "\\d+\\.\\d+"
             branch "v\\d?"
             tag pattern: 'v\\d+.*', comparator: "REGEXP"
-            expression { return params.Run_As_Master_Branch }
+            expression { return params.Run_As_Main_Branch }
             expression { return env.GITHUB_COMMENT?.contains('benchmark tests') }
           }
           expression { return params.bench_ci }
@@ -162,13 +141,13 @@ pipeline {
       }
       stages {
         stage('Clean Workspace') {
-          agent { label 'metal' }
+          agent { label 'microbenchmarks-pool' }
           steps {
             echo "Cleaning Workspace"
           }
           post {
             always {
-              cleanWs()
+              cleanWs(notFailBuild: true)
             }
           }
         }
@@ -183,7 +162,7 @@ pipeline {
               unstash 'source'
               dir("${BASE_DIR}"){
                 script {
-                  def versions = readYaml(file: ".ci/.jenkins_ruby.yml")
+                  def versions = readYaml(file: ".ci/.jenkins_ruby_benchmarks.yml")
                   def benchmarkTask = [:]
                   versions['RUBY_VERSION'].each{ v ->
                     benchmarkTask[v] = runBenchmark(v)
@@ -256,11 +235,12 @@ pipeline {
               (retry 10 curl --silent --show-error --fail -I https://rubygems.org/gems/elastic-apm/versions/${env.VERSION})
             """
             dir("${OPBEANS_REPO}"){
-              git credentialsId: 'f6c7695a-671e-4f4f-a331-acdce44ff9ba',
-                  url: "git@github.com:elastic/${OPBEANS_REPO}.git"
+              git(credentialsId: 'f6c7695a-671e-4f4f-a331-acdce44ff9ba',
+                  url: "git@github.com:elastic/${OPBEANS_REPO}.git",
+                  branch: 'main')
               // It's required to transform the tag value to the gem version
               sh script: ".ci/bump-version.sh ${env.VERSION}", label: 'Bump version'
-              // The opbeans pipeline will trigger a release for the master branch
+              // The opbeans pipeline will trigger a release for the main branch
               gitPush()
               // The opbeans pipeline will trigger a release for the release tag
               gitCreateTag(tag: "${env.BRANCH_NAME}")
@@ -282,7 +262,7 @@ pipeline {
 */
 def runBenchmark(version){
   return {
-    node('metal'){
+    node('microbenchmarks-pool'){
       // Transform the versions like:
       //  - docker.elastic.co/observability-ci/jruby:9.2-12-jdk to jruby-9.2-12-jdk
       //  - jruby:9.1 to jruby-9.1
@@ -298,8 +278,6 @@ def runBenchmark(version){
             }
             try{
               sh """./spec/scripts/benchmarks.sh "${version}" "${REFERENCE_REPO}" """
-            } catch(e){
-              throw e
             } finally {
               archiveArtifacts(
                 allowEmptyArchive: true,
@@ -307,6 +285,7 @@ def runBenchmark(version){
                 onlyIfSuccessful: false)
               sendBenchmarks(file: "benchmark-${transformedVersion}.bulk",
                 index: "benchmark-ruby", archive: true)
+              cleanWs(notFailBuild: true)
             }
           }
         }

data/.ci/jobs/apm-agent-ruby-mbp.yml

@@ -15,7 +15,7 @@
         repo: apm-agent-ruby
         repo-owner: elastic
         credentials-id: 2a9602aa-ab9f-4e52-baf3-b71ca88469c7-UserAndToken
-        head-filter-regex: '^(master|PR-.*|[3-4]\.x)$'
+        head-filter-regex: '^(main|PR-.*|[3-9]\.x|v4\.[5-9]+.*|v[5-9]+.*)$'
         ssh-checkout:
           credentials: f6c7695a-671e-4f4f-a331-acdce44ff9ba
         build-strategies:

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -34,16 +34,16 @@ Add a checklist of things that are required to be reviewed in order to have the
 List here all the items you have verified BEFORE sending this PR. Please DO NOT remove any item, striking through those that do not apply. (Just in case, strikethrough uses two tildes. ~~Scratch this.~~)
 -->
 
-- [ ] I have signed the [Contributor License Agreement](https://www.elastic.co/contributor-agreement/). 
+- [ ] I have signed the [Contributor License Agreement](https://www.elastic.co/contributor-agreement/).
 - [ ] My code follows the style guidelines of this project (See `.rubocop.yml`)
-- [ ] I have rebased my changes on top of the latest master branch
+- [ ] I have rebased my changes on top of the latest main branch
 <!--
-Update your local repository with the most recent code from the main repo, and rebase your branch on top of the latest master branch. We prefer your initial changes to be squashed into a single commit. Later, if we ask you to make changes, add them as separate commits. This makes them easier to review.
+Update your local repository with the most recent code from the main repo, and rebase your branch on top of the latest main branch. We prefer your initial changes to be squashed into a single commit. Later, if we ask you to make changes, add them as separate commits. This makes them easier to review.
 -->
 - [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] New and existing [**unit** tests](https://github.com/elastic/apm-agent-ruby/blob/master/CONTRIBUTING.md#testing) pass locally with my changes
+- [ ] New and existing [**unit** tests](https://github.com/elastic/apm-agent-ruby/blob/main/CONTRIBUTING.md#testing) pass locally with my changes
 <!--
-Run the test suite to make sure that nothing is broken. See https://github.com/elastic/apm-agent-ruby/blob/master/CONTRIBUTING.md#testing for details.
+Run the test suite to make sure that nothing is broken. See https://github.com/elastic/apm-agent-ruby/blob/main/CONTRIBUTING.md#testing for details.
 -->
 - [ ] I have made corresponding changes to the documentation
 - [ ] I have updated [CHANGELOG.asciidoc](CHANGELOG.asciidoc)

data/.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 repos:
--   repo: git://github.com/pre-commit/pre-commit-hooks
+-   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.2.3
     hooks:
     -   id: check-case-conflict
@@ -9,7 +9,7 @@ repos:
     -   id: check-yaml
     -   id: check-xml
 
--   repo: git@github.com:elastic/apm-pipeline-library
+-   repo: https://github.com/elastic/apm-pipeline-library
     rev: current
     hooks:
     -   id: check-bash-syntax

data/CHANGELOG.asciidoc

@@ -35,6 +35,44 @@ endif::[]
 [[release-notes-4.x]]
 === Ruby Agent version 4.x
 
+[[release-notes-4.6.0]]
+==== 4.6.0
+
+[float]
+===== Added
+
+- Added transaction_name to reported error to allow grouping by transaction name {pull}1267[#1267]
+- Added ability to query server for version (useful in the future) {pull}1278[#1278]
+- Added instrumentation for https://github.com/zendesk/racecar/ Racecar Kafka library {pull}1284[#1284]
+
+===== Changed
+
+- Expanded filtering to sanitize any key that contains the string 'auth' {pull}1266[#1266]
+- Rename `log_ecs_formatting` option to `log_ecs_reformatting`, deprecate old option name {pull}1248[#1248]
+- When the configuration value for `log_path` is set, override the `logger` to point to that path instead of using e.g. Rails logger {pull}1247[#1247]
+- Only send tracestate header for distributed tracing when it has content {pull}1277[#1277]
+- Use the hostname as the Kubernetes pod name in the Container Info metadata if the pod id is parsed from cgroup {pull}1314[#1314]
+
+====== Fixed
+
+- Small change to Sidekiq tests to handle new configuration passing method {pull}1283[#1283]
+- Set transaction sample rate to 0 when it's unsampled {pull}1339[#1339]
+- Don't send unsampled transactions to APM server >= 8.0 {pull}1341[#1341]
+
+[[release-notes-4.5.1]]
+==== 4.5.1
+
+[float]
+===== Changed
+
+- Update elasticsearch spy to use new transport gem name {pull}1257[#1257]
+- Standardize placeholder for phone numbers as [PHONENUMBER] per https://github.com/elastic/apm/blob/main/specs/agents/tracing-instrumentation-aws.md {pull}1246[#1246]
+
+===== Fixed
+
+- Fixed dependencies to allow CI to build successfully {pull}1259[#1259]
+- Fixed warnings related to TimeTask timeouts {pull}1255[#1255]
+
 [[release-notes-4.5.0]]
 ==== 4.5.0
 

data/CONTRIBUTING.md

@@ -20,7 +20,7 @@ or that there are particular issues that you should know about before implementi
 
 ### Workflow
 
-All feature development and most bug fixes hit the master branch first.
+All feature development and most bug fixes hit the main branch first.
 Pull requests should be reviewed by someone with commit access.
 Once approved, the author of the pull request,
 or reviewer if the author does not have commit access,
@@ -42,7 +42,7 @@ To release a new version:
 
 1. Update `VERSION` in `lib/elastic_apm/version.rb` according to the changes (major, minor, patch).
 1. Update `CHANGELOG.md` to reflect the new version – change _Unreleased_ section to _Version (release date)_.
-1. For Majors: Add a new row to the EOL table in `docs/upgrading.asciidoc`. The EOL date is the release date plus 18 months. 
+1. For Majors: Add a new row to the EOL table in `docs/upgrading.asciidoc`. The EOL date is the release date plus 18 months.
 1. Make a new commit with the changes above, with a message in the style of `vX.X.X`.
 1. Run `rake release`. This will...
     1. Tag the current commit as new version.

data/Gemfile

@@ -50,14 +50,14 @@ gem 'json'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil
-gem 'rake', require: nil
+gem 'rake', '>= 13.0', require: nil
+gem 'racecar', require: nil if !defined?(JRUBY_VERSION)
 gem 'resque', require: nil
 gem 'sequel', require: nil
 gem 'shoryuken', require: nil
 gem 'sidekiq', require: nil
 gem 'simplecov', require: false
 gem 'simplecov-cobertura', require: false
-gem 'sneakers', '~> 2.12', require: nil
 gem 'sucker_punch', '~> 2.0', require: nil
 gem 'yard', require: nil
 gem 'yarjuf'
@@ -78,6 +78,10 @@ frameworks_versions = parsed_frameworks.inject({}) do |frameworks, str|
 end
 
 frameworks_versions.each do |framework, version|
+  if framework =='rails' && RUBY_VERSION >= '3.1'
+    gem 'net-smtp', require: false
+  end
+
   case version
   when 'master' # sinatra, grape
     gem framework, github: GITHUB_REPOS.fetch(framework)
@@ -116,6 +120,11 @@ else
   gem 'sqlite3'
 end
 
+# sneakers main only supports >=2.5.0
+if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('2.5.0') && !defined?(JRUBY_VERSION)
+  gem 'sneakers', github: 'jondot/sneakers', ref: 'd761dfe1493', require: nil
+end
+
 group :bench do
   gem 'ruby-prof', require: nil, platforms: %i[ruby]
   gem 'stackprof', require: nil, platforms: %i[ruby]

data/README.md

@@ -2,7 +2,7 @@
 
 ## Elastic APM agent for Ruby
 
-[![Jenkins](https://apm-ci.elastic.co/buildStatus/icon?job=apm-agent-ruby/apm-agent-ruby-mbp/master)](https://apm-ci.elastic.co/job/apm-agent-ruby/job/apm-agent-ruby-mbp/job/master/) [![Gem](https://img.shields.io/gem/v/elastic-apm.svg)](https://rubygems.org/gems/elastic-apm)
+[![Jenkins](https://apm-ci.elastic.co/buildStatus/icon?job=apm-agent-ruby/apm-agent-ruby-mbp/main)](https://apm-ci.elastic.co/job/apm-agent-ruby/job/apm-agent-ruby-mbp/job/main/) [![Gem](https://img.shields.io/gem/v/elastic-apm.svg)](https://rubygems.org/gems/elastic-apm)
 
 The official Rubygem for [Elastic][] [APM][].
 

data/Rakefile

@@ -25,9 +25,9 @@ desc 'Post release action:'\
 namespace :release do
   task :update_branch do
     `git checkout 3.x &&
-    git rebase master &&
+    git rebase main &&
     git push origin 3.x &&
-    git checkout master`
+    git checkout main`
   end
 end
 

data/bench/report.rb

@@ -11,7 +11,7 @@ git_date = `git log -n 1 --pretty="format:%ai"`
 platform = Gem::Platform.local
 
 def doc(payload)
-  puts({ index: { _index: "benchmark-ruby", _type: "_doc" } }.to_json)
+  puts({ index: { _index: "benchmark-ruby" } }.to_json)
   puts(payload.to_json)
 end
 

data/docs/api.asciidoc

@@ -334,7 +334,7 @@ Labels are basic key-value pairs that are indexed in your Elasticsearch database
 The value can be a string, nil, numeric or boolean.
 
 TIP: Before using custom labels, ensure you understand the different types of
-{apm-overview-ref-v}/metadata.html[metadata] that are available.
+{apm-guide-ref}/data-model-metadata.html[metadata] that are available.
 
 [source,ruby]
 ----
@@ -361,7 +361,7 @@ Use this to further specify a context that will help you track or diagnose what'
 going on inside your app.
 
 TIP: Before using custom context, ensure you understand the different types of
-{apm-overview-ref-v}/metadata.html[metadata] that are available.
+{apm-guide-ref}/data-model-metadata.html[metadata] that are available.
 
 If called several times during a transaction the custom context will be destructively
 merged with `merge!`.

data/docs/configuration.asciidoc

@@ -170,7 +170,7 @@ WARNING: Secret tokens only provide any real security if your APM server uses TL
 |============
 
 This base64-encoded string is used to ensure that only your agents can send data to your APM server.
-The API key must be created using the {apm-server-ref-v}/api-key.html[APM server command-line tool]. 
+The API key must be created using the {apm-guide-ref}/api-key.html[APM server command-line tool]. 
 
 WARNING: API keys only provide any real security if your APM server uses TLS.
 
@@ -506,12 +506,12 @@ Elastic APM can instrument your Rake tasks. This is an opt-in field, as they are
 
 [float]
 [[config-log-ecs-formatting]]
-==== `log_ecs_formatting`
+==== `log_ecs_reformatting`
 
 [options="header"]
 |============
 | Environment             | `Config` key | Default
-| `ELASTIC_APM_LOG_ECS_FORMATTING` | `log_ecs_formatting`  | `off`
+| `ELASTIC_APM_LOG_ECS_REFORMATTING` | `log_ecs_reformatting`  | `off`
 |============
 
 This is an experimental option that configures the agent to use the logger from the `ecs-logging` gem. The two
@@ -520,7 +520,7 @@ valid options are `off` and `override`.
 Setting this option to `override` will set the agent logger to a `EcsLogging::Logger` instance and all logged output
 will be in ECS-compatible json.
 
-The `ecs-logging` gem must be installed before the agent is started. If `log_ecs_formatting` is set to `override`,
+The `ecs-logging` gem must be installed before the agent is started. If `log_ecs_reformatting` is set to `override`,
 the agent will attempt to require the gem and if it cannot be loaded, it will fall back to using the standard Ruby
 `::Logger` and log the load error.
 
@@ -556,6 +556,8 @@ A path to a log file.
 
 By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails.
 
+If `log_path` is specified, this will override `Rails.log` to point to that path instead.
+
 This should support both absolute and relative paths. Please be sure the directory exists.
 
 [float]
@@ -654,7 +656,7 @@ when this option is false.
 [options="header"]
 |============
 | Environment                        | `Config` key           | Default                                                                                        | Example
-| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `"password,passwd,pwd,secret,*key,*token*,*session*,*credit*,*card*,authorization,set-cookie"` | `Auth*tion,abc*,*xyz`
+| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `"password,passwd,pwd,secret,*key,*token*,*session*,*credit*,*card*,*auth*,set-cookie"` | `Auth*tion,abc*,*xyz`
 |============
 
 Sometimes it is necessary to sanitize the data sent to Elastic APM to remove sensitive values.

data/docs/introduction.asciidoc

@@ -31,6 +31,6 @@ You can then use the APM app in Kibana to gain insight into latency issues and e
 [[additional-components]]
 === Additional Components
 
-APM Agents work in conjunction with the {apm-server-ref-v}/index.html[APM Server], {ref}/index.html[Elasticsearch], and {kibana-ref}/index.html[Kibana].
-The {apm-overview-ref-v}/index.html[APM Overview] provides details on how these components work together,
-and provides a matrix outlining {apm-overview-ref-v}/agent-server-compatibility.html[Agent and Server compatibility].
+APM Agents work in conjunction with the {apm-guide-ref}/index.html[APM Server], {ref}/index.html[Elasticsearch], and {kibana-ref}/index.html[Kibana].
+The {apm-guide-ref}/index.html[APM Guide] provides details on how these components work together,
+and provides a matrix outlining {apm-guide-ref}/agent-server-compatibility.html[Agent and Server compatibility].

data/docs/log-correlation.asciidoc

@@ -118,4 +118,4 @@ PUT _ingest/pipeline/extract_trace_id
 }
 ----
 
-Please see {apm-overview-ref-v}/observability-integrations.html[Observability integrations] for more information.
+Please see {apm-guide-ref}/log-correlation.html[Observability integrations] for more information.

data/docs/upgrading.asciidoc

@@ -6,7 +6,7 @@ Upgrades that involve a major version bump often come with some backwards incomp
 Before upgrading the agent, be sure to review the:
 
 * <<release-notes,Agent release notes>>
-* {apm-overview-ref-v}/agent-server-compatibility.html[Agent and Server compatibility chart]
+* {apm-guide-ref}/agent-server-compatibility.html[Agent and Server compatibility chart]
 
 [float]
 [[end-of-life-dates]]