logInfo¶
- lsst.pipe.base.logInfo(obj, prefix, logLevel=10, metadata=None, logger=None)¶
Log timer information to
obj.metadata
andobj.log
.- Parameters:
- obj
lsst.pipe.base.Task
-type orNone
A
Task
or any other object with these two attributes:metadata
an instance ofTaskMetadata
(or other object withadd(name, value)
method).log
an instance oflogging.Logger
or subclass.
If
None
, at least one ofmetadata
orlogger
should be passed or this function will do nothing.- prefix
str
Name prefix, the resulting entries are
CpuTime
, etc.. For example timeMethod usesprefix = Start
when the method begins andprefix = End
when the method ends.- logLevel
int
, optional Log level (an
logging
level constant, such aslogging.DEBUG
).- metadata
lsst.pipe.base.TaskMetadata
, optional Metadata object to write entries to, overriding
obj.metadata
.- logger
logging.Logger
Log object to write entries to, overriding
obj.log
.
- obj
Notes
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 usedin differential measurements; the time reference point is undefined.
MaxRss
: maximum resident set size.
All logged resource information is only for the current process; child processes are excluded.
Deprecated since version v24: logInfo has been replaced by lsst.utils.timer.logInfo. Will be removed after v25.