Ruby Compatibility Requirements
Compatibility
The Ruby Datadog Trace library is open source - view the GitHub repository for more information.
Supported Ruby interpreters:
Type | Documentation | Version | Support type | Gem version support |
---|
MRI | https://www.ruby-lang.org/ | 3.1 | Full | Latest |
| | 3.0 | Full | Latest |
| | 2.7 | Full | Latest |
| | 2.6 | Full | Latest |
| | 2.5 | Full | Latest |
| | 2.4 | Full | Latest |
| | 2.3 | Full | Latest |
| | 2.2 | Full | Latest |
| | 2.1 | Full | Latest |
| | 2.0 | EOL since June 7th, 2021 | < 0.50.0 |
| | 1.9.3 | EOL since August 6th, 2020 | < 0.27.0 |
| | 1.9.1 | EOL since August 6th, 2020 | < 0.27.0 |
JRuby | https://www.jruby.org | 9.2 | Full | Latest |
Supported web servers:
Supported tracing frameworks:
Full support indicates all tracer features are available.
Deprecated indicates support will transition to Maintenance in a future release.
Maintenance indicates only critical bugfixes are backported until EOL.
EOL indicates support is no longer provided.
Integration instrumentation
Many popular libraries and frameworks are supported out-of-the-box, which can be auto-instrumented. Although they are not activated automatically, they can be activated and configured by using the Datadog.configure
API:
Datadog.configure do |c|
# Activates and configures an integration
c.tracing.instrument :integration_name, options
end
options
is a Hash
of integration-specific configuration settings.
For a list of available integrations, and their configuration options, refer to the following:
Name | Key | Versions Supported: MRI | Versions Supported: JRuby | How to configure | Gem source |
---|
Action Cable | action_cable | >= 5.0 | >= 5.0 | Link | Link |
Action Mailer | action_mailer | >= 5.0 | >= 5.0 | Link | Link |
Action Pack | action_pack | >= 3.2 | >= 3.2 | Link | Link |
Action View | action_view | >= 3.2 | >= 3.2 | Link | Link |
Active Job | active_job | >= 4.2 | >= 4.2 | Link | Link |
Active Model Serializers | active_model_serializers | >= 0.9 | >= 0.9 | Link | Link |
Active Record | active_record | >= 3.2 | >= 3.2 | Link | Link |
Active Support | active_support | >= 3.2 | >= 3.2 | Link | Link |
AWS | aws | >= 2.0 | >= 2.0 | Link | Link |
Concurrent Ruby | concurrent_ruby | >= 0.9 | >= 0.9 | Link | Link |
Dalli | dalli | >= 2.0 | >= 2.0 | Link | Link |
DelayedJob | delayed_job | >= 4.1 | >= 4.1 | Link | Link |
Elasticsearch | elasticsearch | >= 1.0 | >= 1.0 | Link | Link |
Ethon | ethon | >= 0.11 | >= 0.11 | Link | Link |
Excon | excon | >= 0.50 | >= 0.50 | Link | Link |
Faraday | faraday | >= 0.14 | >= 0.14 | Link | Link |
Grape | grape | >= 1.0 | >= 1.0 | Link | Link |
GraphQL | graphql | >= 1.7.9 | >= 1.7.9 | Link | Link |
gRPC | grpc | >= 1.7 | gem not available | Link | Link |
http.rb | httprb | >= 2.0 | >= 2.0 | Link | Link |
httpclient | httpclient | >= 2.2 | >= 2.2 | Link | Link |
httpx | httpx | >= 0.11 | >= 0.11 | Link | Link |
Kafka | ruby-kafka | >= 0.7.10 | >= 0.7.10 | Link | Link |
Makara (via Active Record) | makara | >= 0.3.5 | >= 0.3.5 | Link | Link |
MongoDB | mongo | >= 2.1 | >= 2.1 | Link | Link |
MySQL2 | mysql2 | >= 0.3.21 | gem not available | Link | Link |
Net/HTTP | http | (Any supported Ruby) | (Any supported Ruby) | Link | Link |
Presto | presto | >= 0.5.14 | >= 0.5.14 | Link | Link |
Qless | qless | >= 0.10.0 | >= 0.10.0 | Link | Link |
Que | que | >= 1.0.0.beta2 | >= 1.0.0.beta2 | Link | Link |
Racecar | racecar | >= 0.3.5 | >= 0.3.5 | Link | Link |
Rack | rack | >= 1.1 | >= 1.1 | Link | Link |
Rails | rails | >= 3.2 | >= 3.2 | Link | Link |
Rake | rake | >= 12.0 | >= 12.0 | Link | Link |
Redis | redis | >= 3.2 | >= 3.2 | Link | Link |
Resque | resque | >= 1.0 | >= 1.0 | Link | Link |
Rest Client | rest-client | >= 1.8 | >= 1.8 | Link | Link |
Sequel | sequel | >= 3.41 | >= 3.41 | Link | Link |
Shoryuken | shoryuken | >= 3.2 | >= 3.2 | Link | Link |
Sidekiq | sidekiq | >= 3.5.4 | >= 3.5.4 | Link | Link |
Sinatra | sinatra | >= 1.4 | >= 1.4 | Link | Link |
Sneakers | sneakers | >= 2.12.0 | >= 2.12.0 | Link | Link |
Sucker Punch | sucker_punch | >= 2.0 | >= 2.0 | Link | Link |
Further Reading
Additional helpful documentation, links, and articles: