Redis monitoring and inspection drop-in application using django admin.
If you just want to run redisboard quickly do this::
pip install django-redisboard
redisboard
Don't want to run on 0.0.0.0:8000? Run::
redisboard ip:port
Want a password that ain't random (you might need to rm -rf ~/.redisboard first tho)? Run::
redisboard --password=foobar
Install from pypi, with pip::
pip install django-redisboard
Add redisboard to INSTALLED_APPS:
::
INSTALLED_APPS += ("redisboard", )
After that you need to run::
manage.py migrate
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 /redisboard.
======================================= ====
Setting name Description
======================================= ====
REDISBOARD_CONNECTION_POOL_OPTIONS Extra connection options. Default: {}. Example:
.. sourcecode:: python
REDISBOARD_CONNECTION_POOL_OPTIONS = {'socket_timeout': 60, 'socket_connect_timeout': 10}
REDISBOARD_DECODER_CLASS Default: 'redisboard.data.UTF8BackslashReplaceDecoder'.
REDISBOARD_DISPLAY_CLASS Default: 'redisboard.data.TabularDisplay'.
REDISBOARD_VALUE_QUERY_CLASS Default: 'redisboard.data.ValueQuery'.
REDISBOARD_LENGTH_QUERY_CLASS Default: 'redisboard.data.LengthQuery'.
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:
.. sourcecode:: python
REDISBOARD_DETAIL_FILTERS = ['uptime.*', 'db.*']
To show all the details just use:
.. sourcecode:: python
REDISBOARD_DETAIL_FILTERS = ['.*']
REDISBOARD_DETAIL_CONVERTERS Mapping of regexes to functions to convert those values. Checkout the sourcecode for what's
available.
REDISBOARD_SLOWLOG_NUM Number of slowlog entries to show. Default: 10.
REDISBOARD_SCAN_COUNT Count used for the various scan commands. Affects pagination for key list and key details.
Default: 1000.
REDISBOARD_STRING_PAGINATION Count used just for paginating string values. Default: 10000
======================================= ====
Screenshot of the changelist:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/changelist.png :alt: Screenshot of the changelist
Screenshot of inspecting:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect.png :alt: Screenshot of inspecting
Screenshot of inspecting a sorted set:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-sorted-set.jpg :alt: Screenshot of inspecting a sorted set
Screenshot of inspecting a db:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-db.jpg :alt: Screenshot of inspecting a db
Screenshot of inspecting a big string:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-big-string.jpg :alt: Screenshot of inspecting a big string
Screenshot of inspecting a hash:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-hash.jpg :alt: Screenshot of inspecting a hash
Screenshot of inspecting a hash with binary values:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-binary-hash.jpg :alt: Screenshot of inspecting a hash with binary values
Screenshot of inspecting a binary string:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-binary-string.jpg :alt: Screenshot of inspecting a binary string
Screenshot of inspecting a binary key:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-binary-key.jpg :alt: Screenshot of inspecting a binary key
Screenshot of inspecting a set:
.. image:: https://raw.githubusercontent.com/ionelmc/django-redisboard/master/docs/inspect-set.jpg :alt: Screenshot of inspecting a set
https://django-redisboard.readthedocs.org/en/latest/
To run the all tests run::
tox
REDISBOARD_DETAIL_FILTERS).attrs.--version CLI option.REDISBOARD_DETAIL_CONVERTERS.REDISBOARD_DECODER_CLASS, REDISBOARD_DISPLAY_CLASS, REDISBOARD_VALUE_QUERY_CLASS and
REDISBOARD_LENGTH_QUERY_CLASS.sampling_size and sampling_threshold models fields have been removed, and the REDISBOARD_ITEMS_PER_PAGE
was removed and replaced with REDISBOARD_SCAN_COUNT and REDISBOARD_STRING_PAGINATION.REDISBOARD_DETAIL_CONVERTERS for customizing display of server details somewhat.REDISBOARD_SLOWLOG_NUM option for limiting the slowlow displayed.REDISBOARD_DETAIL_FILTERS setting was changed.__del__ (as a fallback).
There shouldn't be any connection leaks anymore. If the DEBUG setting is True then warnings
will be issued should any connection be closed via __del__.--debug (to enable DEBUG and autoreload) and --decoder (to load a different data decoder) in the redisboard CLI.--password killing the django session (it won't change the password and invalidate session if it's identical).--password CLI option to update the password regardless if the local sqlite was created or not.Drop support for old Python/Django. Minimum requirements are now Python 3.6 and Django 2.2.
Fixed various issues with newer Django (up to 4.0):
default_auto_field - fixes Django complaining about missing migrations if you have a custom DEFAULT_AUTO_FIELD
in settings.#39 <https://github.com/ionelmc/django-redisboard/pull/39>_.#41 <https://github.com/ionelmc/django-redisboard/pull/41>_.#43 <https://github.com/ionelmc/django-redisboard/pull/43>_.redisboard CLI with newer Django
(migrations will run now).favicon.ico and handler in the redisboard CLI.out.#33 <https://github.com/ionelmc/django-redisboard/pull/33>_.run_redisboard.py script to a redisboard bin and fixed Django 2.x issues.#37 <https://github.com/ionelmc/django-redisboard/pull/37>_.#15 <https://github.com/ionelmc/django-redisboard/issues/15>).
Contributed by Erik Telepovský in #29 <https://github.com/ionelmc/django-redisboard/pull/29>.#28 <https://github.com/ionelmc/django-redisboard/pull/28>_.#26 <https://github.com/ionelmc/django-redisboard/pull/26>_.#25 <https://github.com/ionelmc/django-redisboard/pull/25>_.DEBUG OBJECT (LRU, Address, Length etc). Now OBJECT [REFCOUNT|ENCODING|IDLETIME] is used instead. BACKWARDS INCOMPATIBLExrange).run_redisboard.py bootstrapper had with virtualenv.REDISBOARD_SOCKET_TIMEOUT, REDISBOARD_SOCKET_CONNECT_TIMEOUT, REDISBOARD_SOCKET_KEEPALIVE and
REDISBOARD_SOCKET_KEEPALIVE_OPTIONS options.FAQs
Redis monitoring and inspection drop-in application using django admin.
We found that django-redisboard demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.