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

From MidasWiki
Jump to navigation Jump to search
m
Line 10: Line 10:
 
---------------
 
---------------
 
<br>
 
<br>
 
+
== Keys in the <span  style="color: purple;">''/Logger''</span> tree  ==
==  <span  style="color: purple;">''/Logger/Data dir''</span>  ==
+
===  <span  style="color: purple;">''Data dir''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' STRING
 
* '''Type:''' STRING
Line 18: Line 18:
  
  
This key specifies in which directory files produced by the MIDAS logger utility ([[mlogger]]) should be written.  
+
This key in the  ODB  [[#top|/Logger tree]] specifies in which directory files produced by the MIDAS logger utility ([[mlogger]]) should be written.  
 
Once mlogger is running , the key <span  style="color: purple;">''Data dir''</span> will be pointing to the location of
 
Once mlogger is running , the key <span  style="color: purple;">''Data dir''</span> will be pointing to the location of
 
<ul>
 
<ul>
Line 52: Line 52:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/Message File''</span>  ==
+
===  <span  style="color: purple;">''Message File''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' STRING
 
* '''Type:''' STRING
Line 59: Line 59:
  
  
Specifies the filename of the [[Message System#MIDAS Log file|MIDAS Message log file]] .  
+
This key in the  ODB  [[#top|/Logger tree]] specifies the filename of the [[Message System#MIDAS Log file|MIDAS Message log file]] .  
  
 
<br>
 
<br>
Line 66: Line 66:
  
  
==  <span  style="color: purple;">''/Logger/Auto restart''</span>  ==
+
===  <span  style="color: purple;">''Auto restart''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' BOOL
 
* '''Type:''' BOOL
Line 72: Line 72:
 
</div>  
 
</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 key in the  ODB  [[#top|/Logger tree]]  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.
  
Line 79: Line 79:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/Auto restart delay ''</span>  ==
+
===  <span  style="color: purple;">''Auto restart delay ''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' INT
 
* '''Type:''' INT
Line 86: Line 86:
  
  
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 [[#Auto restart|Auto restart key]] is set TRUE, the automatic start of the next run will be delayed by the number of milliseconds specified by this key in the  ODB  [[#top|/Logger tree]].  
  
 
<br>
 
<br>
Line 92: Line 92:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/Run duration ''</span>  ==
+
===  <span  style="color: purple;">''Run duration ''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' INT
 
* '''Type:''' INT
Line 99: Line 99:
  
  
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  
+
This key in the  ODB  [[#top|/Logger tree]] 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|/Logger/Auto restart key]]  to "y"  
 
[[#/Logger/Auto restart|/Logger/Auto restart key]]  to "y"  
  
Line 106: Line 106:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/Write data ''</span>  ==
+
===  <span  style="color: purple;">''Write data ''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' BOOL
 
* '''Type:''' BOOL
Line 113: Line 113:
  
  
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.  
+
Data logging is enabled when this key in the  ODB  [[#top|/Logger tree]]  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.   
 
This key is a predefined key for enabling data logging.   
  
Note that the  [[Keys in the ODB /Logger/Channels tree #/Logger/Channels/0/Settings/Active | Active key]] (in the appropriate   
+
Note that the  [[Keys in the ODB /Logger/Channels tree #Active | Active key]] (in the appropriate   
[[Keys in the ODB /Logger/Channels tree #/Logger/Channels/0/Settings subtree |logging channel subtree ]] )
+
[[Keys in the ODB /Logger/Channels tree #Settings subtree |logging channel subtree ]] )
 
must <b>also</b>  
 
must <b>also</b>  
 
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.
Line 126: Line 126:
  
  
==  <span  style="color: purple;">''/Logger/ODB Dump''</span>  ==
+
===  <span  style="color: purple;">''ODB Dump''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' BOOL
 
* '''Type:''' BOOL
Line 133: Line 133:
  
  
If this flag is set to "y", a dump of the complete ODB will be written to the file specified by  
+
If this key in the  ODB  [[#top|/Logger tree]]  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.  
 
ODB Dump file at the end of each run.  
 
<ul>
 
<ul>
Line 145: Line 145:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/ODB Dump File ''</span>  ==
+
===  <span  style="color: purple;">''ODB Dump File ''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' STRING
 
* '''Type:''' STRING
Line 152: Line 152:
  
  
Specifies the filename in which the dump of the complete ODB will be  
+
This key in the  ODB  [[#top|/Logger tree]] specifies the filename in which the dump of the complete ODB will be  
written at the end of each run if the [[#/Logger/ODB Dump|ODB Dump key]]  is set to "y".
+
written at the end of each run if the [[#ODB Dump|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  
 
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.
 
format see db_copy_xml() or db_copy()respectively.
Line 162: Line 162:
 
<ul>
 
<ul>
 
<li><b>Note:</b> The location of the ODB dump files can also be specified in this field. If the ODB Dump File string contains a DIR_SEPARATOR,  
 
<li><b>Note:</b> 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 [[#/Logger/Data dir |Data dir key]].
+
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 |Data dir key]].
 
</li>
 
</li>
 
</ul>
 
</ul>
Line 170: Line 170:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/WriteFileHistory''</span>  ==
+
===  <span  style="color: purple;">''WriteFileHistory''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' BOOL
 
* '''Type:''' BOOL
Line 176: Line 176:
 
</div>  
 
</div>  
  
 
+
This key in the  ODB  [[#top|/Logger tree]] specifies ???
 
New feature - no information as yet.
 
New feature - no information as yet.
  
Line 183: Line 183:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/Tape message''</span>  ==
+
===  <span  style="color: purple;">''Tape message''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' BOOL
 
* '''Type:''' BOOL
Line 190: Line 190:
  
  
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 this key in the  ODB  [[#top|/Logger tree]] is 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>
Line 196: Line 196:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/ODBC Debug''</span>  ==
+
===  <span  style="color: purple;">''ODBC Debug''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' INT
 
* '''Type:''' INT
Line 202: Line 202:
 
</div>  
 
</div>  
  
This key is now obsolete. It has been replaced by [[Keys in the ODB /Logger/History subtree |key in /Logger/History subtree]]
+
This key in the  ODB  [[#top|/Logger tree]]  is now obsolete. It has been replaced by [[Keys in the ODB /Logger/History subtree |key in /Logger/History subtree]]
 +
It may be found in older versions of MIDAS.
  
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.
+
This was an 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>
Line 210: Line 211:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/ODBC DSN''</span>  ==
+
===  <span  style="color: purple;">''ODBC DSN''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' STRING
 
* '''Type:''' STRING
Line 217: Line 218:
  
  
Optional key created if ODBC is installed (see [[Building Options]]). Default value is blank. See MIDAS [[SQL History system]] for details.
+
Optional key in the  ODB  [[#top|/Logger tree]]  created if ODBC is installed (see [[Building Options]]). Default value is blank. See MIDAS [[SQL History system]] for details.
  
 
<br>
 
<br>
Line 223: Line 224:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/History dir''</span>  ==
+
===  <span  style="color: purple;">''History dir''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' STRING
 
* '''Type:''' STRING
Line 229: Line 230:
 
</div>
 
</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 in the  ODB  [[#top|/Logger tree]]  is used to reassign the location of the saved history files from the default location given by the [[#Data dir |Data dir key]].
  
 
<br>
 
<br>
Line 235: Line 236:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/Elog dir''</span>  ==
+
===  <span  style="color: purple;">''Elog dir''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' STRING
 
* '''Type:''' STRING
Line 242: Line 243:
  
  
This optional key is used to reassign the location of the saved Elog files from the default location given by the [[#/Logger/Data dir |Data dir key]].
+
This optional key in the  ODB  [[#top|/Logger tree]] is used to reassign the location of the saved Elog files from the default location given by the [[#Data dir |Data dir key]].
  
  
Line 249: Line 250:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/Subrun duration''</span>  ==
+
===  <span  style="color: purple;">''/Logger/Subrun duration''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' INT
 
* '''Type:''' INT
Line 256: Line 257:
  
  
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 in the  ODB  [[#top|/Logger tree]]  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>
Line 263: Line 264:
  
  
==  <span  style="color: purple;">''/Logger/Next subrun ''</span>  ==
+
===  <span  style="color: purple;">''Next subrun ''</span>  ===
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 
* '''Type:''' BOOL
 
* '''Type:''' BOOL
Line 270: Line 271:
  
  
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 in the  ODB  [[#top|/Logger tree]] 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.
  
Line 281: Line 282:
 
* '''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 in the  ODB  [[#top|/Logger tree]]  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]].
 +
 
 +
See [[Keys in the ODB /Logger/SQL subtree| /Logger/SQL subtree]]
 +
 
 +
 
 +
[[Category:ODB Tree]]

Revision as of 18:06, 5 June 2014

Links




Keys in the /Logger tree

Data dir

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


This key in the ODB /Logger tree 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




Message File

  • Type: STRING
  • Default: "n"


This key in the ODB /Logger tree specifies the filename of the MIDAS Message log file .





Auto restart

  • Type: BOOL
  • Default: "n"

When this key in the ODB /Logger tree 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.




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 the number of milliseconds specified by this key in the ODB /Logger tree.




Run duration

  • Type: INT
  • Default: 0


This key in the ODB /Logger tree 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"




Write data

  • Type: BOOL
  • Default: "y"


Data logging is enabled when this key in the ODB /Logger tree 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 (in the appropriate logging channel subtree ) must also be set to "y" for the data from that channel to be logged.





ODB Dump

  • Type: BOOL
  • Default: "n"


If this key in the ODB /Logger tree 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).




ODB Dump File

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


This key in the ODB /Logger tree 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.




WriteFileHistory

  • Type: BOOL
  • Default: "y"

This key in the ODB /Logger tree specifies ??? New feature - no information as yet.




Tape message

  • Type: BOOL
  • Default: "n"


If this key in the ODB /Logger tree is 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.




ODBC Debug

  • Type: INT
  • Default: 0

This key in the ODB /Logger tree is now obsolete. It has been replaced by key in /Logger/History subtree It may be found in older versions of MIDAS.

This was an 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.




ODBC DSN

  • Type: STRING
  • Default:


Optional key in the ODB /Logger tree created if ODBC is installed (see Building Options). Default value is blank. See MIDAS SQL History system for details.




History dir

  • Type: STRING
  • Default:

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




Elog dir

  • Type: STRING
  • Default:


This optional key in the ODB /Logger tree 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 in the ODB /Logger tree contains the duration in seconds for each subrun. After this time, a new subrun will be started by the MIDAS logger mlogger.





Next subrun

  • Type: BOOL
  • Default: "n"


This key in the ODB /Logger tree 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 in the ODB /Logger tree for logging to a mySQL database. This ODB subtree will be created if mySQL support has been built into the MIDAS logger.

See /Logger/SQL subtree