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.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.0.0.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

django_redisboard-1.0.0-py2.py3-none-any.whl (21.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-redisboard-1.0.0.tar.gz
Algorithm Hash digest
SHA256 97d7859d38543e26866c4e9f5c19be7eea3b2d2f08244699673d883caf0421ff
MD5 41edc93b7a6314d9738442dcee1f9963
BLAKE2b-256 fa31765c8d2bd830fa813945f73f6ab7ad429e12e8aa913f52daf330b42139d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_redisboard-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4d03e6dbb5c835dd4d680c713479b5a9c68fa4feef12264c1b98b62dbe566e95
MD5 bda92c7d1c1385d46029bf27385d2049
BLAKE2b-256 334d1df8534fbc26ee7204467be7c956cc4c67ac84d23ec77923c85d2e28cb18

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