2.6 KiB
logrotate
The rippled logrotate command closes and reopens the log file. This is intended to help with log rotation on Linux file systems.
Most linux systems come preinstalled with logrotate. Application specific log rotation scripts are placed in /etc/logrotate.d
The following script is a sample that can be created as /etc/logrotate.d/rippled
/var/log/rippled/*.log {
daily
minsize 200M
rotate 7
nocreate
missingok
notifempty
compress
compresscmd /usr/bin/nice
compressoptions -n19 ionice -c3 gzip
compressext .gz
postrotate
/opt/ripple/bin/rippled --conf /opt/ripple/etc/rippled.cfg logrotate
endscript
}
Parameters such as minsize and rotate can be changed depending on the log_level set in rippled.cfg. This sample script is based on standard log_level and will store approximately 2 weeks worth of logs in a compressed format.
Note: Only one system logrotate script should exist per application. Please ensure that you do not have any other log rotation that handles the same directory.
The logrotate method is an admin method that cannot be run by unprivileged users.
Request Format
An example of the request format:
WebSocket
{
"id": "lr1",
"command": "logrotate"
}
Commandline
rippled logrotate
The request includes no parameters.
Response Format
An example of a successful response:
JSON-RPC
200 OK
{
"result" : {
"message" : "The log file was closed and reopened.",
"status" : "success"
}
}
Commandline
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
{
"result" : {
"message" : "The log file was closed and reopened.",
"status" : "success"
}
}
The response follows the [standard format][], with a successful result containing the following fields:
Field |
Type | Description |
|---|---|---|
message |
String | On success, contains the message The log file was closed and reopened. |
Possible Errors
- Any of the [universal error types][].
{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}