diff --git a/docs/server/source/appendices/log-rotation.md b/docs/server/source/appendices/log-rotation.md index b18c48ab..26f05474 100644 --- a/docs/server/source/appendices/log-rotation.md +++ b/docs/server/source/appendices/log-rotation.md @@ -38,6 +38,8 @@ then the logs will be written to `$HOME/.bigchaindb-monit/logs/`. Log rotation is baked into BigchainDB Server using Python's `logging` module. The logs for BigchainDB Server are rotated when any of the above mentioned files exceeds 209715200 bytes (i.e. approximately 209 MB). +See also: [the BigchainDB Server configuration settings related to logging](../server-reference/configuration.html#log). + ## Tendermint Logging and Log Rotation Tendermint writes its logs to the files: diff --git a/docs/server/source/server-reference/configuration.md b/docs/server/source/server-reference/configuration.md index 47d06de8..bbee2128 100644 --- a/docs/server/source/server-reference/configuration.md +++ b/docs/server/source/server-reference/configuration.md @@ -269,11 +269,11 @@ The full path to the file where logs should be written. The user running `bigchaindb` must have write access to the specified path. -**Log rotation:** Log files have a size limit of 200 MB +**Log rotation:** Log files have a size limit of about 200 MB and will be rotated up to five times. -For example, if we `log.file` is set to `"~/bigchain.log"`, then +For example, if `log.file` is set to `"~/bigchain.log"`, then logs would always be written to `bigchain.log`. Each time the file -`bigchain.log` reaches 200 MB it would be closed and renamed +`bigchain.log` reaches 200 MB it will be closed and renamed `bigchain.log.1`. If `bigchain.log.1` and `bigchain.log.2` already exist they would be renamed `bigchain.log.2` and `bigchain.log.3`. This pattern would be applied up to `bigchain.log.5` after which `bigchain.log.5` would be diff --git a/docs/server/source/simple-deployment-template/network-setup.md b/docs/server/source/simple-deployment-template/network-setup.md index a89c3ac4..60e1dcdb 100644 --- a/docs/server/source/simple-deployment-template/network-setup.md +++ b/docs/server/source/simple-deployment-template/network-setup.md @@ -356,10 +356,6 @@ If you started BigchainDB in the foreground, a `Ctrl + C` or `Ctrl + Z` would sh TBD. -## Log rotation - -Please go over the [document describing log rotation of a BigchainDB node](../appendices/log-rotation.md). - [bdb:software]: https://github.com/bigchaindb/bigchaindb/ [bdb:pypi]: https://pypi.org/project/BigchainDB/#history diff --git a/docs/server/source/simple-deployment-template/troubleshooting.md b/docs/server/source/simple-deployment-template/troubleshooting.md index 2d0311fd..dc825527 100644 --- a/docs/server/source/simple-deployment-template/troubleshooting.md +++ b/docs/server/source/simple-deployment-template/troubleshooting.md @@ -3,6 +3,7 @@ ## General Tips - Check the BigchainDB, Tendermint and MongoDB logs. + For help with that, see the page about [Logging and Log Rotation](../appendices/log-rotation.html). - Try Googling the error message. ## Resolving Tendermint Connectivity Problems