Skip to content

1.10.0

Compare
Choose a tag to compare
@github-actions github-actions released this 06 Mar 15:58
· 4903 commits to master since this release
7b39d18

The release of ddtrace 1.10.0 now supports Ruby 3.2 and 128-bit trace id.

Furthermore, CPU Profiling 2.0 is now in opt-in (that is, disabled by default) beta 3. (Click to expand for details)

You can enable it:

  • Using an environment variable by setting DD_PROFILING_FORCE_ENABLE_NEW=true
  • Or via code by adding to your Datadog.configure block:
Datadog.configure do |c|
  # ... existing configuration ...
  c.profiling.advanced.force_enable_new_profiler = true
end

What to expect from Ruby CPU Profiling 2.0 beta 3?

  • Finer-grained profiling data due to our sampling engine rewritten in C+Rust. The profiler will be able to run more often and get more information while keeping the same 2% overhead target you're used to, and with a lower impact on latency. Especially when looking at the "Code Hotspots" panel for a distributed trace, expect more and finer grained profiles.
  • Thread id information now includes the operating system thread id for Ruby 3.1+, so you'll be able to correlate your thread information when looking at other system monitoring tools
  • Thread names are now collected and you're able to filter your profiles by these names
  • The profiler now exposes a Datadog::Profiling.allocation_count API that can be used to measure how many objects were allocated in parts of your application
  • Experimental support for capturing CPU and Wall-time spent doing Garbage Collection. This is disabled by default as we're still improving the performance of this feature and fixing a few incompatibilities with Ruby Ractors. You can enable it by adding DD_PROFILING_FORCE_ENABLE_GC=true or c.profiling.advanced.force_enable_gc_profiling = true to the instructions seen above.

...with more and faster improvements to come soon!

Give it a try, and we'd love to hear your feedback. Below, you'll find a list of known issues that we're still looking into.

Known issues:

  • Rare incompatibilities with native extensions/libraries.

    Ruby CPU Profiling 2.0 gathers profiling data by sending SIGPROF unix signals to Ruby applications. This is a common approach used by many other profilers, and it may cause system calls performed by native extensions/libraries to be interrupted with an EINTR error code (reference).

    Most native extensions/libraries are unaffected by this issue, but we know of at least one case: when using the mysql2 gem together with versions of libmysqlclient older than 8.0.0 this can lead to failed database requests (reference). The affected libmysqlclient version is known to be present on Ubuntu 18.04, but not 20.04 and later releases.

    We expect these occurrences to be rare, and will be working to both improve the ecosystem as well as to deploy countermeasures in the profiler itself to avoid triggering these issues.

  • Ruby 2.5 and below are missing an API that allows the profiler to detect the currently-active Ruby thread. We have deployed a workaround, but suspect that it may lead to crashes in extremely rare situations. We are still researching a solution for this issue and do not plan on rolling out CPU Profiling 2.0 automatically to Ruby 2.5 and below applications until it is fixed.

  • The disabled-by-default experimental support for capturing CPU and Wall-time spent doing Garbage Collection is incompatible with Ractors due to Ruby upstream bugs (https://bugs.ruby-lang.org/issues/18464 and https://bugs.ruby-lang.org/issues/19112). We plan to work with the Ruby developers to incorporate fixes for these issues.

  • The disabled-by-default experimental support for capturing CPU and Wall-time spent doing Garbage Collection can cause a lot of overhead in Ruby applications with high object allocation rates. We will be fixing this soon!

Added

  • Support Ruby 3.2 (#2601)
  • Publish init container image (beta) for dd-trace-rb injection through K8s admission controller (#2606)
  • Tracing: Support 128 bits trace id (#2543)
  • Tracing: Add tags to integrations (que / racecar / resque/ shoryken / sneakers / qless / delayed_job / kafka / sidekiq / dalli / presto / elasticsearch) (#2619, #2613 , #2608, #2590)
  • Appsec: Introduce AppSec::Instrumentation::Gateway::Argument (#2648)
  • Appsec: Block request when user ID matches rules (#2642)
  • Appsec: Block request base on response addresses matches (#2605)
  • Appsec: Allow to set user id denylist (#2612)
  • Profiling: Show profiler overhead in flamegraph for CPU Profiling 2.0 (#2607)
  • Profiling: Add support for allocation samples to ThreadContext (#2657)
  • Profiling: Exclude disabled profiling sample value types from output (#2634)
  • Profiling: Extend stack collector to be able to record the alloc-samples metric (#2618)
  • Profiling: Add Profiling.allocation_count API for new profiler (#2635)

Changed

  • Tracing: rack instrumentation counts time spent in queue as part of the http_server.queue span (#2591) (@agrobbin)
  • Appsec: Update waf ruleset to 1.5.2 (#2662, #2659, #2598)
  • Appsec: Update libddwaf version to 1.6.2.0.0 (#2614)
  • Profiling: Upgrade profiler to use libdatadog v2.0.0 (#2599)
  • Profiling: Remove support for profiling Ruby 2.2 (#2592)

Fixed

  • Fix broken Ruby VM statistics for Ruby 3.2 (#2600)
  • Tracing: Fix 'uninitialized constant GRPC::Interceptor' with gapic-common gem (#2649)
  • Appsec: Make sure to assign a valid processor to appsec component (#2637)
  • Profiling: Fix profiler not adding the "In native code" placeholder (#2594)
  • Fix profiler detection for google-protobuf installation (#2595)

Read the full changeset and the release milestone