These docs are for v5.0.0. Click to read the latest docs for v7.6.0.

Directory Layout

This section describes the default ESF directory layout that is created upon installation. The default installation directory is as follows:

/opt/eurotech/

The esf sub-directory is a logical link on the actual ESF release directory:

esf -> /opt/eurotech/esf_3.0.2_reliagate-10-20_yocto_1.2.1`
esf_3.0.2_reliagate-10-20_yocto_1.2.1`

ESF File Structure

All of the ESF files are located within this parent directory using the structure shown in the following table:

DirectoryDescription
binScripts that start ESF
consoleWeb console CSS file
dataData of the ESF application
data/dbHSQL embedded database
data/paho-persistenceMessage storage for paho (MQTT client) persistence
data/snapshotsXML snapshot files; up to 10 successive configurations including the original (see Snapshot Management)
kuraConfiguration files for the ESF framework and logging
kura/pluginsAll of the ESF specific jar files
kura/packagesDeployment package files that are not part of the standard ESF framework, but are installed at a later time (see Application Management )
lib/extRepository for the native libraries config files
logLog file from the latest ESF installation
pluginsAll of the libraries needed for ESF execution as jar files

Log Files

ESF regularly updates two log files in the /var/log directory:

  • /var/log/kura-console.log - stores the standard console output of the application. This log file contains the eventual errors that are thrown upon ESF startup.

  • /var/log/kura.log - stores all of the logging information from ESF bundles. The logger levels are defined in the log4j.properties configuration file as shown below:

/opt/eurotech/esf/kura/log4j.properties

The default logger level in this file is set to INFO. This level may be modified for the whole application or for a specific bundle as shown in the following example:

log4j.logger.org.eclipse.kura=INFO
log4j.logger.org.eclipse.kura.net.admin=DEBUG

In this example, the logger level is set to DEBUG only for the net.admin bundle. Additional, more specific, properties may be defined as required for your particular logging needs. The logger levels are hierarchical, so that those in a deeper level of the hierarchy will apply; otherwise, the more general logger level will override them.

Once the logger levels are modified as needed and the log4j.properties configuration file is saved, ESF must be restarted in order for the changes to take affect.