Joule Configuration
Configure and enable core Joule features with respect to deployment need
Overview
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
Example configuration
Joule CLI switch
Apply the below command line switch to the Joule process when using a custom joule.properties file. Setting within this file will override the default setting
Enable services
To enable services using default setting the following
Event Lineage
Any event processor that changes the state of the passed event can have this action recorded within the event. There is a small memory overhead to keep changed state.
This is currently an experimental feature which is undergoing further development to determine its usefulness within a stream processing context. Therefore it is set to disabled as a default setting.
Internal Database
Joule ships with an embedded database, DuckDB, that provides core features such as metrics processing, event tapping and external state queries. This feature is enabled by default.
See Internal Database Configuration for further details.
Rest API
Joule ships with an embedded Rest API that provides external query and Web socket APIs. See Rest API documentation for further details. This feature is enabled by default.
See Rest API Configuration for further details.
Internal Database Configuration
Joule ships with an in-memory database to support event capturing, metrics and ad-hoc queries for processors.
Example
Available Properties
Property | Description | Default |
---|---|---|
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: 512MB |
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 worker threads used by the database. | default: 2 |
joule.db.default_order | The query set 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.
Available Properties
Property | Description | Default |
---|---|---|
joule.rest.port | Rest API port | default: 9080 |
joule.rest.downloadPath | Directory the system rest consumer will download files to ready for data ingestion See Rest API documentation | default: downloads |
joule.rest.maxFileSize | The maximum individual file size allowed In GB | default: 2GB |
joule.rest.InMemoryFileSize | The maximum file size to handle in memory in MB | default: 100MB |
joule.rest.totalRequestSize | The maximum size of the entire multipart request in GB | default: 5GB |
joule.rest.enableSSL | If you want to secure your Joule process with SSL set this flag to true. 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 |
Last updated