Ruby

Prerequisites

• You need a Sentry account and project
• Ruby 2.4+ and any of the most recent JRuby versions

Features

In addition to capturing errors, you can monitor interactions between multiple services or applications by enabling tracing. You can also collect and analyze performance profiles from real users with profiling.

Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.

Install

gem "sentry-ruby"

gem "stackprof"
gem "sentry-ruby"

Configure

Configuration should happen as early as possible in your application's lifecycle.

require 'sentry-ruby'

Sentry.init do |config|
  config.dsn = 'https://examplePublicKey@o0.ingest.sentry.io/0'

  # get breadcrumbs from logs
  config.breadcrumbs_logger = [:sentry_logger, :http_logger]

  # Add data like request headers and IP for users, if applicable;
  # see https://docs.sentry.io/platforms/ruby/data-management/data-collected/ for more info
  config.send_default_pii = true
  #  performance

  # enable tracing
  # we recommend adjusting this value in production
  config.traces_sample_rate = 1.0
  #  performance
  #  profiling

  # enable profiling
  # this is relative to traces_sample_rate
  config.profiles_sample_rate = 1.0
  #  profiling
end

Verify

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.

Sentry.capture_message("test message")

To view and resolve the recorded error, log into sentry.io and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.