Skip to main content

Redis monitoring and inspection drop-in application using django admin.

Project description

Documentation Status Travis-CI Build Status AppVeyor Build Status Coverage Status Code Quality Status Scrtinizer Status
PyPI Package latest release PyPI Package monthly downloads PyPI Wheel Supported versions Supported imlementations

Redis monitoring and inspection drop-in application using django admin.

  • Free software: BSD license

Features

  • Sever statistics in the admin changelist

  • Key summary in the inspect view

  • Value introspection with pagination for lists and sorted sets

Requirements

OS:

Any

Runtime:

Python 2.7, 3.4, 3.4 or PyPy

Services:

Redis 2.2 or later.

Packages:

Django>=1.3, py-redis>=2.10.0

Don’t have a django project ?

Use the quick start script ! It will create and run a django project on 0.0.0.0:8000 with just the redisboard installed.

With curl:

curl -L https://raw.github.com/ionelmc/django-redisboard/master/run_redisboard.py | tee run_redisboard.py | sh -e

With wget:

wget --no-check-certificate https://raw.github.com/ionelmc/django-redisboard/master/run_redisboard.py -O - | tee run_redisboard.py | sh -e

Don’t want to run on 0.0.0.0:8000 ? Run:

./run_redisboard.py ip:port

Installation guide

Install from pypi, with pip:

pip install django-redisboard

Or with setuptools:

easy_install django-redisboard

Add redisboard to INSTALLED_APPS:

INSTALLED_APPS += ("redisboard", )

After that you need to run:

manage.py syncdb

Or if you use south you can migrate this app:

manage.py migrate redisboard

Then you can add redis servers in the admin. You will see the stats in the changelist.

Redisboard has few css tweaks for the pages (they are optional). If you use staticfiles just run:

manage.py collectstatic

If you do not use django.contrib.staticfiles you must manually symlink the site-packages/redisboard/static/redisboard dir to <your media root>/redisboard.

Optional django settings

REDISBOARD_DETAIL_FILTERS

REDISBOARD_DETAIL_FILTERS - a list of regular expressions to match against the keys in the server details colum. Eg, to only show uptime and list of active databases:

REDISBOARD_DETAIL_FILTERS = ['uptime.*', 'db.*']

To show all the details just use:

REDISBOARD_DETAIL_FILTERS = ['.*']

REDISBOARD_ITEMS_PER_PAGE

REDISBOARD_ITEMS_PER_PAGE - default 100. Used for paginating the items from a list or a sorted set.

Screenshots

Changelist:

https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/changelist.png

Inspect:

https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect.png

Inspect key details:

https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-key.png

Documentation

https://django-redisboard.readthedocs.org/

Development

To run the all tests run:

tox

Changelog

1.1.0 (2015-01-21)

  • Fix broken slowlog display.

1.0.0 (2014-12-10)

  • Show slowlog and cpu usage and more memory stats (contributed by Rick van Hattem)

  • Use pipelines to send commands for faster response (contributed by Rick van Hattem)

  • Added Python 3.3 and 3.4 support.

  • Added a test suite and other minor fixes.

0.2.7 (?)

  • N/A.

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

django-redisboard-1.1.0.tar.gz (273.5 kB view details)

Uploaded Source

Built Distribution

django_redisboard-1.1.0-py2.py3-none-any.whl (21.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-redisboard-1.1.0.tar.gz.

File metadata

File hashes

Hashes for django-redisboard-1.1.0.tar.gz
Algorithm Hash digest
SHA256 cb42d6547589e8091c7ea15f9a3f41146a704e68b0ca67fd863a229d8ea9b195
MD5 027ea47b947bb5d1c24a9ae142a4a3d8
BLAKE2b-256 061d2566f88cd0b089bda4f3b69b1979c03a39b8ca157d2d7992a260d144cc15

See more details on using hashes here.

File details

Details for the file django_redisboard-1.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_redisboard-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 043db35629434ff9cdf3d7ccf68747a49007aa857120e80f2db12da2cc7fbf21
MD5 cb31fb0d14fb061d2724ac0cf890d9e6
BLAKE2b-256 ab82fbe61f1882e7e7842da417099b56c398285ed87f53e91a3564a561c782cc

See more details on using hashes here.

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