Difference between revisions of "Keys in the ODB /Logger tree"

From MidasWiki
Jump to navigation Jump to search
(Created page with "See also /Logger ODB tree and the MIDAS logger utility mlogger. == <span style="color: purple;">''/Logger/Channels''</span> subtree == '''Type:''' DIR ...")
 
Line 1: Line 1:
See also [[/Logger ODB tree]] and the MIDAS logger utility [[Mlogger|mlogger]].
+
==== Links ====
 
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* [[Keys in the ODB /Logger tree| /Logger tree]]  
 +
* [[Logging to a mySQL database]]
 +
* [[Keys in the ODB /Logger/Channels subtree| /Logger/Channels subtree]]
 +
* [[Keys in the ODB /Logger/SQL subtree| /Logger/SQL subtree]]
 +
* [[mlogger]]  
 +
</div>
 +
---------------
 +
<br>
  
 
==  <span  style="color: purple;">''/Logger/Channels''</span>  subtree ==
 
==  <span  style="color: purple;">''/Logger/Channels''</span>  subtree ==
'''Type:''' DIR   
+
* '''Type:''' DIR   
  
 
This is a subdirectory under the [[/Logger ODB tree]] which contains settings for individual logging channels. By default, only channel "0" is created, but  
 
This is a subdirectory under the [[/Logger ODB tree]] which contains settings for individual logging channels. By default, only channel "0" is created, but  
 
[[#Multiple Logging Channels | multiple logging channels]] can be created. See [[Keys in the ODB /Logger/Channels tree]].
 
[[#Multiple Logging Channels | multiple logging channels]] can be created. See [[Keys in the ODB /Logger/Channels tree]].
  
 +
<br>
 +
------
 +
<br>
  
-------------
 
  
 
==  <span  style="color: purple;">''/Logger/Data dir''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Data dir''</span>  ==
'''Type:''' STRING
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:'''  <Path of experiment given in [[exptab]] >
 +
</div>
  
'''Default:''' Path of experiment given in [[exptab]]
 
  
 
This key specifies in which directory files produced by the MIDAS logger utility ([[mlogger]]) should be written.  
 
This key specifies in which directory files produced by the MIDAS logger utility ([[mlogger]]) should be written.  
Line 46: Line 58:
 
</ul>
 
</ul>
  
 +
<br>
 +
---------
 +
<br>
  
 
==  <span  style="color: purple;">''/Logger/Message File''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Message File''</span>  ==
'''Type:''' STRING
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:'''  "n"
 +
</div>
  
'''Default:''' midas.log
 
  
 
Specifies the filename of the [[Message System#MIDAS Log file|MIDAS Message log file]] .  
 
Specifies the filename of the [[Message System#MIDAS Log file|MIDAS Message log file]] .  
  
 
+
<br>
--------
+
------
 +
<br>
  
  
 
==  <span  style="color: purple;">''/Logger/Auto restart''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Auto restart''</span>  ==
 
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
'''Type:''' BOOL
+
* '''Type:''' BOOL
 
+
* '''Default:''' "n"
'''Default:''' "n"
+
</div>
  
 
When this flag is set to "y" (i.e. TRUE), a new run is automatically restarted when the previous run has been stopped by the MIDAS logger ([[mlogger]])  
 
When this flag is set to "y" (i.e. TRUE), a new run is automatically restarted when the previous run has been stopped by the MIDAS logger ([[mlogger]])  
 
due to an event or byte limit.
 
due to an event or byte limit.
  
 
+
<br>
 
+
------
-------
+
<br>
  
 
==  <span  style="color: purple;">''/Logger/Auto restart delay ''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Auto restart delay ''</span>  ==
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' INT
 +
* '''Default:'''  0
 +
</div>
  
'''Type:''' INT
 
 
'''Default:''' 0
 
  
 
Providing [[# /Logger/Auto restart|Auto restart key]] is set TRUE, the automatic start of the next run will be delayed by this number of milliseconds.
 
Providing [[# /Logger/Auto restart|Auto restart key]] is set TRUE, the automatic start of the next run will be delayed by this number of milliseconds.
  
-----
+
<br>
 +
------
 +
<br>
  
 
==  <span  style="color: purple;">''/Logger/Run duration ''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Run duration ''</span>  ==
'''Type:''' INT
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
+
* '''Type:''' INT
'''Default:''' 0
+
* '''Default:''' 0
 +
</div>
  
  
Line 90: Line 112:
 
[[#/Logger/Auto restart|/Logger/Auto restart key]]  to "y"  
 
[[#/Logger/Auto restart|/Logger/Auto restart key]]  to "y"  
  
 
+
<br>
 
 
 
 
 
------
 
------
 
+
<br>
  
 
==  <span  style="color: purple;">''/Logger/Write data ''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Write data ''</span>  ==
'''Type:''' BOOL
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
+
* '''Type:''' BOOL
'''Default:''' "y"
+
* '''Default:''' "y"
 +
</div>
  
  
Line 110: Line 131:
 
be set to "y" for the data from that channel to be logged.
 
be set to "y" for the data from that channel to be logged.
  
 +
<br>
 
------
 
------
 +
<br>
  
  
 
==  <span  style="color: purple;">''/Logger/ODB Dump''</span>  ==
 
==  <span  style="color: purple;">''/Logger/ODB Dump''</span>  ==
'''Type:''' BOOL
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
+
* '''Type:''' BOOL
'''Default:''' "n"
+
* '''Default:''' "n"
 +
</div>
  
  
Line 127: Line 151:
 
</ul>
 
</ul>
  
 
+
<br>
 
+
------
 
+
<br>
 
 
-------
 
 
 
  
 
==  <span  style="color: purple;">''/Logger/ODB Dump File ''</span>  ==
 
==  <span  style="color: purple;">''/Logger/ODB Dump File ''</span>  ==
'''Type:''' STRING  
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:'''  "run%05d.odb"
 +
</div>
  
'''Default:''' run%05d.odb
 
  
 
Specifies the filename in which the dump of the complete ODB will be  
 
Specifies the filename in which the dump of the complete ODB will be  
Line 153: Line 176:
 
</ul>
 
</ul>
  
 
+
<br>
 
------
 
------
 
+
<br>
  
 
==  <span  style="color: purple;">''/Logger/WriteFileHistory''</span>  ==
 
==  <span  style="color: purple;">''/Logger/WriteFileHistory''</span>  ==
'''Type:''' BOOL   
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' BOOL
 +
* '''Default:''' "y"
 +
</div>
  
'''Default:''' "y"
 
  
 
New feature - no information as yet.
 
New feature - no information as yet.
  
 
+
<br>
 
 
 
------
 
------
 
+
<br>
  
 
==  <span  style="color: purple;">''/Logger/Tape message''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Tape message''</span>  ==
'''Type:''' BOOL   
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' BOOL
 +
* '''Default:''' "n"
 +
</div>
  
'''Default:''' "y"
 
  
 
If set to "y", MIDAS messages during mounting tapes and writing of EOF marks are generated. This can be useful all users in a counting house to be informed about the tape status.
 
If set to "y", MIDAS messages during mounting tapes and writing of EOF marks are generated. This can be useful all users in a counting house to be informed about the tape status.
  
 
+
<br>
 
------
 
------
 
+
<br>
  
 
==  <span  style="color: purple;">''/Logger/ODBC Debug''</span>  ==
 
==  <span  style="color: purple;">''/Logger/ODBC Debug''</span>  ==
'''Type:''' INT
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
+
* '''Type:''' INT
'''Default:''' "y"
+
* '''Default:''' 0
 +
</div>
  
  
 
Optional key created if ODBC is installed (see [[Building Options]]). Used by the [[MIDAS SQL History system]]. Set to 1 to see all SQL commands. Default value is 0.
 
Optional key created if ODBC is installed (see [[Building Options]]). Used by the [[MIDAS SQL History system]]. Set to 1 to see all SQL commands. Default value is 0.
  
 
+
<br>
-------------
+
------
 +
<br>
  
 
==  <span  style="color: purple;">''/Logger/ODBC DSN''</span>  ==
 
==  <span  style="color: purple;">''/Logger/ODBC DSN''</span>  ==
'''Type:''' STRING
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
+
* '''Type:''' STRING
'''Default:''' ""
+
* '''Default:'''
 +
</div>
  
  
 
Optional key created if ODBC is installed (see [[Building Options]]). Default value is blank. See MIDAS [[SQL History system]] for details.
 
Optional key created if ODBC is installed (see [[Building Options]]). Default value is blank. See MIDAS [[SQL History system]] for details.
  
-------------
+
<br>
 +
------
 +
<br>
  
 
==  <span  style="color: purple;">''/Logger/History dir''</span>  ==
 
==  <span  style="color: purple;">''/Logger/History dir''</span>  ==
'''Type:''' STRING
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
+
* '''Type:''' STRING
'''Default:'''  
+
* '''Default:'''
 +
</div>
  
 
This optional key is used to reassign the location of the saved history files from the default location given by the [[#/Logger/Data dir |Data dir key]].
 
This optional key is used to reassign the location of the saved history files from the default location given by the [[#/Logger/Data dir |Data dir key]].
  
-------------
+
<br>
 +
------
 +
<br>
  
 
==  <span  style="color: purple;">''/Logger/Elog dir''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Elog dir''</span>  ==
'''Type:''' STRING
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
+
* '''Type:''' STRING
'''Default:'''  
+
* '''Default:'''
 +
</div>
  
  
Line 219: Line 254:
  
  
 
+
<br>
-------------
+
------
 
+
<br>
 
 
  
 
==  <span  style="color: purple;">''/Logger/Subrun duration''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Subrun duration''</span>  ==
'''Type:''' INT  
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' INT
 +
* '''Default:''' 0
 +
</div>
  
'''Default:'''
 
  
 
This optional key contains the duration in seconds for each [[subruns|subrun]]. After this time, a new subrun will be started by the MIDAS logger [[mlogger]].   
 
This optional key contains the duration in seconds for each [[subruns|subrun]]. After this time, a new subrun will be started by the MIDAS logger [[mlogger]].   
  
 +
<br>
 +
------
 +
<br>
  
-------------
 
  
 
==  <span  style="color: purple;">''/Logger/Next subrun ''</span>  ==
 
==  <span  style="color: purple;">''/Logger/Next subrun ''</span>  ==
'''Type:'''  BOOL
+
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' BOOL
 +
* '''Default:'''  "n"
 +
</div>
  
'''Default:''' "n"
 
  
 
This key allows the user to  manually request a new [[subruns|subrun]]. The MIDAS logger ([[mlogger]]) will stop the present subrun and start a new one. The key   
 
This key allows the user to  manually request a new [[subruns|subrun]]. The MIDAS logger ([[mlogger]]) will stop the present subrun and start a new one. The key   
 
<span  style="color: purple;">''Next subrun''</span> will be set false.
 
<span  style="color: purple;">''Next subrun''</span> will be set false.
  
-------------
+
<br>
 +
------
 +
<br>
  
  
 
==  <span  style="color: purple;">''/Logger/SQL''</span>  subtree ==
 
==  <span  style="color: purple;">''/Logger/SQL''</span>  subtree ==
'''Type:'''  DIR   
+
* '''Type:'''  DIR   
  
Optional directory for [[Logging to a mySQL database]]. This ODB subtree will be created if mySQL support has been [[Building options |built into]] the [[mlogger|MIDAS logger]].
+
Optional directory for [[logging to a mySQL database]]. This ODB subtree will be created if mySQL support has been [[Building options |built into]] the [[mlogger|MIDAS logger]].

Revision as of 14:43, 14 August 2013

Links



/Logger/Channels subtree

  • Type: DIR

This is a subdirectory under the /Logger ODB tree which contains settings for individual logging channels. By default, only channel "0" is created, but multiple logging channels can be created. See Keys in the ODB /Logger/Channels tree.





/Logger/Data dir

  • Type: STRING
  • Default: <Path of experiment given in exptab >


This key specifies in which directory files produced by the MIDAS logger utility (mlogger) should be written. Once mlogger is running , the key Data dir will be pointing to the location of

and the optional

When multiple logging channels are enabled, by default, the data path for all the defined logging channels is set to the same location, given by the Data dir key. However, the data from individual logging channels can also be saved in different locations, using the ODB key /Logger/Channels/<channel-number>/Settings/Filename for each defined logging channel (channel number 0,1...).

The Filename key for each enabled logging channel can contain the full path of the location of the .mid, .ybs, .asc data file.

If the latter key contains the full directory path (i.e. contains the OS specific DIR_SEPARATOR (e.g. "/" for Linux or "\" for Windows), then the global key Data dir will be overruled by the setting for that particular channel.

For example,

  • If key Filename contains "run%05.mid". key Data dir will not be overruled
  • If key Filename contains "/data1/ch1log/run%05.mid". key Data dir will be overruled




/Logger/Message File

  • Type: STRING
  • Default: "n"


Specifies the filename of the MIDAS Message log file .





/Logger/Auto restart

  • Type: BOOL
  • Default: "n"

When this flag is set to "y" (i.e. TRUE), a new run is automatically restarted when the previous run has been stopped by the MIDAS logger (mlogger) due to an event or byte limit.




/Logger/Auto restart delay

  • Type: INT
  • Default: 0


Providing Auto restart key is set TRUE, the automatic start of the next run will be delayed by this number of milliseconds.




/Logger/Run duration

  • Type: INT
  • Default: 0


This key allows for runs with a certain duration. To use this option, the user creates and sets this variable to a non-zero integer value (in seconds). After a run has lasted for this duration, it will be stopped automatically by the MIDAS logger (mlogger). To automatically produce sequences of runs all with the same duration, also set the /Logger/Auto restart key to "y"




/Logger/Write data

  • Type: BOOL
  • Default: "y"


Data logging is enabled when this key is set to "y". It can be set to "n" (FALSE) temporarily to make a short test run without data logging. This key is a predefined key for enabling data logging.

Note that the Active key Active key (in the appropriate logging channel subtree must also be set to "y" for the data from that channel to be logged.





/Logger/ODB Dump

  • Type: BOOL
  • Default: "n"


If this flag is set to "y", a dump of the complete ODB will be written to the file specified by ODB Dump file at the end of each run.

  • The ODB contents is always saved into a file "last.xml" at the beginning of each run regardless of the setting of this key.
  • The ODB contents can also be saved into the data stream as an event (see ODB Dump per logging channel).




/Logger/ODB Dump File

  • Type: STRING
  • Default: "run%05d.odb"


Specifies the filename in which the dump of the complete ODB will be written at the end of each run if the ODB Dump key is set to "y". If this filename has the extension ".xml" or ".XML" the file will be written in XML format, otherwise in ASCII format. For a description of the format see db_copy_xml() or db_copy()respectively.

If this filename contains a "%", the "%" will be replaced by the current run number (cf. format string of printf() C function). The format specifier "%05d" from the example would be evaluated to a five digit run number with leading zeros e.g. run00002.odb. The ODB dump file can be used for off-line analysis to check run parameters etc. (See also ODB Dump per logging channel).

  • Note: The location of the ODB dump files can also be specified in this field. If the ODB Dump File string contains a DIR_SEPARATOR, it is considered as an absolute path. If no DIR_SEPARATOR is present, the dump file will be written to the location given by Data dir key.




/Logger/WriteFileHistory

  • Type: BOOL
  • Default: "y"


New feature - no information as yet.




/Logger/Tape message

  • Type: BOOL
  • Default: "n"


If set to "y", MIDAS messages during mounting tapes and writing of EOF marks are generated. This can be useful all users in a counting house to be informed about the tape status.




/Logger/ODBC Debug

  • Type: INT
  • Default: 0


Optional key created if ODBC is installed (see Building Options). Used by the MIDAS SQL History system. Set to 1 to see all SQL commands. Default value is 0.




/Logger/ODBC DSN

  • Type: STRING
  • Default:


Optional key created if ODBC is installed (see Building Options). Default value is blank. See MIDAS SQL History system for details.




/Logger/History dir

  • Type: STRING
  • Default:

This optional key is used to reassign the location of the saved history files from the default location given by the Data dir key.




/Logger/Elog dir

  • Type: STRING
  • Default:


This optional key is used to reassign the location of the saved Elog files from the default location given by the Data dir key.





/Logger/Subrun duration

  • Type: INT
  • Default: 0


This optional key contains the duration in seconds for each subrun. After this time, a new subrun will be started by the MIDAS logger mlogger.





/Logger/Next subrun

  • Type: BOOL
  • Default: "n"


This key allows the user to manually request a new subrun. The MIDAS logger (mlogger) will stop the present subrun and start a new one. The key Next subrun will be set false.





/Logger/SQL subtree

  • Type: DIR

Optional directory for logging to a mySQL database. This ODB subtree will be created if mySQL support has been built into the MIDAS logger.