diff options
author | Ivan Kanakarakis <ivan.kanak@gmail.com> | 2020-09-29 14:36:41 +0300 |
---|---|---|
committer | Ivan Kanakarakis <ivan.kanak@gmail.com> | 2020-09-29 14:41:48 +0300 |
commit | b4fd75475638c3318dfd00ea6cf0c2a56504a444 (patch) | |
tree | d0676b6b04a1d36b3ba546e8c76e771a22e96603 /docs | |
parent | d62a10c473f64e389d2d26958c83c83daafe38fd (diff) | |
download | pysaml2-b4fd75475638c3318dfd00ea6cf0c2a56504a444.tar.gz |
Support logging configuration through the python logger
Signed-off-by: Ivan Kanakarakis <ivan.kanak@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/howto/config.rst | 58 |
1 files changed, 49 insertions, 9 deletions
diff --git a/docs/howto/config.rst b/docs/howto/config.rst index c4279974..060f4f68 100644 --- a/docs/howto/config.rst +++ b/docs/howto/config.rst @@ -64,6 +64,55 @@ Configuration directives General directives ------------------ +logging +^^^^^^^ + +The logging configuration format is the python logging format. +The configuration is passed to the python logging dictionary configuration handler, +directly. + +Example:: + + "logging": { + "version": 1, + "formatters": { + "simple": { + "format": "[%(asctime)s] [%(levelname)s] [%(name)s.%(funcName)s] %(message)s", + }, + }, + "handlers": { + "stdout": { + "class": "logging.StreamHandler", + "stream": "ext://sys.stdout", + "level": "DEBUG", + "formatter": "simple", + }, + }, + "loggers": { + "saml2": { + "level": "DEBUG" + }, + }, + "root": { + "level": "DEBUG", + "handlers": [ + "stdout", + ], + }, + }, + +The exapmle configuration above will enable DEBUG logging to stdout. + + +debug +^^^^^ + +Example:: + + debug: 1 + +Whether debug information should be sent to the log file. + additional_cert_files ^^^^^^^^^^^^^^^^^^^^^ @@ -186,15 +235,6 @@ and **other**.:: }, ] -debug -^^^^^ - -Example:: - - debug: 1 - -Whether debug information should be sent to the log file. - entityid ^^^^^^^^ |