====== EOS Logging ======

This page contains some notes on how to enable and configure database logging for the EOS server.
Two kinds of events can be logged : 
  * User login and logout events
  * Dataset events

The IOS extension (used by the OFM product) also has [[flashmap:ios:log|logging capabilities]].

===== Configuration File =====

To make logging configurable, make sure the **LoginLogConfiguration** and **AccessLogConfiguration** entries are present in the ''<installation root>/config/eos.ini'' file : 

<code bash>
#
# Orbit Server Configuration File
#
OrbitServer=
 Version=3
 LoginLogConfiguration=
  Enabled=true
  DataSourceName=logdb
  TableName=logins
 AccessLogConfiguration=
  Enabled=true
  DataSourceName=logdb
  TableName=datasets
  DataSetMasks=*multinet*
</code>

These settings are : 
  * LoginLogConfiguration : //Login event section//
    * Enabled : //Enabled?//
    * DataSourceName : //Which datasource?//
    * TableName : //Which table?//
  * AccessLogConfiguration: //Dataset event section//
    * Enabled : //Enabled?//
    * DataSourceName : //Which datasource?//
    * TableName : //Which table?//
    * DataSetMasks : //Dataset mask for constraining the access log.//


===== Database Setup =====

For logging login events, you must prepare a table (default name is 'logins') defining the following columns : 
  * loginidentifier (text) : //A login identifier (can be used to differenciate sessions of the same user)//
  * when (date/time) : //Login timestamp//
  * description (text) : //Description of the event ('login' or 'logout')//
  * usergroupname (text) : //Name of the usergroup of the user//
  * username (text) : //Name of the user//
  * localhostaddress (text) : //The ip address of the login//
  * localhostname (text) : //The name of the system host of the user//
  * localusername (text) : //The name of the system user of the user//

For logging dataset access events, you must prepare a table (default name is 'datasets') defining the following columns : 
  * datsetname(text) : //Name of the dataset//
  * when (date/time) : //Login timestamp//
  * usergroupname (text) : //Name of the usergroup of the user//
  * username (text) : //Name of the user//
  * loginidentifier (text) : //A description of the operation ((Examples : 'Render request', 'Geocode setup', 'Operation: GetBoundsOperation', ...))//
  * description (text) : //Description of the event ('login' or 'logout')//


The server accesses this table through a 'datasource'.  A datasource defines the access to a database for the eos server.\\
Using the [[43:orbitgis:tools:database_connections|JDSA utility]], you can add the datasource.