installers/charm/osm-temporal-ui/src/log.py

   1 #!/usr/bin/env python3
   2 # Copyright 2022 Canonical Ltd.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   5 # not use this file except in compliance with the License. You may obtain
   6 # a copy of the License at
   7 #
   8 #         http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13 # License for the specific language governing permissions and limitations
  14 # under the License.
  15 #
  16 # For those usages not covered by the Apache License, Version 2.0 please
  17 # contact: legal@canonical.com
  18 #
  19 # To get in touch with the maintainers, please contact:
  20 # osm-charmers@lists.launchpad.net
  21 #
  22 #
  23 # Learn more at: https://juju.is/docs/sdk
  24
  25 """Define logging helpers."""
  26
  27 import functools
  28
  29
  30 def log_event_handler(logger):
  31     """Log with the provided logger when a event handler method is executed."""
  32
  33     def decorator(method):
  34         @functools.wraps(method)
  35         def decorated(self, event):
  36             logger.info(f"* running {self.__class__.__name__}.{method.__name__}")
  37             try:
  38                 return method(self, event)
  39             finally:
  40                 logger.info(f"* completed {self.__class__.__name__}.{method.__name__}")
  41
  42         return decorated
  43
  44     return decorator