Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tessus/valkey-stats
A lightweight dashboard to show statistics about a Valkey/Redis server.
https://github.com/tessus/valkey-stats
dashboard php redis redis-stats statistics valkey valkey-stats
Last synced: 25 days ago
JSON representation
A lightweight dashboard to show statistics about a Valkey/Redis server.
- Host: GitHub
- URL: https://github.com/tessus/valkey-stats
- Owner: tessus
- License: mit
- Created: 2024-06-16T03:54:46.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-06-20T09:15:41.000Z (5 months ago)
- Last Synced: 2024-06-21T18:20:49.229Z (5 months ago)
- Topics: dashboard, php, redis, redis-stats, statistics, valkey, valkey-stats
- Language: PHP
- Homepage:
- Size: 94.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# valkey-stats
## Features
- lightweight
- no PHP valkey/redis module required
- connection via IP/port or socket
- password support (including Valkey/Redis 6 ACLs)
- show details
- flush database (async support)
- flush instance (async support)
- command mapping support (when rename-command is used on the server)
- auto refresh
- check for update
## Installation
```
git clone --depth 1 https://github.com/tessus/valkey-stats.git
cd valkey-stats
cp config.template.php config.php
```
## Configuration
### Server information
Servers are defined as an array. There are a few examples in the `config.template.php` file.
Field | Type | Description
----------|---------------|------------------------------------------------------------------
Name | string | name shown in drop-down list (also used for command mapping)
IP/Socket | string | IP address or socket (`unix://`) of the server
Port | integer | port of server, use -1 for socket
Password | string, array | credentials for the server (optional)
string: `password`
array: `['user', 'password']` for Valkey/Redis ACLs
e.g.:
```
$servers = [
[ 'Local', '127.0.0.1', 6379 ],
[ 'Local socket', 'unix:///var/run/valkey.sock', -1 ],
[ 'Local with password', '127.0.0.1', 6379, 'password_here' ],
[ 'Local with user and password', '127.0.0.1', 6379, ['username', 'password_here'] ],
];
```
### Misc options
Name | Default | Description
-----------------|-----------|---------------------------------------------------------------
FLUSHDB | true | Show a 'Flush' button for databases
CONFIRM_FLUSHDB | true | Ask for confirmation before flushing database
FLUSHALL | true | Show a 'Flush All' button for the instance
CONFIRM_FLUSHALL | true | Ask for confirmation before flushing the entire instance
STATUS_LINE | "bottom" | Position of status line: "bottom" or "top"
CHECK_FOR_UPDATE | true | Show a 'Check for update' button
DEBUG | false | debug mode - you don't want to set this to true!
### Command mapping
In case commands have been renamed on the server, there's support to map these commands in the config file.
e.g.:
```
$command = [
'Local' => [ // must be a server name (first field in server array, name shown in drop-down list)
'FLUSHDB' => 'fdb-5dea06694ff64',
'FLUSHALL' => 'fa-5dea067c9bbd6',
'AUTH' => '',
'INFO' => '',
],
];
```
## Screenshot
## Acknowledgements
I found the original script at https://gist.github.com/kabel/10023961