From 29eb161e2404e2a9b1cd049342356277ac85d4d1 Mon Sep 17 00:00:00 2001 From: George McCabe <23407799+georgemccabe@users.noreply.github.com> Date: Mon, 30 Oct 2023 13:26:24 -0600 Subject: [PATCH] add documentation about new config variable LOG_TO_TERMINAL_ONLY --- docs/Users_Guide/glossary.rst | 10 +++++++++- docs/Users_Guide/systemconfiguration.rst | 13 +++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/Users_Guide/glossary.rst b/docs/Users_Guide/glossary.rst index 7aa8545ae5..1a69b95830 100644 --- a/docs/Users_Guide/glossary.rst +++ b/docs/Users_Guide/glossary.rst @@ -2287,7 +2287,15 @@ METplus Configuration Glossary LOG_METPLUS Path to the METplus log file. Control the timestamp appended to the filename with :term:`LOG_TIMESTAMP_TEMPLATE`. - Set this variable to an empty string to turn off all logging. + Set this variable to an empty string or set :term:`LOG_TO_TERMINAL_ONLY` + = True to turn off all file logging and write all logs to the screen. + + | *Used by:* All + + LOG_TO_TERMINAL_ONLY + Set to True to skip writing any log files and instead send all log output + to the screen. Sets :term:`LOG_METPLUS` to an empty string if True. + Defaults to False. | *Used by:* All diff --git a/docs/Users_Guide/systemconfiguration.rst b/docs/Users_Guide/systemconfiguration.rst index 15efdfbeef..bca6adb1db 100644 --- a/docs/Users_Guide/systemconfiguration.rst +++ b/docs/Users_Guide/systemconfiguration.rst @@ -340,6 +340,19 @@ to the METplus log file:: If set to false/no, the output is written to a separate file in the log directory named after the application. + +.. _log_to_terminal_only: + +LOG_TO_TERMINAL_ONLY +"""""""""""""""""""" + +If set to True, all log output is written to the screen only. +This includes output from commands that are run, e.g. MET commands. +No log files will be created and :ref:`log_metplus` will be set to an empty +string. :: + + LOG_TO_TERMINAL_ONLY = True + Log Level Information ^^^^^^^^^^^^^^^^^^^^^