elastic-apm 4.6.2 → 4.7.0

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

@@ -34,6 +34,18 @@ 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
 

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

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

@@ -24,7 +24,7 @@ When using this method, strings are split by comma, e.g.,
 [[configuration-precedence]]
 === Configuration precedence
 
-Options are applied in the following order (last one wins): 
+Options are applied in the following order (last one wins):
 
 1. Defaults
 2. Arguments to `ElasticAPM.start` / `Config.new`
@@ -170,7 +170,7 @@ WARNING: Secret tokens only provide any real security if your APM server uses TL
 |============
 
 This base64-encoded string is used to ensure that only your agents can send data to your APM server.
-The API key must be created using the {apm-guide-ref}/api-key.html[APM server command-line tool]. 
+The API key must be created using the {apm-guide-ref}/api-key.html[APM server command-line tool].
 
 WARNING: API keys only provide any real security if your APM server uses TLS.
 
@@ -199,7 +199,7 @@ The <<config-log-path,logs>> should tell you what went wrong.
 | `ELASTIC_APM_API_REQUEST_SIZE` | `api_request_size` | `"750kb"`
 |============
 
-The maximum amount of bytes sent over one request to APM Server. The agent will open a new request when this limit is reached. 
+The maximum amount of bytes sent over one request to APM Server. The agent will open a new request when this limit is reached.
 
 This must be provided in *<<config-format-size, size format>>*.
 
@@ -301,7 +301,8 @@ If set to `true`, the client will poll the APM Server regularly for new agent co
 
 Usually APM Server determines how often to poll, but if not, set the default interval is 5 minutes.
 
-NOTE: This feature requires APM Server v7.3 or later and that the APM Server is configured with `kibana.enabled: true`.
+NOTE: This feature requires APM Server v7.3 or later.
+See {kibana-ref}/agent-configuration.html[APM Agent central configuration] for more information.
 
 [float]
 [[config-cloud-provider]]
@@ -701,7 +702,7 @@ The name of the given service node. This is optional, and if omitted, the APM
 Server will fall back on `system.container.id` if available, and
 `host.name` if necessary.
 
-This option allows you to set the node name manually to ensure it's unique and meaningful. 
+This option allows you to set the node name manually to ensure it's unique and meaningful.
 
 [float]
 [[config-service-version]]

data/docs/index.asciidoc

@@ -23,12 +23,12 @@ include::./api.asciidoc[]
 
 include::./metrics.asciidoc[]
 
+include::./logs.asciidoc[]
+
 include::./opentracing.asciidoc[]
 
 include::./graphql.asciidoc[]
 
-include::./log-correlation.asciidoc[]
-
 include::./performance-tuning.asciidoc[]
 
 include::./debugging.asciidoc[]

data/docs/{log-correlation.asciidoc → logs.asciidoc}

@@ -3,8 +3,26 @@ NOTE: For the best reading experience,
 please view this documentation at https://www.elastic.co/guide/en/apm/agent/ruby[elastic.co]
 endif::[]
 
-[[log-correlation]]
-== Log correlation
+[[logs]]
+== Logs
+
+Elastic Ruby APM Agent provides the following log features:
+
+- <<log-correlation-ids>>: Automatically inject correlation IDs that allow navigation between logs, traces and services.
+- <<log-reformatting>>: Automatically reformat plaintext logs in {ecs-logging-ref}/intro.html[ECS logging] format.
+
+Those features are part of {observability-guide}/application-logs.html[Application log ingestion strategies].
+
+The {ecs-logging-ruby-ref}/intro.html[`ecs-logging-ruby`] library can also be used to format logs in the {ecs-logging-ref}/intro.html[ECS logging] format without an APM agent.
+When deployed with the Ruby APM agent, the agent will provide <<log-correlation-ids,log correlation>> IDs.
+
+[float]
+[[log-correlation-ids]]
+=== Log correlation
+
+{apm-guide-ref}/log-correlation.html[Log correlation] allows you to navigate to all logs belonging to a particular trace
+and vice-versa: for a specific log, see in which context it has been logged and which parameters the user provided.
+
 
 Trace/log correlation can be set up in three different ways.
 
@@ -119,3 +137,12 @@ PUT _ingest/pipeline/extract_trace_id
 ----
 
 Please see {apm-guide-ref}/log-correlation.html[Observability integrations] for more information.
+
+[float]
+[[log-reformatting]]
+=== Log reformatting (experimental)
+
+Log reformatting is controlled by the <<config-log-ecs-formatting, `log_ecs_reformatting`>> configuration option, and is disabled by default.
+
+The reformatted logs will include both the <<log-correlation-ids, trace and service correlation>> IDs.
+

data/docs/opentracing.asciidoc

@@ -89,6 +89,6 @@ The `Span.set_baggage` method is not supported.
 Baggage items are dropped with a warning log message.
 
 [float]
-[[logs]]
+[[opentracing-logs]]
 === Logs
 Logs are currently not supported.

data/docs/redirects.asciidoc

@@ -0,0 +1,9 @@
+["appendix",role="exclude",id="redirects"]
+= Deleted pages
+
+The following pages have moved or been deleted.
+
+[role="exclude",id="log-correlation"]
+=== Log correlation
+
+This section has moved. See <<logs>>.

data/lib/elastic_apm/context_builder.rb

@@ -44,7 +44,7 @@ module ElasticAPM
       request = context.request
 
       request.socket = Context::Request::Socket.new(req)
-      request.http_version = build_http_version rack_env
+      request.http_version = build_http_version req
       request.method = req.request_method
       request.url = Context::Request::Url.new(req)
 
@@ -104,8 +104,8 @@ module ElasticAPM
       key.gsub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
     end
 
-    def build_http_version(rack_env)
-      return unless (http_version = rack_env['HTTP_VERSION'])
+    def build_http_version(req)
+      return unless (http_version = req.env['HTTP_VERSION'])
       http_version.gsub(%r{HTTP/}, '')
     end
   end

data/lib/elastic_apm/metrics.rb

@@ -50,27 +50,9 @@ module ElasticAPM
           return
         end
 
-        debug 'Starting metrics'
-
-        # Only set the @sets once, in case we stop
-        # and start again.
-        if @sets.nil?
-          sets = {
-            system: CpuMemSet,
-            vm: VMSet,
-            breakdown: BreakdownSet,
-            transaction: TransactionSet
-          }
-          if defined?(JVMSet)
-            debug "Enabling JVM metrics collection"
-            sets[:jvm] = JVMSet
-          end
+        define_sets
 
-          @sets = sets.each_with_object({}) do |(key, kls), _sets_|
-            debug "Adding metrics collector '#{kls}'"
-            _sets_[key] = kls.new(config)
-          end
-        end
+        debug 'Starting metrics'
 
         @timer_task = Concurrent::TimerTask.execute(
           run_now: true,
@@ -135,6 +117,28 @@ module ElasticAPM
           arr.concat(samples)
         end
       end
+
+      def define_sets
+        # Only set the @sets once, in case we stop
+        # and start again.
+        return unless @sets.nil?
+
+        sets = {
+          system: CpuMemSet,
+          vm: VMSet,
+          breakdown: BreakdownSet,
+          transaction: TransactionSet
+        }
+        if defined?(JVMSet)
+          debug "Enabling JVM metrics collection"
+          sets[:jvm] = JVMSet
+        end
+
+        @sets = sets.each_with_object({}) do |(key, kls), _sets_|
+          debug "Adding metrics collector '#{kls}'"
+          _sets_[key] = kls.new(config)
+        end
+      end
     end
   end
 end

data/lib/elastic_apm/span_helpers.rb

@@ -22,17 +22,17 @@ module ElasticAPM
   module SpanHelpers
     # @api private
     module ClassMethods
-      def span_class_method(method, name = nil, type = nil)
-        __span_method_on(singleton_class, method, name, type)
+      def span_class_method(method, name = nil, type = nil, **kwargs)
+        __span_method_on(singleton_class, method, name, type, **kwargs)
       end
 
-      def span_method(method, name = nil, type = nil)
-        __span_method_on(self, method, name, type)
+      def span_method(method, name = nil, type = nil, **kwargs)
+        __span_method_on(self, method, name, type, **kwargs)
       end
 
       private
 
-      def __span_method_on(klass, method, name = nil, type = nil)
+      def __span_method_on(klass, method, name = nil, type = nil, **kwargs)
         name ||= method.to_s
         type ||= Span::DEFAULT_TYPE
 
@@ -42,7 +42,7 @@ module ElasticAPM
               return super(*args, &block)
             end
 
-            ElasticAPM.with_span name.to_s, type.to_s do
+            ElasticAPM.with_span name.to_s, type.to_s, **kwargs do
               super(*args, &block)
             end
           end)

data/lib/elastic_apm/spies/faraday.rb

@@ -109,7 +109,7 @@ module ElasticAPM
                   yield req if block
                 end
               rescue Faraday::ClientError, Faraday::ServerError => e # Faraday::Response::RaiseError
-                status = e.response[:status]
+                status = e.response_status
                 http = span&.context&.http
                 if http && status
                   http.status_code = status.to_s

data/lib/elastic_apm/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '4.6.2'
+  VERSION = '4.7.0'
 end