Sidekiq instrumentation

In addition to your web application itself, the New Relic Ruby agent (version 3.6.0 and later) can instrument your Sidekiq jobs. The perform method on all Sidekiq workers will be instrumented and appear on your Background Tasks dashboard.

Capturing job arguments

Starting with Ruby agent version 3.6.9, you can optionally configure the Ruby agent to capture Sidekiq job arguments in transaction traces and traced errors. This can be especially useful in attempting to reproduce failed jobs.

By default this feature is off in case your job aarguments contain sensitive information. To enable it, set sidekiq.capture_params to true in your newrelic.yml file.

Note: This feature is distinct from the generic capture_params top-level setting, which controls whether HTTP request parameters are captured on transaction traces and traced errors for web requests. You can configure these two settings independently.

Troubleshooting

If it appears that jobs are not being monitored, review the newrelic_agent.log file generated when the worker starts up. It should indicate whether the agent detects Sidekiq and communicates with the server.

If you need support, note the exact command line that you're using to start Sidekiq.

If you need additional help, get support at support.newrelic.com.