Skip to main content

docs

Documentation Status

tests

Travis-CI Build Status AppVeyor Build Status Requirements Status
Coverage Status Coverage Status
Code Quality Status Scrutinizer Status Codacy Code Quality Status CodeClimate Quality Status

package

PyPI Package latest release PyPI Package monthly downloads PyPI Wheel Supported versions Supported implementations

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.

REDISBOARD_SOCKET_TIMEOUT

REDISBOARD_SOCKET_TIMEOUT - default None. Socket operations time out after this many seconds.

REDISBOARD_SOCKET_CONNECT_TIMEOUT

REDISBOARD_SOCKET_CONNECT_TIMEOUT - default None. Socket connect operation times out after this many seconds.

REDISBOARD_SOCKET_KEEPALIVE

REDISBOARD_SOCKET_KEEPALIVE - default None. Enables or Disables socket keepalive.

REDISBOARD_SOCKET_KEEPALIVE_OPTIONS

REDISBOARD_SOCKET_KEEPALIVE_OPTIONS - default None. Additional options for socket keepalive.

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/en/latest/

Development

To run the all tests run:

tox

Changelog

1.2.2 (2015-10-11)

  • Exception handling for AWS ElastiCache Redis or any Redis that does not have DEBUG OBJECT command.

  • Enabled Redis keys to be inspected despite not having details from DEBUG OBJECT command.

1.2.1 (2015-06-30)

  • Fixed a bug on Python 3 (no xrange).

  • Fixed some issues the run_redisboard.py bootstrapper had with virtualenv.

1.2.0 (2015-02-21)

  • Add REDISBOARD_SOCKET_TIMEOUT, REDISBOARD_SOCKET_CONNECT_TIMEOUT, REDISBOARD_SOCKET_KEEPALIVE and REDISBOARD_SOCKET_KEEPALIVE_OPTIONS options.

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.

Release files for django-redisboard 1.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-redisboard 1.2.2
File Size Uploaded
django-redisboard-1.2.2.tar.gz 281.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for django-redisboard 1.2.2
File Interpreter ABI Platform
django_redisboard-1.2.2-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 304.6 kB

Release files / django-redisboard-1.2.2.tar.gz

Download URL django-redisboard-1.2.2.tar.gz
Size 281.9 kB
Tags Source
SHA-256 checksum
How to use checksums
6d92ff070fe5ace87df07e74676e2467cb18c7649830a658e1da0ba8ce8b8b47
BLAKE2b-256 checksum
How to use checksums
a705b7d4397192850a777cbfa180faf22059a2e59cf2ff6bdfe2b0c5ae3d4469
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / django_redisboard-1.2.2-py2.py3-none-any.whl

Download URL django_redisboard-1.2.2-py2.py3-none-any.whl
Size 22.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
643ae79cecf46a7548aada46d1f028d61315770838d34872115ecf6c95ac7366
BLAKE2b-256 checksum
How to use checksums
14ae2424ab94ca547f0c0f438b4306b8809f66672d1e9d719687fa8b4e112ec0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

9.0.0

2 release files

8.4.0

2 release files

8.3.1

2 release files

8.3.0

2 release files

8.2.2

2 release files

8.2.1

2 release files

8.2.0

2 release files

8.1.0

2 release files

8.0.1

2 release files

8.0.0

2 release files

7.0.1

2 release files

7.0.0

2 release files

6.0.0

2 release files

5.0.0

2 release files

4.1.1

2 release files

4.1.0

2 release files

4.0.0

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.0.0

2 release files

This release

1.2.2 This release

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page