elastic-apm 4.3.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc66ce3466effa6740c0b8c9dbb0d74358b54d9039ceebe2938674170e68662b
-  data.tar.gz: d3288b6cf41bbe33fb6594789371d36fcb66ccc2b9ec9d8d2f6aed08f4d212f7
+  metadata.gz: 176cc8d035203774027d36d50769b763761354f3b9627f024ce90e07cd9069e3
+  data.tar.gz: 19a6d7ed6796133c1b79b2e762718f4be7068e4e5876e13e9e898894fc112900
 SHA512:
-  metadata.gz: 6fcdb201cf7b1824776fffff92e8fc538613928b4ae977f694f67239c15a9e10f14a1ceb4669248eb658c4b2fd439398d0badd231292367e8371655cd2bae738
-  data.tar.gz: 72fdb5641db042a4c7ccd6fcdfc97d43949d1f8ed0b561029e6beffa640262d04c2a639f5f75944b944c1283dae8b2c929f0a3aae14e7e2547af3e942e4307a8
+  metadata.gz: e2c34d43d849374706b481eabda64190ae0469e6770f068166eae20d42f7b12a54213820fac8a78e9343cca785f68378e9d4212a3fa6235966f6bb2a8517ca2d
+  data.tar.gz: c19991391535b0ab3087bcdb3bf3d7354a160570fa08a80c313391ab739c9996872e1b68f7ec164223bec2f2f70e643daa6c2ca69adb9549a1255abac5c1f794

data/.ci/.jenkins_exclude.yml

@@ -1,23 +1,23 @@
 exclude:
-  # Ruby 2.3
+  # Ruby 2.4
   # Only includes rails-5.2, sinatra-2.0
-  - RUBY_VERSION: ruby:2.3
+  - 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
+  - RUBY_VERSION: ruby:2.4
     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: grape-1.6
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: grape-1.6,sinatra-2.0,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
@@ -105,9 +105,9 @@ exclude:
 
   # grape 1.5 doesn't support ruby 3.0
   - 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.0,rails-6.1
 
   # only test ruby 3.0 with rails 6.0 and rails 6.1
   - RUBY_VERSION: ruby:3.0
@@ -117,18 +117,18 @@ exclude:
 
   # Unsupported
   - RUBY_VERSION: ruby:2.6
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
   - RUBY_VERSION: ruby:2.5
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: grape-1.6,sinatra-2.0,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.0,rails-6.1
   - RUBY_VERSION: jruby:9.2
-    FRAMEWORK: grape-1.5,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.0,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.0,rails-6.1
   - 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.0,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.0,rails-6.1

data/.ci/.jenkins_framework.yml

@@ -7,6 +7,6 @@ FRAMEWORK:
   - sinatra-2.0
   - sinatra-1.4
 
-  - grape-1.5
+  - grape-1.6
 
-  - grape-1.5,sinatra-2.0,rails-6.1
+  - grape-1.6,sinatra-2.0,rails-6.1

data/.ci/Jenkinsfile

@@ -22,7 +22,7 @@ pipeline {
     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'
+    ITS_PIPELINE = 'apm-integration-tests-selector-mbp/main'
     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'
@@ -39,10 +39,10 @@ pipeline {
     quietPeriod(10)
   }
   triggers {
-    issueCommentTrigger('(?i).*(?:jenkins\\W+)?run\\W+(?:the\\W+)?(?:benchmark\\W+)?tests(?:\\W+please)?.*')
+    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 +71,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,11 +115,11 @@ 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')
             }
           }
         }
@@ -129,7 +129,7 @@ pipeline {
             beforeAgent true
             anyOf {
               changeRequest()
-              expression { return !params.Run_As_Master_Branch }
+              expression { return !params.Run_As_Main_Branch }
             }
           }
           steps {
@@ -150,11 +150,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 }
@@ -256,11 +256,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}")

data/.ci/docker/jruby/11-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.2.10.0
+ENV JRUBY_VERSION 9.2.16.0
 ENV JRUBY_SHA256 9199707712c683c525252ccb1de5cb8e75f53b790c5b57a18f6367039ec79553
 
 RUN mkdir -p /opt/jruby \

data/.ci/docker/jruby/12-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.2.10.0
+ENV JRUBY_VERSION 9.3.1.0
 ENV JRUBY_SHA256 9199707712c683c525252ccb1de5cb8e75f53b790c5b57a18f6367039ec79553
 
 RUN mkdir -p /opt/jruby \

data/.ci/docker/jruby/13-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.2.10.0
+ENV JRUBY_VERSION 9.3.1.0
 ENV JRUBY_SHA256 9199707712c683c525252ccb1de5cb8e75f53b790c5b57a18f6367039ec79553
 
 RUN mkdir -p /opt/jruby \

data/.ci/docker/jruby/7-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.1.17.0
+ENV JRUBY_VERSION 9.3.1.0
 ENV JRUBY_SHA256 6a22f7bf8fef1a52530a9c9781a9d374ad07bbbef0d3d8e2af0ff5cbead0dfd5
 
 RUN mkdir -p /opt/jruby \

data/.ci/docker/jruby/8-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.2.10.0
+ENV JRUBY_VERSION 9.2.14.0
 ENV JRUBY_SHA256 9199707712c683c525252ccb1de5cb8e75f53b790c5b57a18f6367039ec79553
 
 RUN mkdir -p /opt/jruby \

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

@@ -15,6 +15,7 @@
         repo: apm-agent-ruby
         repo-owner: elastic
         credentials-id: 2a9602aa-ab9f-4e52-baf3-b71ca88469c7-UserAndToken
+        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,48 @@ endif::[]
 [[release-notes-4.x]]
 === Ruby Agent version 4.x
 
+[[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
+
+[float]
+===== Changed
+
+- Stop collecting the field `http.request.socket.encrypted` {pull}1181[#1181]
+
+[float]
+===== Fixed
+
+- Fixed MongoDB spy thread safety {pull}1202[#1202]
+- Fixed span context fields for DynamoDB instrumentation {pull}1178[#1178]
+- Fixed span context fields for S3 instrumentation {pull}1179[#1179]
+- Update user agent info to match spec {pull}1182[#1182]
+
+[[release-notes-4.4.0]]
+==== 4.4.0
+
+[float]
+===== Added
+- Optional span to be ended instead of current span {pull}1039[#1039]
+- Config option `log_ecs_formatting` {pull}1053[#1053]
+
+[float]
+===== Fixed
+- Fixed detecting Linux on Alpine for CPU/MEM metrics {pull}1057[#1057]
+
 [[release-notes-4.3.0]]
 ==== 4.3.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

@@ -37,6 +37,7 @@ gem 'aws-sdk-s3', require: nil
 gem 'aws-sdk-sqs', require: nil
 gem 'aws-sdk-sns', require: nil
 gem 'azure-storage-table', require: nil if RUBY_VERSION < '3.0'
+gem 'ecs-logging', require: 'ecs_logging/logger'
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 gem 'faraday', require: nil
@@ -45,26 +46,21 @@ 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', '2.6.2' # note: can be unpinned when https://github.com/flori/json/issues/495 is resolved
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil
-gem 'rake', require: nil
+gem 'rake', '>= 13.0', require: nil
 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'
 
-# 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',
@@ -100,6 +96,9 @@ if frameworks_versions.key?('rails')
 end
 
 if RUBY_PLATFORM == 'java'
+  # See issue #6547 in the JRuby repo. It is fixed in JRuby 9.3
+  gem 'i18n', '< 1.8.8' if JRUBY_VERSION < '9.3'
+
   case rails = frameworks_versions['rails']
   when 'main'
     gem 'activerecord-jdbcsqlite3-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', glob: 'activerecord-jdbcsqlite3-adapter/*.gemspec'
@@ -116,6 +115,11 @@ else
   gem 'sqlite3'
 end
 
+# current sneakers only supports >=2.5.0
+if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('2.5.0')
+  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/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.
 
@@ -240,7 +240,7 @@ NOTE: This feature requires APM Server and Kibana >= 7.3.
 <<dynamic-configuration, image:./images/dynamic-config.svg[] >>
 
 |============
-| Environment                | `Config` key   | Default | Example |
+| Environment                | `Config` key   | Default | Example
 | `ELASTIC_APM_CAPTURE_BODY` | `capture_body` | `"off"` | `"all"`
 |============
 
@@ -502,7 +502,31 @@ Use this option to ignore certain URL patterns such as healthchecks or admin sec
 | `ELASTIC_APM_INSTRUMENTED_RAKE_TASKS` | `instrumented_rake_tasks` | `[]`    | `['my_task']`
 |============
 
-Elastic APM can instrument your Rake tasks. Theis is an opt-in field, as they are used are for a multitude of things. 
+Elastic APM can instrument your Rake tasks. This is an opt-in field, as they are used are for a multitude of things.
+
+[float]
+[[config-log-ecs-formatting]]
+==== `log_ecs_formatting`
+
+[options="header"]
+|============
+| Environment             | `Config` key | Default
+| `ELASTIC_APM_LOG_ECS_FORMATTING` | `log_ecs_formatting`  | `off`
+|============
+
+This is an experimental option that configures the agent to use the logger from the `ecs-logging` gem. The two
+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 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.
+
+Note that if you're using Rails, the agent will ignore this option and use the Rails logger. If you want to use a
+`EcsLogging::Logger` when using Rails, set the agent's logger config option explicitly to a `EcsLogging::Logger`
+instance.
 
 [float]
 [[config-log-level]]

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]]

data/elastic-apm.gemspec

@@ -20,15 +20,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elastic_apm/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'elastic-apm'
-  spec.version       = ElasticAPM::VERSION
-  spec.authors       = ['Mikkel Malmberg']
-  spec.email         = ['mikkel@elastic.co']
+  spec.name    = 'elastic-apm'
+  spec.version = ElasticAPM::VERSION
+  spec.authors = ['Mikkel Malmberg']
+  spec.email   = ['mikkel@elastic.co']
 
-  spec.summary       = 'The official Elastic APM agent for Ruby'
-  spec.homepage      = 'https://github.com/elastic/apm-agent-ruby'
-  spec.metadata     = { 'source_code_uri' => 'https://github.com/elastic/apm-agent-ruby' }
-  spec.license       = 'Apache-2.0'
+  spec.summary  = 'The official Elastic APM agent for Ruby'
+  spec.homepage = 'https://github.com/elastic/apm-agent-ruby'
+  spec.metadata = { 'source_code_uri' => 'https://github.com/elastic/apm-agent-ruby' }
+  spec.license  = 'Apache-2.0'
   spec.required_ruby_version = ">= 2.3.0"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|

data/lib/elastic_apm/agent.rb

@@ -211,8 +211,8 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/ParameterLists
 
-    def end_span
-      instrumenter.end_span
+    def end_span(span = nil)
+      instrumenter.end_span(span)
     end
 
     def set_label(key, value)

data/lib/elastic_apm/config.rb

@@ -70,6 +70,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_ecs_formatting,                type: :string, default: 'off'
     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
@@ -246,11 +247,29 @@ module ElasticAPM
     end
 
     def build_logger
+      if self.log_ecs_formatting == 'override'
+        begin
+          return build_ecs_logger
+        rescue LoadError
+          logger.info "Attempted to use EcsLogging::Logger but the gem couldn't be " \
+            "loaded so a ::Logger was created instead. Check if you have the `ecs-logging` " \
+            "gem installed and attempt to start the agent again."
+        end
+      end
+
       Logger.new(log_path == '-' ? $stdout : log_path).tap do |logger|
         logger.level = log_level
       end
     end
 
+    def build_ecs_logger
+      require 'ecs_logging/logger'
+
+      ::EcsLogging::Logger.new(log_path == '-' ? $stdout : log_path).tap do |logger|
+        logger.level = log_level
+      end
+    end
+
     def app_type?(app)
       if defined?(::Rails::Application) && app.is_a?(::Rails::Application)
         return :rails

data/lib/elastic_apm/context/request/socket.rb

@@ -26,10 +26,9 @@ module ElasticAPM
       class Socket
         def initialize(req)
           @remote_addr = req.env['REMOTE_ADDR']
-          @encrypted = req.scheme == 'https'
         end
 
-        attr_reader :remote_addr, :encrypted
+        attr_reader :remote_addr
       end
     end
   end