elastic-apm 4.6.2 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7c28585ab44cfdb7a4eb8c32b8dd60e1ecb10c091357c25a6b13f35a0fe2ffc
-  data.tar.gz: 3aad55a03f8c2a4d824ea09731be304e7712ee306dc4e585c5cc29ba11e25413
+  metadata.gz: 5ebd8a3592a4632b3f13811b920430b0052a67d80c921827ceb6639764c99de1
+  data.tar.gz: 485ec2dcb2f45d58fef2dbdb2acaa2cf515d33d0ce634bc44ef6f0f526e80f41
 SHA512:
-  metadata.gz: eb6480a61567bd000e5325e12702c46882a42a9c452a60bd7af997b7138b076cd332d853f101b694af30d120bdd3b48f1b911feb6ecf12e94cdfc58ba096855c
-  data.tar.gz: e626d4a1cb9370780d764385585fb4c4025d612a84b7ef36ae0525f6d6f6a83ddf7d5aa670ccf2610bf10f9e2c2d9a87f2f97818cc9e8de27153c3a85cd34875
+  metadata.gz: d39a813a6c001fe599e397ec74b8a5037ad3b07c9c0710124046f58ffb96a06c18bbd0021672d6b00e55ef1317a008f354ddf5061eb58ba560ab1684bbb29a0b
+  data.tar.gz: e72c6f09511b8f2884e7f07d053c8ee4618fc18692e453e4afafd81d164f890fe2fd6c39b1f47097ae828d789c620c72c6448ca85a30746925be4be9ca24625e

data/.ci/.exclude.yml

@@ -0,0 +1,132 @@
+exclude:
+  # Ruby 2.4
+  # Only test on rails-4.2, sinatra-1.4
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-7.2
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-6.1
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-5.2
+  - VERSION: ruby:2.4
+    FRAMEWORK: sinatra-2.2
+  - VERSION: ruby:2.4
+    FRAMEWORK: grape-1.6
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-main
+  - VERSION: ruby:2.4
+    FRAMEWORK: sinatra-main
+  - VERSION: ruby:2.4
+    FRAMEWORK: grape-master
+
+  # rails-4.2 exclusions
+  # Only test on ruby 2.4
+  - VERSION: ruby:3.4
+    FRAMEWORK: rails-4.2
+  - VERSION: ruby:3.1
+    FRAMEWORK: rails-4.2
+  - VERSION: ruby:2.7
+    FRAMEWORK: rails-4.2
+  - VERSION: ruby:2.6
+    FRAMEWORK: rails-4.2
+  - VERSION: jruby:9.2
+    FRAMEWORK: rails-4.2
+  - VERSION: elasticobservability/jruby:9.2-13-jdk
+    FRAMEWORK: rails-4.2
+  - VERSION: elasticobservability/jruby:9.2-11-jdk
+    FRAMEWORK: rails-4.2
+  - VERSION: elasticobservability/jruby:9.2-8-jdk
+    FRAMEWORK: rails-4.2
+  # sinatra-1.4 exclusions
+  - VERSION: ruby:3.1
+    FRAMEWORK: sinatra-1.4
+  - VERSION: ruby:2.7
+    FRAMEWORK: sinatra-1.4
+  - VERSION: jruby:9.2
+    FRAMEWORK: sinatra-1.4
+  - VERSION: elasticobservability/jruby:9.2-13-jdk
+    FRAMEWORK: sinatra-1.4
+  - VERSION: elasticobservability/jruby:9.2-11-jdk
+    FRAMEWORK: sinatra-1.4
+  - VERSION: elasticobservability/jruby:9.2-8-jdk
+    FRAMEWORK: sinatra-1.4
+
+  # rails-6.1 and rails 7.0 exclusions
+  # Don't test on ruby 2.4
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-6.1
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-7.2
+
+  # Only test rails main on ruby 3.1
+  - VERSION: ruby:2.7
+    FRAMEWORK: rails-main
+  - VERSION: ruby:2.6
+    FRAMEWORK: rails-main
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-main
+  - VERSION: jruby:9.2
+    FRAMEWORK: rails-main
+  - VERSION: elasticobservability/jruby:9.2-13-jdk
+    FRAMEWORK: rails-main
+  - VERSION: elasticobservability/jruby:9.2-11-jdk
+    FRAMEWORK: rails-main
+  - VERSION: elasticobservability/jruby:9.2-8-jdk
+    FRAMEWORK: rails-main
+
+  # Only test rails 7.2 on ruby >= 3.1
+  - VERSION: ruby:2.7
+    FRAMEWORK: rails-7.2
+  - VERSION: ruby:2.6
+    FRAMEWORK: rails-7.2
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-7.2
+  - VERSION: jruby:9.2
+    FRAMEWORK: rails-7.2
+  - VERSION: elasticobservability/jruby:9.2-13-jdk
+    FRAMEWORK: rails-7.2
+  - VERSION: elasticobservability/jruby:9.2-11-jdk
+    FRAMEWORK: rails-7.2
+  - VERSION: elasticobservability/jruby:9.2-8-jdk
+    FRAMEWORK: rails-7.2
+
+  # Only test sinatra main on ruby 2.7 and ruby 3.1
+  - VERSION: ruby:2.6
+    FRAMEWORK: sinatra-main
+  - VERSION: ruby:2.4
+    FRAMEWORK: sinatra-main
+  - VERSION: jruby:9.2
+    FRAMEWORK: sinatra-main
+  - VERSION: elasticobservability/jruby:9.2-13-jdk
+    FRAMEWORK: sinatra-main
+  - VERSION: elasticobservability/jruby:9.2-11-jdk
+    FRAMEWORK: sinatra-main
+  - VERSION: elasticobservability/jruby:9.2-8-jdk
+    FRAMEWORK: sinatra-main
+
+  # Only test grape master on ruby 2.7 and ruby 3.1
+  - VERSION: ruby:2.6
+    FRAMEWORK: grape-master
+  - VERSION: ruby:2.4
+    FRAMEWORK: grape-master
+  - VERSION: jruby:9.2
+    FRAMEWORK: grape-master
+  - VERSION: elasticobservability/jruby:9.2-13-jdk
+    FRAMEWORK: grape-master
+  - VERSION: elasticobservability/jruby:9.2-11-jdk
+    FRAMEWORK: grape-master
+  - VERSION: elasticobservability/jruby:9.2-8-jdk
+    FRAMEWORK: grape-master
+
+  # grape 1.5 doesn't support ruby 3.1
+  - VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6
+
+  # only test ruby >= 3.1 with rails 6.1 and rails 7.0
+  - VERSION: ruby:3.4
+    FRAMEWORK: rails-5.2
+  - VERSION: ruby:3.4
+    FRAMEWORK: rails-5.1
+  - VERSION: ruby:3.1
+    FRAMEWORK: rails-5.2
+  - VERSION: ruby:3.1
+    FRAMEWORK: rails-5.1

data/.ci/{.jenkins_framework.yml → .framework.yml}

@@ -1,7 +1,6 @@
 FRAMEWORK:
-  - rails-7.0
+  - rails-7.2
   - rails-6.1
-  - rails-6.0
   - rails-5.2
   - rails-4.2
 
@@ -9,5 +8,3 @@ FRAMEWORK:
   - sinatra-1.4
 
   - grape-1.6
-
-  - grape-1.6,sinatra-2.2,rails-6.1

data/.ci/.ruby.yml

@@ -0,0 +1,10 @@
+VERSION:
+  - ruby:3.4
+  - ruby:3.1
+  - ruby:2.7
+  - ruby:2.6
+  - ruby:2.4
+  - jruby:9.2
+  - elasticobservability/jruby:9.2-13-jdk
+  - elasticobservability/jruby:9.2-11-jdk
+  - elasticobservability/jruby:9.2-8-jdk

data/.ci/scripts/bench.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# Bash strict mode
+set -eo pipefail
+
+# Found current script directory
+RELATIVE_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+# Found project directory
+BASE_PROJECT="$(dirname "$(dirname "${RELATIVE_DIR}")")"
+
+## Buildkite specific configuration
+if [ "$CI" == "true" ] ; then
+  # If HOME is not set then use the Buildkite workspace
+  # that's normally happening when running in the CI
+  # owned by Elastic.
+  if [ -z "$HOME" ] ; then
+    HOME=$BUILDKITE_BUILD_CHECKOUT_PATH
+    export HOME
+  fi
+
+  # required when running the benchmark
+  PATH=$PATH:$HOME/.local/bin
+  export PATH
+
+  echo 'Docker login is done in the Buildkite hooks'
+fi
+
+# It does not fail so it runs for every single version and then we report the error at the end.
+set +e
+status=0
+
+for VERSION in "ruby:3.1" "ruby:3.0" "ruby:2.7" "ruby:2.6" "jruby:9.2" ; do
+    ## Transform the versions like:
+    ## jruby:9.1 to jruby-9.1
+  echo "--- Benchmark for :ruby: ${VERSION}"
+  OUTPUT_NAME=benchmark-$(echo "${VERSION//:/-}")
+
+  # TBC, maybe a timeout could help so it can run the other versions?
+  ${BASE_PROJECT}/spec/scripts/benchmarks.sh "${VERSION}" "${OUTPUT_NAME}"
+
+  # Gather error if any
+  if [ $? -gt 0 ] ; then
+    status=1
+  fi
+
+  # Then we ship the data using the helper
+  sendBenchmark "${ES_USER_SECRET}" "${ES_PASS_SECRET}" "${ES_URL_SECRET}" "${BASE_PROJECT}/spec/${OUTPUT_NAME}.bulk"
+done
+
+# Report status
+exit $status

data/.ci/scripts/install-build-system.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+gem install rake yard rspec

data/.ci/updatecli/values.d/apm-data-spec.yml

@@ -0,0 +1 @@
+apm_schema_specs_path: spec/fixtures

data/.ci/updatecli/values.d/apm-gherkin.yml

@@ -0,0 +1 @@
+apm_gherkin_specs_path: features

data/.ci/updatecli/values.d/apm-json-specs.yml

@@ -0,0 +1 @@
+apm_json_specs_path: spec/fixtures

data/.ci/updatecli/values.d/scm.yml

@@ -0,0 +1,10 @@
+scm:
+  enabled: true
+  owner: elastic
+  repository: apm-agent-ruby
+  branch: main
+  commitusingapi: true
+  # begin update-compose policy values
+  user: obltmachine
+  email: obltmachine@users.noreply.github.com
+  # end update-compose policy values

data/.ci/updatecli/values.d/update-compose.yml

@@ -0,0 +1,3 @@
+spec:
+  files:
+    - "updatecli-compose.yaml"

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -46,8 +46,8 @@ Update your local repository with the most recent code from the main repo, and r
 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)
-- [ ] I have updated [supported-technologies.asciidoc](docs/supported-technologies.asciidoc)
+- [ ] I have updated [docs/release-notes/index.md](../docs/release-notes/index.md)
+- [ ] I have updated [docs/reference/supported-technologies.md](../docs/reference/supported-technologies.md)
 - [ ] Added an API method or config option? Document in which version this will be introduced
 
 ## Related issues

data/.github/dependabot.yml

@@ -1,16 +1,37 @@
+---
 version: 2
 updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-  ignore:
-  - dependency-name: sucker_punch
-    versions:
-    - "> 2.0"
-  - dependency-name: i18n
-    versions:
-    - 1.8.10
-    - 1.8.8
-    - 1.8.9
+
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "22:00"
+    open-pull-requests-limit: 5
+    ignore:
+    - dependency-name: sucker_punch
+      versions:
+        - "> 2.0"
+    - dependency-name: i18n
+      versions:
+        - 1.8.10
+        - 1.8.8
+        - 1.8.9
+
+  # Maintain dependencies for GitHub Actions (/.github/workflows)
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "22:00"
+    open-pull-requests-limit: 5
+    reviewers:
+      - "elastic/observablt-ci"
+    labels:
+      - dependencies
+    groups:
+      github-actions:
+        patterns:
+          - "*"

data/.github/workflows/README.md

@@ -0,0 +1,57 @@
+## CI/CD
+
+There are 5 main stages that run on GitHub actions:
+
+* Linting
+* Test
+* Test `main` versions
+* Package
+* Release
+
+There are some other stages that run for every push on the main branches:
+
+* [Microbenchmark](./microbenchmark.yml)
+
+### Scenarios
+
+* Compatibility matrix runs on branches, tags and PRs basis.
+* Tests should be triggered on branch, tag and PR basis.
+* Commits that are only affecting the docs files should not trigger any test or similar stages that are not required.
+* Automated release in the CI gets triggered when a tag release is created.
+* **This is not the case yet**, but if Github secrets are required then Pull Requests from forked repositories won't run any build accessing those secrets. If needed, then create a feature branch.
+
+### Compatibility matrix
+
+Ruby agent supports compatibility to different ruby versions and frameworks, those are defined in:
+
+* [frameworks](../../.ci/.framework.yml) for all the PRs.
+* [frameworks](../../.ci/.main_framework.yml) for all the PRs using the `main` branches.
+* Ruby [versions](../../.ci/.ruby.yml) for all the `*nix` builds.
+* [Exclude list](../../.ci/.exclude.yml) for the above entries.
+
+### How to interact with the CI?
+
+#### On a PR basis
+
+Once a PR has been opened then there are two different ways you can trigger builds in the CI:
+
+1. Commit based
+1. UI based, any Elasticians can force a build through the GitHub UI
+
+#### Branches
+
+Every time there is a merge to main or any release branches the whole workflow will compile and test every entry in the compatibility matrix for Linux.
+
+### Release process
+
+This process has been fully automated and it gets triggered when a tag release has been created.
+The tag release follows the naming convention: `v.<major>.<minor>.<patch>`, where `<major>`, `<minor>` and `<patch>`.
+
+### OpenTelemetry
+
+Every workflow and its logs are exported to OpenTelemetry traces/logs/metrics. Those details can be seen [here](https://ela.st/oblt-ci-cd-stats) (**NOTE**: only available for Elasticians).
+
+## Bump automation
+
+[updatecli](https://www.updatecli.io/) is the tool we use to automatically update the specs
+the [APM agents](./updatecli.yml) use.

data/.github/workflows/addToProject.yml

@@ -5,14 +5,27 @@ on:
     types: [opened, edited, milestoned]
   pull_request_target:
     types: [opened, edited, milestoned]
-env:
-  MY_GITHUB_TOKEN: ${{ secrets.APM_TECH_USER_TOKEN }}
+
+permissions:
+  contents: read
 
 jobs:
   assign_one_project:
     runs-on: ubuntu-latest
     name: Assign milestoned to Project
     steps:
+    - 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: >-
+          {
+            "issues": "read",
+            "organization_projects": "write",
+            "pull_requests": "read"
+          }
     - name: Assign issues with milestones to project
       uses: elastic/assign-one-project-github-action@1.2.2
       if: github.event.issue && github.event.issue.milestone
@@ -20,6 +33,8 @@ jobs:
         project: 'https://github.com/orgs/elastic/projects/454'
         project_id: '5882982'
         column_name: 'Planned'
+      env:
+        MY_GITHUB_TOKEN: ${{ steps.get_token.outputs.token }}
     - name: Assign new pull requests to project
       uses: elastic/assign-one-project-github-action@1.2.2
       if: github.event.action == 'opened' && github.event.pull_request
@@ -27,3 +42,5 @@ jobs:
         project: 'https://github.com/orgs/elastic/projects/454'
         project_id: '5882982'
         column_name: 'In Progress'
+      env:
+        MY_GITHUB_TOKEN: ${{ steps.get_token.outputs.token }}

data/.github/workflows/ci-docs.yml

@@ -0,0 +1,20 @@
+---
+# This workflow sets the test / all status check to success in case it's a docs only PR and ci.yml is not triggered
+# https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks#handling-skipped-but-required-checks
+name: ci # The name must be the same as in ci.yml
+
+on:
+  pull_request:
+    paths-ignore: # This expression needs to match the paths ignored on ci.yml.
+      - '**'
+      - '!**/*.md'
+      - '!**/*.asciidoc'
+
+permissions:
+  contents: read
+
+jobs:
+  all:
+    runs-on: ubuntu-latest
+    steps:
+      - run: 'echo "No build required"'

data/.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+name: ci
+
+on:
+  pull_request:
+    paths-ignore:
+      - "**/*.asciidoc"
+      - "**/*.md"
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - "**/*.asciidoc"
+      - "**/*.md"
+
+permissions:
+  contents: read
+
+jobs:
+  sanity-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: elastic/oblt-actions/pre-commit@v1
+
+  # Invokes the actual matrix workflow with the provided files.
+  matrix:
+    uses: ./.github/workflows/run-matrix.yml
+    with:
+      versionsFile: .ci/.ruby.yml
+      frameworksFile: .ci/.framework.yml
+      excludedFile: .ci/.exclude.yml
+
+  # Invokes the actual matrix workflow with the provided files.
+  # In this case it's for the main frameworks.
+  matrix-main-frameworks:
+    uses: ./.github/workflows/run-matrix.yml
+    with:
+      versionsFile: .ci/.ruby.yml
+      frameworksFile: .ci/.main_framework.yml
+      excludedFile: .ci/.exclude.yml
+
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Install build system
+        run: .ci/scripts/install-build-system.sh
+      - name: Create gem
+        run: rake build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: package
+          path: ./pkg/**/*
+
+  all:
+    if: always()
+    runs-on: ubuntu-latest
+    needs:
+      - sanity-checks
+      - matrix
+      - matrix-main-frameworks
+      - package
+    steps:
+      - id: check
+        uses: elastic/oblt-actions/check-dependent-jobs@v1
+        with:
+          jobs: ${{ toJSON(needs) }}
+      - run: ${{ steps.check.outputs.is-success }}

data/.github/workflows/docs-build.yml

@@ -0,0 +1,19 @@
+name: docs-build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request_target: ~
+  merge_group: ~
+
+jobs:
+  docs-preview:
+    uses: elastic/docs-builder/.github/workflows/preview-build.yml@main
+    with:
+      path-pattern: docs/**
+    permissions:
+      deployments: write
+      id-token: write
+      contents: read
+      pull-requests: read

data/.github/workflows/docs-cleanup.yml

@@ -0,0 +1,14 @@
+name: docs-cleanup
+
+on:
+  pull_request_target:
+    types:
+      - closed
+
+jobs:
+  docs-preview:
+    uses: elastic/docs-builder/.github/workflows/preview-cleanup.yml@main
+    permissions:
+      contents: none
+      id-token: write
+      deployments: write

data/.github/workflows/github-commands-comment.yml

@@ -0,0 +1,38 @@
+---
+name: github-commands-comment
+
+on:
+  pull_request_target:
+    types:
+      - opened
+
+permissions:
+  contents: read
+
+jobs:
+  comment:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          script: |
+            const body = `
+              ### :robot: GitHub comments
+
+              <details><summary>Expand to view the GitHub comments</summary>
+              <p>
+
+              Just comment with:
+              - `run` `docs-build` : Re-trigger the docs validation. (use unformatted text in the comment!)
+              </p>
+              </details>
+            `.replace(/  +/g, '')
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: body
+            })

data/.github/workflows/labeler.yml

@@ -5,6 +5,11 @@ on:
   pull_request_target:
     types: [opened]
 
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
 jobs:
   triage:
     runs-on: ubuntu-latest

data/.github/workflows/microbenchmark.yml

@@ -0,0 +1,31 @@
+name: microbenchmark
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+      - '**.asciidoc'
+
+# limit the access of the generated GITHUB_TOKEN
+permissions:
+  contents: read
+
+jobs:
+  microbenchmark:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Run microbenchmark
+        uses: elastic/oblt-actions/buildkite/run@v1
+        with:
+          pipeline: "apm-agent-microbenchmark"
+          token: ${{ secrets.BUILDKITE_TOKEN }}
+          wait-for: false
+          env-vars: |
+            script=.ci/scripts/bench.sh
+            repo=apm-agent-ruby
+            sha=${{ github.sha }}
+            BRANCH_NAME=${{ github.ref_name }}