elastic-apm 4.7.3 → 4.8.0

data/docs/reference/opentracing-api.md

@@ -0,0 +1,70 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/apm/agent/ruby/current/opentracing.html
+---
+
+# OpenTracing API [opentracing]
+
+The Elastic APM OpenTracing bridge allows to create Elastic APM `Transactions` and `Spans`, using the OpenTracing API. In other words, it translates the calls to the OpenTracing API to Elastic APM and thus allows for reusing existing instrumentation.
+
+The first span of a service will be converted to an Elastic APM `Transaction`, subsequent spans are mapped to Elastic APM `Span`.
+
+
+## Operation Modes [operation-modes]
+
+This bridge allows for different operation modes in combination with the Elastic APM Agent.
+
+* Noop<br> If no Elastic APM agent is running, the bridge is in noop mode and does not actually record and report spans.
+* Mix and Match<br> If you want to leverage the auto instrumentation of Elastic APM, but also want do create custom spans or use the OpenTracing API to add custom tags to the spans created by Elastic APM, you can just do that. The OpenTracing bridge and the standard Elastic APM API interact seamlessly.
+* Manual instrumentation<br> If you don’t want Elastic APM to auto-instrument known frameworks, but instead only rely on manual instrumentation, disable the auto instrumentation setting the configuration option [`instrument`](/reference/configuration.md#config-instrument) to `false`.
+
+
+## Getting started [getting-started]
+
+Either `require 'elastic_apm/opentracing'` during the boot of your app or specify the `require:` argument to your `Gemfile`, eg. `gem 'elastic_apm', require: 'elastic_apm/opentracing'`.
+
+
+## Set Elastic APM as the global tracer [init-tracer]
+
+```ruby
+::OpenTracing.global_tracer = ElasticAPM::OpenTracing::Tracer.new
+```
+
+
+## Elastic APM specific tags [elastic-apm-tags]
+
+Elastic APM defines some tags which are not included in the OpenTracing API but are relevant in the context of Elastic APM.
+
+* `type` - sets the type of the transaction, for example `request`, `ext` or `db`
+* `user.id` - sets the user id, appears in the "User" tab in the transaction details in the Elastic APM app
+* `user.email` - sets the user email, appears in the "User" tab in the transaction details in the Elastic APM app
+* `user.username` - sets the user name, appears in the "User" tab in the transaction details in the Elastic APM app
+* `result` - sets the result of the transaction. Overrides the default value of `success`. If the `error` tag is set to `true`, the default value is `error`.
+
+
+## Caveats [unsupported]
+
+Not all features of the OpenTracing API are supported.
+
+
+### Context propagation [propagation]
+
+This bridge only supports the format `OpenTracing::FORMAT_RACK`, using HTTP headers with capitalized names, prefixed with `HTTP_` as Rack does it.
+
+`OpenTracing::FORMAT_BINARY` is currently not supported.
+
+
+### Span References [references]
+
+Currently, this bridge only supports `child_of` references. Other references, like `follows_from` are not supported yet.
+
+
+### Baggage [baggage]
+
+The `Span.set_baggage` method is not supported. Baggage items are dropped with a warning log message.
+
+
+### Logs [opentracing-logs]
+
+Logs are currently not supported.
+

data/docs/reference/performance-tuning.md

@@ -0,0 +1,71 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/apm/agent/ruby/current/tuning-and-overhead.html
+---
+
+# Performance tuning [tuning-and-overhead]
+
+Using any APM solution comes with trade-offs, and the Elastic APM Ruby Agent is no different. Instrumenting your code, using timers, recording context data, etc., uses resources—for example:
+
+* CPU time
+* Memory
+* Bandwidth
+* Elasticsearch storage
+
+We invest a lot of effort to ensure that the Ruby Agent is suitable for production code and that its overhead remains as low as possible. However, because every application is different, there are some knobs you can turn and tweak to adapt the Agent to your specific needs.
+
+
+## Transaction sample rate [tuning-sample-rate]
+
+By default, the Agent samples every transaction. The easiest way to reduce both the overhead of the agent and storage requirements, is to tell it to do less, i.e., sample fewer transactions. To do this, set the [`transaction_sample_rate`](/reference/configuration.md#config-transaction-sample-rate) to a value between `0.0` and `1.0`—the percentage of transactions you’d like to randomly sample. The Agent will still record the overall time and result of unsampled transactions, but not context information, tags, or spans.
+
+
+## Collecting frame context [tuning-frame-context]
+
+The Agent automatically captures several lines of source code around each frame location in the stack trace. This enables the APM app to provide greater insight into exactly where an error or span is occurring in your code. This insight does come at a cost—in terms of performance, stack trace collection is the most expensive thing the Agent does.
+
+There are settings you can modify to control this behavior:
+
+1. Disable stack trace frame collection for short-duration spans by setting [`span_frames_min_duration`](/reference/configuration.md#config-span-frames-min-duration-ms) to `0`.
+2. Modify the number of source code lines collected. These settings are divided between app frames, which represent your application code, and library frames, which represent the code of your dependencies. Each of these categories are further split into separate error and span settings.
+
+    * [`source_lines_error_app_frames`](/reference/configuration.md#config-source-lines-error-app-frames)
+    * [`source_lines_error_library_frames`](/reference/configuration.md#config-source-lines-error-library-frames)
+    * [`source_lines_span_app_frames`](/reference/configuration.md#config-source-lines-span-app-frames)
+    * [`source_lines_span_library_frames`](/reference/configuration.md#config-source-lines-span-library-frames)
+
+3. If you’re using the API to create a custom span, you can disable stack trace collection with the [`include_stacktrace` argument](/reference/api-reference.md#api-agent-start_span).
+
+Reading source files inside a running application can cause a lot of disk I/O, and sending up source lines for each frame will have a network and storage cost that is quite high. Turning these limits down will prevent storing excessive amounts of data in Elasticsearch.
+
+
+## Transaction queue [tuning-queue]
+
+The Agent does not send every transaction as it happens. Instead, to reduce load on the APM Server, the Agent uses a queue. The queue is flushed periodically, or when it reaches a maximum size.
+
+While this reduces the load on the APM Server, holding on to transaction data in a queue uses memory. If you notice a large increase in memory use, try adjusting these settings:
+
+* [`api_request_time`](/reference/configuration.md#config-api-request-time) to reduce the duration of a single streaming request. This setting is helpful if you have a sustained high number of transactions.
+* [`api_request_size`](/reference/configuration.md#config-api-request-size) to reduce the maximum size of one request. This setting can help if you experience transaction peaks (a large number in a short period of time).
+
+Keep in mind that reducing the value of either setting will cause the agent to send more HTTP requests to the APM Server, potentially causing a higher load.
+
+
+## Spans per transaction [tuning-max-spans]
+
+The number of spans per transaction will influence both how much time the agent spends in each transaction collecting contextual data, and how much storage space is needed in Elasticsearch. In our experience, most *usual* transactions should have well below 100 spans. In some cases, however, the number of spans can explode—for example:
+
+* Long-running transactions
+* Unoptimized code, e.g., doing hundreds of SQL queries in a loop
+
+To avoid these edge cases which overload both the Agent and the APM Server, the Agent will stop recording spans when a specified limit is reached. This limit is configurable with [`transaction_max_spans`](/reference/configuration.md#config-transaction-max-spans).
+
+
+## Capturing headers and request body [tuning-body-headers]
+
+You can configure the Agent to capture headers and request bodies with [`capture_headers`](/reference/configuration.md#config-capture-headers) and [`capture_body`](/reference/configuration.md#config-capture-body). By default, headers are captured and request bodies are not.
+
+Depending on the nature of your POST requests, capturing request bodies for transactions may introduce noticeable overhead, as well as increased storage use. In most scenarios, we advise against enabling request body capturing for transactions, and only enabling it if necessary for errors.
+
+Capturing request/response headers has less overhead on the agent than capturing request bodies, but can have an impact on storage use.
+

data/docs/reference/set-up-apm-ruby-agent.md

@@ -0,0 +1,16 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/apm/agent/ruby/current/set-up.html
+---
+
+# Set up the APM Ruby agent [set-up]
+
+To get you off the ground, we’ve prepared guides for setting up the Agent with different frameworks:
+
+* [Rails](/reference/getting-started-rails.md)
+* [Rack](/reference/getting-started-rack.md)
+
+For custom instrumentation, see the [*API reference*](/reference/api-reference.md).
+
+
+

data/docs/reference/supported-technologies.md

@@ -0,0 +1,128 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/apm/agent/ruby/current/supported-technologies.html
+---
+
+# Supported technologies [supported-technologies]
+
+The Elastic APM Ruby Agent has built-in support for many frameworks and libraries. Generally, we want to support all of the most popular libraries. If your favorite is missing, feel free to request it in an issue, or better yet, create a pull request.
+
+
+## Ruby [supported-technologies-ruby]
+
+We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
+
+
+## Web Frameworks and Libraries [supported-technologies-web]
+
+We have automatic support for Ruby on Rails and all Rack compatible web frameworks.
+
+We test against all supported minor versions of Rails, Sinatra, and Grape.
+
+
+### Ruby on Rails [supported-technologies-rails]
+
+We currently support all versions of Rails since 4.2. This follows Rails' own [Security policy](https://rubyonrails.org/security/).
+
+See [Getting started with Rails](/reference/getting-started-rails.md).
+
+
+### Sinatra [supported-technologies-sinatra]
+
+We currently support all versions of Sinatra since 1.0.
+
+See [Getting started with Rack](/reference/getting-started-rack.md).
+
+
+### Grape [supported-technologies-grape]
+
+We currently support all versions of Grape since 1.2.
+
+See [Grape example](/reference/getting-started-rack.md#getting-started-grape).
+
+
+## Databases [supported-technologies-databases]
+
+We automatically instrument database actions using:
+
+* ActiveRecord (v4.2+)
+* DynamoDB (v1.0+)
+* Elasticsearch (v0.9+)
+* Mongo (v2.1+)
+* Redis (v3.1+)
+* Sequel (v4.35+)
+
+
+## External HTTP requests [supported-technologies-http]
+
+We automatically instrument and add support for distributed tracing to external requests using these libraries:
+
+* `net/http`
+* Http.rb (v0.6+)
+* Faraday (v0.2.1+)
+
+**Note:** These libraries usually assume `localhost` if no `Host` is specified, so the agent does as well.
+
+
+## Background Processing [supported-technologies-backgroud-processing]
+
+We automatically instrument background processing using:
+
+* DelayedJob
+* Sidekiq
+* Shoryuken
+* Sneakers (v2.12.0+) (Experimental, see [#676](https://github.com/elastic/apm-agent-ruby/pull/676))
+* Resque (v2.0.0+)
+* SuckerPunch (v2.0.0+)
+
+
+## Resque [supported-technologies-resque]
+
+To make the agent work with Resque, you need to require `elastic_apm/resque` before you boot your Resque worker process.
+
+For example in your `Rakefile`:
+
+```ruby
+require 'resque'
+require 'elastic_apm'
+require 'elastic_apm/resque'
+```
+
+When you start Resque, you should see a series of messages like the following in the Resque logs:
+
+```ruby
+I, [XXX #81227]  INFO -- : Starting worker main
+D, [XXX #81227] DEBUG -- : Registered signals
+I, [XXX #81227]  INFO -- : Running before_first_fork hooks
+D, [XXX #81227] DEBUG -- : Starting ElasticAPM agent
+```
+
+Also be sure to set the Resque environment variable `RUN_AT_EXIT_HOOKS` to `true`. Otherwise, the fork may be terminated before the agent has a chance to send all the fork’s events to the APM server.
+
+
+## SuckerPunch [supported-technologies-sucker-punch]
+
+Asynchronously executed jobs in SuckerPunch are automatically instrumented.
+
+Note that errors raised in the user-defined `JobClass#perform` method will be first handled by the SuckerPunch exception handler before being handled by the agent. The handler is accessed/set via `SuckerPunch.exception_handler` in version 2.0. The agent transaction will be marked as successful unless you re-raise the error in the exception handler. You can also explicitly report the error via [`ElasticAPM.report`](/reference/api-reference.md#api-agent-report) in a custom SuckerPunch exception handler.
+
+
+## gRPC [supported-technologies-grpc]
+
+We automatically instrument gRPC using the `grpc` gem. Note that this is experimental, as the `grpc` gem’s support for `Interceptors` is experimental as of version 1.27.0.
+
+To instrument a client, add the `ElasticAPM::GRPC::ClientInterceptor` as an `interceptor` at Stub creation.
+
+```ruby
+Helloworld::Greeter::Stub.new(
+  'localhost:50051',
+  interceptors: [ElasticAPM::GRPC::ClientInterceptor.new]
+)
+```
+
+To instrument a server, add the `ElasticAPM::GRPC::ServerInterceptor`.
+
+```ruby
+GRPC::RpcServer.new(interceptors: [ElasticAPM::GRPC::ServerInterceptor.new])
+```
+

data/docs/reference/toc.yml

@@ -0,0 +1,22 @@
+project: 'APM Ruby agent reference'
+toc:
+  - file: index.md
+  - file: set-up-apm-ruby-agent.md
+    children:
+      - file: getting-started-rails.md
+      - file: getting-started-rack.md
+  - file: supported-technologies.md
+  - file: configuration.md
+  - file: advanced-topics.md
+    children:
+      - file: context.md
+      - file: custom-instrumentation.md
+  - file: api-reference.md
+  - file: metrics.md
+  - file: logs.md
+  - file: opentracing-api.md
+  - file: graphql.md
+  # TO DO: Not available on master
+  # - file: log-correlation.md
+  - file: performance-tuning.md
+  - file: upgrading.md

data/docs/reference/upgrading.md

@@ -0,0 +1,19 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/apm/agent/ruby/current/upgrading.html
+---
+
+# Upgrading [upgrading]
+
+Upgrades between minor versions of the agent, like from 2.1 to 2.2 are always backwards compatible. Upgrades that involve a major version bump often come with some backwards incompatible changes.
+
+Before upgrading the agent, be sure to review the:
+
+* [Agent release notes](/release-notes/index.md)
+* [Agent and Server compatibility chart](docs-content://solutions/observability/apps/apm-agent-compatibility.md)
+
+
+## End of life dates [end-of-life-dates]
+
+We love all our products, but sometimes we must say goodbye to a release so that we can continue moving forward on future development and innovation. Our [End of life policy](https://www.elastic.co/support/eol) defines how long a given release is considered supported, as well as how long a release is considered still in active development or maintenance.
+

data/docs/release-notes/index.md

@@ -0,0 +1,166 @@
+---
+navigation_title: "Elastic APM Ruby Agent"
+mapped_pages:
+  - https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes.html
+  - https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes-4.x.html
+---
+
+# Elastic APM Ruby Agent release notes [elastic-apm-ruby-agent-release-notes]
+
+Review the changes, fixes, and more in each version of Elastic APM Ruby Agent. 
+
+To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).
+
+All notable changes to this project will be documented here. This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.md).
+
+% Release notes includes only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections. 
+
+% ## version.next [elastic-apm-ruby-agent-versionext-release-notes]
+% **Release date:** Month day, year
+
+% ### Features and enhancements [elastic-apm-ruby-agent-versionext-features-enhancements]
+
+% ### Fixes [elastic-apm-ruby-agent-versionext-fixes]
+
+## 4.8.0 [elastic-apm-ruby-agent-480-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-480-features-enhancements]
+* Support ruby 3.4 [#1510](https://github.com/elastic/apm-agent-ruby/pull/1510)
+
+## 4.7.3 [elastic-apm-ruby-agent-473-release-notes]
+
+### Fixes [elastic-apm-ruby-agent-473-fixes]
+* Address a bug where if `capture_headers` is false, `ContextBuilder` will raise `"undefined method 'has_key?' for nil:NilClass"` [#1449](https://github.com/elastic/apm-agent-ruby/pull/1449)
+
+## 4.7.2 [elastic-apm-ruby-agent-472-release-notes]
+
+### Fixes [elastic-apm-ruby-agent-472-fixes]
+* Address machineType not being returned in GCP metadata [#1435](https://github.com/elastic/apm-agent-ruby/pull/1435)
+
+## 4.7.1 [elastic-apm-ruby-agent-471-release-notes]
+
+### Fixes [elastic-apm-ruby-agent-471-fixes]
+* Skip capturing cookie header when it’s set separately [#1405](https://github.com/elastic/apm-agent-ruby/pull/1405)
+* Changes/fixes to metadata.cloud.* fields collected for GCP [#1415](https://github.com/elastic/apm-agent-ruby/pull/1415)
+* Pin version of bigdecimal for ruby 2.4 [#1417](https://github.com/elastic/apm-agent-ruby/pull/1417)
+* Use response method on Faraday error for older versions of the library [#1419](https://github.com/elastic/apm-agent-ruby/pull/1419)
+* Fix ActionDispatchSpy#render_exception for Rails 7.1 [#1423](https://github.com/elastic/apm-agent-ruby/pull/1423)
+* Use graphql < 2.1 when Ruby < 2.7 [#1425](https://github.com/elastic/apm-agent-ruby/pull/1425)
+* Guard against various Faraday exception response formats [#1428](https://github.com/elastic/apm-agent-ruby/pull/1428)
+
+## 4.7.0 [elastic-apm-ruby-agent-470-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-470-features-enhancements]
+* Add keyword args for span_method helper [#1395](https://github.com/elastic/apm-agent-ruby/pull/1395)
+
+### Fixes [elastic-apm-ruby-agent-470-fixes]
+* Handle Faraday response being nil [#1382](https://github.com/elastic/apm-agent-ruby/pull/1382)
+* Fix error with invalid %-encoding [#1400](https://github.com/elastic/apm-agent-ruby/pull/1400)
+
+## 4.6.2 [elastic-apm-ruby-agent-462-release-notes]
+
+### Fixes [elastic-apm-ruby-agent-462-fixes]
+* Fix Faraday::RackBuilder::StackLocked [#1371](https://github.com/elastic/apm-agent-ruby/pull/1371)
+
+## 4.6.1 [elastic-apm-ruby-agent-461-release-notes]
+
+### Fixes [elastic-apm-ruby-agent-461-fixes]
+* Fix growing number of open file descriptors when HTTP request to APM is never sent [#1351](https://github.com/elastic/apm-agent-ruby/pull/1351)
+* Fix setting span http status code when Faraday Middleware is used [#1368](https://github.com/elastic/apm-agent-ruby/pull/1368)
+* Handle whitespace when splitting tracestate entries [#1353](https://github.com/elastic/apm-agent-ruby/pull/1353)
+
+## 4.6.0 [elastic-apm-ruby-agent-460-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-460-features-enhancements]
+* Added transaction_name to reported error to allow grouping by transaction name [#1267](https://github.com/elastic/apm-agent-ruby/pull/1267)
+* Added ability to query server for version (useful in the future) [#1278](https://github.com/elastic/apm-agent-ruby/pull/1278)
+* Added instrumentation for [https://github.com/zendesk/racecar/](https://github.com/zendesk/racecar/) Racecar Kafka library [#1284](https://github.com/elastic/apm-agent-ruby/pull/1284)
+* Expanded filtering to sanitize any key that contains the string *auth* [#1266](https://github.com/elastic/apm-agent-ruby/pull/1266)
+* Rename `log_ecs_formatting` option to `log_ecs_reformatting`, deprecate old option name [#1248](https://github.com/elastic/apm-agent-ruby/pull/1248)
+* When the configuration value for `log_path` is set, override the `logger` to point to that path instead of using e.g. Rails logger [#1247](https://github.com/elastic/apm-agent-ruby/pull/1247)
+* Only send tracestate header for distributed tracing when it has content [#1277](https://github.com/elastic/apm-agent-ruby/pull/1277)
+* Use the hostname as the Kubernetes pod name in the Container Info metadata if the pod id is parsed from cgroup [#1314](https://github.com/elastic/apm-agent-ruby/pull/1314)
+
+### Fixes [elastic-apm-ruby-agent-460-fixes]
+* Small change to Sidekiq tests to handle new configuration passing method [#1283](https://github.com/elastic/apm-agent-ruby/pull/1283)
+* Set transaction sample rate to 0 when it’s unsampled [#1339](https://github.com/elastic/apm-agent-ruby/pull/1339)
+* Don’t send unsampled transactions to APM server >= 8.0 [#1341](https://github.com/elastic/apm-agent-ruby/pull/1341)
+
+## 4.5.1 [elastic-apm-ruby-agent-451-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-461-features-enhancements]
+* Update elasticsearch spy to use new transport gem name [#1257](https://github.com/elastic/apm-agent-ruby/pull/1257)
+* Standardize placeholder for phone numbers as [PHONENUMBER] per [https://github.com/elastic/apm/blob/main/specs/agents/tracing-instrumentation-aws.md](https://github.com/elastic/apm/blob/main/specs/agents/tracing-instrumentation-aws.md) [#1246](https://github.com/elastic/apm-agent-ruby/pull/1246)
+
+### Fixes [elastic-apm-ruby-agent-451-fixes]
+* Fixed dependencies to allow CI to build successfully [#1259](https://github.com/elastic/apm-agent-ruby/pull/1259)
+* Fixed warnings related to TimeTask timeouts [#1255](https://github.com/elastic/apm-agent-ruby/pull/1255)
+
+## 4.5.0 [elastic-apm-ruby-agent-450-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-460-features-enhancements]
+* Stop collecting the field `http.request.socket.encrypted` [#1181](https://github.com/elastic/apm-agent-ruby/pull/1181)
+
+### Fixes [elastic-apm-ruby-agent-450-fixes]
+* Fixed MongoDB spy thread safety [#1202](https://github.com/elastic/apm-agent-ruby/pull/1202)
+* Fixed span context fields for DynamoDB instrumentation [#1178](https://github.com/elastic/apm-agent-ruby/pull/1178)
+* Fixed span context fields for S3 instrumentation [#1179](https://github.com/elastic/apm-agent-ruby/pull/1179)
+* Update user agent info to match spec [#1182](https://github.com/elastic/apm-agent-ruby/pull/1182)
+
+## 4.4.0 [elastic-apm-ruby-agent-440-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-460-features-enhancements]
+* Optional span to be ended instead of current span [#1039](https://github.com/elastic/apm-agent-ruby/pull/1039)
+* Config option `log_ecs_formatting` [#1053](https://github.com/elastic/apm-agent-ruby/pull/1053)
+
+### Fixes [elastic-apm-ruby-agent-440-fixes]
+* Fixed detecting Linux on Alpine for CPU/MEM metrics [#1057](https://github.com/elastic/apm-agent-ruby/pull/1057)
+
+## 4.3.0 [elastic-apm-ruby-agent-430-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-430-features-enhancements]
+* Add JVM memory metrics [#1040](https://github.com/elastic/apm-agent-ruby/pull/1040)
+
+## 4.2.0 [elastic-apm-ruby-agent-420-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-420-features-enhancements]
+* Add support for AWS Storage Table/CosmosDB [#999](https://github.com/elastic/apm-agent-ruby/pull/999)
+
+### Fixes [elastic-apm-ruby-agent-420-fixes]
+* Align HTTP span types/subtypes with spec [#1014](https://github.com/elastic/apm-agent-ruby/pull/1014)
+* Passing a full URL as a path to `Net::HTTP` [#1029](https://github.com/elastic/apm-agent-ruby/pull/1029)
+* Fix growing number of open file descriptors [#1033](https://github.com/elastic/apm-agent-ruby/pull/1033)
+
+## 4.1.0 [elastic-apm-ruby-agent-410-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-410-features-enhancements]
+* Azure App Services instance metadata [#1007](https://github.com/elastic/apm-agent-ruby/pull/1007)
+* `hostname` is now reported split by `configured_hostname` and `detected_hostname` [#1009](https://github.com/elastic/apm-agent-ruby/pull/1009)
+
+### Fixes [elastic-apm-ruby-agent-410-fixes]
+* `service_node_name` is now correctly reported as `service.node.configured_name` [#1009](https://github.com/elastic/apm-agent-ruby/pull/1009)
+* Fix JSON parsing when using yajl-ruby [#1012](https://github.com/elastic/apm-agent-ruby/pull/1012)
+* Fix SpanHelpers when methods take blocks [#1013](https://github.com/elastic/apm-agent-ruby/pull/1013)
+* Fix missing `environment` param when fetching from Central Config [#1014](https://github.com/elastic/apm-agent-ruby/pull/1014)
+
+## 4.0.0 [elastic-apm-ruby-agent-400-release-notes]
+
+### Features and enhancements [elastic-apm-ruby-agent-400-features-enhancements]
+* Be aware that this release changes the agent’s general approach to instrumenting third party libraries. It now uses `Module#prepend` over alias method chaining. This doesn’t necessarily impact your application but it could if you are using other gems that use the old approach to patch the same method. Mixing the two approaches can lead to infinite recursion.
+* Removed support for Ruby 2.3 and JRuby 9.1 [#901](https://github.com/elastic/apm-agent-ruby/pull/901)
+* Removed config option `active`, see `enabled` [#900](https://github.com/elastic/apm-agent-ruby/pull/900)
+* Removed config option `custom_key_filters`, see `sanitize_field_names` [#900](https://github.com/elastic/apm-agent-ruby/pull/900)
+* Removed config option `default_tags`, see `global_labels` [#900](https://github.com/elastic/apm-agent-ruby/pull/900)
+* Removed config option `default_labels`, see `global_labels` [#900](https://github.com/elastic/apm-agent-ruby/pull/900)
+* Removed config option `ignore_url_patterns`, see `transaction_ignore_urls` [#900](https://github.com/elastic/apm-agent-ruby/pull/900)
+* Removed config option `use_legacy_sql_parser`, legacy parser no longer included [#900](https://github.com/elastic/apm-agent-ruby/pull/900)
+* Integrations (Spies) use Module#prepend over class_eval [#890](https://github.com/elastic/apm-agent-ruby/pull/890)
+* The secrets filter no longer filters based on values, see `sanitize_field_names` [#900](https://github.com/elastic/apm-agent-ruby/pull/900)
+* The secrets filter is aligned with other agents, see `sanitize_field_names` [#900](https://github.com/elastic/apm-agent-ruby/pull/900)
+* Added `set_service` API [#1006](https://github.com/elastic/apm-agent-ruby/pull/1006)
+
+### Fixes [elastic-apm-ruby-agent-400-fixes]
+* AWS S3 spy accepts symbol bucket names [#998](https://github.com/elastic/apm-agent-ruby/pull/998)
+* AWS S3 spy passing on blocks [#998](https://github.com/elastic/apm-agent-ruby/pull/998)
+* SQL scanner now recognizes CQL style comments [#1004](https://github.com/elastic/apm-agent-ruby/pull/1004)
+

data/docs/release-notes/known-issues.md

@@ -0,0 +1,24 @@
+---
+navigation_title: "Known issues"
+
+---
+
+# Elastic APM Ruby Agent known issues [elastic-apm-ruby-agent-known-issues]
+
+Known issues are significant defects or limitations that may impact your implementation. These issues are actively being worked on and will be addressed in a future release. Review the Elastic APM Ruby Agent known issues to help you make informed decisions, such as upgrading to a new version.
+
+% Use the following template to add entries to this page.
+
+% :::{dropdown} Title of known issue
+% **Details** 
+% On [Month/Day/Year], a known issue was discovered that [description of known issue].
+
+% **Workaround** 
+% Workaround description.
+
+% **Resolved**
+% On [Month/Day/Year], this issue was resolved.
+
+:::
+
+_No known issues_

data/docs/release-notes/toc.yml

@@ -0,0 +1,3 @@
+toc:
+  - file: index.md
+  - file: known-issues.md

data/lib/elastic_apm/context_builder.rb

@@ -79,8 +79,11 @@ module ElasticAPM
       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

data/lib/elastic_apm/spies/sidekiq.rb

@@ -24,6 +24,7 @@ module ElasticAPM
     class SidekiqSpy
       ACTIVE_JOB_WRAPPER =
         'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'
+      ACTIVE_JOB_WRAPPER_V8 = 'Sidekiq::ActiveJob::Wrapper'
 
       # @api private
       class Middleware
@@ -50,7 +51,7 @@ module ElasticAPM
         klass = job['class']
 
         case klass
-        when ACTIVE_JOB_WRAPPER
+        when ACTIVE_JOB_WRAPPER, ACTIVE_JOB_WRAPPER_V8
           job['wrapped']
         else
           klass

data/lib/elastic_apm/stacktrace_builder.rb

@@ -24,7 +24,7 @@ module ElasticAPM
   # @api private
   class StacktraceBuilder
     JAVA_FORMAT = /^(.+)\.([^.]+)\(([^:]+):(\d+)\)$/.freeze
-    RUBY_FORMAT = /^(.+?):(\d+)(?::in `(.+?)')?$/.freeze
+    RUBY_FORMAT = /^(.+?):(\d+)(?::in ['`](.+#)?(.+?)')?$/.freeze
 
     RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}.freeze
     JRUBY_ORG_REGEX = %r{org/jruby}.freeze
@@ -77,9 +77,9 @@ module ElasticAPM
       ruby_match = line.match(RUBY_FORMAT)
 
       if ruby_match
-        _, file, number, method = ruby_match.to_a
+        _, file, number, module_name, method = ruby_match.to_a
         file.sub!(/\.class$/, '.rb')
-        module_name = nil
+        module_name&.sub!('#', '')
       else
         java_match = line.match(JAVA_FORMAT)
         _, module_name, method, file, number = java_match.to_a

data/lib/elastic_apm/version.rb

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

data/updatecli-compose.yaml

@@ -0,0 +1,23 @@
+# Config file for `updatecli compose ...`.
+# https://www.updatecli.io/docs/core/compose/
+policies:
+  - name: Handle apm-data server specs
+    policy: ghcr.io/elastic/oblt-updatecli-policies/apm/apm-data-spec:0.6.0@sha256:c0bbdec23541bed38df1342c95aeb601530a113db1ff11715c1c7616ed5e9e8b
+    values:
+      - .ci/updatecli/values.d/scm.yml
+      - .ci/updatecli/values.d/apm-data-spec.yml
+  - name: Handle apm gherkin specs
+    policy: ghcr.io/elastic/oblt-updatecli-policies/apm/apm-gherkin:0.6.0@sha256:dbaf4d855c5c212c3b5a8d2cc98c243a2b769ac347198ae8814393a1a0576587
+    values:
+      - .ci/updatecli/values.d/scm.yml
+      - .ci/updatecli/values.d/apm-gherkin.yml
+  - name: Handle apm json specs
+    policy: ghcr.io/elastic/oblt-updatecli-policies/apm/apm-json-specs:0.6.0@sha256:e5a74c159ceed02fd20515ea76fa25ff81e3ccf977e74e636f9973db86aa52a5
+    values:
+      - .ci/updatecli/values.d/scm.yml
+      - .ci/updatecli/values.d/apm-json-specs.yml
+  - name: Update Updatecli policies
+    policy: ghcr.io/updatecli/policies/autodiscovery/updatecli:0.8.0@sha256:99e9e61b501575c2c176c39f2275998d198b590a3f6b1fe829f7315f8d457e7f
+    values:
+      - .ci/updatecli/values.d/scm.yml
+      - .ci/updatecli/values.d/update-compose.yml