Difference between revisions of "Config:Logging"

From SUMOwiki
Jump to navigationJump to search
m
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
By default, the SUMO Toolbox displays messages about the progress the modeling process to the Matlab console and also writes them to a log file which can be found in the output folder. A general log file is also generated and saved in the ''output'' folder in the SUMO Root directory. The logging configuration lets you control the granularity of the messages and the source of the messages. The possible granularity levels are "OFF, SEVERE, WARNING, INFO, FINE, FINER, FINEST, ALL".
 +
 +
The ConsoleHandler configuration lets you control the granularity of the console messages and the FileHandler lets you control the granularity of the messages written to the log file. You can also control the granularity of the messages generated by the Matlab code in the toolbox and that of the messages generated by the Java code in the Toolbox.
 +
 +
'''Generated for SUMO toolbox version 7.0'''.
 +
''We are well aware that documentation is not always complete and possibly even out of date in some cases. We try to document everything as best we can but much is limited by available time and manpower.  We are an university research group after all. The most up to date documentation can always be found (if not here) in the default.xml configuration file and, of course, in the source files.  If something is unclear please dont hesitate to [[Reporting problems|ask]].''
 
== Logging ==
 
== Logging ==
 +
=== RootLogger ===
 +
Root logger
 +
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
 +
 +
<!--Root logger-->
 +
  <[[Config:RootLogger|RootLogger]]>
 +
 
 +
      <!-- log all run-specific information in the main log as well -->
 +
      <Option key="runsInMainLog" value="true"/>
 +
 
 +
      <!-- Set the default logging level for the root logger -->
 +
      <Option key="Level" value="INFO"/>
 +
 +
      <!-- Specify the handlers to create in the root logger
 +
      (all loggers are children of the root logger).  The handlers determine
 +
      where logging output is sent to.
 +
     
 +
      Possible levels are: OFF, SEVERE, WARNING, INFO, FINE, FINER, FINEST, ALL
 +
      -->     
 +
      <[[Config:Handlers|Handlers]]>
 +
        <!-- Configure ConsoleHandler (= output to the screen) -->
 +
        <[[Config:ConsoleHandler|ConsoleHandler]]>
 +
            <Option key="Level" value="INFO"/>
 +
        </[[Config:ConsoleHandler|ConsoleHandler]]>
 +
 +
        <!-- Configure FileHandler (= output to file)-->
 +
        <[[Config:FileHandler|FileHandler]]>
 +
            <Option key="Level" value="ALL"/>
 +
        </[[Config:FileHandler|FileHandler]]>
 +
      </[[Config:Handlers|Handlers]]>
 +
  </[[Config:RootLogger|RootLogger]]></source>
 
=== Custom Options ===
 
=== Custom Options ===
 
Available options:
 
Available options:
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
 
<source xmlns:saxon="http://icl.com/saxon" lang="xml">
  
<!--Specify the handlers to create in the root logger (all loggers are children of the root logger) The following creates two handlers-->
+
<!--<Option key="loggername" value="level" />-->
<Option key="handlers" value="java.util.logging.ConsoleHandler,java.util.logging.FileHandler"/>
+
  <Option key="ibbt.sumo" value="FINEST"/>
<!--Set the default logging level for the root logger-->
+
<!--<Option key="loggername" value="level" />-->
<Option key=".level" value="INFO"/>
+
  <Option key="Matlab" value="FINEST"/></source>
<!--This setting determins how much output you see on your console-->
 
<Option key="java.util.logging.ConsoleHandler.level" value="INFO"/>
 
<!--Set the default formatter-->
 
<Option key="java.util.logging.ConsoleHandler.formatter" value="ibbt.sumo.util.SUMOFormatter"/>
 
<!--Log everything to file-->
 
<Option key="java.util.logging.FileHandler.level" value="ALL"/>
 
<!--Set the default formatter-->
 
<Option key="java.util.logging.FileHandler.formatter" value="ibbt.sumo.util.SUMOFormatter"/>
 
<!--Max logfile size in bytes-->
 
<Option key="java.util.logging.FileHandler.limit" value="0"/>
 
<!--How many output files to cycle through-->
 
<Option key="java.util.logging.FileHandler.count" value="1"/>
 
<!--Should existing files be appended-->
 
<Option key="java.util.logging.FileHandler.append" value="false"/>
 
<!--The file naming pattern-->
 
<Option key="java.util.logging.FileHandler.pattern" value="output/SUMO-Toolbox.%g.%u.log"/>
 
<!--Set the default logging level for the SUMO-Toolbox-->
 
<Option key="ibbt.sumo.level" value="FINEST"/>
 
<!--Set the default logging level for the SUMO-Toolbox-->
 
<Option key="Matlab.level" value="FINEST"/></source>
 

Latest revision as of 18:43, 31 January 2012

By default, the SUMO Toolbox displays messages about the progress the modeling process to the Matlab console and also writes them to a log file which can be found in the output folder. A general log file is also generated and saved in the output folder in the SUMO Root directory. The logging configuration lets you control the granularity of the messages and the source of the messages. The possible granularity levels are "OFF, SEVERE, WARNING, INFO, FINE, FINER, FINEST, ALL".

The ConsoleHandler configuration lets you control the granularity of the console messages and the FileHandler lets you control the granularity of the messages written to the log file. You can also control the granularity of the messages generated by the Matlab code in the toolbox and that of the messages generated by the Java code in the Toolbox.

Generated for SUMO toolbox version 7.0. We are well aware that documentation is not always complete and possibly even out of date in some cases. We try to document everything as best we can but much is limited by available time and manpower. We are an university research group after all. The most up to date documentation can always be found (if not here) in the default.xml configuration file and, of course, in the source files. If something is unclear please dont hesitate to ask.

Logging

RootLogger

Root logger

<!--Root logger-->
   <[[Config:RootLogger|RootLogger]]>
   
      <!-- log all run-specific information in the main log as well -->
      <Option key="runsInMainLog" value="true"/>
   
      <!-- Set the default logging level for the root logger -->
      <Option key="Level" value="INFO"/>

      <!-- Specify the handlers to create in the root logger
       (all loggers are children of the root logger).  The handlers determine
       where logging output is sent to. 
       
       Possible levels are: OFF, SEVERE, WARNING, INFO, FINE, FINER, FINEST, ALL
       -->      
      <[[Config:Handlers|Handlers]]>
         <!-- Configure ConsoleHandler (= output to the screen) -->
         <[[Config:ConsoleHandler|ConsoleHandler]]>
            <Option key="Level" value="INFO"/>
         </[[Config:ConsoleHandler|ConsoleHandler]]>

         <!-- Configure FileHandler (= output to file)-->
         <[[Config:FileHandler|FileHandler]]>
            <Option key="Level" value="ALL"/>
         </[[Config:FileHandler|FileHandler]]>
      </[[Config:Handlers|Handlers]]>
   </[[Config:RootLogger|RootLogger]]>

Custom Options

Available options:

<!--<Option key="loggername" value="level" />-->
   <Option key="ibbt.sumo" value="FINEST"/>
<!--<Option key="loggername" value="level" />-->
   <Option key="Matlab" value="FINEST"/>