Skip to main content

Flask based dynamic and actionable dashboard for monitoring RQs

Project description


RQ Monitor

RQ Monitor is Flask based more actionable and dynamic web frontend for monitoring your RQ.

GitHub PyPI PyPI - Python Version GitHub issues GitHub pull requests Travis (.org)

Key FeaturesInstallUsageCreditsContributeSimilar ToolLicense

screenshot

Key Features

  • Redis RQ Memory monitoring - Implemented through Lua Scripting
    • Possibly RQ is only using some subset of your redis and some other important data is also you want to keep a close eye on memory
  • All data through DataTables:
    • All jobs, queues, workers are rendered by DataTables so you get additional functionality of sorting, searching, robust pagination.
  • More Ajax less reloading
    • Once after firing up the dashboard no refresh is necessary, almost every refresh is done via ajax.
  • Jobs Filtering Support
    • You can choose jobs from certain queue with certain status
  • Send Signals to Workers
    • Maybe you want to kill some workers and feel too lazy to open up the RQ instance, don't worry rqmonitor has your back, directly send signals to your workers.
  • Highly Scalable Jobs Dashboard
    • Jobs datatable is implemented via serverside with ajax pipelining
  • Last but not the least is beautiful UI
  • More features coming!

Install

  1. Install with pip
    • $ pip install rqmonitor

Usage

Download latest version of rqmonitor from pypi and fire up your command line and type rqmonitor --help.

Usage: rqmonitor [OPTIONS]

  Run the RQ Monitor Flask server.

  All configuration can be set on the command line or through environment
  variables of the form RQ_MONITOR_*. For example RQ_MONITOR_USERNAME.

  A subset of the configuration (the configuration parameters used by the
  underlying flask blueprint) can also be provided in a Python module
  referenced using --config, or with a .cfg file referenced by the
  RQ_MONITOR_SETTINGS environment variable.

Options:
  -b, --bind TEXT                 IP or hostname on which to bind HTTP server
  -p, --port INTEGER              Port on which to bind HTTP server
  --url-prefix TEXT               URL prefix e.g. for use behind a reverse
                                  proxy
  --username TEXT                 HTTP Basic Auth username (not used if not
                                  set)
  --password TEXT                 HTTP Basic Auth password
  -c, --config TEXT               Configuration file (Python module on search
                                  path)
  -u, --redis-url TEXT            Redis URL. Can be specified multiple times.
                                  Default: redis://127.0.0.1:6379
  --refresh-interval, --interval INTEGER
                                  Refresh interval in ms
  --extra-path TEXT               Append specified directories to sys.path
  --debug / --normal              Enter DEBUG mode
  -v, --verbose                   Enable verbose logging
  --help                          Show this message and exit.

Credits

This software majorly uses the following open source packages:

Contribute


  1. Clone repo and create a new branch: $ git checkout https://github.com/pranavgupta1234/rqmonitor -b name_for_new_branch.
  2. Make changes and test
  3. Submit Pull Request with comprehensive description of changes

Similar Tool

License

Apache

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rqmonitor-0.0.5.tar.gz (14.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page