Keys in the ODB /Logger/History subtree: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
(Created page with "==== Links ==== <div style="column-count:3;-moz-column-count:3;-webkit-column-count:3"> * /Logger tree * Logging to a mySQL database * Keys in the...")
 
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==== Links ====
== Links ==
<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">
* [[/Logger ODB tree| /Logger tree]]  
* [[/Logger ODB tree| /Logger tree]]  
* [[/History ODB tree| /History tree]]
* [[History System]]
* [[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]]  
Line 11: Line 13:
<br>
<br>


== <span style="color: purple;">''/Logger/History''</span> subtree ==
=<span style="color: purple;">''/Logger/History''</span> subtree =


The ODB <span style="color: purple;">''/Logger/History''</span>  subtree is a subdirectory of the [[Keys in the ODB /Logger tree | ODB /Logger tree]], created
The ODB <span style="color: purple;">''/Logger/History''</span>  subtree is a subdirectory of the [[Keys in the ODB /Logger tree | ODB /Logger tree]], created
when the MIDAS logger utility [[mlogger]] is started for the first time. The keys will be filled with default values which users may change as required to customize their experiments.  
when the MIDAS logger utility [[mlogger]] is started for the first time. The keys will be filled with default values which users may change as required to customize their experiments.  


When [[mlogger]] is started for the first time, it creates '''three''' odb subtrees
When [[mlogger]] is started for the first time, it now creates '''five''' <span style="color: purple;"> /Logger/History/<''history-logging-channel''></span> ODB subtrees to control the five default history-logging-channels'',  named for each of the default
<span style="color: purple;">''0,1''</span> and <span style="color: purple;">''2''</span> as shown in the following example:
[[History System#History drivers|History drivers]].


=== Example  ===
The keys present in each history-logging-channel are described below.
 
<br>
---------------
<br>
 
= Example  =
The following example shows the <span style="color:purple; font-style:italic">/Logger/History </span>  ODB subtree after creation by [[mlogger]]  (obtained using the [[odbedit]] '''ls''' command).   
The following example shows the <span style="color:purple; font-style:italic">/Logger/History </span>  ODB subtree after creation by [[mlogger]]  (obtained using the [[odbedit]] '''ls''' command).   
See below for information on individual keys.  
See below for information on individual keys.  


[local:pol:S]/>cd /logger
 
[local:pol:S]/Logger>ls -r history
<pre>
History
[local:midas:S]/>ls -r /Logger/History
     0
History
     MIDAS
         Type                    MIDAS
         Type                    MIDAS
         Active                  y
         Active                  y
         Debug                  0
         Debug                  0
         PerVariableHistory      0
         PerVariableHistory      0
     1
     ODBC
         Type                    ODBC
         Type                    ODBC
         Active                  n
         Active                  n
Line 37: Line 46:
         Writer_ODBC_DSN        history_writer
         Writer_ODBC_DSN        history_writer
         Reader_ODBC_DSN        history_reader
         Reader_ODBC_DSN        history_reader
     2
     SQLITE
         Type                    SQLITE
         Type                    SQLITE
         Active                  n
         Active                  n
         Debug                  0
         Debug                  0
         Sqlite dir
         Sqlite dir
    MYSQL
        Type                    MYSQL
        Active                  n
        Debug                  0
        MYSQL Writer            mysql_writer.txt
        MYSQL Reader            mysql_reader.txt
    FILE
        Type                    FILE
        Active                  n
        Debug                  0
        History dir
</pre>


The three subtrees are each a ''history-logging-channel'' created
to control one of the three different types of history logging available, i.e. MIDAS, ODBC and SQLITE.
Each subdirectory is created with a different value in the
<span style="color:purple; font-style:italic">subkey "Type"</span>, i.e.
* Subtree  <span style="color: purple;">''0''</span> for MIDAS  (key <span style="color:purple; font-style:italic">Type</span> set to "MIDAS")
* Subtree  <span style="color: purple;">''1''</span> for ODBC  (key <span style="color:purple; font-style:italic">Type</span> set to "ODBC")
* Subtree  <span style="color: purple;">''2''</span> for SQLITE (key <span style="color:purple; font-style:italic">Type</span> set to "SQLITE")




The keys present in each ''history-logging-channel'' are described below.
<br>
<br>
-----
-----
<br>
<br>


== <span style="color: purple;">''/Logger/History/0/''</span> subtree ==
= <span style="color: purple;">''<history-logging-channel>''</span> subtrees =
 
Each <''history-logging-channel''> subtree in the [[#top|Logger/History subtree]]
is created  (by [[mlogger]]) to control one of the [[History System#History drivers|history drivers]] available, and named for that history driver.
<br>Presently the five following history-logging-channel subtrees are created :
* MIDAS
* ODBC
* SQLITE
* MYSQL
* FILE
(see [[#Example|Example]] above).


This subtree controls history logging of Midas events.
By default, only the MIDAS-history logging channel is [[#active|Active]].
 
;NOTE
: In older MIDAS versions, the history-logging-channel subtrees were named 0,1,2... respectively


<br>
<br>
Line 67: Line 91:
<br>
<br>


=== <span style="color: purple;">''/Logger/History/0/Type''</span> ===
== Keys common to all history logging channel subtrees ==
The following three keys are common to all [[#<history-logging-channel> subtrees|history logging channel subtrees]] :
 
 
=== <span style="color: purple;">''Type''</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:'''  MIDAS
* '''Default:'''  [[History System#History drivers|History driver]] name
</div>  
</div>  


This key specifies the type of history logging for this ''history-logging-channel''.


[[mlogger]] creates this channel with this key set to "MIDAS" since this subtree  <span style="color: purple;">''0''</span>  controls MIDAS history logging.
Each [[#<history-logging-channel> subtrees |history-logging-channel subtree]] contains a  <span style="color: purple;">''Type''</span> key which specifies the type of
[[History System#History drivers|History driver]] for this channel.
 
When the subtree is created, the <span style="color: purple;">''Type''</span> key is set to the respective History driver name, e.g.
: ODB key <span style="color: purple;">/Logger/History/'''MIDAS'''/Type</span> will be set to '''"MIDAS"'''
: ODB key <span style="color: purple;">/Logger/History/'''ODBC'''/Type</span> will be set to '''"ODBC"'''
   
and so on (see [[#Example|Example]] above for all five logging channels).


<br>
<br>
----------
---------------
<br>
<br>
 
=== <span style="color: purple;">''Active''</span> ===
 
 
=== <span style="color: purple;">''/Logger/History/0/Active''</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
* '''Default:'''  "y"
* '''Default:'''  "n"
</div>
</div>


If set to "y", MIDAS history logging is active.
Each [[#<history-logging-channel> subtrees |history-logging-channel subtree]] contains a  <span style="color: purple;">''Active''</span> key
Set to "n" to disable MIDAS history logging.
which enables or disables history logging in this channel.


See also [[#/Logger/History/0/Type|Type key]].  
By default, only the MIDAS-history logging channel will be set active, i.e. ODB key <span style="color: purple;">/Logger/History/'''MIDAS'''/Active</span> will be set to "y".  


Note:this key replaces obsolete key  
<br>
[[Keys in the ODB /Logger tree #/Logger/WriteFileHistory|/Logger/WriteFileHistory]]  
;Note
: This key in the [[#MIDAS subtree|MIDAS subtree]]  replaces obsolete key [[Keys in the ODB /Logger tree #/Logger/WriteFileHistory|/Logger/WriteFileHistory]]  


<br>
<br>
Line 103: Line 135:




=== <span style="color: purple;">''/Logger/History/0/Debug''</span> ===
=== <span style="color: purple;">''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 109: Line 141:
</div>
</div>


If set to 1, debug is enabled for this history logging channel.
Each [[#<history-logging-channel> subtrees |history-logging-channel subtree]] contains a  <span style="color: purple;">''Debug''</span> key
which controls the debug level for this channel. If set to 0, debugging is disabled.
 
;Note
:This key in the [[#ODBC subtree|ODBC subtree]]  replaces obsolete key [[Keys in the ODB /Logger tree #/Logger/ODBC_Debug |/Logger/ODBC_Debug]]
 


<br>
<br>
Line 115: Line 152:
<br>
<br>


== <span style="color: purple;">''MIDAS''</span> subtree ==
This is the  [[#<history-logging-channel> subtrees| history-logging-channel subtree]]  that  controls  [[History System#History drivers|MIDAS-history]] logging.
For those Keys common to all history-logging-channels see
*[[#Type|Type]]
*[[#Active|Active]]
*[[#Debug|Debug]]
;Note
: By default, this logging channel will be set active.
The following section(s) describe keys unique to the <span style="color: purple;">''MIDAS''</span> subtree :




=== <span style="color: purple;">''/Logger/History/0/PerVariableHistory''</span> ===
 
=== <span style="color: purple;">''PerVariableHistory''</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 123: Line 176:
</div>
</div>


This key is present in a history channel of Type "MIDAS" only (see  [[#/Logger/History/0/Type|Type key]]).  
This key is present in the [[#MIDAS subtree|MIDAS subtree]] (whose [[#Type|Type]] key set to "MIDAS").


The default value of 0 is intended to operate the midas history in "traditional" mode. In this mode:
The default value of 0 is intended to operate the MIDAS-history in "traditional" mode. In this mode:
* there is one history record for each equipment
* there is one history record for each equipment
* history record id is equal to the equipment id
* history record id is equal to the equipment id
* /History/Events and /History/Tags are not required and can be safely deleted
* Subtrees <span style="color: purple;">/History/Events</span> and <span style="color: purple;">/History/Tags</span> are not required and can be safely deleted
 
 
;Note
: this key replaces obsolete key <span style="color: purple;">/History/PerVariableHistory</span>
 




Note: this key replaces obsolete key /history/PerVariableHistory
<br>
<br>
--------------
--------------
Line 140: Line 197:




== <span style="color: purple;">''ODBC''</span> subtree ==


This is the  [[#<history-logging-channel> subtrees| history-logging-channel subtree]]  that  controls  [[History System#History drivers|ODBC-history]] logging.




== <span style="color: purple;">''/Logger/History/1/''</span> subtree ==


This subtree controls history logging of ODBC
For those Keys common to all history-logging-channels see
*[[#Type|Type]]
*[[#Active|Active]]
*[[#Debug|Debug]]


;Note
:[[#Debug|Debug]] key in this subtree  replaces obsolete key [[Keys in the ODB /Logger tree #/Logger/ODBC_Debug |/Logger/ODBC_Debug]].




The following section(s) describe keys unique to the ODBC subtree:


=== <span style="color: purple;">''/Logger/History/1/Type''</span> ===
 
=== <span style="color: purple;">''Writer_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
* '''Default:'''  "ODBC"
* '''Default:'''  "history_writer"
</div>  
</div>


This key specifies the type of history logging for this ''history-logging-channel''.  
This key is present in the [[#ODBC subtree|ODBC]] subtree  (whose [[#Type|Type]] key is set to "ODBC").


[[mlogger]] creates this channel with this key set to "ODBC" since this subtree  <span style="color: purple;">''1''</span>  controls ODBC history logging.
It contains the ODBC Data Source Name for writing and is used by [[mlogger]].


;Note
: this key replaces obsolete key [[Keys in the ODB /Logger tree #/Logger/ODBC DSN |/Logger/ODBC DSN]]
<br>
<br>
----------
--------------
<br>
<br>


=== <span style="color: purple;">''/Logger/History/1/Active''</span> ===
=== <span style="color: purple;">''Reader_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:''' BOOL
* '''Type:''' STRING
* '''Default:'''  "n"
* '''Default:'''  "history_reader"
</div>
</div>


If set to "y", ODBC history logging is active.
This key is present in the [[#ODBC subtree|ODBC]] subtree  (whose [[#Type|Type]] key is set to "ODBC").


It contains the ODBC Data Source Name for reading, and is used by [[mhttpd]] and [[mhist]] utilities.


See also [[#/Logger/History/1/Type|Type key]].
;Note
: this key replaces obsolete key  <span style="color: purple;">/history/ODB_DSN</span>






=== <span style="color: purple;">''/Logger/History/1/Debug''</span> ===
<br>
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
--------------
* '''Type:''' INT
<br>
* '''Default:'''  0
 
</div>
 


If set to 1, debug is enabled for ODBC history logging.


See also [[#/Logger/History/1/Type|Type key]].
== <span style="color: purple;">''SQLITE''</span> subtree ==




Note: this key replaces obsolete key  /Logger/ODBC_Debug
This is the  [[#<history-logging-channel> subtrees| history-logging-channel subtree]]  that  controls  [[History System#History drivers|SQLITE-history]] logging.


<br>
--------------
<br>


=== <span style="color: purple;">''/Logger/History/1/Writer_ODBC_DSN''</span> ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' STRING
* '''Default:'''  "history_writer"
</div>


This key is present in a history channel of Type "ODBC" only, and is created by [[mlogger]].
For those Keys common to all history-logging-channels see
*[[#Type|Type]]
*[[#Active|Active]]
*[[#Debug|Debug]]


See also [[#/Logger/History/1/Type|Type key]].
The following section(s) describe keys unique to the SQLITE subtree :


Note: this key replaces obsolete key /logger/ODB_DSN


<br>
--------------
<br>




=== <span style="color: purple;">''/Logger/History/1/Reader_ODBC_DSN''</span> ===
=== <span style="color: purple;">''Sqlite 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:'''  "history_reader"
* '''Default:'''   
</div>
</div>


This key is present in a history channel of Type "ODBC" only, and is created by [[mlogger]].
This key is present in the [[#SQLITE subtree|SQLITE subtree]] (whose [[#Type|Type]] key is set to "SQLITE").
 
See also [[#/Logger/History/1/Type|Type key]].  
 
Note: this key replaces obsolete key /history/ODB_DSN


It contains the location of SQLITE database files, and is of the form "/file/system/path".




Line 228: Line 284:
--------------
--------------
<br>
<br>
== <span style="color: purple;">''MYSQL''</span> subtree ==
This is the  [[#<history-logging-channel> subtrees| history-logging-channel subtree]]  that  controls  [[History System#History drivers|MYSQL-history]] logging.






For those Keys common to all history-logging-channels see
*[[#Type|Type]]
*[[#Active|Active]]
*[[#Debug|Debug]]


== <span style="color: purple;">''/Logger/History/2/''</span> subtree ==
The following section(s) describe keys unique to the MYSQL subtree :


This subtree controls history logging of SQLITE




=== <span style="color: purple;">''/Logger/History/2/Type''</span> ===
=== <span style="color: purple;">''MYSQL Writer''</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:'''  "SQLITE"
* '''Default:'''  mysql_writer.txt
</div>  
</div>
 
This key specifies the type of history logging for this ''history-logging-channel''.


[[mlogger]] creates this channel with this key set to "SQLITE" since this subtree  <span style="color: purple;">''2''</span>  controls SQLITE history logging.
This key is present in the [[#MYSQL subtree|MYSQL subtree]]  (whose [[#Type|Type]] key is set to "MYSQL").


It contains the name of the config file for the MYSQL database and the history writer account. This file should look similar to the following: see [[History_System#Write_MYSQL-history_events]]
<br>
<br>
----------
--------------
<br>
<br>


=== <span style="color: purple;">''/Logger/History/2/Active''</span> ===
=== <span style="color: purple;">''MYSQL Reader''</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:''' STRING
* '''Default:'''  "n"
* '''Default:'''  mysql_reader.txt
</div>
</div>


If set to "y", SQLITE history logging is active.
This key is present in the [[#MYSQL subtree|MYSQL subtree]]  (whose  [[#Type|Type]] key is set to "MYSQL").


It contains the name of the config file for the MYSQL database and the history reader account. This file should look similar to the following: see [[History_System#Write_MYSQL-history_events]]
<br>
--------------
<br>


See also [[#/Logger/History/2/Type|Type key]].
== <span style="color: purple;">''FILE''</span> subtree ==




This is the  [[#<history-logging-channel> subtrees| history-logging-channel subtree]]  that  controls  [[History System#History drivers|FILE-history]] logging.


=== <span style="color: purple;">''/Logger/History/2/Debug''</span> ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' INT
* '''Default:'''  0
</div>


If set to 1, debug is enabled for SQLITE history logging.


See also [[#/Logger/History/2/Type|Type key]].
For those Keys common to all history-logging-channels see
*[[#Type|Type]]
*[[#Active|Active]]
*[[#Debug|Debug]]


The following section(s) describe keys unique to the FILE subtree :


<br>
--------------
<br>




=== <span style="color: purple;">''/Logger/History/2/Sqlite 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
* '''Default:'''   
* '''Default:'''  ""
</div>
</div>


This key is present in a history channel of Type "SQLITE" only, and is created by [[mlogger]].
This key is present in the [[#FILE subtree|FILE subtree]]  (whose [[#Type|Type]] key is set to "FILE").
 
It contains the name of the directory in which the FILE-history files are to be stored.
 
<br>
--------------
<br>


See also [[#/Logger/History/2/Type|Type key]].
[[Category: Logger Tree]] [[Category:History]]

Latest revision as of 09:08, 30 July 2020

Links




/Logger/History subtree

The ODB /Logger/History subtree is a subdirectory of the ODB /Logger tree, created when the MIDAS logger utility mlogger is started for the first time. The keys will be filled with default values which users may change as required to customize their experiments.

When mlogger is started for the first time, it now creates five /Logger/History/<history-logging-channel> ODB subtrees to control the five default history-logging-channels, named for each of the default History drivers.

The keys present in each history-logging-channel are described below.




Example

The following example shows the /Logger/History ODB subtree after creation by mlogger (obtained using the odbedit ls command). See below for information on individual keys.


[local:midas:S]/>ls -r /Logger/History
History
    MIDAS
        Type                    MIDAS
        Active                  y
        Debug                   0
        PerVariableHistory      0
    ODBC
        Type                    ODBC
        Active                  n
        Debug                   0
        Writer_ODBC_DSN         history_writer
        Reader_ODBC_DSN         history_reader
    SQLITE
        Type                    SQLITE
        Active                  n
        Debug                   0
        Sqlite dir
    MYSQL
        Type                    MYSQL
        Active                  n
        Debug                   0
        MYSQL Writer            mysql_writer.txt
        MYSQL Reader            mysql_reader.txt
    FILE
        Type                    FILE
        Active                  n
        Debug                   0
        History dir





<history-logging-channel> subtrees

Each <history-logging-channel> subtree in the Logger/History subtree is created (by mlogger) to control one of the history drivers available, and named for that history driver.
Presently the five following history-logging-channel subtrees are created :

  • MIDAS
  • ODBC
  • SQLITE
  • MYSQL
  • FILE

(see Example above).

By default, only the MIDAS-history logging channel is Active.

NOTE
In older MIDAS versions, the history-logging-channel subtrees were named 0,1,2... respectively




Keys common to all history logging channel subtrees

The following three keys are common to all history logging channel subtrees :


Type


Each history-logging-channel subtree contains a Type key which specifies the type of History driver for this channel.

When the subtree is created, the Type key is set to the respective History driver name, e.g.

ODB key /Logger/History/MIDAS/Type will be set to "MIDAS"
ODB key /Logger/History/ODBC/Type will be set to "ODBC"

and so on (see Example above for all five logging channels).




Active

  • Type: BOOL
  • Default: "n"

Each history-logging-channel subtree contains a Active key which enables or disables history logging in this channel.

By default, only the MIDAS-history logging channel will be set active, i.e. ODB key /Logger/History/MIDAS/Active will be set to "y".


Note
This key in the MIDAS subtree replaces obsolete key /Logger/WriteFileHistory





Debug

  • Type: INT
  • Default: 0

Each history-logging-channel subtree contains a Debug key which controls the debug level for this channel. If set to 0, debugging is disabled.

Note
This key in the ODBC subtree replaces obsolete key /Logger/ODBC_Debug






MIDAS subtree

This is the history-logging-channel subtree that controls MIDAS-history logging.

For those Keys common to all history-logging-channels see

Note
By default, this logging channel will be set active.


The following section(s) describe keys unique to the MIDAS subtree :


PerVariableHistory

  • Type: INT
  • Default: 0

This key is present in the MIDAS subtree (whose Type key set to "MIDAS").

The default value of 0 is intended to operate the MIDAS-history in "traditional" mode. In this mode:

  • there is one history record for each equipment
  • history record id is equal to the equipment id
  • Subtrees /History/Events and /History/Tags are not required and can be safely deleted


Note
this key replaces obsolete key /History/PerVariableHistory







ODBC subtree

This is the history-logging-channel subtree that controls ODBC-history logging.


For those Keys common to all history-logging-channels see

Note
Debug key in this subtree replaces obsolete key /Logger/ODBC_Debug.


The following section(s) describe keys unique to the ODBC subtree:


Writer_ODBC_DSN

  • Type: STRING
  • Default: "history_writer"

This key is present in the ODBC subtree (whose Type key is set to "ODBC").

It contains the ODBC Data Source Name for writing and is used by mlogger.

Note
this key replaces obsolete key /Logger/ODBC DSN




Reader_ODBC_DSN

  • Type: STRING
  • Default: "history_reader"

This key is present in the ODBC subtree (whose Type key is set to "ODBC").

It contains the ODBC Data Source Name for reading, and is used by mhttpd and mhist utilities.

Note
this key replaces obsolete key /history/ODB_DSN







SQLITE subtree

This is the history-logging-channel subtree that controls SQLITE-history logging.


For those Keys common to all history-logging-channels see

The following section(s) describe keys unique to the SQLITE subtree :



Sqlite dir

  • Type: STRING
  • Default:

This key is present in the SQLITE subtree (whose Type key is set to "SQLITE").

It contains the location of SQLITE database files, and is of the form "/file/system/path".





MYSQL subtree

This is the history-logging-channel subtree that controls MYSQL-history logging.


For those Keys common to all history-logging-channels see

The following section(s) describe keys unique to the MYSQL subtree :


MYSQL Writer

  • Type: STRING
  • Default: mysql_writer.txt

This key is present in the MYSQL subtree (whose Type key is set to "MYSQL").

It contains the name of the config file for the MYSQL database and the history writer account. This file should look similar to the following: see History_System#Write_MYSQL-history_events



MYSQL Reader

  • Type: STRING
  • Default: mysql_reader.txt

This key is present in the MYSQL subtree (whose Type key is set to "MYSQL").

It contains the name of the config file for the MYSQL database and the history reader account. This file should look similar to the following: see History_System#Write_MYSQL-history_events



FILE subtree

This is the history-logging-channel subtree that controls FILE-history logging.


For those Keys common to all history-logging-channels see

The following section(s) describe keys unique to the FILE subtree :


History dir

  • Type: STRING
  • Default: ""

This key is present in the FILE subtree (whose Type key is set to "FILE").

It contains the name of the directory in which the FILE-history files are to be stored.