elastic-apm 4.6.2 → 4.8.0

data/.github/workflows/release.yml

@@ -0,0 +1,86 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+*"
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      attestations: write
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - 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: ${{ secrets.RUBYGEMS_API_KEY }}" >> "${RUBY_CREDENTIALS_FILE}"
+          chmod 0600 "${RUBY_CREDENTIALS_FILE}"
+
+      - name: Install build system
+        run: .ci/scripts/install-build-system.sh
+
+      - name: rake release (only for tags)
+        run: rake release
+        if: startsWith(github.ref, 'refs/tags')
+
+      - name: rake build
+        run: rake build
+        if:  ${{ ! startsWith(github.ref, 'refs/tags') }}
+
+      - name: generate build provenance
+        uses: actions/attest-build-provenance@db473fddc028af60658334401dc6fa3ffd8669fd  # v2.3.0
+        with:
+          subject-path: "${{ github.workspace }}/pkg/*.gem" 
+      
+  update-branch:
+    needs:
+      - release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Setup Git
+        uses: elastic/oblt-actions/git/setup@v1
+      - name: Install build system
+        run: .ci/scripts/install-build-system.sh
+      - name: rake release:update_branch (only for tags)
+        run: rake release:update_branch
+        if: startsWith(github.ref, 'refs/tags')
+
+  status:
+    if: always()
+    runs-on: ubuntu-latest
+    needs:
+      - release
+      - update-branch
+    steps:
+      - id: check
+        uses: elastic/oblt-actions/check-dependent-jobs@v1
+        with:
+          jobs: ${{ toJSON(needs) }}
+      - run: ${{ steps.check.outputs.is-success }}
+      - if: ${{ always() && startsWith(github.ref, 'refs/tags') }}
+        uses: elastic/oblt-actions/slack/notify-result@v1
+        with:
+          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/.github/workflows/run-matrix.yml

@@ -0,0 +1,68 @@
+---
+# 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
+
+permissions:
+  contents: read
+
+jobs:
+  create-test-matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.generate.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v4
+      - id: generate
+        uses: elastic/oblt-actions/version-framework@v1
+        with:
+          versions-file: ${{ inputs.versionsFile }}
+          frameworks-file: ${{ inputs.frameworksFile }}
+          excluded-file: ${{ 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@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()
+        id: normalize-junit
+        uses: actions/github-script@v7
+        with:
+          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()
+        name: Upload JUnit Test Results
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results-${{ steps.normalize-junit.outputs.result }}
+          path: "**/spec/junit-reports/**/*ruby-agent-junit.xml"

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

@@ -0,0 +1,25 @@
+---
+## 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
+  actions: read
+  checks: write
+
+jobs:
+  report:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: elastic/oblt-actions/test-report@v1
+        with:
+          artifact: /test-results(.*)/
+          name: 'Test Report $1'
+          path: "**/*ruby-agent-junit.xml"
+          reporter: java-junit

data/.github/workflows/updatecli.yml

@@ -0,0 +1,61 @@
+name: updatecli
+
+on:
+  workflow_dispatch: ~
+  schedule:
+    - cron: '0 6 * * *'
+
+permissions:
+  contents: read
+
+jobs:
+  compose:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
+    steps:
+      - 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:
+          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/oblt-actions/slack/send@v1
+        with:
+          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/.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/Gemfile

@@ -41,9 +41,14 @@ 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'
@@ -62,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',
@@ -82,6 +91,10 @@ frameworks_versions.each do |framework, version|
     gem 'net-smtp', require: false
   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)
@@ -94,6 +107,11 @@ frameworks_versions.each do |framework, version|
   end
 end
 
+# Handle Rack::Auth::Digest being removed in rack 3.1, grape requires it
+if frameworks_versions.key?('grape')
+  gem 'rack', '~> 3.0.0'
+end
+
 if frameworks_versions.key?('rails')
   unless /^(main|6)/.match?(frameworks_versions['rails'])
     gem 'delayed_job', require: nil
@@ -116,8 +134,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
@@ -127,6 +149,10 @@ if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('2.5.0') && !defined
   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/bench/rubyprof.rb

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

data/bin/dev

@@ -40,7 +40,7 @@ def run(cmd)
 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 +48,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-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

@@ -35,8 +35,11 @@ services:
   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
 

data/docs/docset.yml

@@ -0,0 +1,9 @@
+project: 'APM Ruby agent docs'
+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,12 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/apm/agent/ruby/current/advanced.html
+---
+
+# Advanced topics [advanced]
+
+* [Adding additional context](/reference/context.md)
+* [Custom instrumentation](/reference/custom-instrumentation.md)
+
+
+