Metadata-Version: 2.4
Name: redis-metrics
Version: 0.1.0
Summary: A Django admin Redis monitoring dashboard with key exploration, live charts, and multi-connection support.
Author: Kaushal Dhungel
License: MIT License
        
        Copyright (c) 2026 Kaushal Dhungel
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/Kaushal-Dhungel/redis-metrics
Project-URL: Repository, https://github.com/Kaushal-Dhungel/redis-metrics
Project-URL: Issues, https://github.com/Kaushal-Dhungel/redis-metrics/issues
Keywords: django,redis,monitoring,admin,cache,celery
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django>=3.2
Requires-Dist: redis>=4.0
Provides-Extra: dev
Requires-Dist: build>=1.2.2; extra == "dev"
Requires-Dist: twine>=5.1.1; extra == "dev"
Dynamic: license-file

# redis-metrics

`redis-metrics` adds a Redis monitoring dashboard directly inside Django admin.

## Features

- Multi-Redis connection support
- Redis health checks
- Live-updating performance charts
- Key explorer with search, paging, delete, and edit support
- Prefix, TTL, and key size analysis
- Slow query visibility via Redis `SLOWLOG`
- Expiry and eviction monitoring
- Celery-aware queue and broker summaries

## Installation

```bash
pip install redis-metrics
```

## Django Setup

Add the app:

```python
INSTALLED_APPS = [
    # ...
    "redis_metrics",
]
```

Optional multi-connection configuration:

```python
REDIS_METRICS_CONNECTIONS = {
    "cache": {
        "LOCATION": "redis://127.0.0.1:6379/0",
        "ROLE": "cache",
        "LABEL": "Cache",
    },
    "celery": {
        "LOCATION": "redis://127.0.0.1:6379/1",
        "ROLE": "celery",
        "LABEL": "Celery",
    },
}
```

Then open Django admin and visit the Redis Metrics dashboard.

## Packaging

Build locally with:

```bash
python -m build
```
