Current Dir: /snap/core22/2955/usr/lib/python3/dist-packages/cloudinit/
[DIR] analyze [ delete | rename ]
[DIR] cmd [ delete | rename ]
[DIR] config [ delete | rename ]
[DIR] distros [ delete | rename ]
[DIR] filters [ delete | rename ]
[DIR] handlers [ delete | rename ]
[DIR] log [ delete | rename ]
[DIR] mergers [ delete | rename ]
[DIR] net [ delete | rename ]
[DIR] reporting [ delete | rename ]
[DIR] sources [ delete | rename ]
[DIR] __pycache__ [ delete | rename ]
[FILE] apport.py [ edit | delete | rename ]
[FILE] atomic_helper.py [ edit | delete | rename ]
[FILE] cloud.py [ edit | delete | rename ]
[FILE] dmi.py [ edit | delete | rename ]
[FILE] event.py [ edit | delete | rename ]
[FILE] features.py [ edit | delete | rename ]
[FILE] gpg.py [ edit | delete | rename ]
[FILE] helpers.py [ edit | delete | rename ]
[FILE] importer.py [ edit | delete | rename ]
[FILE] lifecycle.py [ edit | delete | rename ]
[FILE] netinfo.py [ edit | delete | rename ]
[FILE] performance.py [ edit | delete | rename ]
[FILE] persistence.py [ edit | delete | rename ]
[FILE] registry.py [ edit | delete | rename ]
[FILE] safeyaml.py [ edit | delete | rename ]
[FILE] settings.py [ edit | delete | rename ]
[FILE] signal_handler.py [ edit | delete | rename ]
[FILE] simpletable.py [ edit | delete | rename ]
[FILE] socket.py [ edit | delete | rename ]
[FILE] ssh_util.py [ edit | delete | rename ]
[FILE] stages.py [ edit | delete | rename ]
[FILE] subp.py [ edit | delete | rename ]
[FILE] templater.py [ edit | delete | rename ]
[FILE] temp_utils.py [ edit | delete | rename ]
[FILE] type_utils.py [ edit | delete | rename ]
[FILE] url_helper.py [ edit | delete | rename ]
[FILE] user_data.py [ edit | delete | rename ]
[FILE] util.py [ edit | delete | rename ]
[FILE] version.py [ edit | delete | rename ]
[FILE] warnings.py [ edit | delete | rename ]
[FILE] __init__.py [ edit | delete | rename ]
Viewing: /snap/core22/2955/usr/lib/python3/dist-packages/cloudinit/performance.py
import functools
import logging
import time
LOG = logging.getLogger(__name__)
class Timed:
"""
A context manager which measures and optionally logs context run time.
:param msg: A message that describes the thing that is being measured
:param threshold: Threshold, in seconds. When the context exceeds this
threshold, a log will be made.
:param log_mode: Control whether to log. Defaults to "threshold". Possible
values include:
"always" - Always log 'msg', even when 'threshold' is not reached.
"threshold" - Log when context time exceeds 'threshold'.
"skip" - Do not log. Context time and message are stored in the
'output' and 'delta' attributes, respectively. Used to manually
coalesce with other logs at the call site.
usage:
this call:
```
with Timed("Configuring the network"):
run_configure()
```
might produce this log:
```
Configuring the network took 0.100 seconds
```
"""
def __init__(
self,
msg: str,
*,
threshold: float = 0.01,
log_mode: str = "threshold",
):
self.msg = msg
self.threshold = threshold
self.log_mode = log_mode
self.output = ""
self.start = 0.0
self.delta = 0.0
def __enter__(self):
self.start = time.monotonic()
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.delta = time.monotonic() - self.start
suffix = f"took {self.delta:.3f} seconds"
if "always" == self.log_mode:
LOG.debug("%s %s", self.msg, suffix)
elif "skip" == self.log_mode:
return
elif "threshold" == self.log_mode:
if self.delta > self.threshold:
LOG.debug("%s %s", self.msg, suffix)
self.output = f"{self.msg} {suffix}"
else:
raise ValueError(
f"Invalid Timed log_mode value: '{self.log_mode}'."
)
def timed(msg: str, *, threshold: float = 0.01, log_mode: str = "threshold"):
"""
A decorator which measures and optionally logs context run time.
:param msg: A message that describes the thing that is being measured
:param threshold: Threshold, in seconds. When the context exceeds this
threshold, a log will be made.
:param log_mode: Control whether to log. Defaults to "threshold". Possible
values include:
"always" - Always log 'msg', even when 'threshold' is not reached.
"threshold" - Log when context time exceeds 'threshold'.
usage:
this call:
```
@timed("Configuring the network")
def run_configure():
...
```
might produce this log:
```
Configuring the network took 0.100 seconds
```
"""
def wrapper(func):
@functools.wraps(func)
def decorator(*args, **kwargs):
with Timed(msg, threshold=threshold, log_mode=log_mode):
return func(*args, **kwargs)
return decorator
return wrapper