Enabling the Ruby Profiler
The profiler is shipped within Datadog tracing libraries. If you are already using APM to collect traces for your application, you can skip installing the library and go directly to enabling the profiler.
The Datadog Profiler requires MRI Ruby 2.1+.
The following operating systems and architectures are supported:
- Linux (GNU libc) x86-64, aarch64
- Alpine Linux (musl libc) x86-64, aarch64
Continuous Profiler is not supported on serverless platforms, such as AWS Lambda.
To begin profiling applications:
If you are already using Datadog, upgrade your agent to version 7.20.2+ or 6.20.2+.
google-protobuf gems to your
gem 'ddtrace', '~> 1.0'
gem 'google-protobuf', '~> 3.0'
Install the gems with
Enable the profiler:
Datadog.configure do |c|
c.profiling.enabled = true
c.env = 'prod'
c.service = 'my-web-app'
c.version = '1.0.3'
Note: For Rails applications, create a
config/initializers/datadog.rb file with the code configuration above.
ddtracerb exec command to your Ruby application start command:
bundle exec ddtracerb exec ruby myapp.rb
bundle exec ddtracerb exec bin/rails s
If starting the application via
ddtracerb exec is not an option (eg. when using the Phusion Passenger web server), you can alternatively start the profiler by adding the following to your application entry point such as
config.ru for a web application:
A minute or two after starting your Ruby application, your profiles will show up on the Datadog APM > Profiler page.
Not sure what to do next?
The Getting Started with Profiler guide takes a sample service with a performance problem and shows you how to use Continuous Profiler to understand and fix the problem.
Additional helpful documentation, links, and articles: