elastic-apm 4.6.2 → 4.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7c28585ab44cfdb7a4eb8c32b8dd60e1ecb10c091357c25a6b13f35a0fe2ffc
-  data.tar.gz: 3aad55a03f8c2a4d824ea09731be304e7712ee306dc4e585c5cc29ba11e25413
+  metadata.gz: 2a42c0ce245df1d22209302a5047957fdc35532ef06e0834078200305377df50
+  data.tar.gz: 43cbfaca9d8b8d382bb95c42559a7a497e28926bf7067558741b57aa036842e0
 SHA512:
-  metadata.gz: eb6480a61567bd000e5325e12702c46882a42a9c452a60bd7af997b7138b076cd332d853f101b694af30d120bdd3b48f1b911feb6ecf12e94cdfc58ba096855c
-  data.tar.gz: e626d4a1cb9370780d764385585fb4c4025d612a84b7ef36ae0525f6d6f6a83ddf7d5aa670ccf2610bf10f9e2c2d9a87f2f97818cc9e8de27153c3a85cd34875
+  metadata.gz: fe8f8a3f6228788632530c5ee4ecfcf8ade01e199aa5cc06bc40e1af68a54f75266d5fcae91aa4d2357bb57fbd54c62f357b24a6e89b841ac449ae75199b1603
+  data.tar.gz: 2d3f2ece8d92db1a43475384e284fc82678ca5bf8352ce3b5d384e682dfbf55c6324886de1a94f95641861ce808cadaa1f057e7956c2b46fe4ab39db213fa0c1

data/.ci/.exclude.yml

@@ -0,0 +1,193 @@
+exclude:
+  # Ruby 2.4
+  # Only test on rails-4.2, sinatra-1.4
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-7.0
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-6.1
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-6.0
+  - 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: grape-1.6,sinatra-2.2,rails-6.0
+  - 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.1
+    FRAMEWORK: rails-4.2
+  - VERSION: ruby:3.0
+    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:3.0
+    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.0 and rails-6.1 exclusions
+  # Don't test on ruby 2.4
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-6.1
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-6.0
+
+  # Only test rails main on ruby 3.1
+  - VERSION: ruby:3.0
+    FRAMEWORK: rails-main
+  - VERSION: ruby:2.7
+    FRAMEWORK: rails-main
+  - VERSION: ruby:2.6
+    FRAMEWORK: rails-main
+  - VERSION: ruby:2.5
+    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.0 on ruby >= 2.7
+  - VERSION: ruby:2.6
+    FRAMEWORK: rails-7.0
+  - VERSION: ruby:2.5
+    FRAMEWORK: rails-7.0
+  - VERSION: ruby:2.4
+    FRAMEWORK: rails-7.0
+  - VERSION: jruby:9.2
+    FRAMEWORK: rails-7.0
+  - VERSION: elasticobservability/jruby:9.2-13-jdk
+    FRAMEWORK: rails-7.0
+  - VERSION: elasticobservability/jruby:9.2-11-jdk
+    FRAMEWORK: rails-7.0
+  - VERSION: elasticobservability/jruby:9.2-8-jdk
+    FRAMEWORK: rails-7.0
+
+  # Only test sinatra main on ruby 2.7 and ruby 3.1
+  - VERSION: ruby:3.0
+    FRAMEWORK: sinatra-main
+  - VERSION: ruby:2.6
+    FRAMEWORK: sinatra-main
+  - VERSION: ruby:2.5
+    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.0
+  - VERSION: ruby:2.6
+    FRAMEWORK: grape-master
+  - VERSION: ruby:2.5
+    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.0
+  - VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6
+  - VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  - VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - VERSION: ruby:3.0
+    FRAMEWORK: grape-1.6
+  - VERSION: ruby:3.0
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+
+  # only test ruby >= 3.0 with rails 6.0 and rails 6.1
+  - VERSION: ruby:3.1
+    FRAMEWORK: rails-5.2
+  - VERSION: ruby:3.1
+    FRAMEWORK: rails-5.1
+  - VERSION: ruby:3.0
+    FRAMEWORK: rails-5.2
+  - VERSION: ruby:3.0
+    FRAMEWORK: rails-5.1
+
+  # Unsupported
+  # Ruby 2.6
+  - VERSION: ruby:2.6
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - VERSION: ruby:2.6
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # Ruby 2.5
+  - VERSION: ruby:2.5
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - VERSION: ruby:2.5
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # Ruby 2.4
+  - VERSION: ruby:2.4
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - VERSION: ruby:2.4
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2
+  - VERSION: jruby:9.2
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - VERSION: jruby:9.2
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2-13-jdk
+  - VERSION: elasticobservability/jruby:9.2-13-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - VERSION: elasticobservability/jruby:9.2-13-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2-11-jdk
+  - VERSION: elasticobservability/jruby:9.2-11-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - VERSION: elasticobservability/jruby:9.2-11-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2-8-jdk
+  - VERSION: elasticobservability/jruby:9.2-8-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - VERSION: elasticobservability/jruby:9.2-8-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0

data/.ci/.ruby.yml

@@ -0,0 +1,10 @@
+VERSION:
+  - ruby:3.1
+  - ruby:3.0
+  - 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/snapshoty.yml

@@ -23,12 +23,11 @@ artifacts:
     # Files pattern to match
     files_pattern: 'elastic-apm-(?P<app_version>\d+\.\d+\.\d+)\.gem'
     # File layout on GCS bucket
-    output_pattern: '{project}/{jenkins_branch_name}/elastic-apm-ruby-{app_version}-{jenkins_git_commit_short}.gem'
+    output_pattern: '{project}/{github_branch_name}/elastic-apm-ruby-{app_version}-{github_sha_short}.gem'
     # List of metadata processors to use.
     metadata:
       # Define static custom metadata
       - name: 'custom'
         data:
           project: 'apm-agent-ruby'
-      # Add jenkins metadata
-      - name: 'jenkins'
+      - name: 'github_actions'

data/.ci/updatecli.d/update-gherkin-specs.yml

@@ -0,0 +1,126 @@
+name: update-gherkin-specs
+pipelineid: update-gherkin-specs
+title: synchronize gherkin specs
+
+scms:
+  default:
+    kind: github
+    spec:
+      user: '{{ requiredEnv "GIT_USER" }}'
+      email: '{{ requiredEnv "GIT_EMAIL" }}'
+      owner: elastic
+      repository: apm-agent-ruby
+      token: '{{ requiredEnv "GITHUB_TOKEN" }}'
+      username: '{{ requiredEnv "GIT_USER" }}'
+      branch: main
+
+sources:
+  sha:
+    kind: file
+    spec:
+      file: 'https://github.com/elastic/apm/commit/main.patch'
+      matchpattern: "^From\\s([0-9a-f]{40})\\s"
+    transformers:
+      - findsubmatch:
+          pattern: "[0-9a-f]{40}"
+  pull_request:
+    kind: shell
+    dependson:
+      - sha
+    spec:
+      command: gh api /repos/elastic/apm/commits/{{ source "sha" }}/pulls --jq '.[].html_url'
+      environments:
+        - name: GITHUB_TOKEN
+        - name: PATH
+  api_key.feature:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/gherkin-specs/api_key.feature
+  azure_app_service_metadata.feature:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/gherkin-specs/azure_app_service_metadata.feature
+  azure_functions_metadata.feature:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/gherkin-specs/azure_functions_metadata.feature
+  otel_bridge.feature:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/gherkin-specs/otel_bridge.feature
+  outcome.feature:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/gherkin-specs/outcome.feature
+  user_agent.feature:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/gherkin-specs/user_agent.feature
+
+actions:
+  pr:
+    kind: "github/pullrequest"
+    scmid: default
+    title: '[Automation] Update Gherkin specs'
+    spec:
+      automerge: false
+      draft: false
+      labels:
+        - "automation"
+      description: |-
+        ### What
+        APM agent Gherkin specs automatic sync
+        ### Why
+        *Changeset*
+        * https://github.com/elastic/apm/commit/{{ source "sha" }}
+        * {{ source "pull_request" }}
+
+targets:
+  api_key.feature:
+    name: api_key.feature
+    scmid: default
+    sourceid: api_key.feature
+    kind: file
+    spec:
+      file: features/api_key.feature
+      forcecreate: true
+  azure_app_service_metadata.feature:
+    name: azure_app_service_metadata.feature
+    scmid: default
+    sourceid: azure_app_service_metadata.feature
+    kind: file
+    spec:
+      file: features/azure_app_service_metadata.feature
+      forcecreate: true
+  azure_functions_metadata.feature:
+    name: azure_functions_metadata.feature
+    scmid: default
+    sourceid: azure_functions_metadata.feature
+    kind: file
+    spec:
+      file: features/azure_functions_metadata.feature
+      forcecreate: true
+  otel_bridge.feature:
+    name: otel_bridge.feature
+    scmid: default
+    sourceid: otel_bridge.feature
+    kind: file
+    spec:
+      file: features/otel_bridge.feature
+      forcecreate: true
+  outcome.feature:
+    name: outcome.feature
+    scmid: default
+    sourceid: outcome.feature
+    kind: file
+    spec:
+      file: features/outcome.feature
+      forcecreate: true
+  user_agent.feature:
+    name: user_agent.feature
+    scmid: default
+    sourceid: user_agent.feature
+    kind: file
+    spec:
+      file: features/user_agent.feature
+      forcecreate: true

data/.ci/updatecli.d/update-json-specs.yml

@@ -0,0 +1,130 @@
+name: update-json-specs
+pipelineid: update-json-specs
+title: synchronize json specs
+
+scms:
+  default:
+    kind: github
+    spec:
+      user: '{{ requiredEnv "GIT_USER" }}'
+      email: '{{ requiredEnv "GIT_EMAIL" }}'
+      owner: elastic
+      repository: apm-agent-ruby
+      token: '{{ requiredEnv "GITHUB_TOKEN" }}'
+      username: '{{ requiredEnv "GIT_USER" }}'
+      branch: main
+
+sources:
+  sha:
+    kind: file
+    spec:
+      file: 'https://github.com/elastic/apm/commit/main.patch'
+      matchpattern: "^From\\s([0-9a-f]{40})\\s"
+    transformers:
+      - findsubmatch:
+          pattern: "[0-9a-f]{40}"
+  pull_request:
+    kind: shell
+    dependson:
+      - sha
+    spec:
+      command: gh api /repos/elastic/apm/commits/{{ source "sha" }}/pulls --jq '.[].html_url'
+      environments:
+        - name: GITHUB_TOKEN
+        - name: PATH
+  container_metadata_discovery.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/json-specs/container_metadata_discovery.json
+  service_resource_inference.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/json-specs/service_resource_inference.json
+  span_types.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/json-specs/span_types.json
+  sql_signature_examples.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/json-specs/sql_signature_examples.json
+  sql_token_examples.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/json-specs/sql_token_examples.json
+  w3c_distributed_tracing.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/json-specs/w3c_distributed_tracing.json
+  wildcard_matcher_tests.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm/main/tests/agents/json-specs/wildcard_matcher_tests.json
+actions:
+  pr:
+    kind: "github/pullrequest"
+    scmid: default
+    title: '[Automation] Update JSON specs'
+    spec:
+      automerge: false
+      draft: false
+      labels:
+        - "automation"
+      description: |-
+        ### What
+        APM agent specs automatic sync
+        ### Why
+        *Changeset*
+        * https://github.com/elastic/apm/commit/{{ source "sha" }}
+        * {{ source "pull_request" }}
+
+targets:
+  container_metadata_discovery.json:
+    name: container_metadata_discovery.json
+    scmid: default
+    sourceid: container_metadata_discovery.json
+    kind: file
+    spec:
+      file: spec/fixtures/container_metadata_discovery.json
+  service_resource_inference.json:
+    name: service_resource_inference.json
+    scmid: default
+    sourceid: service_resource_inference.json
+    kind: file
+    spec:
+      file: spec/fixtures/service_resource_inference.json
+  span_types.json:
+    name: span_types.json
+    scmid: default
+    sourceid: span_types.json
+    kind: file
+    spec:
+      file: spec/fixtures/span_types.json
+  sql_signature_examples.json:
+    name: sql_signature_examples.json
+    scmid: default
+    sourceid: sql_signature_examples.json
+    kind: file
+    spec:
+      file: spec/fixtures/sql_signature_examples.json
+  sql_token_examples.json:
+    name: sql_token_examples.json
+    scmid: default
+    sourceid: sql_token_examples.json
+    kind: file
+    spec:
+      file: spec/fixtures/sql_token_examples.json
+  w3c_distributed_tracing.json:
+    name: w3c_distributed_tracing.json
+    scmid: default
+    sourceid: w3c_distributed_tracing.json
+    kind: file
+    spec:
+      file: spec/fixtures/w3c_distributed_tracing.json
+  wildcard_matcher_tests.json:
+    name: wildcard_matcher_tests.json
+    scmid: default
+    sourceid: wildcard_matcher_tests.json
+    kind: file
+    spec:
+      file: spec/fixtures/wildcard_matcher_tests.json

data/.ci/{update-specs.yml → updatecli.d/update-specs.yml}

@@ -23,6 +23,15 @@ sources:
     transformers:
       - findsubmatch:
           pattern: "[0-9a-f]{40}"
+  pull_request:
+    kind: shell
+    dependson:
+      - sha
+    spec:
+      command: gh api /repos/elastic/apm-data/commits/{{ source "sha" }}/pulls --jq '.[].html_url'
+      environments:
+        - name: GITHUB_TOKEN
+        - name: PATH
   error.json:
     kind: file
     spec:
@@ -64,6 +73,7 @@ actions:
         ### Why
         *Changeset*
         * https://github.com/elastic/apm-data/commit/{{ source "sha" }}
+        * {{ source "pull_request" }}
 
 targets:
   error.json:

data/.github/dependabot.yml

@@ -3,7 +3,9 @@ updates:
 - package-ecosystem: bundler
   directory: "/"
   schedule:
-    interval: daily
+    interval: "weekly"
+    day: "sunday"
+    time: "22:00"
   open-pull-requests-limit: 10
   ignore:
   - dependency-name: sucker_punch
@@ -14,3 +16,17 @@ updates:
     - 1.8.10
     - 1.8.8
     - 1.8.9
+
+  # GitHub actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    reviewers:
+      - "elastic/observablt-ci"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "22:00"
+    groups:
+      github-actions:
+        patterns:
+          - "*"

data/.github/workflows/README.md

@@ -0,0 +1,58 @@
+## 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)
+* [Snapshoty](./snapshoty.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
+
+There is a GitHub workflow in charge to populate what the workflow run in terms of jobs and steps. Those details can be seen in [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/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"'