doc/html/fwkJobReport.html

0001 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
0002 <BODY bgcolor="FFFFFF">
0003 <title>
0004           CMS MessageLogger: Framework Job Reports
0005 </title>
0006
0007 <center>
0008 <h1> <img src="header-public.gif" align="center"> </h1>
0009
0010 <font color=red>
0011 <h1>CMS MessageLogger Service
0012 <br>
0013 Framework Job Reports</h1>
0014 </font>
0015 </center>
0016
0017 Ordinary output destinations are formatted for human readability.
0018 CMS has specified an alternative <em>xml</em> format which may
0019 facilitate the creation of automated parsing tools for programmatic
0020 understanding of log files.
0021
0022 <pre>
0023 process TEST = {
0024
0025  service = MessageLogger {
0026     vstring destinations =  {   "detailedInfo.txt"
0027                               , "critical.txt"
0028                             }
0029     <font color=red>vstring fwkJobReports = {   "long_job_report.xml"
0030                       , "terse_job_report.xml"
0031                 }</font>
0032
0033     <font color=red>PSet long_job_report.xml  = { string threshold = "INFO"  }</font>
0034     <font color=red>PSet terse_job_report.xml = { string threshold = "ERROR" }</font>
0035   }
0036   untracked PSet maxEvents = {untracked int32 input = 5}
0037   path p = { myAnalysisModule }
0038   module myAnalysisModule = ModuleThatIssuesMessages { }
0039   source = EmptySource { }
0040 }
0041 </pre>
0042
0043 The  <font color=red>vstring fwkJobReports = { ... }</font> parameter
0044 instructs the message logger to form one or more (in this case, two)
0045 <font color=blue>ELfwkJobReport</font> destinations.
0046 Each such destination can be (and in the above example is)
0047 controlled by a PSet, establishing thresholds and limits.
0048 <p>
0049 One set of limits is imposed on the
0050 <font color=blue>ELfwkJobReport</font> destination
0051 by default and need not be mentioned in the .cfg file:
0052 The routine informational messages from the framework reporting
0053 transitions between modules and the start of each new event are
0054 defaulted to a limit of zero (and thus will not appear in the file, unless
0055 the .cfg file explicitly sets a different limit for them).
0056
0057 <p>
0058 The format of the output is illustrated by this example, from
0059 long_job_report.xml:
0060 <font color=blue>
0061 <pre>
0062 &lt;FrameworkJobReport&gt;
0063
0064   &lt;Report&gt;
0065     &lt;Severity&gt; -e &lt;/Severity&gt;
0066     &lt;Category&gt; cat_A &lt;/Category&gt;
0067     &lt;Message&gt;
0068       &lt;Item&gt; LogError was used to send this message  &lt;/Item&gt;
0069     &lt;/Message&gt;
0070     &lt;Module&gt; UnitTestClient_A:sendSomeMessages &lt;/Module&gt;
0071   &lt;/Report&gt;
0072
0073   &lt;Report&gt;
0074     &lt;Severity&gt; -e &lt;/Severity&gt;
0075     &lt;Category&gt; cat_B &lt;/Category&gt;
0076     &lt;Message&gt;
0077       &lt;Item&gt; LogError was used to send this other message  &lt;/Item&gt;
0078     &lt;/Message&gt;
0079     &lt;Module&gt; UnitTestClient_A:sendSomeMessages &lt;/Module&gt;
0080   &lt;/Report&gt;
0081
0082   &lt;Report&gt;
0083     &lt;Severity&gt; -w &lt;/Severity&gt;
0084     &lt;Category&gt; cat_A &lt;/Category&gt;
0085     &lt;Message&gt;
0086       &lt;Item&gt; LogWarning was used to send a message with the number &lt;/Item&gt;
0087       &lt;Item&gt; 46 &lt;/Item&gt;
0088       &lt;Item&gt; and this other string streamed to the logger &lt;/Item&gt;
0089     &lt;/Message&gt;
0090     &lt;Module&gt; UnitTestClient_A:sendSomeMessages &lt;/Module&gt;
0091   &lt;/Report&gt;
0092
0093   &lt;Report&gt;
0094     &lt;Severity&gt; -w &lt;/Severity&gt;
0095     &lt;Category&gt; cat_B &lt;/Category&gt;
0096     &lt;Message&gt;
0097       &lt;Item&gt; LogWarning was used to send this other message  &lt;/Item&gt;
0098     &lt;/Message&gt;
0099     &lt;Module&gt; UnitTestClient_A:sendSomeMessages &lt;/Module&gt;
0100   &lt;/Report&gt;
0101
0102   &lt;Report&gt;
0103     &lt;Severity&gt; -i &lt;/Severity&gt;
0104     &lt;Category&gt; cat_A &lt;/Category&gt;
0105     &lt;Message&gt;
0106       &lt;Item&gt; LogInfo was used to send this message  &lt;/Item&gt;
0107     &lt;/Message&gt;
0108     &lt;Module&gt; UnitTestClient_A:sendSomeMessages &lt;/Module&gt;
0109   &lt;/Report&gt;
0110
0111   &lt;Report&gt;
0112     &lt;Severity&gt; -i &lt;/Severity&gt;
0113     &lt;Category&gt; cat_B &lt;/Category&gt;
0114     &lt;Message&gt;
0115       &lt;Item&gt; LogInfo was used to send this other message  &lt;/Item&gt;
0116     &lt;/Message&gt;
0117     &lt;Module&gt; UnitTestClient_A:sendSomeMessages &lt;/Module&gt;
0118   &lt;/Report&gt;
0119
0120  &lt;/FrameworkJobReport&gt;
0121 </pre>
0122 </font>
0123 <p><center>
0124 <img src="bar.gif"></center>
0125
0126 <p><center>
0127 <a href="http://www.uscms.org/SoftwareComputing/index.html">
0128 USCMS Software and Computing Home Page </a> -
0129 <a href="MessageLogger.html"> CMS MessageLogger Service Page </a> -
0130 <a href="parameters.html#example"> Configuration File </a>
0131 </center>
0132
0133 <p>
0134       <hr>
0135       <address><a href="mailto:mf@fnal.gov">Mark Fischler</a></address>
0136 <!-- hhmts start -->
0137 Last modified: November 29, 2005
0138 <!-- hhmts end -->
0139 </body>