Skip to main content

Ruby

Supported platforms#

LinuxmacOSWindowsDocker

Profiling Ruby applications#

Add the pyroscope gem to your Gemfile:

bundle add pyroscope

Basic Configuration#

Add the following code to your application. If you're using rails, put this into config/initializers directory. This code will initialize pyroscope profiler and start profiling:

require 'pyroscope'
Pyroscope.configure do |config|  config.application_name = "my.ruby.app" # replace this with some name for your application  config.server_address   = "http://my-pyroscope-server:4040" # replace this with the address of your pyroscope server  # config.auth_token     = "{YOUR_API_KEY}" # optionally, if authentication is enabled, specify the API keyend

Tags#

Pyroscope ruby integration provides a number of ways to tag profiling data. For example, you can provide tags when you're initializing the profiler:

require 'pyroscope'
Pyroscope.configure do |config|  config.application_name = "my.ruby.app"  config.server_address   = "http://my-pyroscope-server:4040"
  config.tags = {    "hostname" => ENV["HOSTNAME"],  }end

or you can dynamically tag certain parts of your code:

Pyroscope.tag_wrapper({ "controller": "slow_controller_i_want_to_profile" }) do  slow_codeend

Auto-Instrumentation#

Rails#

By default, if you add pyroscope to a rails application it will automatically tag your actions with action="<controller_name>/<action_name>" tag.

To disable rails autoinstrumentation, set autoinstrument_rails to false:

Pyroscope.configure do |config|  config.autoinstrument_rails = false  # more configurationend

Sending data to Phlare with Pyroscope Ruby integration#

Starting with weekly-f8 you can ingest pyroscope profiles directly to phlare.

require "pyroscope"
Pyroscope.configure do |config|  config.application_name = "phlare.ruby.app"  config.server_address = "<URL>"  config.basic_auth_username='<User>'  config.basic_auth_password='<Password>'  config.tenant_id='<TenantID>'end

To configure Ruby integration to send data to Phlare, replace the <URL> placeholder with the appropriate server URL. This could be the grafana.com Phlare URL or your own custom Phlare server URL.

If you need to send data to grafana.com, you'll have to configure HTTP Basic authentication. Replace <User> with your grafana.com stack user and <Password> with your grafana.com API key.

If your Phlare server has multi-tenancy enabled, you'll need to configure a tenant ID. Replace <TenantID> with your Phlare tenant ID.

Ruby profiling examples#

Check out the following resources to learn more about Ruby profiling:

Frame width represents CPU time per function
Pyroscope