﷽
When residue server starts it can accept some commands from command-line interface. This document lists these commands.
Please note, some of these commands can also be triggered using admin requests.
Quits the server gracefully
Reloads configurations from same file as initially loaded
Reloads server configuration and reconfigure loggers
Resets the server with following things (be careful in doing this as it may affect connected clients)
- Reloads configurations
- Disconnect all the clients (and remove corresponding tokens)
- Disconnect active sessions
Display history of valid commands (default maximum = 5)
Number of connected clients (dead or alive) that have not yet been removed from the server
Runs client integrity task and cleans all the dead clients
Lists all the connected clients (and DEAD status if they're dead)
List associated key with the rest of the details
Lists all the tokens for selected client (and EXPIRED status if they're expired).
The client ID to see tokens for
Manually run log rotator for specified logger
The logger ID to run log rotation for.
If this option is set the archival task will not run and it will just copy the logs to backup directory.
Only check the schedule for this logger rotation
Displays server stats and number of active sessions
Lists for active sessions (received, sent and how long session has been active for and associated clients if registered)
List dynamic buffer status
List processing queue status
You can also run sampling on the queue by providing sampling. Thread will be stalled for the amount of seconds value you provide (valid value from 3 to 10)
For example
stats queue sampling 6 --client-id unmanaged
It will list the speed of each queue, e.g,
Queue For: unmanaged Active: 8376 Backlog: 7442 Speed: 5 items/s (incl. bulk)
Sampling is done only on a non-empty active queue
Filters stats for specified client. Some of the clients may not be listed as they're only registered when server receives anything from them.
Displays list of logging files for speicified client, logger or levels
Client to display files for (all loggers if no --logger-id specified)
Limit the list to specified logger id (for specified client)
Comma seperated logging levels, e.g, info,error