valkey-stats

Features

• lightweight
• no PHP valkey/redis module required
• tls support (PHP valkey/redis module required)
• connection via IP/hostname/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 tls options and command mapping)
IP/Socket	string	IP address, hostname, 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'] ],
	[ 'TLS connection with user and password', 'tls://localhost', 6379, ['username', 'password_here'] ],
];

TLS configuration

If an IP address or hostname starts with tls://, a TLS context is created for that connection. The default-options apply to all TLS connections and can be overridden by connection specific options.

For a list of possible options, please have a look at the SSL context options in the PHP manual.

$tls = [
	'default-options' => [ // these are the default TLS options
		'verify_peer'       => true,
		'verify_peer_name'  => true,
		'allow_self_signed' => false,
	],
	'TLS connection with user and password' => [ // must be a server name (first field in server array, name shown in drop-down list)
		'local_cert' => '/path/to/client.pem',
		'local_pk'   => '/path/to/clientkey.pem',
		'cafile'     => '/path/to/cacert.crt'
	]
];

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
USE_MODULE_IF_LOADED	true	Use the php extension, if loaded
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. Please note that this has been deprecated for years and is not supported when using the extension (module).

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