discourse-sidekiq-monitor/README.md

1.0 KiB

sidekiq-monitor

Exposes an endpoint to show the current status of sidekiq

Build Status Coverage Status

Bug reports

Bug reports should be filed by following the process described here.

Usage

Set the API key in the sidekiq_monitor_key setting.

Then use that key in the X-Sidekiq-Monitor-Key header, to query /sidekiq_monitor/status.json:

curl -H 'X-Sidekiq-Monitor-Key: 1234' localhost:3000/sidekiq_monitor/status.json

If the key is invalid, the endpoint will return a 404 status.

If the key is valid, the endpoint will return a 200 status and:

  • running: true, if sidekiq is running
  • running: false, if sidekiq isn't running