Joule
Search
⌃K

Joule Configuration

Joule internal setting can be custom configured to suit the needs of your environment. To override the default setting provide a single configuration file and use the -c command line switch to specify the file path.

Eample configuration

# Internal database setting
joule.db.path=./jouleDB/joule.db
joule.db.memoryOnly=false
joule.db.memory_limit='4GB'
joule.db.access_mode=READ_WRITE
joule.db.threads=8
joule.db.default_order='DESC'
​
# RestAPI setting
joule.rest.port=8080
​
# SSL config
joule.rest.enableSSL=false
joule.rest.pemCertPath=./conf/cert.pem
joule.rest.keyCertPath=./conf/key.pem
Joule CLI switch -c /app/joule/config/joule.properties

Database Configuration

Joule ships with an in-memory database to support event capturing, metrics and ad-hoc queries for processors.

Example

# Internal database setting
joule.db.path=./db/joule.db
joule.db.memoryOnly=false
joule.db.memory_limit=4GB
joule.db.access_mode=READ_WRITE
joule.db.threads=8
joule.db.default_order=DESC

joule.db.path

Relative path to the Joule process include database file name.
default: ./db/joule.db

joule.db.memoryOnly

Boolean flag set to true an in-memory database is created. Note that for an in-memory database no data is persisted to disk.
default: false

joule.db.memory_limit

The maximum memory of the database system (e.g. 1GB)
default: 2GB

joule.db.access_mode

Access mode of the database (AUTOMATIC, READ_ONLY or READ_WRITE).
default: READ_WRITE

joule.db.threads

The number of total threads used by the database.
default: 4

joule.db.default_order

The order type used when none is specified (ASC or DESC).
default: DESC

Rest API Configuration

Joule enables Rest API when the in-memory database is enabled. Dynamic endpoints are created to support data exports and paginated queries. See Rest API documentation for further information.
# RestAPI setting
joule.rest.port=8080
​
# SSL config
joule.rest.enableSSL=false
joule.rest.pemCertPath=./conf/cert.pem
joule.rest.keyCertPath=./conf/key.pem

joule.rest.port

Rest API port
default: 8080

joule.rest.enableSSL

If you want to secure your Joule process with SSL set this flag to true. Default setting is false. Supported certificate formats are PKCS#12 (.p12) and PKCS#8 (.pem) and Java KeyStore (.jks).
default: false

joule.rest.pemCertPath

Certificate from a trusted CA or a self-signed certificate.
default: /app/joule/certs/cert.pem

joule.rest.keyCertPath

Private key
default" /app/joule/certs/key.pem