diff --git a/changelog/65630.fixed.md b/changelog/65630.fixed.md new file mode 100644 index 00000000000..e8650abcdc1 --- /dev/null +++ b/changelog/65630.fixed.md @@ -0,0 +1 @@ +Added SSH wrapper for logmod diff --git a/salt/client/ssh/wrapper/logmod.py b/salt/client/ssh/wrapper/logmod.py new file mode 100644 index 00000000000..911fd7a1d4c --- /dev/null +++ b/salt/client/ssh/wrapper/logmod.py @@ -0,0 +1,79 @@ +""" +On-demand logging +================= + +.. versionadded:: 2017.7.0 + +The sole purpose of this module is logging messages in the minion. +It comes very handy when debugging complex Jinja templates, for example: + +.. code-block:: jinja + + {%- for var in range(10) %} + {%- do salt["log.info"](var) -%} + {%- endfor %} + +CLI Example: + +.. code-block:: bash + + salt '*' log.error "Please don't do that, this module is not for CLI use!" +""" + +import logging + +log = logging.getLogger(__name__) + +__virtualname__ = "log" + + +def __virtual__(): + return __virtualname__ + + +def debug(message): + """ + Log message at level DEBUG. + """ + log.debug(message) + return True + + +def info(message): + """ + Log message at level INFO. + """ + log.info(message) + return True + + +def warning(message): + """ + Log message at level WARNING. + """ + log.warning(message) + return True + + +def error(message): + """ + Log message at level ERROR. + """ + log.error(message) + return True + + +def critical(message): + """ + Log message at level CRITICAL. + """ + log.critical(message) + return True + + +def exception(message): + """ + Log message at level EXCEPTION. + """ + log.exception(message) + return True