- lsst.utils.timer.logInfo(obj: Any, prefix: str, logLevel: int = 10, metadata: MutableMapping | None = None, logger: Logger | None = None, stacklevel: int | None = None) None ¶
Log timer information to
An object with both or one these two attributes:
dict-like container for storing metadata. Can use the
add(name, value)method if found, else will append entries to a list.
logan instance of
None, at least one of
loggershould be passed or this function will do nothing.
Name prefix, the resulting entries are
CpuTime, etc.. For example
prefix = Startwhen the method begins and
prefix = Endwhen the method ends.
Metadata object to write entries to, overriding
Log object to write entries to, overriding
The stack level to pass to the logger to adjust which stack frame is used to report the file information. If
Nonethe stack level is computed such that it is reported as the first package outside of the utils package. If a value is given here it is adjusted by 1 to account for this caller.
Logged items include:
Utc: UTC date in ISO format (only in metadata since log entries have timestamps).
CpuTime: System + User CPU time (seconds). This should only be used
in differential measurements; the time reference point is undefined.
MaxRss: maximum resident set size. Always in bytes.
All logged resource information is only for the current process; child processes are excluded.
The metadata will be updated with a
__version__field to indicate the version of the items stored. If there is no version number it is assumed to be version 0.
MaxResidentSetSizeunits are platform-dependent.
MaxResidentSetSizewill be stored in bytes.