elastic-apm 4.5.1 → 4.7.2

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/updatecli.d/update-specs.yml

@@ -0,0 +1,118 @@
+name: update-specs
+
+title: synchronize schema 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-data/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-data/commits/{{ source "sha" }}/pulls --jq '.[].html_url'
+      environments:
+        - name: GITHUB_TOKEN
+        - name: PATH
+  error.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/error.json
+  metadata.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/metadata.json
+  metricset.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/metricset.json
+  span.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/span.json
+  transaction.json:
+    kind: file
+    spec:
+      file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/transaction.json
+
+
+
+
+
+actions:
+  pr:
+    kind: "github/pullrequest"
+    scmid: default
+    sourceid: sha
+    spec:
+      automerge: false
+      draft: false
+      labels:
+        - "automation"
+      description: |-
+        ### What
+        APM agent json schema automatic sync
+        ### Why
+        *Changeset*
+        * https://github.com/elastic/apm-data/commit/{{ source "sha" }}
+        * {{ source "pull_request" }}
+
+targets:
+  error.json:
+    name: error.json
+    scmid: default
+    sourceid: error.json
+    kind: file
+    spec:
+      file: spec/fixtures/error.json
+      forcecreate: true
+  metadata.json:
+    name: metadata.json
+    scmid: default
+    sourceid: metadata.json
+    kind: file
+    spec:
+      file: spec/fixtures/metadata.json
+      forcecreate: true
+  metricset.json:
+    name: metricset.json
+    scmid: default
+    sourceid: metricset.json
+    kind: file
+    spec:
+      file: spec/fixtures/metricset.json
+      forcecreate: true
+  span.json:
+    name: span.json
+    scmid: default
+    sourceid: span.json
+    kind: file
+    spec:
+      file: spec/fixtures/span.json
+      forcecreate: true
+  transaction.json:
+    name: transaction.json
+    scmid: default
+    sourceid: transaction.json
+    kind: file
+    spec:
+      file: spec/fixtures/transaction.json
+      forcecreate: true

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"'

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/apm-pipeline-library/.github/actions/pre-commit@current
+
+  # 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@v3
+      - 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@v3
+        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/apm-pipeline-library/.github/actions/check-dependent-jobs@current
+        with:
+          needs: ${{ toJSON(needs) }}
+      - run: ${{ steps.check.outputs.isSuccess }}

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

@@ -0,0 +1,34 @@
+---
+## Workflow to process coverage report
+## For now the coverage is not reported. This workflow is just here as preparation for
+## https://github.com/elastic/observability-robots/issues/1546
+name: coverage-reporter
+on:
+  workflow_run:
+    workflows:
+      - test
+    types:
+      - completed
+
+permissions:
+  contents: read
+
+jobs:
+  report:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download artifacts
+        run: >
+          gh run download ${{ github.event.workflow_run.id }}
+          --name coverage
+          --repo "${GITHUB_REPOSITORY}" 
+          --dir coverage
+        env:
+          GH_TOKEN: ${{ github.token }}
+      - run: ls -l coverage/matrix_results
+#      - run: ./spec/scripts/coverage_converge.sh
+#      - uses: actions/upload-artifact@v3
+#        with:
+#          name: coverage-report
+#          path: coverage/coverage.xml

data/.github/workflows/microbenchmark.yml

@@ -0,0 +1,48 @@
+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
+    # wait up to 1 hour
+    timeout-minutes: 60
+    steps:
+      - id: buildkite
+        name: Run buildkite pipeline
+        uses: elastic/apm-pipeline-library/.github/actions/buildkite@current
+        with:
+          vaultUrl: ${{ secrets.VAULT_ADDR }}
+          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
+          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}
+          pipeline: apm-agent-microbenchmark
+          triggerMessage: "${{ github.repository }}@${{ github.ref_name }}"
+          waitFor: true
+          printBuildLogs: true
+          buildEnvVars: |
+            script=.ci/scripts/bench.sh
+            repo=apm-agent-ruby
+            sha=${{ github.sha }}
+            BRANCH_NAME=${{ github.ref_name }}
+
+      - if: ${{ failure() }}
+        uses: elastic/apm-pipeline-library/.github/actions/slack-message@current
+        with:
+          url: ${{ secrets.VAULT_ADDR }}
+          roleId: ${{ secrets.VAULT_ROLE_ID }}
+          secretId: ${{ secrets.VAULT_SECRET_ID }}
+          channel: "#apm-agent-ruby"
+          message: |
+            :ghost: [${{ github.repository }}] microbenchmark *${{ github.ref_name }}* failed to run in Buildkite.
+            Build: (<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|here>)

data/.github/workflows/opentelemetry.yml

@@ -0,0 +1,27 @@
+---
+name: OpenTelemetry Export Trace
+
+on:
+  workflow_run:
+    workflows:
+      - Auto Assign to Project(s)
+      - Issue Labeler
+      - ci
+      - coverage-reporter
+      - microbenchmark
+      - release
+      - run-matrix
+      - snapshoty
+      - test-reporter
+      - updatecli
+    types: [completed]
+
+jobs:
+  otel-export-trace:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: elastic/apm-pipeline-library/.github/actions/opentelemetry@current
+        with:
+          vaultUrl: ${{ secrets.VAULT_ADDR }}
+          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
+          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}