elastic-apm 4.7.3 → 4.9.0

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

@@ -24,13 +24,13 @@ jobs:
     outputs:
       matrix: ${{ steps.generate.outputs.matrix }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - id: generate
-        uses: elastic/apm-pipeline-library/.github/actions/version-framework@current
+        uses: elastic/oblt-actions/version-framework@v1
         with:
-          versionsFile: ${{ inputs.versionsFile }}
-          frameworksFile: ${{ inputs.frameworksFile }}
-          excludedFile: ${{ inputs.excludedFile }}
+          versions-file: ${{ inputs.versionsFile }}
+          frameworks-file: ${{ inputs.frameworksFile }}
+          excluded-file: ${{ inputs.excludedFile }}
   test:
     needs:
       - create-test-matrix
@@ -40,20 +40,29 @@ jobs:
       max-parallel: 20
       matrix: ${{ fromJSON(needs.create-test-matrix.outputs.matrix) }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - 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
+        id: normalize-junit
+        uses: actions/github-script@v7
         with:
-          name: test-results
-          path: "**/spec/junit-reports/**/*ruby-agent-junit.xml"
+          result-encoding: string
+          script: |
+            function normalizeName(name) {
+              return name.replace(/["/:<>|*?\\]/g, '-')
+            }
+            const framework = normalizeName('${{ matrix.framework }}')
+            const version = normalizeName('${{ matrix.version }}')
+            return `${version}-${framework}`
       - if: success() || failure()
-        uses: actions/upload-artifact@v3
+        name: Upload JUnit Test Results
+        uses: actions/upload-artifact@v4
         with:
-          name: coverage
-          path: "coverage/"
+          name: test-results-${{ steps.normalize-junit.outputs.result }}
+          path: "**/spec/junit-reports/**/*ruby-agent-junit.xml"

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

@@ -10,15 +10,16 @@ on:
 
 permissions:
   contents: read
+  actions: read
   checks: write
 
 jobs:
   report:
     runs-on: ubuntu-latest
     steps:
-      - uses: elastic/apm-pipeline-library/.github/actions/test-report@current
+      - uses: elastic/oblt-actions/test-report@v1
         with:
-          artifact: test-results
-          name: test-report
+          artifact: /test-results(.*)/
+          name: 'Test Report $1'
           path: "**/*ruby-agent-junit.xml"
           reporter: java-junit

data/.github/workflows/updatecli.yml

@@ -9,21 +9,53 @@ permissions:
   contents: read
 
 jobs:
-  bump:
+  compose:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
     steps:
-      - uses: actions/checkout@v3
-      - uses: elastic/apm-pipeline-library/.github/actions/updatecli@current
+      - uses: actions/checkout@v4
+
+      - name: Get token
+        id: get_token
+        uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a # v2.1.0
+        with:
+          app_id: ${{ secrets.OBS_AUTOMATION_APP_ID }}
+          private_key: ${{ secrets.OBS_AUTOMATION_APP_PEM }}
+          permissions: >-
+            {
+              "contents": "write",
+              "pull_requests": "write"
+            }
+
+      - uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3.4.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: elastic/oblt-actions/updatecli/run@v1
+        with:
+          command: --experimental compose diff
+          # TODO: update to the latest version so the policies can work as expected.
+          #       latest changes in the policies require to use the dependson feature.
+          version: "v0.88.0"
+        env:
+          GITHUB_TOKEN: ${{ steps.get_token.outputs.token }}
+
+      - uses: elastic/oblt-actions/updatecli/run@v1
         with:
-          vaultUrl: ${{ secrets.VAULT_ADDR }}
-          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
-          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}
-          pipeline: .ci/updatecli/updatecli.d
-          values: .ci/updatecli/values.yml
+          command: --experimental compose apply
+          # TODO: update to the latest version so the policies can work as expected.
+          #       latest changes in the policies require to use the dependson feature.
+          version: "v0.88.0"
+        env:
+          GITHUB_TOKEN: ${{ steps.get_token.outputs.token }}
+
       - if: failure()
-        uses: elastic/apm-pipeline-library/.github/actions/notify-build-status@current
+        uses: elastic/oblt-actions/slack/send@v1
         with:
-          vaultUrl: ${{ secrets.VAULT_ADDR }}
-          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
-          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}
-          slackChannel: "#apm-agent-ruby"
+          bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
+          channel-id: "#apm-agent-ruby"
+          message: ":traffic_cone: updatecli failed for `${{ github.repository }}@${{ github.ref_name }}`, @robots-ci please look what's going on <https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}|here>"

data/Dockerfile

@@ -1,4 +1,4 @@
-ARG RUBY_IMAGE
+ARG RUBY_IMAGE=ruby:3.3
 FROM ${RUBY_IMAGE}
 
 ARG USER_ID_GROUP
@@ -9,10 +9,18 @@ ARG BUNDLER_VERSION
 # For tzdata
 # ENV DEBIAN_FRONTEND=noninteractive
 
-RUN apt-get update -qq \
-      && apt-get install -qq -y --no-install-recommends \
-        build-essential libpq-dev git \
-      && rm -rf /var/lib/apt/lists/*
+RUN set -eux; \
+      apt-get update -qq || ( \
+        find /etc/apt -name '*.list' -type f -print0 | xargs -0 sed -i \
+          -e 's|deb.debian.org/debian|archive.debian.org/debian|g' \
+          -e 's|security.debian.org/debian-security|archive.debian.org/debian-security|g'; \
+        find /etc/apt -name '*.list' -type f -print0 | xargs -0 sed -i '/buster-updates/d'; \
+        printf 'Acquire::Check-Valid-Until "false";\n' > /etc/apt/apt.conf.d/99no-check-valid; \
+        apt-get -o Acquire::Check-Valid-Until=false update -qq \
+      ); \
+      apt-get install -qq -y --no-install-recommends \
+        build-essential libpq-dev git netbase; \
+      rm -rf /var/lib/apt/lists/*
 
 # Configure bundler and PATH
 ENV LANG=C.UTF-8
@@ -29,15 +37,33 @@ ENV FRAMEWORKS $FRAMEWORKS
 RUN mkdir -p $VENDOR_PATH \
       && chown -R $USER_ID_GROUP $VENDOR_PATH
 
-USER $USER_ID_GROUP
-
-# Upgrade RubyGems and install required Bundler version
-RUN gem update --system && \
-      gem install bundler:$BUNDLER_VERSION
+# Upgrade RubyGems with a Ruby-version-compatible strategy and install Bundler.
+RUN set -eux; \
+      if ruby -e 'require "rubygems"; exit(Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.2") ? 0 : 1)'; then \
+        gem update --system 3.2.3; \
+      else \
+        gem update --system; \
+      fi; \
+      if ruby -e 'require "rubygems"; exit(Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5") ? 0 : 1)'; then \
+        gem install bundler:1.17.3; \
+      else \
+        gem install bundler:$BUNDLER_VERSION; \
+      fi
 
-# Use unpatched, system version for more speed over less security
-RUN gem install nokogiri -- --use-system-libraries
+# Use unpatched, system version for more speed over less security.
+# Pin Nokogiri by Ruby compatibility to support old CI targets (e.g. Ruby 2.4).
+RUN set -eux; \
+      if ruby -e 'require "rubygems"; exit(Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5") ? 0 : 1)'; then \
+        gem install nokogiri -v 1.10.10 -- --use-system-libraries; \
+      elif ruby -e 'require "rubygems"; exit(Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.2") ? 0 : 1)'; then \
+        gem install nokogiri -v 1.12.5 -- --use-system-libraries; \
+      else \
+        gem install nokogiri -- --use-system-libraries; \
+      fi
 # Rake is required to build http-parser on some jruby images
 RUN gem install rake
 
+RUN chown -R $USER_ID_GROUP $VENDOR_PATH
+USER $USER_ID_GROUP
+
 WORKDIR /app

data/Gemfile

@@ -59,7 +59,6 @@ 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
@@ -91,6 +90,14 @@ frameworks_versions.each do |framework, version|
     gem 'net-smtp', require: false
   end
 
+  if framework =='rails' && RUBY_VERSION < '3.2' && !defined?(JRUBY_VERSION) && version >= '5.2'
+    gem 'i18n', '1.14.8'
+  end
+
+  if framework =='rails' && RUBY_VERSION >= '3.4' && ['4.2', '5.2', '6.1'].include?(version)
+    gem 'mutex_m'
+  end
+
   case version
   when 'master' # grape
     gem framework, github: GITHUB_REPOS.fetch(framework)
@@ -103,12 +110,36 @@ frameworks_versions.each do |framework, version|
   end
 end
 
+# Handle Rack::Auth::Digest being removed in rack 3.1, grape requires it.
+# Sinatra 2.x depends on rack 2.x, so use a compatible rack line when both are present.
+if frameworks_versions.key?('grape')
+  sinatra_version = frameworks_versions['sinatra']
+  if sinatra_version&.start_with?('2.')
+    gem 'rack', '~> 2.2.0'
+  else
+    gem 'rack', '~> 3.0.0'
+  end
+end
+
 if frameworks_versions.key?('rails')
-  unless /^(main|6)/.match?(frameworks_versions['rails'])
-    gem 'delayed_job', require: nil
+  rails_version = frameworks_versions['rails']
+  unless /^(main|6)/.match?(rails_version)
+    if rails_version.start_with?('4.') || rails_version.start_with?('5.')
+      gem 'delayed_job', '~> 4.1.13', require: nil
+    else
+      gem 'delayed_job', require: nil
+    end
   end
 end
 
+# Shoryuken 7.x references ActiveJob::QueueAdapters::AbstractAdapter, which
+# is missing in the Ruby 3.4 + Rails 6.1 matrix target.
+if frameworks_versions['rails'] == '6.1' && RUBY_VERSION >= '3.4'
+  gem 'shoryuken', '< 7.0', require: nil
+else
+  gem 'shoryuken', require: nil
+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'
@@ -125,8 +156,12 @@ if RUBY_PLATFORM == 'java'
   end
 elsif frameworks_versions['rails'] =~ /^(4|5)/
   gem 'sqlite3', '~> 1.3.6'
+elsif frameworks_versions['rails'] =~ /^(6|7)/
+  gem 'sqlite3', '~> 1.4'
 elsif RUBY_VERSION < '2.7'
   gem 'sqlite3', '~> 1.4.4'
+elsif RUBY_VERSION < '3.0'
+  gem 'sqlite3', '~> 1.3.6'
 else
   gem 'sqlite3'
 end

data/bin/dev

@@ -26,21 +26,33 @@ end.parse!
 USER_ID_GROUP = %w[u g].map { |f| `id -#{f}`.chomp }.join(':')
 
 RUBY_IMAGE = options.fetch(:image, 'ruby:latest')
-FRAMEWORKS = options.fetch(:frameworks, 'rails,sinatra,grape')
+default_frameworks = if RUBY_IMAGE.include?('jruby')
+                       'rails-6.1,sinatra-2.2,grape-1.6'
+                     else
+                       'rails,sinatra,grape'
+                     end
+FRAMEWORKS = options.fetch(:frameworks, default_frameworks)
 
 IMAGE_PATH_SAFE = RUBY_IMAGE.tr(':', '_')
 IMAGE_NAME = "apm-agent-ruby:#{IMAGE_PATH_SAFE}"
 VENDOR_PATH = "/vendor/#{IMAGE_PATH_SAFE}"
+legacy_ruby_image = RUBY_IMAGE.match?(/^ruby:(2\.[0-9]+|1\.[0-9]+)/)
+DOCKER_PLATFORM = if RUBY_IMAGE.include?('jruby') || legacy_ruby_image
+                    'linux/amd64'
+                  end
 
 def run(cmd)
-  "IMAGE_NAME=#{IMAGE_NAME} #{cmd}".tap do |str|
+  env = ["IMAGE_NAME=#{IMAGE_NAME}"]
+  env << "DOCKER_DEFAULT_PLATFORM=#{DOCKER_PLATFORM}" if DOCKER_PLATFORM
+
+  "#{env.join(' ')} #{cmd}".tap do |str|
     puts str
     system str
   end
 end
 
 unless options[:skip_build]
-  run 'docker-compose build ' \
+  run 'docker compose build ' \
     " --build-arg RUBY_IMAGE=#{RUBY_IMAGE}" \
     " --build-arg USER_ID_GROUP=#{USER_ID_GROUP}" \
     " --build-arg FRAMEWORKS=#{FRAMEWORKS}" \
@@ -48,7 +60,7 @@ unless options[:skip_build]
   exit $?.exitstatus unless $?.success?
 end
 
-run 'docker-compose run' \
+run 'docker compose run' \
   " -u #{USER_ID_GROUP}" \
   ' --rm' \
   " specs #{ARGV.join}"

data/bin/run-bdd

@@ -9,9 +9,9 @@ if [[ $specific_feature = '' ]]; then
   echo 'Running all features'
 
   echo "========================================"
-  cucumber
+  bundle exec cucumber
 else
   echo "Running only $specific_feature"
 
-  cucumber $specific_feature
+  bundle exec cucumber $specific_feature
 fi

data/docker-compose.yml

@@ -1,5 +1,4 @@
 ---
-version: '3.4'
 
 services:
   mongodb:
@@ -14,10 +13,18 @@ services:
       context: .
       args:
         BUNDLER_VERSION: '2.2.21'
+        RUBY_IMAGE: ${RUBY_IMAGE:-ruby:3.3}
+        USER_ID_GROUP: ${USER_ID_GROUP:-1000:1000}
+        FRAMEWORKS: ${FRAMEWORKS:-rails,sinatra,grape}
+        VENDOR_PATH: ${VENDOR_PATH:-/vendor/ruby_3.3}
     image: '$IMAGE_NAME'
     environment:
       HOME: '/tmp'
       MONGODB_URL: 'mongodb:27017'
+      USER_ID: ${USER_ID:-1000}
+      LOCAL_USER_ID: ${LOCAL_USER_ID:-1000}
+      LOCAL_GROUP_ID: ${LOCAL_GROUP_ID:-1000}
+      RUBY_VERSION: ${RUBY_VERSION:-3.3}
     entrypoint:
       'spec/entrypoint.sh'
     tty: true
@@ -28,17 +35,17 @@ services:
       - /tmp:exec,mode=1777
     depends_on:
       - mongodb
-    user: ${USER_ID}
+    user: ${USER_ID:-1000}
     security_opt:
       - no-new-privileges
 
   ruby_rspec:
-    image: apm-agent-ruby:${RUBY_VERSION}
+    image: apm-agent-ruby:${RUBY_VERSION:-3.3}
     environment:
       APP_PATH: /opt/app
       FRAMEWORK: rails
-      LOCAL_USER_ID: ${LOCAL_USER_ID}
-      LOCAL_GROUP_ID: ${LOCAL_GROUP_ID}
+      LOCAL_USER_ID: ${LOCAL_USER_ID:-1000}
+      LOCAL_GROUP_ID: ${LOCAL_GROUP_ID:-1000}
       MONGODB_URL: 'mongodb:27017'
     security_opt:
       - no-new-privileges

data/docs/docset.yml

@@ -0,0 +1,11 @@
+project: 'APM Ruby agent docs'
+products:
+  - id: apm-agent
+cross_links:
+  - apm-agent-rum-js
+  - docs-content
+  - ecs-logging
+  - ecs-logging-ruby
+toc:
+  - toc: reference
+  - toc: release-notes

data/docs/reference/advanced-topics.md

@@ -0,0 +1,18 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/apm/agent/ruby/current/advanced.html
+applies_to:
+  stack:
+  serverless:
+    observability:
+  product:
+    apm_agent_ruby: ga
+---
+
+# Advanced topics [advanced]
+
+* [Adding additional context](/reference/context.md)
+* [Custom instrumentation](/reference/custom-instrumentation.md)
+
+
+