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

From MidasWiki
Jump to navigation Jump to search
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{Pagelinks}}
 +
 
==== Links ====
 
==== Links ====
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
+
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
 
* [[/Logger ODB tree| /Logger tree]]  
 
* [[/Logger ODB tree| /Logger tree]]  
 
* [[Logging to a mySQL database]]
 
* [[Logging to a mySQL database]]
 
* [[Keys in the ODB /Logger/Channels subtree| /Logger/Channels subtree]]  
 
* [[Keys in the ODB /Logger/Channels subtree| /Logger/Channels subtree]]  
 
* [[Keys in the ODB /Logger/SQL subtree| /Logger/SQL subtree]]  
 
* [[Keys in the ODB /Logger/SQL subtree| /Logger/SQL subtree]]  
 +
* [[Keys in the ODB /Logger/History subtree |/Logger/History subtree]]
 +
* [[/History ODB tree]]
 
* [[mlogger |MIDAS logger (mlogger)]]  
 
* [[mlogger |MIDAS logger (mlogger)]]  
 
</div>
 
</div>
 +
<br>
 
---------------
 
---------------
 
<br>
 
<br>
 
+
== Keys in the <span  style="color: purple;">''/Logger''</span> tree ==
==  <span  style="color: purple;">''/Logger/Channels''</span>  subtree ==
+
===  <span  style="color: purple;">''Data dir''</span>  ===
* '''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 | multiple logging channels]] can be created. See [[Keys in the ODB /Logger/Channels tree]].
 
 
 
<br>
 
------
 
<br>
 
 
 
 
 
==  <span  style="color: purple;">''/Logger/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 28: Line 22:
  
  
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>
 
<li>the data file(s) (unless overruled by the [[Keys in the ODB /Logger/Channels tree #/Logger/Channels/0/Settings/Filename | Filename ]] key(s) ), </li>
 
<li>the message log file (unless overruled by [[#/Logger/Message File | Message File]]),</li>
 
<li>the ODB dump files (unless overruled by [[#/Logger/ODB Dump File | ODB Dump File]]),</li>
 
</ul>
 
: and the optional
 
<ul>
 
<li>elog files (unless overruled by [[#/Logger/Elog dir|Elog dir]]),</li>
 
<li>history files (unless overruled by [[#/Logger/History dir | History Dir]])</li> 
 
</ul>
 
  
When [[#Multiple Logging Channels| multiple logging channels]] are enabled,
+
* the data file(s) (unless overruled by the [[Keys in the ODB /Logger/Channels tree #/Logger/Channels/0/Settings/Filename | Filename ]] key(s) ),
 +
* the message log file (unless overruled by [[#/Logger/Message File | Message File]]),
 +
* the ODB dump files (unless overruled by [[#/Logger/ODB Dump File | ODB Dump File]]),
 +
 
 +
* and the optional
 +
** elog files (unless overruled by [[#/Logger/Elog dir|Elog dir]]),
 +
** [[History System|MIDAS history files]] (unless overruled by [[#/Logger/History dir | History Dir]])
 +
 
 +
It is preferable to use a full directory path for this key (i.e. "''/home/username/online/data''" rather than a relative path, such as the current directory "''./''"). If set to the current directory, running a client such as [[odbedit]] from a different directory will result in a second midas.log file created in that directory.
 +
 
 +
When '''[[#Multiple Logging Channels| multiple logging channels]]''' are enabled,
 
by default, the data path for <b>all</b> the defined logging channels is set to the same location, given by the  <span style="color: purple;">''Data dir''</span> key.
 
by default, the data path for <b>all</b> the defined logging channels is set to the same location, given by the  <span style="color: purple;">''Data dir''</span> key.
 
However, the data from individual logging channels can also be saved in different locations, using
 
However, the data from individual logging channels can also be saved in different locations, using
Line 62: Line 56:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/Message File''</span>  ==
+
===  <span  style="color: purple;">''Message 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
* '''Default:'''  "n"
+
* '''Default:'''  ""
 +
</div>
 +
 
 +
 
 +
This key was introduced in August 2020. It specifies the directory in which [[Message System#MIDAS Log file|MIDAS Message log files]] will be stored. If this ODB entry is empty, the same directory as specified in [[#Data_dir"|Data dir]] will be used.
 +
 
 +
<br>
 +
------
 +
<br>
 +
 
 +
===  <span  style="color: purple;">''Message file date format''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:'''  ""
 +
</div>
 +
 
 +
 
 +
This key was introduced in August 2020. It specifies a date-based suffix to be used when creating [[Message System#MIDAS Log file|MIDAS Message log files]] (e.g. if you want to automatically create a new log file every year, you could specify "%Y" as the format. Any format specifiers recognised by [http://www.cplusplus.com/reference/ctime/strftime/ strftime] may be used.
 +
 
 +
If this key is empty, the full filenames used are "<message_dir>/<facility>.log", where the facility is normally midas.
 +
 
 +
If this key is not empty, the full filenames used are "<message_dir>/<facility>_<date_based_suffix>.log". E.g. if the specified format is %Y, files will be created named midas_2020.log, midas_2021.log etc. If one wants one message file per day, one could use %y%m%d, which produces midas_200810.log, midas_200811.log, etc.
 +
 
 +
<br>
 +
------
 +
<br>
 +
 
 +
===  <span  style="color: purple;">''Message File (obsolete)''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:'''  "midas.log"
 
</div>  
 
</div>  
  
  
Specifies the filename of the [[Message System#MIDAS Log file|MIDAS Message log file]] .  
+
This key was replaced by the [[#Message_dir|Message dir]] and [[#Message_file_date_format|Message file date format]] keys in August 2020. Before then, it was used to specify the filename of the [[Message System#MIDAS Log file|MIDAS Message log file]] .  
  
 
<br>
 
<br>
Line 76: Line 100:
  
  
==  <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 82: Line 106:
 
</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 89: Line 113:
 
<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 96: Line 120:
  
  
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 102: Line 126:
 
<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 109: Line 133:
  
  
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 116: Line 140:
 
<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 123: Line 147:
  
  
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]] 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 136: Line 160:
  
  
==  <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 143: Line 167:
  
  
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 the key [[#ODB Dump file|ODB Dump file]] at the end of each run.
ODB Dump file at the end of each run.  
 
 
<ul>
 
<ul>
  
<li>The ODB contents is <b>always</b> saved into a file "last.xml" at the beginning of each run regardless of the setting of this key.</li>
+
;NOTE
<li>The ODB contents can also be saved into the data stream as an event (see ODB Dump per logging channel).  </li>
+
<li>The ODB contents is <b>always</b> saved into a file (default is "last.json") at the beginning of each run regardless of the setting of this key.</li> The format is specified by the [[Keys in the ODB /Logger/Channels subtree#ODB dump format]] key.
 +
 
 +
<li>The ODB contents can also be saved into the data stream as an event (see [[Keys in the ODB /Logger/Channels tree #ODB Dump|ODB Dump per logging channel]]).  </li>
 
</ul>
 
</ul>
  
Line 155: Line 180:
 
<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
* '''Default:'''  "run%05d.odb"
+
* '''Default:'''  "run%05d.json"
 
</div>  
 
</div>  
  
  
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]] key is set to "y". The default for the format of the file
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  
+
is now json (since March 2019). Previously it was "run%05d.odb", with the format being xml by default.
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  
+
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.json. The ODB dump file can be used for off-line analysis to check run parameters etc. (See also  
 
[[Keys in the ODB /Logger/Channels tree #/Logger/Channels/0/Settings/ODB Dump | ODB Dump per logging channel]]).
 
[[Keys in the ODB /Logger/Channels tree #/Logger/Channels/0/Settings/ODB Dump | ODB Dump per logging channel]]).
  
 
<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 180: Line 204:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/WriteFileHistory''</span>  ==
+
===  <span  style="color: purple;">''ODB Last Dump File ''</span>  ===
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' STRING
 +
* '''Default:'''  "last.json"
 +
</div>
 +
 
 +
This key in the  ODB  [[#top|/Logger tree]] contains the filename of the odb dump file last saved. It is always saved, independent of the setting of the key [[#ODB Dump]].
 +
 
 +
<br>
 +
------
 +
<br>
 +
===  <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 186: Line 221:
 
</div>  
 
</div>  
  
 +
This key in the  ODB  [[#top|/Logger tree]] is obsolete. Use [[Keys in the ODB /Logger/History subtree#/Logger/History/0/Active|Active]] key instead.
  
New feature - no information as yet.
 
  
 
<br>
 
<br>
Line 193: Line 228:
 
<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 200: Line 235:
  
  
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 206: Line 241:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/ODBC Debug''</span>   ==
+
===  <span  style="color: purple;">''ODBC Debug''</span> (obsolete)  ===
 
<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 212: Line 247:
 
</div>  
 
</div>  
  
 
+
This key in the  ODB  [[#top|/Logger tree]] is now obsolete. It has been replaced by [[Keys in the ODB /Logger/History subtree#/Logger/History/1/Debug|Debug]] key.
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 219: Line 253:
 
<br>
 
<br>
  
==  <span  style="color: purple;">''/Logger/ODBC DSN''</span>   ==
+
===  <span  style="color: purple;">''ODBC DSN''</span> (obsolete)  ===
 
<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 225: Line 259:
 
</div>  
 
</div>  
  
 +
This key  in the  ODB  [[#top|/Logger tree]]  is now obsolete. It has been replaced by [[Keys in the ODB /Logger/History subtree#/Logger/History/1/Writer_ODBC_DSN|Writer_ODBC_DSN]] key.
  
Optional key created if ODBC is installed (see [[Building Options]]). Default value is blank. See MIDAS [[SQL History system]] for details.
 
  
 
<br>
 
<br>
Line 232: Line 266:
 
<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 238: Line 272:
 
</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 key in the  ODB  [[#top|/Logger tree]]  is used to reassign the location of the saved [[Keys in the ODB /Logger/History subtree#/Logger/History/0/Type|MIDAS type]]  history files from the default location given by the [[#Data dir |Data dir key]].
  
 
<br>
 
<br>
Line 244: Line 278:
 
<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 251: Line 285:
  
  
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 258: Line 292:
 
<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 265: Line 299:
  
  
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 272: Line 306:
  
  
==  <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 279: Line 313:
  
  
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 286: Line 320:
 
<br>
 
<br>
  
 +
==  <span  style="color: purple;">''/Logger/Channels''</span>  subtree ==
 +
* '''Type:'''  DIR 
 +
 +
This subdirectory is created and used by the [[mlogger]] utility for data logging. See [[Keys in the ODB /Logger/Channels subtree| /Logger/Channels subtree]].
 +
 +
<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 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]]
 +
 
 +
 
 +
<br>
 +
------
 +
<br>
 +
 
 +
==  <span  style="color: purple;">''/Logger/History''</span>  subtree ==
 +
* '''Type:'''  DIR 
 +
 
 +
This subdirectory  in the [[#top|/Logger tree]] is created by the [[mlogger]] utility and used by the [[History System]].
 +
 
 +
See [[Keys in the ODB /Logger/History subtree |keys in /Logger/History subtree]]
 +
 
 +
[[Category:Data Logging]]

Latest revision as of 09:15, 10 August 2020


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

It is preferable to use a full directory path for this key (i.e. "/home/username/online/data" rather than a relative path, such as the current directory "./"). If set to the current directory, running a client such as odbedit from a different directory will result in a second midas.log file created in that directory.

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 dir

  • Type: STRING
  • Default: ""


This key was introduced in August 2020. It specifies the directory in which MIDAS Message log files will be stored. If this ODB entry is empty, the same directory as specified in Data dir will be used.




Message file date format

  • Type: STRING
  • Default: ""


This key was introduced in August 2020. It specifies a date-based suffix to be used when creating MIDAS Message log files (e.g. if you want to automatically create a new log file every year, you could specify "%Y" as the format. Any format specifiers recognised by strftime may be used.

If this key is empty, the full filenames used are "<message_dir>/<facility>.log", where the facility is normally midas.

If this key is not empty, the full filenames used are "<message_dir>/<facility>_<date_based_suffix>.log". E.g. if the specified format is %Y, files will be created named midas_2020.log, midas_2021.log etc. If one wants one message file per day, one could use %y%m%d, which produces midas_200810.log, midas_200811.log, etc.




Message File (obsolete)

  • Type: STRING
  • Default: "midas.log"


This key was replaced by the Message dir and Message file date format keys in August 2020. Before then, it was used to specify 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 the key ODB Dump file at the end of each run.




ODB Dump File

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


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". The default for the format of the file is now json (since March 2019). Previously it was "run%05d.odb", with the format being xml by default.

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.json. 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.




ODB Last Dump File

  • Type: STRING
  • Default: "last.json"

This key in the ODB /Logger tree contains the filename of the odb dump file last saved. It is always saved, independent of the setting of the key #ODB Dump.




WriteFileHistory

  • Type: BOOL
  • Default: "y"

This key in the ODB /Logger tree is obsolete. Use Active key instead.





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 (obsolete)

  • Type: INT
  • Default: 0

This key in the ODB /Logger tree is now obsolete. It has been replaced by Debug key.




ODBC DSN (obsolete)

  • Type: STRING
  • Default:

This key in the ODB /Logger tree is now obsolete. It has been replaced by Writer_ODBC_DSN key.





History dir

  • Type: STRING
  • Default:

This key in the ODB /Logger tree is used to reassign the location of the saved MIDAS type 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/Channels subtree

  • Type: DIR

This subdirectory is created and used by the mlogger utility for data logging. See /Logger/Channels subtree.




/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





/Logger/History subtree

  • Type: DIR

This subdirectory in the /Logger tree is created by the mlogger utility and used by the History System.

See keys in /Logger/History subtree