elastic-apm 4.5.1 → 4.7.2

data/.github/workflows/release.yml

@@ -0,0 +1,71 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+*"
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - uses: hashicorp/vault-action@v2.4.2
+        with:
+          url: ${{ secrets.VAULT_ADDR }}
+          method: approle
+          roleId: ${{ secrets.VAULT_ROLE_ID }}
+          secretId: ${{ secrets.VAULT_SECRET_ID }}
+          secrets: |
+            secret/apm-team/ci/apm-agent-ruby-rubygems-release apiKey | API_KEY ;
+      - name: RubyGems login
+        run: |
+          RUBY_HOME="${HOME}/.gem"
+          RUBY_CREDENTIALS_FILE="${RUBY_HOME}/credentials"
+          mkdir -p "${RUBY_HOME}"
+          echo '---' > "${RUBY_CREDENTIALS_FILE}"
+          echo ":rubygems_api_key: ${API_KEY}" >> "${RUBY_CREDENTIALS_FILE}"
+          chmod 0600 "${RUBY_CREDENTIALS_FILE}"
+      - name: Install build system
+        run: .ci/scripts/install-build-system.sh
+      - run: rake release
+  update-branch:
+    needs:
+      - release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Setup Git
+        uses: elastic/apm-pipeline-library/.github/actions/setup-git@current
+      - name: Install build system
+        run: .ci/scripts/install-build-system.sh
+      - run: rake release:update_branch
+
+  status:
+    if: always()
+    runs-on: ubuntu-latest
+    needs:
+      - release
+      - update-branch
+    steps:
+      - id: check
+        uses: elastic/apm-pipeline-library/.github/actions/check-dependent-jobs@current
+        with:
+          needs: ${{ toJSON(needs) }}
+      - run: ${{ steps.check.outputs.isSuccess }}
+      - if: always()
+        uses: elastic/apm-pipeline-library/.github/actions/notify-build-status@current
+        with:
+          vaultUrl: ${{ secrets.VAULT_ADDR }}
+          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
+          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}
+          slackChannel: "#apm-agent-ruby"

data/.github/workflows/run-matrix.yml

@@ -0,0 +1,56 @@
+---
+# Runs the tests based on the provided files in ci.yml
+name: run-matrix
+
+on:
+  workflow_call:
+    inputs:
+      versionsFile:
+        required: true
+        type: string
+      frameworksFile:
+        required: true
+        type: string
+      excludedFile:
+        required: true
+        type: string
+
+jobs:
+  create-test-matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.generate.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v3
+      - id: generate
+        uses: elastic/apm-pipeline-library/.github/actions/version-framework@current
+        with:
+          versionsFile: ${{ inputs.versionsFile }}
+          frameworksFile: ${{ inputs.frameworksFile }}
+          excludedFile: ${{ inputs.excludedFile }}
+  test:
+    needs:
+      - create-test-matrix
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      max-parallel: 20
+      matrix: ${{ fromJSON(needs.create-test-matrix.outputs.matrix) }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run BDD tests
+        run: ./spec/scripts/features.sh ${{ matrix.version }}
+      - name: Run test
+        run: ./spec/scripts/spec.sh ${{ matrix.version }} ${{ matrix.framework }}
+        env:
+          JUNIT_PREFIX: ${{ matrix.version }}-${{ matrix.framework }}
+      - if: success() || failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-results
+          path: "**/spec/junit-reports/**/*ruby-agent-junit.xml"
+      - if: success() || failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage
+          path: "coverage/"

data/.github/workflows/snapshoty.yml

@@ -0,0 +1,35 @@
+name: snapshoty
+
+on:
+  workflow_run:
+    workflows:
+      - ci
+    types:
+      - completed
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download artifacts
+        run: >
+          gh run download ${{ github.event.workflow_run.id }}
+          --name package
+          --repo "${GITHUB_REPOSITORY}" 
+          --dir pkg
+        env:
+          GH_TOKEN: ${{ github.token }}
+      - name: Publish snapshot
+        uses: elastic/apm-pipeline-library/.github/actions/snapshoty-simple@current
+        with:
+          config: '.ci/snapshoty.yml'
+          vaultUrl: ${{ secrets.VAULT_ADDR }}
+          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
+          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}

data/.github/workflows/test-reporter.yml

@@ -0,0 +1,24 @@
+---
+## Workflow to process the JUnit test results and add a report to the checks.
+name: test-reporter
+on:
+  workflow_run:
+    workflows:
+      - ci
+    types:
+      - completed
+
+permissions:
+  contents: read
+  checks: write
+
+jobs:
+  report:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: elastic/apm-pipeline-library/.github/actions/test-report@current
+        with:
+          artifact: test-results
+          name: test-report
+          path: "**/*ruby-agent-junit.xml"
+          reporter: java-junit

data/.github/workflows/updatecli.yml

@@ -0,0 +1,28 @@
+name: updatecli
+
+on:
+  workflow_dispatch: ~
+  schedule:
+    - cron: '0 6 * * *'
+
+permissions:
+  contents: read
+
+jobs:
+  bump:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: elastic/apm-pipeline-library/.github/actions/updatecli@current
+        with:
+          vaultUrl: ${{ secrets.VAULT_ADDR }}
+          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
+          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}
+          pipeline: .ci/updatecli.d
+      - if: failure()
+        uses: elastic/apm-pipeline-library/.github/actions/notify-build-status@current
+        with:
+          vaultUrl: ${{ secrets.VAULT_ADDR }}
+          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
+          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}
+          slackChannel: "#apm-agent-ruby"

data/.pre-commit-config.yaml

@@ -13,6 +13,4 @@ repos:
     rev: current
     hooks:
     -   id: check-bash-syntax
-    -   id: check-jenkins-pipelines
-    -   id: check-jjbb
     -   id: check-unicode-non-breaking-spaces

data/CHANGELOG.asciidoc

@@ -25,7 +25,6 @@ endif::[]
 
 [float]
 ===== Fixed
-- Fix {pull}2526[#2526]
 
 [float]
 [[unreleased]]
@@ -35,6 +34,79 @@ endif::[]
 [[release-notes-4.x]]
 === Ruby Agent version 4.x
 
+[[release-notes-4.7.2]
+==== 4.7.2
+
+[float]
+===== Fixed
+- Address machineType not being returned in GCP metadata {pull}1435[#1435]
+
+[[release-notes-4.7.1]
+==== 4.7.1
+
+[float]
+===== Fixed
+- Skip capturing cookie header when it's set separately {pull}1405[#1405]
+- Changes/fixes to metadata.cloud.* fields collected for GCP {pull}1415[#1415]
+- Pin version of bigdecimal for ruby 2.4 {pull}1417[#1417]
+- Use response method on Faraday error for older versions of the library {pull}1419[#1419]
+- Fix ActionDispatchSpy#render_exception for Rails 7.1 {pull}1423[#1423]
+- Use graphql < 2.1 when Ruby < 2.7 {pull}1425[#1425]
+- Guard against various Faraday exception response formats {pull}1428[#1428]
+
+[[release-notes-4.7.0]]
+==== 4.7.0
+
+[float]
+===== Fixed
+- Handle Faraday response being nil {pull}1382[#1382]
+- Fix error with invalid %-encoding {pull}1400[#1400]
+
+[float]
+===== Added
+- Add keyword args for span_method helper {pull}1395[#1395]
+
+[[release-notes-4.6.2]]
+==== 4.6.2
+
+[float]
+===== Fixed
+- Fix Faraday::RackBuilder::StackLocked {pull}1371[#1371]
+
+[[release-notes-4.6.1]]
+==== 4.6.1
+
+[float]
+===== Fixed
+
+- Fix growing number of open file descriptors when HTTP request to APM is never sent {pull}1351[#1351]
+- Fix setting span http status code when Faraday Middleware is used {pull}1368[#1368]
+- Handle whitespace when splitting tracestate entries {pull}1353[#1353]
+
+[[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
 

data/CONTRIBUTING.md

@@ -49,4 +49,4 @@ To release a new version:
     2. Push the tag to GitHub.
     3. Build the gem and upload to Rubygems (local user needs to be signed in and authorized.)
 1. Run `rake release:update_branch`. This will...
-    1. Update `3.x` branch to be at released commit and push it to GitHub.
+    1. Update `4.x` branch to be at released commit and push it to GitHub.

data/Gemfile

@@ -41,16 +41,22 @@ gem 'ecs-logging', require: 'ecs_logging/logger'
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 gem 'faraday', require: nil
-gem 'graphql', require: nil
-if !defined?(JRUBY_VERSION) && RUBY_VERSION < '2.5'
-  gem 'google-protobuf', '< 3.12'
+if RUBY_VERSION < '2.7'
+  gem 'graphql', '< 2.1', require: nil
+else
+  gem 'graphql', require: nil
+end
+if !defined?(JRUBY_VERSION)
+  gem 'google-protobuf', '< 3.12' if RUBY_VERSION < '2.5'
+  gem 'google-protobuf', '< 3.23' if RUBY_VERSION < '2.7' && RUBY_VERSION > '2.5'
 end
 gem 'grpc' if !defined?(JRUBY_VERSION) && RUBY_VERSION < '3.0'
-gem 'json', '2.6.2' # note: can be unpinned when https://github.com/flori/json/issues/495 is resolved
+gem 'json'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', 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
@@ -61,6 +67,10 @@ gem 'sucker_punch', '~> 2.0', require: nil
 gem 'yard', require: nil
 gem 'yarjuf'
 
+if RUBY_VERSION < '2.5'
+  gem 'loofah', '~> 2.20.0', require: nil
+end
+
 ## Install Framework
 GITHUB_REPOS = {
   'grape' => 'ruby-grape/grape',
@@ -77,10 +87,14 @@ 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
+  when 'master' # grape
     gem framework, github: GITHUB_REPOS.fetch(framework)
-  when 'main' # rails
+  when 'main' # sinatra, rails
     gem framework, github: GITHUB_REPOS.fetch(framework), branch: 'main'
   when /.+/
     gem framework, "~> #{version}.0"
@@ -111,15 +125,21 @@ if RUBY_PLATFORM == 'java'
   end
 elsif frameworks_versions['rails'] =~ /^(4|5)/
   gem 'sqlite3', '~> 1.3.6'
+elsif RUBY_VERSION < '2.7'
+  gem 'sqlite3', '~> 1.4.4'
 else
   gem 'sqlite3'
 end
 
-# current sneakers only supports >=2.5.0
-if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('2.5.0')
+# 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
 
+if Gem::Version.create(RUBY_VERSION) <= Gem::Version.create('2.5.0')
+  gem 'bigdecimal', '1.3.5'
+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/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)
+[![ci](https://github.com/elastic/apm-agent-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/elastic/apm-agent-ruby/actions/workflows/ci.yml) [![Gem](https://img.shields.io/gem/v/elastic-apm.svg)](https://rubygems.org/gems/elastic-apm)
 
 The official Rubygem for [Elastic][] [APM][].
 

data/Rakefile

@@ -24,9 +24,9 @@ desc 'Post release action:'\
 
 namespace :release do
   task :update_branch do
-    `git checkout 3.x &&
+    `git checkout 4.x &&
     git rebase main &&
-    git push origin 3.x &&
+    git push origin 4.x &&
     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/bench/rubyprof.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require 'ruby-prof'

data/bin/run-tests

@@ -1,6 +1,8 @@
 #!/bin/bash
 set -e
 
+JUNIT_PREFIX=${JUNIT_PREFIX:-""}
+
 runRspec(){
   local case=${1:-""}
   local bn=${case}
@@ -8,9 +10,16 @@ runRspec(){
   if [ -n "${case}" ]; then
     bn="$(basename ${case} _spec.rb)/"
   fi
+  # If working on an isolated environment then copy the file to
+  # the original location
+  TEST_REPORT_DIR=spec/junit-reports/${JUNIT_PREFIX}${bn}
+  if [ -n "$APP_PATH" ] ; then
+    TEST_REPORT_DIR=$APP_PATH/$TEST_REPORT_DIR
+    mkdir -p $TEST_REPORT_DIR
+  fi
   bundle exec rspec \
     -f progress \
-    -r yarjuf -f JUnit -o spec/junit-reports/${bn}ruby-agent-junit.xml \
+    -r yarjuf -f JUnit -o ${TEST_REPORT_DIR}ruby-agent-junit.xml \
     ${case}
 }
 specific_spec=$1

data/docker-compose.yml

@@ -6,6 +6,8 @@ services:
     image: mongo:latest
     volumes: ['mongodata:/data/db']
     ports: ['27017:27017']
+    security_opt:
+      - no-new-privileges
 
   specs:
     build:
@@ -27,12 +29,19 @@ services:
     depends_on:
       - mongodb
     user: ${USER_ID}
+    security_opt:
+      - no-new-privileges
 
   ruby_rspec:
     image: apm-agent-ruby:${RUBY_VERSION}
     environment:
+      APP_PATH: /opt/app
+      FRAMEWORK: rails
+      LOCAL_USER_ID: ${LOCAL_USER_ID}
+      LOCAL_GROUP_ID: ${LOCAL_GROUP_ID}
       MONGODB_URL: 'mongodb:27017'
-    user: ${USER_ID}
+    security_opt:
+      - no-new-privileges
 
 volumes:
   vendor:

data/docs/configuration.asciidoc

@@ -24,7 +24,7 @@ When using this method, strings are split by comma, e.g.,
 [[configuration-precedence]]
 === Configuration precedence
 
-Options are applied in the following order (last one wins): 
+Options are applied in the following order (last one wins):
 
 1. Defaults
 2. Arguments to `ElasticAPM.start` / `Config.new`
@@ -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-guide-ref}/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.
 
@@ -199,7 +199,7 @@ The <<config-log-path,logs>> should tell you what went wrong.
 | `ELASTIC_APM_API_REQUEST_SIZE` | `api_request_size` | `"750kb"`
 |============
 
-The maximum amount of bytes sent over one request to APM Server. The agent will open a new request when this limit is reached. 
+The maximum amount of bytes sent over one request to APM Server. The agent will open a new request when this limit is reached.
 
 This must be provided in *<<config-format-size, size format>>*.
 
@@ -301,7 +301,8 @@ If set to `true`, the client will poll the APM Server regularly for new agent co
 
 Usually APM Server determines how often to poll, but if not, set the default interval is 5 minutes.
 
-NOTE: This feature requires APM Server v7.3 or later and that the APM Server is configured with `kibana.enabled: true`.
+NOTE: This feature requires APM Server v7.3 or later.
+See {kibana-ref}/agent-configuration.html[APM Agent central configuration] for more information.
 
 [float]
 [[config-cloud-provider]]
@@ -506,12 +507,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 +521,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 +557,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 +657,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.
@@ -699,7 +702,7 @@ The name of the given service node. This is optional, and if omitted, the APM
 Server will fall back on `system.container.id` if available, and
 `host.name` if necessary.
 
-This option allows you to set the node name manually to ensure it's unique and meaningful. 
+This option allows you to set the node name manually to ensure it's unique and meaningful.
 
 [float]
 [[config-service-version]]

data/docs/index.asciidoc

@@ -23,12 +23,12 @@ include::./api.asciidoc[]
 
 include::./metrics.asciidoc[]
 
+include::./logs.asciidoc[]
+
 include::./opentracing.asciidoc[]
 
 include::./graphql.asciidoc[]
 
-include::./log-correlation.asciidoc[]
-
 include::./performance-tuning.asciidoc[]
 
 include::./debugging.asciidoc[]

data/docs/{log-correlation.asciidoc → logs.asciidoc}

@@ -3,8 +3,26 @@ NOTE: For the best reading experience,
 please view this documentation at https://www.elastic.co/guide/en/apm/agent/ruby[elastic.co]
 endif::[]
 
-[[log-correlation]]
-== Log correlation
+[[logs]]
+== Logs
+
+Elastic Ruby APM Agent provides the following log features:
+
+- <<log-correlation-ids>>: Automatically inject correlation IDs that allow navigation between logs, traces and services.
+- <<log-reformatting>>: Automatically reformat plaintext logs in {ecs-logging-ref}/intro.html[ECS logging] format.
+
+Those features are part of {observability-guide}/application-logs.html[Application log ingestion strategies].
+
+The {ecs-logging-ruby-ref}/intro.html[`ecs-logging-ruby`] library can also be used to format logs in the {ecs-logging-ref}/intro.html[ECS logging] format without an APM agent.
+When deployed with the Ruby APM agent, the agent will provide <<log-correlation-ids,log correlation>> IDs.
+
+[float]
+[[log-correlation-ids]]
+=== Log correlation
+
+{apm-guide-ref}/log-correlation.html[Log correlation] allows you to navigate to all logs belonging to a particular trace
+and vice-versa: for a specific log, see in which context it has been logged and which parameters the user provided.
+
 
 Trace/log correlation can be set up in three different ways.
 
@@ -119,3 +137,12 @@ PUT _ingest/pipeline/extract_trace_id
 ----
 
 Please see {apm-guide-ref}/log-correlation.html[Observability integrations] for more information.
+
+[float]
+[[log-reformatting]]
+=== Log reformatting (experimental)
+
+Log reformatting is controlled by the <<config-log-ecs-formatting, `log_ecs_reformatting`>> configuration option, and is disabled by default.
+
+The reformatted logs will include both the <<log-correlation-ids, trace and service correlation>> IDs.
+

data/docs/opentracing.asciidoc

@@ -89,6 +89,6 @@ The `Span.set_baggage` method is not supported.
 Baggage items are dropped with a warning log message.
 
 [float]
-[[logs]]
+[[opentracing-logs]]
 === Logs
 Logs are currently not supported.

data/docs/redirects.asciidoc

@@ -0,0 +1,9 @@
+["appendix",role="exclude",id="redirects"]
+= Deleted pages
+
+The following pages have moved or been deleted.
+
+[role="exclude",id="log-correlation"]
+=== Log correlation
+
+This section has moved. See <<logs>>.