elastic-apm 4.6.1 → 4.7.0

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

@@ -0,0 +1,121 @@
+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}"
+
+  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" }}
+
+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/.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 }}

data/.github/workflows/release.yml

@@ -0,0 +1,71 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+*"
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - uses: hashicorp/vault-action@v2.4.2
+        with:
+          url: ${{ secrets.VAULT_ADDR }}
+          method: approle
+          roleId: ${{ secrets.VAULT_ROLE_ID }}
+          secretId: ${{ secrets.VAULT_SECRET_ID }}
+          secrets: |
+            secret/apm-team/ci/apm-agent-ruby-rubygems-release apiKey | API_KEY ;
+      - 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: ${API_KEY}" >> "${RUBY_CREDENTIALS_FILE}"
+          chmod 0600 "${RUBY_CREDENTIALS_FILE}"
+      - name: Install build system
+        run: .ci/scripts/install-build-system.sh
+      - run: rake release
+  update-branch:
+    needs:
+      - release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Setup Git
+        uses: elastic/apm-pipeline-library/.github/actions/setup-git@current
+      - name: Install build system
+        run: .ci/scripts/install-build-system.sh
+      - run: rake release:update_branch
+
+  status:
+    if: always()
+    runs-on: ubuntu-latest
+    needs:
+      - release
+      - update-branch
+    steps:
+      - id: check
+        uses: elastic/apm-pipeline-library/.github/actions/check-dependent-jobs@current
+        with:
+          needs: ${{ toJSON(needs) }}
+      - run: ${{ steps.check.outputs.isSuccess }}
+      - if: always()
+        uses: elastic/apm-pipeline-library/.github/actions/notify-build-status@current
+        with:
+          vaultUrl: ${{ secrets.VAULT_ADDR }}
+          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
+          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}
+          slackChannel: "#apm-agent-ruby"

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

@@ -0,0 +1,56 @@
+---
+# 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
+
+jobs:
+  create-test-matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.generate.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v3
+      - id: generate
+        uses: elastic/apm-pipeline-library/.github/actions/version-framework@current
+        with:
+          versionsFile: ${{ inputs.versionsFile }}
+          frameworksFile: ${{ inputs.frameworksFile }}
+          excludedFile: ${{ 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@v3
+      - 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
+        with:
+          name: test-results
+          path: "**/spec/junit-reports/**/*ruby-agent-junit.xml"
+      - if: success() || failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage
+          path: "coverage/"

data/.github/workflows/snapshoty.yml

@@ -0,0 +1,35 @@
+name: snapshoty
+
+on:
+  workflow_run:
+    workflows:
+      - ci
+    types:
+      - completed
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download artifacts
+        run: >
+          gh run download ${{ github.event.workflow_run.id }}
+          --name package
+          --repo "${GITHUB_REPOSITORY}" 
+          --dir pkg
+        env:
+          GH_TOKEN: ${{ github.token }}
+      - name: Publish snapshot
+        uses: elastic/apm-pipeline-library/.github/actions/snapshoty-simple@current
+        with:
+          config: '.ci/snapshoty.yml'
+          vaultUrl: ${{ secrets.VAULT_ADDR }}
+          vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
+          vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}

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

@@ -0,0 +1,24 @@
+---
+## 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
+  checks: write
+
+jobs:
+  report:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: elastic/apm-pipeline-library/.github/actions/test-report@current
+        with:
+          artifact: test-results
+          name: test-report
+          path: "**/*ruby-agent-junit.xml"
+          reporter: java-junit

data/.github/workflows/{update-specs.yml → updatecli.yml}

@@ -1,4 +1,4 @@
-name: update-specs
+name: updatecli
 
 on:
   workflow_dispatch: ~
@@ -14,13 +14,11 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: elastic/apm-pipeline-library/.github/actions/updatecli@current
-        env:
-          BRANCH_NAME: ${{ github.ref_name }}
         with:
           vaultUrl: ${{ secrets.VAULT_ADDR }}
           vaultRoleId: ${{ secrets.VAULT_ROLE_ID }}
           vaultSecretId: ${{ secrets.VAULT_SECRET_ID }}
-          pipeline: ./.ci/update-specs.yml
+          pipeline: .ci/updatecli.d
       - if: failure()
         uses: elastic/apm-pipeline-library/.github/actions/notify-build-status@current
         with:

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/CHANGELOG.asciidoc

@@ -25,7 +25,6 @@ endif::[]
 
 [float]
 ===== Fixed
-- Fix {pull}2526[#2526]
 
 [float]
 [[unreleased]]
@@ -35,6 +34,25 @@ endif::[]
 [[release-notes-4.x]]
 === Ruby Agent version 4.x
 
+[[release-notes-4.7.0]]
+==== 4.7.0
+
+[float]
+===== Fixed
+- Handle Faraday response being nil {pull}1382[#1382]
+- Fix error with invalid %-encoding {pull}1400[#1400]
+
+[float]
+===== Added
+- Add keyword args for span_method helper {pull}1395[#1395]
+
+[[release-notes-4.6.2]]
+==== 4.6.2
+
+[float]
+===== Fixed
+- Fix Faraday::RackBuilder::StackLocked {pull}1371[#1371]
+
 [[release-notes-4.6.1]]
 ==== 4.6.1
 

data/CONTRIBUTING.md

@@ -49,4 +49,4 @@ To release a new version:
     2. Push the tag to GitHub.
     3. Build the gem and upload to Rubygems (local user needs to be signed in and authorized.)
 1. Run `rake release:update_branch`. This will...
-    1. Update `3.x` branch to be at released commit and push it to GitHub.
+    1. Update `4.x` branch to be at released commit and push it to GitHub.

data/Gemfile

@@ -62,6 +62,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',
@@ -83,9 +87,9 @@ frameworks_versions.each do |framework, version|
   end
 
   case version
-  when 'master' # sinatra, grape
+  when 'master' # grape
     gem framework, github: GITHUB_REPOS.fetch(framework)
-  when 'main' # rails
+  when 'main' # sinatra, rails
     gem framework, github: GITHUB_REPOS.fetch(framework), branch: 'main'
   when /.+/
     gem framework, "~> #{version}.0"

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/Rakefile

@@ -24,9 +24,9 @@ desc 'Post release action:'\
 
 namespace :release do
   task :update_branch do
-    `git checkout 3.x &&
+    `git checkout 4.x &&
     git rebase main &&
-    git push origin 3.x &&
+    git push origin 4.x &&
     git checkout main`
   end
 end

data/bench/rubyprof.rb

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

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