elastic-apm 4.0.0.beta.1 → 4.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2edbff5770e48799701579f045a0ed3871da1b65037ec0a951ecd106138202c
-  data.tar.gz: 750e7a30a2a69e5c36d35373d842eec64e8e89b5bab66ce6d4c25c69564fb38e
+  metadata.gz: da1239b00118fb2c21b67f917ba1956eec7fe030a69492b7f1d816d75e756130
+  data.tar.gz: 708d649fd0d1b1c27a46e0a9e938f75a81a89586f877d456cdf822d2a354d3b3
 SHA512:
-  metadata.gz: 6add102bc8f803850243de2c7ef517f0be8ab57b8cc89f0d251034b86d83d5073685b3266123b3813496fd1c57fbc7f9c8855df63c5bcf8c35c807a746800803
-  data.tar.gz: fadf416339fa263a2bae03832fa9d46038953f563117c1bfb0623118364bc0bd40d75ca31585cb775d2d69cf708c0848e033c4b7dcae231b2832b6f83da41918
+  metadata.gz: a2d683ea3dfcc8ba86eb9e86caf042b3013f2b85cbce87ddf07bd52eff554f2af344ceaf37b3b33bc2ab144e875ded5730b3e6ada3624c3db9fcb5e1942086f1
+  data.tar.gz: a345b9b8cc2d03596ce20abe1dce4e5e93391405c25bff926e15dedaf2924ebc8c305b389cf8f838b352385f87bc4d24ed613eaa39c6017fe4152c19d1d47881

data/.ci/.jenkins_exclude.yml

@@ -34,6 +34,19 @@ exclude:
     FRAMEWORK: rails-4.2
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
     FRAMEWORK: rails-4.2
+  # sinatra-1.4 exclusions
+  - RUBY_VERSION: ruby:3.0
+    FRAMEWORK: sinatra-1.4
+  - RUBY_VERSION: ruby:2.7
+    FRAMEWORK: sinatra-1.4
+  - RUBY_VERSION: jruby:9.2
+    FRAMEWORK: sinatra-1.4
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
+    FRAMEWORK: sinatra-1.4
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
+    FRAMEWORK: sinatra-1.4
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: sinatra-1.4
 
   # rails-6.0 and rails-6.1 exclusions
   # Don't test on ruby 2.4

data/.ci/Jenkinsfile

@@ -389,6 +389,7 @@ def runScript(Map params = [:]){
       dir("${BASE_DIR}"){
         sleep randomNumber(min:10, max: 30)
         dockerLogin(secret: "${DOCKER_SECRET}", registry: "${DOCKER_REGISTRY}")
+        sh(label: "Run BDD tests", script: "./spec/scripts/features.sh ${ruby}")
         sh("./spec/scripts/spec.sh ${ruby} ${framework}")
       }
     }

data/CHANGELOG.asciidoc

@@ -36,6 +36,23 @@ endif::[]
 === Ruby Agent version 4.x
 
 [[release-notes-4.0.0]]
+
+[float]
+==== 4.0.0.beta.2
+
+[float]
+===== Added
+
+- Added `set_service` API {pull}1006[#1006]
+
+[float]
+===== Fixed
+
+- AWS S3 spy accepts symbol bucket names {pull}998[#998]
+- AWS S3 spy passing on blocks {pull}998[#998]
+- SQL scanner now recognizes CQL style comments {pull}1004[#1004]
+
+[float]
 ==== 4.0.0.beta.1
 
 [float]

data/README.md

@@ -52,15 +52,27 @@ The official Rubygem for [Elastic][] [APM][].
   <li>
     <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/opentracing.html">OpenTracing API</a>
   </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/graphql.html">GraphQL</a>
+  </li>
   <li>
     <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/log-correlation.html">Log correlation</a>
   </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/tuning-and-overhead.html">Performance tuning</a>
+  </li>
   <li>
     <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/debugging.html">Troubleshooting</a>
   </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/upgrading.html">Upgrading</a>
+  </li>
   <li class="collapsible">
     <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes.html">Release notes</a>
     <ul>
+      <li>
+        <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes-4.x.html">Ruby Agent version 4.x</a>
+      </li>
       <li>
         <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes-3.x.html">Ruby Agent version 3.x</a>
       </li>

data/bin/run-bdd

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -e
+
+specific_feature=$1
+
+export CUCUMBER_PUBLISH_QUIET=true
+
+if [[ $specific_feature = '' ]]; then
+  echo 'Running all features'
+
+  echo "========================================"
+  cucumber
+else
+  echo "Running only $specific_feature"
+
+  cucumber $specific_feature
+fi

data/bin/run-tests

@@ -29,5 +29,5 @@ if [[ $specific_spec = '' ]]; then
 else
   echo "Running only $specific_spec"
 
-  runRspec $1
+  runRspec $specific_spec
 fi

data/docs/configuration.asciidoc

@@ -1,14 +1,14 @@
 ifdef::env-github[]
 NOTE: For the best reading experience,
 please view this documentation at
-https://www.elastic.co/guide/en/apm/agent/ruby/current/introduction.html[elastic.co]
+https://www.elastic.co/guide/en/apm/agent/ruby/current/introduction.html[elastic.co].
 endif::[]
 
 [[configuration]]
 == Configuration
 
 There are several ways to configure how Elastic APM behaves.
-The recommended way is to specify options in a `config/elastic_apm.yml` file:
+We recommend using a `config/elastic_apm.yml` file:
 
 [source,yaml]
 ----
@@ -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`
@@ -71,7 +71,7 @@ ElasticAPM.start(
 )
 ----
 
-Alternatively, you can use the `ElasticAPM::Sinatra.start` API:
+Alternatively, use the `ElasticAPM::Sinatra.start` API:
 
 [source,ruby]
 ----
@@ -87,7 +87,7 @@ See <<getting-started-rack>>.
 [float]
 === Grape and Rack
 
-When using Grape and Rack (without Rails), you can configure when starting
+When using Grape and Rack (without Rails), configure when starting
 the agent:
 
 [source,ruby]
@@ -114,7 +114,7 @@ See <<getting-started-rack>>.
 | `ELASTIC_APM_CONFIG_FILE` | `config_file` | `config/elastic_apm.yml`
 |============
 
-Path to the configuration YAML-file.
+The path to the configuration YAML-file.
 Elastic APM will load config options from this if the file exists.
 The file will be evaluated as ERB, so you can include `ENV` variables like in
 your `database.yml`, eg:
@@ -150,7 +150,7 @@ and port.
 
 This string is used to ensure that only your agents can send data to your APM server.
 Both the agents and the APM server have to be configured with the same secret token.
-One example to generate a secure secret token is:
+Here's an example that generates a secure secret token:
 
 [source,bash]
 ----
@@ -170,11 +170,9 @@ 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.
-You must have created the api key using the APM server command line tool. Please see the APM server
-documentation for details on how to do that. Please note that this feature is experimental in the
-APM server in version 7.6.
+The API key must be created using the {apm-server-ref-v}/api-key.html[APM server command-line tool]. 
 
-WARNING: Api keys only provide any real security if your APM server uses TLS.
+WARNING: API keys only provide any real security if your APM server uses TLS.
 
 [float]
 [[config-api-buffer-size]]
@@ -184,12 +182,11 @@ WARNING: Api keys only provide any real security if your APM server uses TLS.
 | `ELASTIC_APM_API_BUFFER_SIZE` | `api_buffer_size` | `256`
 |============
 
-Maximum amount of objects kept in queue, before sending to APM Server.
+The maximum amount of objects kept in queue before sending to APM Server.
 
-If you hit this limit you either have to increase the agent's
-<<config-pool-size,worker pool size>> or it could mean the agent has trouble
-connecting to APM Server. The <<config-log-path,logs>> should tell you what
-went wrong.
+If you hit the limit, consider increasing the agent's <<config-pool-size,worker pool size>>.
+If you don't, the agent may have trouble connecting to APM Server.
+The <<config-log-path,logs>> should tell you what went wrong.
 
 [float]
 [[config-api-request-size]]
@@ -202,10 +199,9 @@ went wrong.
 | `ELASTIC_APM_API_REQUEST_SIZE` | `api_request_size` | `"750kb"`
 |============
 
-Maximum amount of bytes sent over one request to APM Server. When reached the agent
-will open a new request.
+The maximum amount of bytes sent over one request to APM Server. The agent will open a new request when this limit is reached. 
 
-It has to be provided in *<<config-format-size, size format>>*.
+This must be provided in *<<config-format-size, size format>>*.
 
 [float]
 [[config-api-request-time]]
@@ -218,12 +214,11 @@ It has to be provided in *<<config-format-size, size format>>*.
 | `ELASTIC_APM_API_REQUEST_TIME` | `api_request_time` | `"10s"`
 |============
 
-Maximum duration of a single streaming request to APM Server before opening
+The maximum duration of a single streaming request to APM Server before opening
 a new one.
 
-APM Server has its own limit of 30 seconds before it will close requests.
-
-It has to be provided in *<<config-format-duration, duration format>>*.
+The APM Server has its own limit of 30 seconds before it will close requests.
+This must be provided in *<<config-format-duration, duration format>>*.
 
 [float]
 [[config-breakdown-metrics]]
@@ -233,8 +228,8 @@ It has to be provided in *<<config-format-duration, duration format>>*.
 | `ELASTIC_APM_BREAKDOWN_METRICS` | `breakdown_metrics` | `true`
 |============
 
-Enable/disable the tracking and collection of breakdown metrics.
-By setting this to `False`, tracking this metric is completely disabled, which can reduce the overhead of the agent.
+Enable or disable the tracking and collection of breakdown metrics.
+Setting this to `False` disables the tracking of breakdown metrics, which can reduce the overhead of the agent.
 
 NOTE: This feature requires APM Server and Kibana >= 7.3.
 
@@ -249,14 +244,13 @@ NOTE: This feature requires APM Server and Kibana >= 7.3.
 | `ELASTIC_APM_CAPTURE_BODY` | `capture_body` | `"off"` | `"all"`
 |============
 
-For transactions that are HTTP requests,
-the Ruby agent can optionally capture the request body (e.g. `POST` variables or JSON data).
+The Ruby agent can optionally capture the request body (e.g. `POST` variables or JSON data) for transactions that are HTTP requests.
 
 Possible values: `"errors"`, `"transactions"`, `"all"`, `"off"`.
 
 If the request has a body and this setting is disabled, the body will be shown as `[SKIPPED]`.
 
-WARNING: request bodies often contain sensitive values like passwords, credit card numbers etc.
+WARNING: Request bodies often contain sensitive values like passwords and credit card numbers.
 We try to strip sensitive looking data from form bodies but don't touch text bodies like JSON.
 If your service handles data like this, we advise to only enable this feature with care.
 
@@ -272,7 +266,7 @@ If your service handles data like this, we advise to only enable this feature wi
 | `ELASTIC_APM_CAPTURE_HEADERS` | `capture_headers` | `true`
 |============
 
-Whether or not to attach the request headers to transactions and errors.
+This indicates whether or not to attach the request headers to transactions and errors.
 
 [float]
 [[config-capture-elasticsearch-queries]]
@@ -282,7 +276,7 @@ Whether or not to attach the request headers to transactions and errors.
 | `ELASTIC_APM_CAPTURE_ELASTICSEARCH_QUERIES` | `capture_elasticsearch_queries` | `false`
 |============
 
-Whether or not to capture the body from requests in Elasticsearch.
+This indicates whether or not to capture the body from requests in Elasticsearch.
 
 [float]
 [[config-capture-env]]
@@ -292,7 +286,7 @@ Whether or not to capture the body from requests in Elasticsearch.
 | `ELASTIC_APM_CAPTURE_ENV` | `capture_env` | `true`
 |============
 
-Whether or not to attach `ENV` from Rack to transactions and errors.
+This indicates whether or not to attach `ENV` from Rack to transactions and errors.
 
 [float]
 [[config-central-config]]
@@ -302,10 +296,10 @@ Whether or not to attach `ENV` from Rack to transactions and errors.
 | `ELASTIC_APM_CENTRAL_CONFIG` | `central_config` | `true`
 |============
 
-Enables {apm-app-ref}/agent-configuration.html[APM Agent Configuration via Kibana].
+This enables {apm-app-ref}/agent-configuration.html[APM Agent Configuration via Kibana].
 If set to `true`, the client will poll the APM Server regularly for new agent configuration.
 
-Usually APM Server determines how often to poll, but if not the default interval is 5 minutes.
+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`.
 
@@ -318,7 +312,7 @@ NOTE: This feature requires APM Server v7.3 or later and that the APM Server is
 |============
 
 Specify the cloud provider for metadata collection.
-Defaults to `"auto"`, which means the agent uses trial and
+This defaults to `"auto"`, which means the agent uses trial and
 error to collect metadata from all supported cloud providers.
 
 Valid options are `"auto"`, `"aws"`, `"gcp"`, `"azure"`, and `"none"`.
@@ -336,7 +330,7 @@ attempts to collect metadata will only be performed from the chosen provider.
 
 A comma-separated list of dotted metrics names that should not be sent to the APM Server.
 You can use `*` to match multiple metrics.
-Matching is case-insensitive.
+Matching is not case sensitive.
 
 [float]
 [[config-disable-send]]
@@ -346,7 +340,7 @@ Matching is case-insensitive.
 | `ELASTIC_APM_DISABLE_SEND` | `disable_send` | `false`
 |============
 
-Disables sending payloads to APM Server.
+This disables sending payloads to APM Server.
 
 [float]
 [[config-disable-start-message]]
@@ -356,7 +350,7 @@ Disables sending payloads to APM Server.
 | `ELASTIC_APM_DISABLE_START_MESSAGE` | `disable_start_message` | `false`
 |============
 
-Disables the agent's startup message announcing itself.
+This disables the agents startup message announcing itself.
 
 [float]
 [[config-disabled-instrumentations]]
@@ -368,7 +362,7 @@ Disables the agent's startup message announcing itself.
 | `ELASTIC_APM_DISABLE_INSTRUMENTATIONS` | `disable_instrumentations` | `['json']`
 |============
 
-Elastic APM automatically instruments select third party libraries.
+Elastic APM automatically instruments select third-party libraries.
 Use this option to disable any of these.
 
 Get an array of enabled instrumentations with `ElasticAPM.agent.config.enabled_instrumentations`.
@@ -382,7 +376,7 @@ Get an array of enabled instrumentations with `ElasticAPM.agent.config.enabled_i
 | `ELASTIC_APM_ENABLED` | `enabled`     | `true`
 |============
 
-Whether or not to start the agent.
+Indicates whether or not to start the agent.
 If `enabled` is `false`, `ElasticAPM.start` will do nothing and all calls to the root API will return `nil`.
 
 [float]
@@ -399,7 +393,7 @@ The name of the environment this service is deployed in,
 e.g. "production" or "staging".
 
 Environments allow you to easily filter data on a global level in the APM app.
-It's important to be consistent when naming environments across agents.
+Be consistent when naming environments across agents.
 See {apm-app-ref}/filters.html#environment-selector[environment selector] in the APM app for more information.
 
 Defaults to `ENV['RAILS_ENV'] || ENV['RACK_ENV']`.
@@ -426,7 +420,7 @@ Use this to filter error tracking for specific error constants.
 | `ELASTIC_APM_FRAMEWORK_NAME` | `framework_name` | Depending on framework
 |============
 
-Name of the used framework.
+The name of the used framework.
 For Rails or Sinatra, this defaults to `Ruby on Rails` and `Sinatra` respectively,
 otherwise defaults to `nil`.
 
@@ -439,7 +433,7 @@ otherwise defaults to `nil`.
 | `ELASTIC_APM_FRAMEWORK_VERSION` | `framework_version` | Depending on framework
 |============
 
-Version number of the used framework.
+The version number of the used framework.
 For Ruby on Rails and Sinatra, this defaults to the used version of the framework,
 otherwise, the default is `nil`.
 
@@ -479,12 +473,12 @@ The host name to use when sending error and transaction data to the APM server.
 | `ELASTIC_APM_IGNORE_URL_PATTERNS` | `ignore_url_patterns` | `[]`    | `['^/ping', %r{^/admin}]`
 |============
 
-Use this option to ignore certain URL patterns eg. healthchecks or admin sections.
+Use this option to ignore certain URL patterns such as healthchecks or admin sections.
 
 _Ignoring_ in this context means _don't wrap in a <<api-transaction,Transaction>>_.
 Errors will still be reported.
 
-When setting this option via `ENV`, use a comma separated string.
+Use a comma separated string when setting this option via `ENV`.
 Eg. `ELASTIC_APM_IGNORE_URL_PATTERNS="a,b" # => [/a/, /b/]`
 
 [float]
@@ -496,7 +490,7 @@ Eg. `ELASTIC_APM_IGNORE_URL_PATTERNS="a,b" # => [/a/, /b/]`
 | `ELASTIC_APM_INSTRUMENT` | `instrument` | `true`  | `0`
 |============
 
-Use this option to ignore certain URL patterns eg. healthchecks or admin sections.
+Use this option to ignore certain URL patterns such as healthchecks or admin sections.
 
 [float]
 [[config-instrumented-rake-tasks]]
@@ -508,7 +502,7 @@ Use this option to ignore certain URL patterns eg. healthchecks or admin section
 | `ELASTIC_APM_INSTRUMENTED_RAKE_TASKS` | `instrumented_rake_tasks` | `[]`    | `['my_task']`
 |============
 
-Elastic APM can instrument your Rake tasks but given that they are used for a multitude of sometimes very different and not always relevant things, this is opt in.
+Elastic APM can instrument your Rake tasks. Theis is an opt-in field, as they are used are for a multitude of things. 
 
 [float]
 [[config-log-level]]
@@ -538,7 +532,7 @@ A path to a log file.
 
 By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails.
 
-Should support both absolute and relative paths. Just make sure the directory exists.
+This should support both absolute and relative paths. Please be sure the directory exists.
 
 [float]
 [[config-logger]]
@@ -552,7 +546,7 @@ Should support both absolute and relative paths. Just make sure the directory ex
 
 By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails.
 
-Use this to provide another logger. Expected to have the same API as Ruby's built-in `Logger`.
+Use this to provide another logger. This is expected to have the same API as Ruby's built-in `Logger`.
 
 [float]
 [[config-metrics-interval]]
@@ -566,7 +560,7 @@ Use this to provide another logger. Expected to have the same API as Ruby's buil
 
 Specify the interval for reporting metrics to APM Server.
 The interval should be in seconds,
-or should include a time suffix.
+or include a time suffix.
 
 To disable metrics reporting,
 set the interval to `0`.
@@ -625,7 +619,7 @@ See https://github.com/httprb/http/wiki/Proxy-Support[Http.rb's docs].
 |============
 
 Enable or disable the recording of events.
-If set to false, then the agent does not create or send any events to the Elastic APM server,
+If set to `false`, then the agent does not create or send any events to the Elastic APM server,
 and instrumentation overhead is minimized. The agent continues to poll the server for configuration changes
 when this option is false.
 
@@ -639,9 +633,9 @@ when this option is false.
 | `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `"password,passwd,pwd,secret,*key,*token*,*session*,*credit*,*card*,authorization,set-cookie"` | `Auth*tion,abc*,*xyz`
 |============
 
-Sometimes it is necessary to sanitize the data sent to Elastic APM, e.g. remove sensitive data.
+Sometimes it is necessary to sanitize the data sent to Elastic APM to remove sensitive values.
 
-Configure a list of wildcard patterns of field names which should be sanitized. These apply to HTTP headers and bodies (if you're capturing those.)
+Configure a list of wildcard patterns of field names which should be sanitized. These apply to HTTP headers and bodies, if they're being captured.
 
 Supports the wildcard `*`, which matches zero or more characters.
 Examples: `/foo/*/bar/*/baz*`, `*foo*`.
@@ -657,16 +651,15 @@ Matching is case insensitive.
 | `ELASTIC_APM_SERVICE_NAME` | `service_name` | App's name | `MyApp`
 |============
 
-The name of your service.
-This is used to keep all the errors and transactions of your service together and is
+The name of your service. This is used to group the errors and transactions of your service and is
 the primary filter in the Elastic APM user interface.
 
 If you're using Ruby on Rails this will default to your app's name.
 If you're using Sinatra it will default to the name of your app's class.
 
 NOTE: The service name must conform to this regular expression: `^[a-zA-Z0-9 _-]+$`.
-In layman's terms: Your service name must only contain characters from the ASCII
-alphabet, numbers, dashes, underscores and spaces.
+In other words, it must only contain characters from the ASCII
+alphabet, numbers, dashes, underscores, and spaces.
 
 [float]
 [[config-service-node-name]]
@@ -679,11 +672,10 @@ alphabet, numbers, dashes, underscores and spaces.
 |============
 
 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 finally
+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 uniqueness and
-meaningfulness.
+This option allows you to set the node name manually to ensure it's unique and meaningful. 
 
 [float]
 [[config-service-version]]
@@ -694,8 +686,8 @@ meaningfulness.
 | `ELASTIC_APM_SERVICE_VERSION`  | `service_version` | `git` sha | A string indicating the version of the deployed service
 |============
 
-Deployed version of your service.
-Defaults to `git rev-parse --verify HEAD`.
+The deployed version of your service.
+This defaults to `git rev-parse --verify HEAD`.
 
 [float]
 [[config-source-lines-error-app-frames]]
@@ -719,7 +711,7 @@ Defaults to `git rev-parse --verify HEAD`.
 |============
 
 By default, the APM agent collects source code snippets for errors.
-With the above settings, you can modify how many lines of source code is collected.
+Use the above settings to modify how many lines of source code are collected.
 
 We differ between errors and spans, as well as library frames and app frames.
 
@@ -737,7 +729,7 @@ storage use in your Elasticsearch cluster.
 | `ELASTIC_APM_SPAN_FRAMES_MIN_DURATION` | `span_frames_min_duration` | `"5ms"`
 |============
 
-Use this to disable stacktrace frame collection for spans with a duration shorter
+Use this to disable stack trace frame collection for spans with a duration shorter
 than or equal to the given amount of milleseconds.
 
 The default is `"5ms"`.
@@ -804,7 +796,7 @@ To reduce overhead and storage requirements, you can set the sample rate to a va
 between `0.0` and `1.0`.
 We still record overall time and the result for unsampled transactions, but no
 context information, tags, or spans.
-Note that the sample rate will be rounded to 4 digits of precision.
+The sample rate will be rounded to 4 digits of precision.
 
 [float]
 [[config-verify-server-cert]]
@@ -857,14 +849,14 @@ The unit is provided as suffix directly after the number, without any separation
  * `mb` (megabytes)
  * `gb` (gigabytes)
 
-NOTE: we use the power-of-two sizing convention, e.g. `1 kilobyte == 1024 bytes`
+NOTE: We use the power-of-two sizing convention, e.g. `1 kilobyte == 1024 bytes`.
 
 [float]
 [[special-configuration]]
 === Special configuration
 
-Elastic APM patches `Kernel#require` to auto-detect and instrument supported third party libraries. It does so with the utmost care but in rare cases it can conflict with some libraries.
+Elastic APM patches `Kernel#require` to auto-detect and instrument supported third-party libraries. It does so with the utmost care but in rare cases, it can conflict with some libraries.
 
 To get around this patch, set the environment variable `ELASTIC_APM_SKIP_REQUIRE_PATCH` to `"1"`.
 
-If you choose to do so, the agent might need some additional tweaking to make sure the third party libraries are picked up and instrumented. Make sure you require the agent _after_ you require your other dependencies.
+The agent might need some additional tweaking to make sure the third-party libraries are picked up and instrumented. Make sure you require the agent _after_ you require your other dependencies.

data/docs/release-notes.asciidoc

@@ -6,6 +6,7 @@
 All notable changes to this project will be documented here.
 This project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioning].
 
+* <<release-notes-4.x>>
 * <<release-notes-3.x>>
 * <<release-notes-2.x>>
 * <<release-notes-1.x>>

data/docs/upgrading.asciidoc

@@ -16,30 +16,3 @@ We love all our products, but sometimes we must say goodbye to a release so that
 forward on future development and innovation.
 Our https://www.elastic.co/support/eol[End of life policy] defines how long a given release is considered supported,
 as well as how long a release is considered still in active development or maintenance.
-The table below is a simplified description of this policy.
-
-[options="header"]
-|====
-|Agent version |EOL Date |Maintained until
-|3.5.x |2021-07-17 | 3.6
-|3.4.x |2021-07-10 | 3.5
-|3.3.x |2021-06-04 | 3.4
-|3.2.x |2021-05-19 | 3.3
-|3.1.x |2021-04-21 | 3.2
-|3.0.x |2021-04-08 | 3.1
-|2.12.x |2021-04-01 |4.0
-|2.11.x |2021-03-23 |2.12
-|2.10.x |2021-03-03 |2.11
-|2.9.x |2020-12-25 |2.10
-|2.8.x |2020-11-20 |2.9
-|2.7.x |2020-11-07 |2.8
-|2.6.x |2020-09-19 |2.7
-|2.5.x |2020-09-01 |2.6
-|2.4.x |2020-08-27 |2.5
-|2.3.x |2020-07-29 |2.4
-|2.2.x |2020-07-22 |2.3
-|2.1.x |2020-06-04 |2.2
-|2.0.x |2020-05-14 |2.1
-|1.1.x |2020-03-07 |3.0
-|1.0.x |2019-12-29 |1.1
-|====

data/lib/elastic_apm.rb

@@ -380,6 +380,16 @@ module ElasticAPM
       agent&.set_user(user)
     end
 
+    # Set destination fields on the current span
+    #
+    # @param address [String] Destination address
+    # @param address [String] Destination address
+    # @param address [Hash] Destination service
+    # @param address [Hash] Destination cloud
+    def set_destination(address: nil, port: nil, service: nil, cloud: nil)
+      agent&.set_destination(address: address, port: port, service: service, cloud: cloud)
+    end
+
     # Provide a filter to transform payloads before sending them off
     #
     # @param key [Symbol] Unique filter key

data/lib/elastic_apm/agent.rb

@@ -227,6 +227,10 @@ module ElasticAPM
       instrumenter.set_user(user)
     end
 
+    def set_destination(address: nil, port: nil, service: nil, cloud: nil)
+      current_span&.set_destination(address: nil, port: nil, service: nil, cloud: nil)
+    end
+
     def build_context(rack_env:, for_type:)
       @context_builder.build(rack_env: rack_env, for_type: for_type)
     end

data/lib/elastic_apm/grpc.rb

@@ -50,11 +50,9 @@ module ElasticAPM
 
         split_peer = URI.split(peer)
         destination = ElasticAPM::Span::Context::Destination.new(
-          type: TYPE,
-          name: SUBTYPE,
-          resource: peer,
           address: split_peer[0],
-          port: split_peer[6]
+          port: split_peer[6],
+          service: { type: TYPE, name: SUBTYPE, resource: peer }
         )
         ElasticAPM::Span::Context.new(destination: destination)
       end

data/lib/elastic_apm/normalizers/rails/active_record.rb

@@ -48,7 +48,7 @@ module ElasticAPM
           context =
             Span::Context.new(
               db: { statement: payload[:sql], type: 'sql' },
-              destination: { name: subtype, resource: subtype, type: TYPE }
+              destination: { service: { name: subtype, resource: subtype, type: TYPE } }
             )
 
           [name, TYPE, subtype, ACTION, context]

data/lib/elastic_apm/span.rb

@@ -131,7 +131,14 @@ module ElasticAPM
       started? && !stopped?
     end
 
-    # relations
+    def set_destination(address: nil, port: nil, service: nil, cloud: nil)
+      context.destination = Span::Context::Destination.new(
+        address: address,
+        port: port,
+        service: service,
+        cloud: cloud
+      )
+    end
 
     def inspect
       "<ElasticAPM::Span id:#{trace_context&.id}" \

data/lib/elastic_apm/span/context.rb

@@ -47,12 +47,13 @@ module ElasticAPM
 
       attr_reader(
         :db,
-        :destination,
         :http,
         :labels,
         :sync,
         :message
       )
+
+      attr_accessor :destination
     end
   end
 end

data/lib/elastic_apm/span/context/destination.rb

@@ -23,6 +23,22 @@ module ElasticAPM
       # @api private
       class Destination
 
+        # @api private
+        class Service
+          class MissingValues < StandardError; end
+
+          def initialize(name: nil, type: nil, resource: nil)
+            @name = name
+            @type = type
+            @resource = resource
+
+            # APM Server expects all values for service
+            raise MissingValues unless @name && @type && resource
+          end
+
+          attr_accessor :name, :type, :resource
+        end
+
         # @api private
         class Cloud
           def initialize(region: nil)
@@ -33,39 +49,37 @@ module ElasticAPM
         end
 
         def initialize(
-          name: nil,
-          resource: nil,
-          type: nil,
           address: nil,
           port: nil,
+          service: nil,
           cloud: nil
         )
-          @name = name
-          @resource = resource
-          @type = type
           @address = address
           @port = port
-          @cloud = cloud
+          @service = build_service(service)
+          @cloud = build_cloud(cloud)
         end
 
         attr_reader(
-          :name,
-          :resource,
-          :type,
           :address,
           :port,
+          :service,
           :cloud
         )
 
         def self.from_uri(uri_or_str, type: 'external', port: nil)
           uri = normalize(uri_or_str)
 
-          new(
+          service = Service.new(
             name: only_scheme_and_host(uri),
             resource: "#{uri.host}:#{uri.port}",
-            type: type,
+            type: type
+          )
+
+          new(
             address: uri.hostname,
-            port: port || uri.port
+            port: port || uri.port,
+            service: service
           )
         end
 
@@ -84,6 +98,24 @@ module ElasticAPM
             URI(uri_or_str)
           end
         end
+
+        private
+
+        def build_service(service = nil)
+          return unless service
+          return service if service.is_a?(Service)
+
+          Service.new(**service)
+        rescue Service::MissingValues
+          nil # If we are missing any service value, return nothing
+        end
+
+        def build_cloud(cloud = nil)
+          return unless cloud
+          return cloud if cloud.is_a?(Cloud)
+
+          Cloud.new(**cloud)
+        end
       end
     end
   end

data/lib/elastic_apm/spies/dynamo_db.rb

@@ -22,6 +22,7 @@ module ElasticAPM
   module Spies
     # @api private
     class DynamoDBSpy
+      NAME = 'dynamodb'
       TYPE = 'db'
       SUBTYPE = 'dynamodb'
 
@@ -65,8 +66,11 @@ module ElasticAPM
                 },
                 destination: {
                   cloud: cloud,
-                  resource: SUBTYPE,
-                  type: TYPE
+                  service: {
+                    name: NAME,
+                    resource: SUBTYPE,
+                    type: TYPE
+                  }
                 }
               )
 

data/lib/elastic_apm/spies/elasticsearch.rb

@@ -61,9 +61,11 @@ module ElasticAPM
           context = Span::Context.new(
             db: { statement: statement.reduce({}, :merge).to_json },
             destination: {
-              name: SUBTYPE,
-              resource: SUBTYPE,
-              type: TYPE
+              service: {
+                name: SUBTYPE,
+                resource: SUBTYPE,
+                type: TYPE
+              }
             }
           )
 

data/lib/elastic_apm/spies/http.rb

@@ -35,11 +35,9 @@ module ElasticAPM
           method = req.verb.to_s.upcase
           host = req.uri.host
 
-          destination =
-            ElasticAPM::Span::Context::Destination.from_uri(req.uri)
           context = ElasticAPM::Span::Context.new(
             http: { url: req.uri, method: method },
-            destination: destination
+            destination: ElasticAPM::Span::Context::Destination.from_uri(req.uri)
           )
 
           name = "#{method} #{host}"

data/lib/elastic_apm/spies/mongo.rb

@@ -108,9 +108,11 @@ module ElasticAPM
               user: nil
             },
             destination: {
-              name: SUBTYPE,
-              resource: SUBTYPE,
-              type: TYPE
+              service: {
+                name: SUBTYPE,
+                resource: SUBTYPE,
+                type: TYPE
+              }
             }
           )
         end

data/lib/elastic_apm/spies/net_http.rb

@@ -69,13 +69,10 @@ module ElasticAPM
           url << "?#{query}" if query
           uri = URI(url)
 
-          destination =
-            ElasticAPM::Span::Context::Destination.from_uri(uri)
-
           context =
             ElasticAPM::Span::Context.new(
               http: { url: uri, method: method },
-              destination: destination
+              destination: ElasticAPM::Span::Context::Destination.from_uri(uri)
             )
 
           ElasticAPM.with_span(

data/lib/elastic_apm/spies/s3.rb

@@ -41,13 +41,10 @@ module ElasticAPM
       end
 
       def self.bucket_name(params)
-        if params[:bucket]
-          if index = params[:bucket].rindex(AP_REGEX)
-            params[:bucket][index+1..-1]
-          else
-            params[:bucket]
-          end
-        end
+        return unless (bucket = params[:bucket]&.to_s)
+        return bucket unless (index = bucket.rindex(AP_REGEX))
+
+        bucket[index+1..-1]
       end
 
       def self.accesspoint_region(params)
@@ -84,18 +81,18 @@ module ElasticAPM
         def self.prepended(mod)
           # Alias all available operations
           mod.api.operation_names.each do |operation_name|
-            define_method(operation_name) do |params = {}, options = {}|
+            define_method(operation_name) do |params = {}, options = {}, &block|
               bucket_name = ElasticAPM::Spies::S3Spy.bucket_name(params)
-              cloud = ElasticAPM::Span::Context::Destination::Cloud.new(
-                region: ElasticAPM::Spies::S3Spy.accesspoint_region(params) || config.region
-              )
+              region = ElasticAPM::Spies::S3Spy.accesspoint_region(params) || config.region
 
               context = ElasticAPM::Span::Context.new(
                 destination: {
-                  cloud: cloud,
-                  resource: bucket_name,
-                  type: TYPE,
-                  name: SUBTYPE
+                  cloud: { region: region },
+                  service: {
+                    resource: bucket_name,
+                    type: TYPE,
+                    name: SUBTYPE
+                  }
                 }
               )
 
@@ -107,7 +104,7 @@ module ElasticAPM
                 context: context
               ) do
                 ElasticAPM::Spies::S3Spy.without_net_http do
-                  super(params, options)
+                  super(params, options, &block)
                 end
               end
             end

data/lib/elastic_apm/spies/sequel.rb

@@ -46,7 +46,7 @@ module ElasticAPM
 
           context = ElasticAPM::Span::Context.new(
             db: { statement: sql, type: 'sql', user: opts[:user] },
-            destination: { name: subtype, resource: subtype, type: TYPE }
+            destination: { service: { name: subtype, resource: subtype, type: TYPE } }
           )
 
           span = ElasticAPM.start_span(

data/lib/elastic_apm/spies/sns.rb

@@ -64,62 +64,63 @@ module ElasticAPM
       end
 
       def self.span_context(topic, region)
-        cloud = ElasticAPM::Span::Context::Destination::Cloud.new(region: region)
-
         ElasticAPM::Span::Context.new(
           message: {
             queue_name: topic
           },
           destination: {
-            resource: [SUBTYPE, topic].compact.join('/'),
-            type: TYPE,
-            name: SUBTYPE,
-            cloud: cloud
+            service: {
+              resource: [SUBTYPE, topic].compact.join('/'),
+              type: TYPE,
+              name: SUBTYPE,
+            },
+            cloud: ElasticAPM::Span::Context::Destination::Cloud.new(region: region)
           }
         )
       end
 
-      def install
-        ::Aws::SNS::Client.class_eval do
-          alias :publish_without_apm :publish
+      # @api private
+      module Ext
+        def publish(params = {}, options = {})
+          unless (transaction = ElasticAPM.current_transaction)
+            return super(params, options)
+          end
 
-          def publish(params = {}, options = {})
-            unless (transaction = ElasticAPM.current_transaction)
-              return publish_without_apm(params, options)
+          topic = ElasticAPM::Spies::SNSSpy.get_topic(params)
+          span_name = topic ? "SNS PUBLISH to #{topic}" : 'SNS PUBLISH'
+          region = ElasticAPM::Spies::SNSSpy.arn_region(
+            params[:topic_arn] || params[:target_arn]
+          )
+          context = ElasticAPM::Spies::SNSSpy.span_context(
+            topic,
+            region || config.region
+          )
+
+          ElasticAPM.with_span(
+            span_name,
+            TYPE,
+            subtype: SUBTYPE,
+            action: 'publish',
+            context: context
+          ) do |span|
+            trace_context = span&.trace_context || transaction.trace_context
+            trace_context.apply_headers do |key, value|
+              params[:message_attributes] ||= {}
+              params[:message_attributes][key] ||= {}
+              params[:message_attributes][key][:string_value] = value
+              params[:message_attributes][key][:data_type] = 'String'
             end
 
-            topic = ElasticAPM::Spies::SNSSpy.get_topic(params)
-            span_name = topic ? "SNS PUBLISH to #{topic}" : 'SNS PUBLISH'
-            region = ElasticAPM::Spies::SNSSpy.arn_region(
-              params[:topic_arn] || params[:target_arn]
-            )
-            context = ElasticAPM::Spies::SNSSpy.span_context(
-              topic,
-              region || config.region
-            )
-
-            ElasticAPM.with_span(
-              span_name,
-              TYPE,
-              subtype: SUBTYPE,
-              action: 'publish',
-              context: context
-            ) do |span|
-              trace_context = span&.trace_context || transaction.trace_context
-              trace_context.apply_headers do |key, value|
-                params[:message_attributes] ||= {}
-                params[:message_attributes][key] ||= {}
-                params[:message_attributes][key][:string_value] = value
-                params[:message_attributes][key][:data_type] = 'String'
-              end
-
-              ElasticAPM::Spies::SNSSpy.without_net_http do
-                publish_without_apm(params, options)
-              end
+            ElasticAPM::Spies::SNSSpy.without_net_http do
+              super(params, options)
             end
           end
         end
       end
+
+      def install
+        ::Aws::SNS::Client.prepend(Ext)
+      end
     end
 
     register(

data/lib/elastic_apm/spies/sqs.rb

@@ -57,9 +57,11 @@ module ElasticAPM
             queue_name: queue_name
           },
           destination: {
-            resource: [SUBTYPE, queue_name].compact.join('/'),
-            type: TYPE,
-            name: SUBTYPE,
+            service: {
+              resource: [SUBTYPE, queue_name].compact.join('/'),
+              type: TYPE,
+              name: SUBTYPE
+            },
             cloud: cloud
           }
         )

data/lib/elastic_apm/sql/tokenizer.rb

@@ -69,7 +69,7 @@ module ElasticAPM
         when '['   then scan_quoted_indentifier(']')
         when '('   then LPAREN
         when ')'   then RPAREN
-        when '/'   then scan_bracketed_comment
+        when '/'   then scan_bracketed_or_cql_comment
         when '-'   then scan_simple_comment
         when "'"   then scan_string_literal
         when ALPHA then scan_keyword_or_identifier(possible_keyword: true)
@@ -185,10 +185,16 @@ module ElasticAPM
         IDENT
       end
 
+      def scan_bracketed_or_cql_comment
+        case peek_char
+        when '*' then scan_bracketed_comment
+        when '/' then scan_cql_comment
+        else OTHER
+        end
+      end
+
       # rubocop:disable Metrics/CyclomaticComplexity
       def scan_bracketed_comment
-        return OTHER unless peek_char == '*'
-
         nesting = 1
 
         while (char = next_char)
@@ -207,6 +213,16 @@ module ElasticAPM
       end
       # rubocop:enable Metrics/CyclomaticComplexity
 
+      def scan_cql_comment
+        return OTHER unless peek_char == '/'
+
+        while (char = next_char)
+          break if char == "\n"
+        end
+
+        COMMENT
+      end
+
       def scan_simple_comment
         return OTHER unless peek_char == '-'
 

data/lib/elastic_apm/transport/serializers/span_serializer.rb

@@ -93,16 +93,20 @@ module ElasticAPM
           end
 
           def build_destination(destination)
-            base =
-              {
-                service: {
-                  name: keyword_field(destination.name),
-                  resource: keyword_field(destination.resource),
-                  type: keyword_field(destination.type)
-                },
-                address: keyword_field(destination.address),
-                port: destination.port
+            return unless destination
+
+            base = {
+              address: keyword_field(destination.address),
+              port: destination.port
+            }
+
+            if service = destination.service
+              base[:service] = {
+                name: keyword_field(destination.service.name),
+                resource: keyword_field(destination.service.resource),
+                type: keyword_field(destination.service.type)
               }
+            end
 
             if cloud = destination.cloud
               base[:cloud] = { region: cloud.region }

data/lib/elastic_apm/transport/user_agent.rb

@@ -21,7 +21,8 @@ module ElasticAPM
   module Transport
     # @api private
     class UserAgent
-      def initialize(config)
+      def initialize(config, version: VERSION)
+        @version = version
         @built = build(config)
       end
 
@@ -35,7 +36,7 @@ module ElasticAPM
         service = Metadata::ServiceInfo.new(config)
 
         [
-          "elastic-apm-ruby/#{VERSION}",
+          "elastic-apm-ruby/#{@version}",
           HTTP::Request::USER_AGENT,
           [
             service.runtime.name,

data/lib/elastic_apm/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '4.0.0.beta.1'
+  VERSION = '4.0.0.beta.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta.1
+  version: 4.0.0.beta.2
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -95,6 +95,7 @@ files:
 - bin/build_docs
 - bin/console
 - bin/dev
+- bin/run-bdd
 - bin/run-tests
 - bin/setup
 - bin/with_framework
@@ -267,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: The official Elastic APM agent for Ruby