22 """Utilities for measuring execution time.
24 from __future__
import absolute_import, division
30 from lsst.log
import Log, log
32 __all__ = [
"logInfo",
"timeMethod"]
36 """Log ``(name, value)`` pairs to ``obj.metadata`` and ``obj.log``
40 obj : `lsst.pipe.base.Task`-type
41 A `~lsst.pipe.base.Task` or any other object with these two attributes:
43 - ``metadata`` an instance of `lsst.daf.base.PropertyList`` (or other object with
44 ``add(name, value)`` method).
45 - ``log`` an instance of `lsst.log.Log`.
48 A sequence of ``(name, value)`` pairs.
50 Log level (an `lsst.log` level constant, such as `lsst.log.Log.DEBUG`).
53 for name, value
in pairs:
55 obj.metadata.add(name, value)
56 except Exception
as e:
57 obj.log.fatal(
"%s.metadata.add(name=%r, value=%r) failed with error=%s",
58 type(obj).__name__, name, value, e)
59 strList.append(
"%s=%s" % (name, value))
60 log(obj.log.getName(), logLevel,
"; ".join(strList))
63 def logInfo(obj, prefix, logLevel=Log.DEBUG):
64 """Log timer information to ``obj.metadata`` and ``obj.log``.
68 obj : `lsst.pipe.base.Task`-type
69 A `~lsst.pipe.base.Task` or any other object with these two attributes:
71 - ``metadata`` an instance of `lsst.daf.base.PropertyList`` (or other object with
72 ``add(name, value)`` method).
73 - ``log`` an instance of `lsst.log.Log`.
76 Name prefix, the resulting entries are ``CpuTime``, etc.. For example timeMethod uses
77 ``prefix = Start`` when the method begins and ``prefix = End`` when the method ends.
79 Log level (an `lsst.log` level constant, such as `lsst.log.Log.DEBUG`).
85 - ``Utc``: UTC date in ISO format (only in metadata since log entries have timestamps).
86 - ``CpuTime``: CPU time (seconds).
87 - ``MaxRss``: maximum resident set size.
89 All logged resource information is only for the current process; child processes are excluded.
91 cpuTime = time.clock()
92 utcStr = datetime.datetime.utcnow().isoformat()
93 res = resource.getrusage(resource.RUSAGE_SELF)
94 obj.metadata.add(name=prefix +
"Utc", value=utcStr)
97 (prefix +
"CpuTime", cpuTime),
98 (prefix +
"UserTime", res.ru_utime),
99 (prefix +
"SystemTime", res.ru_stime),
100 (prefix +
"MaxResidentSetSize", int(res.ru_maxrss)),
101 (prefix +
"MinorPageFaults", int(res.ru_minflt)),
102 (prefix +
"MajorPageFaults", int(res.ru_majflt)),
103 (prefix +
"BlockInputs", int(res.ru_inblock)),
104 (prefix +
"BlockOutputs", int(res.ru_oublock)),
105 (prefix +
"VoluntaryContextSwitches", int(res.ru_nvcsw)),
106 (prefix +
"InvoluntaryContextSwitches", int(res.ru_nivcsw)),
113 """Decorator to measure duration of a task method.
122 Writes various measures of time and possibly memory usage to the task's metadata; all items are prefixed
123 with the function name.
127 This decorator only works with instance methods of Task, or any class with these attributes:
129 - ``metadata``: an instance of `lsst.daf.base.PropertyList` (or other object with
130 ``add(name, value)`` method).
131 - ``log``: an instance of `lsst.log.Log`.
137 import lsst.pipe.base as pipeBase
138 class FooTask(pipeBase.Task):
142 def run(self, ...): # or any other instance method you want to time
146 @functools.wraps(func)
147 def wrapper(self, *args, **keyArgs):
148 logInfo(obj=self, prefix=func.__name__ +
"Start")
150 res = func(self, *args, **keyArgs)
152 logInfo(obj=self, prefix=func.__name__ +
"End")