Engine Configuration

Skip to end of metadata
Go to start of metadata

Main configuration file: engine.xml

Overview

Main configuration file is located in conf subdirectory of LOGALYZE_HOME and called engine.xml by default.

It has a XML Schema file in the same directory:

- logalyze-engine-config-1.0.xsd for LOGalyze version from 4.0.0 to 4.1.3

- logalyze-engine-config-2.0.xsd for LOGalyze version 4.1.4

Configuration options

Option
Xpath
Description
Default value
Repository Directory
/engine-config/repository@dir
Absolute or relative path to repository folder. LOGalyze will store here the definition files downloaded from central LOGalyze Repository. Relative path are calculated from conf directory. Since: 4.0.0 repository
Effective path: $LOGALYZE_HOME/conf/repository
Definition files
/engine-config/definitions@file
Absolute or relative path to configuration file of Definitions. Attribute defaultFor contains the default definition type for that file. Can exist as many as needed. Since: 4.0.0  
Configuration file for Collectors
/engine-config/collectors@file
Absolute or relative path to configuration file of Collectors. Relative path are calculated from conf directory. Since: 4.0.0 collectors.xml
Effective path: $LOGALYZE_HOME/conf/collectors.xml
Internal Queue Capacity /engine-config/internalqueuecapacity Numerical value. Size of internal process queue. Number of log object can be stored in the internal queue. Since: 4.0.0 10000
Number of processor threads
/engine-config/numofprocthreads
Numerical value. Number of processor threads. Since: 4.1.4 2
Index directory
/engine-config/indexdir Absolute or relative path to index root folder. LOGalyze will create subdirectories for indexes under this folder. Since: 4.0.0 ../var/index
LogStore directory /engine-config/logstoredir Absolute or relative path to logstore root folder. LOGalyze will create subdirectories for raw log files under this folder. Since: 4.0.0 ../var/logstore
Embedded DB directory
/engine-config/dbdir Absolute or relative path to database folder. LOGalyze will store embedded database files under this folder. Since: 4.0.0 ../var/db
Reports directory
/engine-config/reportsdir Absolute or relative path to reports folder. LOGalyze will store generated report files under this folder. Since: 4.0.0 ../var/reports
Collectors state store directory /engine-config/collectordir Absolute or relative path to collector folder. LOGalyze will store collectors state store files under this folder. Since: 4.1.4 ../var/collector
Host groups store directory /engine-config/hostsdir Absolute or relative path to hosts folder. LOGalyze will store host grouping files under this folder. Since: 4.1.4 ../var/hosts
Index configuration /engine-config/indexconfig See below. Since: 4.1.4  
Index and logstore rolling configuration /engine-config/rollingconfig See below. Since: 4.1.4  
Embedded DB settings
/engine-config/db
See below. Since: 4.1.4  
SOAP API URI
/engine-config/endpointURI SOAP API endpoint. Since: 4.0.0 http://localhost:8088/logalyze
API Key
/engine-config/authkey
API Key for clients. With this key clients do not need to start user session and authenticate . Since: 4.0.0 ak
SMTP Settings
/engine-config/smtp
See below. Since: 4.0.0  

Index configuration

Option
XPath
Description
Default value
writelocktimeout
/engine-config/indexconfig/writelocktimeout
Lucene IndexWriterConfig's writeLockTimeout property in ms.
LOGalyze/Lucene: 1000
rambuffersizemb
/engine-config/indexconfig/rambuffersizemb
Lucene IndexWriterConfig's ramBufferSizeMB property.
48 (Lucene: 16)

Index and logstore rolling configuration

Option
XPath
Description
Default value
indexrollingfreq
/engine-config/rollingconfig/indexrollingfreq
Index rolling frequency. Valid values: 1h, 12h, 24h, w, m (hourly, half-daily, daily, weekly, monthly).
24h
indexdocnumlimit
/engine-config/rollingconfig/indexdocnumlimit
Maximum number of documents per index.
10.000.000
rawentrynumlimit
/engine-config/rollingconfig/rawentrynumlimit
Maximum number of log entries in logstore file. 0 means that there is no limit.
0
rawfilesizethreshold
/engine-config/rollingconfig/rawfilesizethreshold
Maximum file size of logstore file in bytes. Valid value examples: 1, 1kB, 1MB, 1GB. 0 means that there is no limit. 0

Embedded DB Settings

Option
XPath
Description
Default value
name
/engine-config/db@name
Name of database.
logalyzeDb
user
/engine-config/db@user
Username for database.
logalyze
password
/engine-config/db@password
Password for database.
logalyze

SMTP Settings

Option
XPath
Description
Default value
SMTP server
/engine-config/smtp/property@key=smtp.host
SMTP server hostname or IP address
127.0.0.1
SMTP port
/engine-config/smtp/property@key=smtp.port
SMTP server port
25
Use SSL
/engine-config/smtp/property@key=smtp.ssl
Boolean. Use SSL or not.
false
Need authentication
/engine-config/smtp/property@key=smtp.auth
Need SMTP password authentication
false
SMTP username
/engine-config/smtp/property@key=smtp.user
Username for SMTP authentication
 
SMTP password
/engine-config/smtp/property@key=smtp.password
Password for SMTP authentication
 
From address
/engine-config/smtp/property@key=email.from
From email address
 
To store or not
/engine-config/smtp/property@key=store
If true, sent mails will be stored in an IMAP folder
false
IMAP server
/engine-config/smtp/property@key=imap.host
IMAP server hostname or IP address
127.0.0.1
IMAP port
/engine-config/smtp/property@key=imap.port
IMAP server port
143
IMAP username
/engine-config/smtp/property@key=imap.user
IMAP username for authentication
 
IMAP password
/engine-config/smtp/property@key=imap.password
IMAP password for authentication
 
To debug or not
/engine-config/smtp/property@key=debug
If true, see engine.log for debug log messages
false
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.