Merge branch 'add-transaction-name-sampling-config' into pr-1510-and-1531

* add-transaction-name-sampling-config:
  Add ability to configure sampling rate based on transaction span name
  Updates to allow tests to pass (elastic#1541)
  fix image paths for docs-assembler (elastic#1538)

Author: jclusso

.ci/.exclude.yml

@@ -2,19 +2,15 @@ exclude:
   # Ruby 2.4
   # Only test on rails-4.2, sinatra-1.4
   - VERSION: ruby:2.4
-    FRAMEWORK: rails-7.0
+    FRAMEWORK: rails-7.2
   - 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
@@ -26,8 +22,6 @@ exclude:
   # 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
@@ -43,8 +37,6 @@ exclude:
   # 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
@@ -56,22 +48,18 @@ exclude:
   - VERSION: elasticobservability/jruby:9.2-8-jdk
     FRAMEWORK: sinatra-1.4
 
-  # rails-6.0 and rails-6.1 exclusions
+  # 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-6.0
+    FRAMEWORK: rails-7.2
 
   # 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
@@ -83,29 +71,25 @@ exclude:
   - VERSION: elasticobservability/jruby:9.2-8-jdk
     FRAMEWORK: rails-main
 
-  # Only test rails 7.0 on ruby >= 2.7
+  # Only test rails 7.2 on ruby >= 3.1
+  - VERSION: ruby:2.7
+    FRAMEWORK: rails-7.2
   - VERSION: ruby:2.6
-    FRAMEWORK: rails-7.0
-  - VERSION: ruby:2.5
-    FRAMEWORK: rails-7.0
+    FRAMEWORK: rails-7.2
   - VERSION: ruby:2.4
-    FRAMEWORK: rails-7.0
+    FRAMEWORK: rails-7.2
   - VERSION: jruby:9.2
-    FRAMEWORK: rails-7.0
+    FRAMEWORK: rails-7.2
   - VERSION: elasticobservability/jruby:9.2-13-jdk
-    FRAMEWORK: rails-7.0
+    FRAMEWORK: rails-7.2
   - VERSION: elasticobservability/jruby:9.2-11-jdk
-    FRAMEWORK: rails-7.0
+    FRAMEWORK: rails-7.2
   - VERSION: elasticobservability/jruby:9.2-8-jdk
-    FRAMEWORK: rails-7.0
+    FRAMEWORK: rails-7.2
 
   # 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
@@ -117,11 +101,9 @@ exclude:
   - VERSION: elasticobservability/jruby:9.2-8-jdk
     FRAMEWORK: sinatra-main
 
-  # Only test grape master on ruby 2.7 and ruby 3.0
+  # Only test grape master on ruby 2.7 and ruby 3.1
   - 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
@@ -133,61 +115,12 @@ exclude:
   - VERSION: elasticobservability/jruby:9.2-8-jdk
     FRAMEWORK: grape-master
 
-  # grape 1.5 doesn't support ruby 3.0
+  # grape 1.5 doesn't support ruby 3.1
   - 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
+  # only test ruby >= 3.1 with rails 6.1 and rails 7.0
   - 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

.ci/.framework.yml

@@ -1,13 +1,10 @@
 FRAMEWORK:
-  - rails-7.0
+  - rails-7.2
   - rails-6.1
-  - rails-6.0
   - rails-5.2
   - rails-4.2
 
   - sinatra-2.2
   - sinatra-1.4
 
   - grape-1.6
-
-  - grape-1.6,sinatra-2.2,rails-6.1

.ci/.ruby.yml

@@ -1,7 +1,6 @@
 VERSION:
   - ruby:3.4
   - ruby:3.1
-  - ruby:3.0
   - ruby:2.7
   - ruby:2.6
   - ruby:2.4

Gemfile

@@ -103,6 +103,11 @@ frameworks_versions.each do |framework, version|
   end
 end
 
+# Handle Rack::Auth::Digest being removed in rack 3.1, grape requires it
+if frameworks_versions.key?('grape')
+  gem 'rack', '~> 3.0.0'
+end
+
 if frameworks_versions.key?('rails')
   unless /^(main|6)/.match?(frameworks_versions['rails'])
     gem 'delayed_job', require: nil
@@ -125,8 +130,12 @@ if RUBY_PLATFORM == 'java'
   end
 elsif frameworks_versions['rails'] =~ /^(4|5)/
   gem 'sqlite3', '~> 1.3.6'
+elsif frameworks_versions['rails'] =~ /^(6|7)/
+  gem 'sqlite3', '~> 1.4'
 elsif RUBY_VERSION < '2.7'
   gem 'sqlite3', '~> 1.4.4'
+elsif RUBY_VERSION < '3.0'
+  gem 'sqlite3', '~> 1.3.6'
 else
   gem 'sqlite3'
 end

docs/reference/configuration.md

@@ -23,12 +23,12 @@ Options are applied in the following order (last one wins):
 2. Arguments to `ElasticAPM.start` / `Config.new`
 3. Config file, e.g., `config/elastic_apm.yml`
 4. Environment variables
-5. [Central configuration](docs-content://solutions/observability/apps/apm-agent-central-configuration.md) (supported options are marked with [![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration))
+5. [Central configuration](docs-content://solutions/observability/apps/apm-agent-central-configuration.md) (supported options are marked with [![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration))
 
 
 ## Dynamic configuration [dynamic-configuration]
 
-Configuration options marked with the ![dynamic config](/reference/images/dynamic-config.svg "") badge can be changed at runtime when set from a supported source.
+Configuration options marked with the ![dynamic config](images/dynamic-config.svg "") badge can be changed at runtime when set from a supported source.
 
 The Agent supports [Central configuration](docs-content://solutions/observability/apps/apm-agent-central-configuration.md), which allows you to fine-tune certain configurations via the APM app. This feature is enabled in the Agent by default, with [`central_config`](#config-central-config).
 
@@ -65,7 +65,7 @@ ElasticAPM::Sinatra.start(
 )
 ```
 
-See [Getting started with Rack](/reference/getting-started-rack.md).
+See [Getting started with Rack](getting-started-rack.md).
 
 
 ## Grape and Rack [_grape_and_rack]
@@ -80,7 +80,7 @@ ElasticAPM::Grape.start(
 )
 ```
 
-See [Getting started with Rack](/reference/getting-started-rack.md).
+See [Getting started with Rack](getting-started-rack.md).
 
 
 ## Options [_options]
@@ -154,7 +154,7 @@ If you hit the limit, consider increasing the agent’s [worker pool size](#conf
 
 ### `api_request_size` [config-api-request-size]
 
-[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
+[![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration)
 
 |     |     |     |
 | --- | --- | --- |
@@ -168,7 +168,7 @@ This must be provided in **[size format](#config-format-size)**.
 
 ### `api_request_time` [config-api-request-time]
 
-[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
+[![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration)
 
 |     |     |     |
 | --- | --- | --- |
@@ -197,7 +197,7 @@ This feature requires APM Server and Kibana >= 7.3.
 
 ### `capture_body` [config-capture-body]
 
-[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
+[![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration)
 
 |     |     |     |     |
 | --- | --- | --- | --- |
@@ -218,7 +218,7 @@ Request bodies often contain sensitive values like passwords and credit card num
 
 ### `capture_headers` [config-capture-headers]
 
-[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
+[![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration)
 
 |     |     |     |
 | --- | --- | --- |
@@ -404,7 +404,7 @@ The host name to use when sending error and transaction data to the APM server.
 
 Use this option to ignore certain URL patterns such as healthchecks or admin sections.
 
-*Ignoring* in this context means *don’t wrap in a [Transaction](/reference/api-reference.md#api-transaction)*. Errors will still be reported.
+*Ignoring* in this context means *don’t wrap in a [Transaction](api-reference.md#api-transaction)*. Errors will still be reported.
 
 Use a comma separated string when setting this option via `ENV`. Eg. `ELASTIC_APM_IGNORE_URL_PATTERNS="a,b" # => [/a/, /b/]`
 
@@ -444,7 +444,7 @@ Note that if you’re using Rails, the agent will ignore this option and use the
 
 ### `log_level` [config-log-level]
 
-[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
+[![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration)
 
 | Environment | `Config` key | Default |
 | --- | --- | --- |
@@ -526,7 +526,7 @@ See [Http.rb’s docs](https://github.com/httprb/http/wiki/Proxy-Support).
 
 ### `recording` [config-recording]
 
-[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
+[![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration)
 
 | Environment | `Config` key | Default |
 | --- | --- | --- |
@@ -619,7 +619,7 @@ Especially for spans, collecting source code can have a large impact on storage
 
 ### `span_frames_min_duration` [config-span-frames-min-duration-ms]
 
-[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
+[![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration)
 
 |     |     |     |
 | --- | --- | --- |
@@ -655,7 +655,7 @@ The maximum number of stack trace lines per span/error.
 
 ### `transaction_max_spans` [config-transaction-max-spans]
 
-[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
+[![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration)
 
 |     |     |     |
 | --- | --- | --- |
@@ -667,7 +667,7 @@ Limits the amount of spans that are recorded per transaction. This is helpful in
 
 ### `transaction_sample_rate` [config-transaction-sample-rate]
 
-[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
+[![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration)
 
 |     |     |     |
 | --- | --- | --- |

lib/elastic_apm/context_builder.rb

@@ -79,8 +79,11 @@ def get_body(req)
       when 'application/x-www-form-urlencoded', 'multipart/form-data'
         req.POST.dup
       else
-        body = req.body.read
-        req.body.rewind
+        io = req.body
+        return '' unless io
+
+        body = io.read
+        io.rewind
         body.byteslice(0, MAX_BODY_LENGTH).force_encoding('utf-8').scrub
       end
     end

lib/elastic_apm/instrumenter.rb

@@ -202,12 +202,9 @@ def start_span(
         # we need to check if the span should be sampled
         # and update the transaction's sample rate accordingly
         if transaction.started_spans == 0 && span_sample_rate && span_sample_rate != transaction.sample_rate
-        # if span_sample_rate && span_sample_rate != transaction.sample_rate
           span_sampled = random_sample?(span_sample_rate)
-          if transaction.sampled? != span_sampled
-            transaction.sampled = span_sampled
-            transaction.sample_rate = span_sample_rate
-          end
+          transaction.sampled = span_sampled
+          transaction.sample_rate = span_sampled ? span_sample_rate : 0
         end
       end
 

spec/elastic_apm/grpc_spec.rb

@@ -19,7 +19,7 @@
 
 require 'spec_helper'
 
-# if !defined?(JRUBY_VERSION) && RUBY_VERSION < '3.0'
+# if !defined?(JRUBY_VERSION) && RUBY_VERSION >= '3.0'
 #   require 'grpc'
 #
 #   module ElasticAPM