This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Ruby Agent version 3.x Ruby Agent version 1.x »

›

Ruby Agent version 2.x

Ruby Agent version 2.x

2.12.0 (2019-10-01)

Changed

disabled_spies renamed to disabled_instrumentations with fallback #539
Rename set_tag to set_label and deprecate set_tag #543
Allow non-String label values #543

Fixed

Handles a case where stacktrace frames are empty #538

Deprecated

Deprecate set_tag #543

2.11.0 (2019-09-23)

Added

Add Rails module with #start method to run Rails setup explicitly #522
Support for log/trace correlation #527

Changed

Split dot-separated span.type into .type, .subtype and .action (auto-upgrades dot style) #531

2.10.1

Fixed

Fixed loading options from a config file specified by ELASTIC_APM_CONFIG_FILE #518
Fixed an issue with CentralConfig polling not starting #525

Added

Support for chained exceptions #488

2.10.0

Added

Add Ruby specific metrics #437
Support for APM Agent Configuration via Kibana #464
Change span name format and add command to context’s db.statement for MongoSpy #488

Changed

ElasticAPM.report and ElasticAPM.report_message return the string ID of the generated Error objects #507

2.9.1 (2019-06-28)

Fixed

Use system CA certificate if none is specified #460

2.9.0 (2019-06-25)

Security

NB: If you are using a custom CA cert via server_ca_cert, versions of the agent prior to 2.9.0 may not have validated the certificate of APM Server correctly.

Added

Add transaction.type to errors #434
Add cookies to request.cookies #448

Fixed

Fix support for older versions of Http.rb #438
Strip Cookie and Set-Cookie from headers #448
Fix disabling SSL verification #449

2.8.1 (2019-05-29)

Fixed

Database statements are properly truncated #431

2.8.0 (2019-05-20)

Added

The option stack_trace_limit #424

Changed

Use standardized User-Agent #419

Fixed

error.culprit is properly truncated to 1024 characters #418
Force convert transaction.context.response.status_code to integer #423

2.7.0 (2019-05-07)

Added

Added disable_start_message for those wanting complete silence on boot #397

Changed

Attempt to strip secrets from request.env #410

Fixed

Rewritten most of the internal transport code, streaming events to APM Server #372
Re-added default_tags #395
A bug in the Faraday spy when disabling the Net::HTTP spy #396
Fix disabling the ActionDispatch spy #399

2.6.1 (2019-03-28)

Fixed

Setting config_file via ELASTIC_APM_CONFIG_FILE #363
Stopping the Metrics collector when it is disabled #357
HTTP proxy settings can now be set by ENV variable #367

2.6.0 (2019-03-19)

Deprecated

ElasticAPM.build_context now takes two keyword arguments instead of a single, normal argument. Docs.
The option capture_body has a string value instead of boolean. Docs.

Both APIs are backwards compatible with fallbacks and deprecation warnings, scheduled for removal in next major release.

Added

Configuration options to use an HTTP proxy #352

Changed

Errors get their own contexts, perhaps leading to slightly different (but more correct) results. #335
The agent no longer starts automatically inside Rails' console #343

Fixed

Fixed reading available memory on older Linux kernels #351
Don’t apply filters to original response headers #354

2.5.0 (2019-03-01)

Added

Added the option active that will prevent the agent from starting if set to false #338

Fixed

Fix error with capture_body and nested request bodies #339

2.4.0 (2019-02-27)

Added

Added option to specify a custom server CA certificate #315

Changed

NB: Default value of option capture_body flipped to false to align with other agents. Set capture_body: true in your configuration to get them back. #324

Fixed

Reading CPU stats from /proc/stat on RHEL #312
Change TraceContext to differentiate between id and parent_id #326
capture_body will now force encode text bodies to utf-8 when possible #332

2.3.1 (2019-01-31)

Added

Read container info from Docker or Kupernetes #303

Fixed

Fix logging exceptions when booting via Railtie #306

2.3.0 (2019-01-29)

Added

Support for Metrics #276

2.2.0 (2019-01-22)

Added

Support for OpenTracing #273
Add capture\_\* options #279
Evaluate the config file as ERB #288

Changed

Rename Traceparent object to TraceContext #271

Fixed

An issue where Spans would not get Stacktraces attached #282
Skip caller unless needed #287

2.1.2 (2018-12-07)

Fixed

Fix truncation of transaction.request.url values #267
Fix Faraday calls with url_prefix #263
Force span.context.http.status_code to be an integer

2.1.1 (2018-12-04)

Fixed

Set traceparent span.id to transaction id when span is missing #261

2.1.0 (2018-12-04)

Added

Support for Faraday #249

Fixed

Truncate keyword fields to 1024 chars #240
Lazy boot worker threads on first event. Fixes apps using Puma’s preload_app! #239
Fix missing disable_send implementation #257
Add warnings for invalid config options #254

2.0.1 (2018-11-15)

Fixed

Stop sending span.start #234

2.0.0 (2018-11-14)

Version adds support for APM Server 6.5 and needs at least that.

Added

Support for APM Server 6.5 (Intake v2)
Support for Distributed Tracing (beta)
Support for RUM Agent correlation (Distributed Tracing)
Support for HTTP.rb (Instrumentation + Distributed Tracing)

Changed

Custom instrumentation APIs #209
Tag keys will convert disallowed chars to _
Default log level changed to info
Laxed version requirement of concurrent-ruby
Change log_level to only concern agent log

Deprecated

APIs:

ElasticAPM.transaction
ElasticAPM.span

Options:

compression_level
compression_minimum_size
debug_http
debug_transactions
flush_interval
http_open_timeout
http_read_timeout
enabled_environments
disable_environment_warning

Some options that used to take a certain unit for granted now expects explicit units – but will fall back to old default.

Removed

Support for APM Server versions prior to 6.5.
Support for Ruby 2.2 (eol)

« Ruby Agent version 3.x Ruby Agent version 1.x »