From 9006ff6979e9968a08abf920b6cdac315914b131 Mon Sep 17 00:00:00 2001 From: James Elliott Date: Mon, 1 May 2023 13:44:39 +1000 Subject: [PATCH] docs: include stdout information about complete logs (#5346) Signed-off-by: James Elliott --- docs/content/en/reference/guides/troubleshooting.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/content/en/reference/guides/troubleshooting.md b/docs/content/en/reference/guides/troubleshooting.md index 96f0b07d9..8e984dfbe 100644 --- a/docs/content/en/reference/guides/troubleshooting.md +++ b/docs/content/en/reference/guides/troubleshooting.md @@ -30,6 +30,19 @@ log files. In addition the [log level](../../configuration/miscellaneous/logging Complete logs means at minimum from the [log severity line](#log-severity-line) until the actual issue occurs. Though more than this may be included at the users discretion. +### Output + +Logging can be [configured](../../configuration/miscellaneous/logging.md) to output to both a file and stdout / console +/ docker logs. + +- If you configure the [file_path] option with the [keep_stdout] configuration option enabled then you will only be + required to supply the stdout / console / docker logs and should ignore the file logs. +- If you configure the [file_path] option without the [keep_stdout] configuration option enabled then you will be + required to join the stdout / console / docker logs with the file logs. + +[keep_stdout]: ../../configuration/miscellaneous/logging.md#keepstdout +[file_path]: ../../configuration/miscellaneous/logging.md#filepath + ### Large Amount of Logs In instances where the logs are substantial we will accept truncated logs. There are however some very intentional rules