Rails

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.init initializes the SDK. 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.init("<YOUR_PROJECT_ID>", environment: "production") do |c|
  c.service_name = "my-app"
  c.service_version = "1.0.0"
end

Record custom traces. (optional)

If you want to explicitly send a trace to Highlight, you can use the start_span method to wrap any code you want to trace.

Highlight.start_span('my-span') do |span|
	# ...
end

Verify your backend traces are being recorded.

Visit the highlight traces portal and check that backend traces are coming in.

Tracing in Ruby Tracing with Other Ruby Frameworks