docs: add link to log rotation tunables details
authorJérôme Benoit <jerome.benoit@sap.com>
Fri, 24 Mar 2023 16:24:24 +0000 (17:24 +0100)
committerJérôme Benoit <jerome.benoit@sap.com>
Fri, 24 Mar 2023 16:24:24 +0000 (17:24 +0100)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
README.md

index 90a1853588922173e76444a6b43380c5e9131865..378c83c8c0a8f1b183d7f2a9fca83d607640b9f4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -103,9 +103,9 @@ But the modifications to test have to be done to the files in the build target d
 | logStatisticsInterval      |                                                  | 60                                                                                                                                                                                                            | integer                                                                                                                                                                                                                             | seconds between charging stations statistics output in the logs                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 | logConsole                 | true/false                                       | false                                                                                                                                                                                                         | boolean                                                                                                                                                                                                                             | output logs on the console                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | logFormat                  |                                                  | simple                                                                                                                                                                                                        | string                                                                                                                                                                                                                              | [winston](https://github.com/winstonjs/winston) log format                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| logRotate                  | true/false                                       | true                                                                                                                                                                                                          | boolean                                                                                                                                                                                                                             | enable daily log files rotation                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| logMaxFiles                | x/"xd" where x is an integer                     | undefined                                                                                                                                                                                                     | integer \| string                                                                                                                                                                                                                   | maximum number of log files                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
-| logMaxSize                 | x/"xk"/"xm"/"xg" where x is a number             | undefined                                                                                                                                                                                                     | number \| string                                                                                                                                                                                                                    | maximum size of log files in bytes, or units of kb, mb, and gb                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| logRotate                  | true/false                                       | true                                                                                                                                                                                                          | boolean                                                                                                                                                                                                                             | enable log files rotation                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| logMaxFiles                | x/"xd" where x is an integer                     | undefined                                                                                                                                                                                                     | integer \| string                                                                                                                                                                                                                   | maximum number of log files: https://github.com/winstonjs/winston-daily-rotate-file#options                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| logMaxSize                 | x/"xk"/"xm"/"xg" where x is a number             | undefined                                                                                                                                                                                                     | number \| string                                                                                                                                                                                                                    | maximum size of log files in bytes, or units of kb, mb, and gb: https://github.com/winstonjs/winston-daily-rotate-file#options                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | logLevel                   | emerg/alert/crit/error/warning/notice/info/debug | info                                                                                                                                                                                                          | string                                                                                                                                                                                                                              | [winston](https://github.com/winstonjs/winston) logging level                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | logFile                    |                                                  | combined.log                                                                                                                                                                                                  | string                                                                                                                                                                                                                              | log file relative path                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | logErrorFile               |                                                  | error.log                                                                                                                                                                                                     | string                                                                                                                                                                                                                              | error log file relative path                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |