Using highlight.io with Other Ruby Frameworks

H.init("<YOUR_PROJECT_ID>", {
  tracingOrigins: ['localhost', 'example.myapp.com/backend'],
  networkRecording: {
    enabled: true,
    recordHeadersAndBody: true,
  },
});

Install the Highlight Ruby SDK.

Add Highlight to your Gemfile and install with Bundler.

gem "highlight_io"

bundle install

Initialize the Highlight Ruby SDK.

Highlight::H.new initializes the SDK and allows you to call the singleton Highlight::H.instance. Setting your project ID also lets Highlight record errors for background tasks and processes that aren't associated with a frontend session.

require "highlight"

Highlight::H.new("<YOUR_PROJECT_ID>", environment: "production") do |c|
  c.service_name = "my-app"
  c.service_version = "1.0.0"
end

Add Highlight tracing.

trace will automatically record raised exceptions and send them to Highlight.

require "highlight"

Highlight::H.instance.trace(nil, nil) do
  # your code here
end

Verify your errors are being recorded.

Now that you've set up the Middleware, verify that the backend error handling works by consuming an error from traced code.

Record custom errors. (optional)

If you want to explicitly send an error to Highlight, you can use the record_exception method within traced code.

Highlight::H.instance.record_exception(e)

Set up logging.

Start sending logs to Highlight! Follow the logging setup guide to get started.

Error Monitoring in Ruby Using highlight.io with Ruby on Rails