Exposes an endpoint to show the current status of sidekiq
Перейти к файлу
Leo McArdle 34178b637e
Add bug reports section
2019-05-29 13:59:40 +01:00
app/controllers/sidekiq_monitor expose monitoring endpoint 2018-08-08 18:54:31 +01:00
config expose monitoring endpoint 2018-08-08 18:54:31 +01:00
jobs/scheduled expose monitoring endpoint 2018-08-08 18:54:31 +01:00
lib expose monitoring endpoint 2018-08-08 18:54:31 +01:00
spec expose monitoring endpoint 2018-08-08 18:54:31 +01:00
.gitignore set up travis 2018-08-08 13:31:15 +01:00
.travis.yml set up travis 2018-08-08 13:31:15 +01:00
CODE_OF_CONDUCT.md See PR for details 2019-05-29 13:58:17 +01:00
LICENSE Initial commit 2018-08-02 11:32:11 +01:00
README.md Add bug reports section 2019-05-29 13:59:40 +01:00
plugin.rb expose monitoring endpoint 2018-08-08 18:54:31 +01:00

README.md

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