pylog/onaplogging/monkey.py

   1 # Copyright 2018 ke liang <lokyse@163.com>.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #         http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 from typing import Optional
  16
  17 from .mdcContext import patch_logging_mdc
  18 from .logWatchDog import patch_logging_yaml
  19
  20
  21 __all__ = ["patch_all"]
  22
  23
  24 def patch_all(mdc=True, yaml=True):
  25     # type: ( Optional[bool], Optional[bool] ) -> None
  26     """
  27     Patches both MDC contextual information and YAML configuration file to the
  28     logger by default. To exclude any or both set `mdc` and/or `yaml`
  29     parameters to False.
  30
  31     Args:
  32         mdc (bool, optional): Defaults to True.
  33         yaml (bool, optional): Defaults to True.
  34     """
  35
  36     if mdc is True:
  37         patch_logging_mdc()
  38
  39     if yaml is True:
  40         patch_logging_yaml()