logpresso.conf file properties
Overview
This document describes the options defined in logpresso.conf.
Environment variables and launcher options
The following options control the runtime environment, such as JVM memory/GC, ulimit, and paths, and are not mapped to -D system properties (some are used for the JVM flags -X, -XX or for script behavior).
| Option | Function summary | Allowed values | Default |
|---|---|---|---|
| ETCDIR | Configuration file directory location | Path | $BASEDIR/etc |
| LOGDIR | Log directory location | Path | $BASEDIR/log |
| HOSTNAME | Host name (compatibility) | String | $(hostname) |
| ARAQNE_CORE_VERSION | Core version (display/compatibility) | String | Undefined |
| OPEN_FILE_LIMIT | Process open file limit | Integer | 50,240 |
| OPEN_PROC_LIMIT | Process count limit | Integer | 50,240 |
| JAVA_HOME | JDK path | Path | Undefined |
| MIN_HEAP_SIZE | JVM initial heap size | e.g. 2G | 2G |
| MAX_HEAP_SIZE | JVM maximum heap size | e.g. 4G | 4G |
| MAX_PERMGEN_SIZE | PermGen (old JDK) | e.g. 300M | 300M |
| MAX_DIRECT_MEM_SIZE | Direct memory | e.g. 4G | 4G |
| GC_LOG_FILECOUNT | Number of GC log files | Integer | 10 |
| GC_LOG_FILESIZE | Maximum size of one GC log | Size (e.g. 10240K) | 10240K |
| TRIM_NATIVE_HEAP_INTERVAL | Native heap trim interval | Milliseconds | 300,000 |
| PIDFILE | PID file path | Path | /var/run/logpresso/logpresso.pid |
Note: TRIM_NATIVE_HEAP_INTERVAL is applied as -XX:TrimNativeHeapInterval on JDK 21 or later. MIN_HEAP_SIZE/MAX_HEAP_SIZE are applied as -Xms/-Xmx, respectively.
System options
The following options are passed by the launcher as system properties (the mapped -D key is noted in parentheses).
| Option | Function summary | Allowed values | Default |
|---|---|---|---|
BASEDIR (-Daraqne.dir) | Default installation path | Path | /opt/logpresso |
CERTDIR (-Daraqne.cert.dir) | Certificate/key directory | Path | Undefined |
CACHEDIR (-Daraqne.cache.dir) | Cache directory (components) | Path | $BASEDIR/cache (recommended) |
DATADIR (-Daraqne.data.dir) | Data directory | Path | $BASEDIR/data |
DIAGDIR (-Daraqne.diag.dir) | Abnormal termination/memory dump storage | Path | $BASEDIR/diag |
DOWNDIR (-Daraqne.download.dir) | Temporary bundle download directory | Path | $BASEDIR/download |
SFTPDIR (-Daraqne.home.dir) | SFTP home directory | Path | $BASEDIR/home |
PLGNDIR (-Daraqne.plugin.dir) | Plugin directory | Path | $BASEDIR/plugin |
LOGDIR (-Daraqne.log.dir) | Log directory | Path | $BASEDIR/log |
INDEXDIR (-Daraqne.index.dir) | Index directory | Path | $DATADIR/logpresso-index/online |
LOG_API_STATE_DIR (-Daraqne.logapi.state.dir) | Log API state directory | Path | $DATADIR/araqne-log-api/state |
PACKMANDIR (-Daraqne.packman.dir) | Package directory | Path | $BASEDIR/pkg |
PIDFILE (-Daraqne.core.pid_file) | PID file path | Path | /var/run/logpresso/logpresso.pid |
HTTP_404 (-Daraqne.http.404) | 404 page path | Path | Predefined page |
HTTP_500 (-Daraqne.http.500) | 500 page path | Path | Predefined page |
HTTPD_AES256 (-Daraqne.httpd.aes256) | Use strong TLS suites | disabled/enabled | disabled |
HTTPD_CORS (-Daraqne.httpd.cors) | Enable CORS | disabled/enabled | disabled |
HTTPD_LOG_PATH (-Daraqne.httpd.log_path) | HTTP POST logging path | Path | $LOGDIR/httpd |
HTTPD_LOG_RETENTION (-Daraqne.httpd.log_days) | HTTP log retention days | Integer (days) | 7 |
HTTPD_WORKER_POOL (-Daraqne.httpd.max_worker) | Number of web worker threads | 4 - number of CPU cores | Automatic |
HTTPD_XSS_PROTECT (-Daraqne.httpd.xss_protection) | XSS protection header | disabled/enabled | enabled |
HTTPS_PROTOCOL (-Daraqne.https.protocols) | TLS protocol list | TLSv1.1/1.2/1.3,... | Undefined (null) |
SSH_OPEN (-Daraqne.ssh.server) | Enable SSH service | disabled/enabled | disabled |
SSH_ADDR (-Daraqne.ssh.address) | SSH bind address | IPv4 | 127.0.0.1 |
SSH_PORT (-Daraqne.ssh.port) | SSH port | 1–65535 | 7022 |
SSH_TMOUT (-Daraqne.ssh.timeout) | SSH session timeout (ms) | Integer | 600,000 |
TEL_OPEN (-Daraqne.telnet.server) | Telnet service | disabled/enabled | disabled |
TEL_ADDR (-Daraqne.telnet.address) | Telnet bind address | IPv4 | 127.0.0.1 |
TEL_PORT (-Daraqne.telnet.port) | Telnet port | 1–65535 | 7004 |
ADM_IP (-Daraqne.dom.admin_trust_hosts) | Administrator access allow IP | IPv4 (up to 2, comma-separated) | Undefined (unlimited) |
BLOCK_CC_ADM (-Daraqne.dom.block_concurrent_admin) | Block concurrent administrator login | disabled/enabled | disabled |
BLOCK_CC_LOGIN (-Daraqne.dom.block_concurrent_login) | Block concurrent login | disabled/enabled | disabled |
SSO_TMOUT (-Daraqne.sso.timeout) | SSO token timeout (ms) | Integer | 3,600,000 |
LOGKEEPDAY (-Daraqne.log.keepdays) | Log retention days | Integer (days) | 7 |
TAIL_LIMIT (-Daraqne.log.last_size) | logger.tail result limit | Integer (<=0 is treated as 0) | 1,000 |
LOGSTORAGE_REPAIR (-Daraqne.logstorage.repair) | Log storage integrity repair | disabled/enabled | enabled |
MSGBUS_DELAY (-Daraqne.msgbus.delay) | Simulate response delay (ms) | Integer | 0 |
RPC_CLIENT_IOWORKER (-Daraqne.rpc.client.ioworker) | RPC client IO workers | Integer | 2 |
RPC_CLIENT_OIO (-Daraqne.rpc.client.oio) | RPC OIO mode (blocking I/O) | disabled/enabled | disabled |
RPC_WORKER (-Daraqne.rpc.max_worker) | RPC worker thread upper limit | 4–8 | Automatic |
REPAIR_FORCECHECK (-Dlogpresso.repair.forcecheck) | Force integrity check on next boot | false/true | false |
LOG_EMPTY_LINE (-Daraqne.logapi.collect_empty_line) | Allow empty line collection | disabled/enabled | disabled |
LOG_EVICT_MS (-Daraqne.logapi.evict_interval) | Collection buffer eviction interval (ms) | Integer | 3,600,000 |
LOG_WATCHER_MODE (-Daraqne.logapi.watcher) | File watch mode | naive/null | null |
LOG_NIO_POLL_MS (-Daraqne.nio.poll_interval) | NIO polling interval (ms) | Integer | 0 |
LOG_NIO_POLL_TMOUT (-Daraqne.nio.poll_timeout) | NIO polling timeout (ms) | Integer | 100 |
HP_FTP_FIX (-Dlogpresso.ftp.rotation.useWuFtpFix) | WuFtpd compatibility fix | false/true | false |
JDBC_FETCH (-Dlogpresso.jdbc.fetch_size) | DB fetch size | Integer | 10,000 (collection)/5,000 (query) |
SNMP_MAX_REPEAT (-Dlogpresso.snmp.bulk_max_repeat) | SNMP bulk max-repeat | Integer | 20 |
SSH_BULK_REQ (-Dlogpresso.ssh.bulk_req) | SFTP bulk request count | Integer | 16 |
ALLOWED_FILE_SCAN_PATHS (-Daraqne.logdb.allowed_file_scan_paths) | Local file access allowed paths | Path (comma-separated) | $DATADIR/araqne-logdb/scan,$LOGDIR |
LOGDB_ARRAY_CAP (-Daraqne.logdb.array_capacity) | array() input upper limit | Integer | 100 |
CEPENGINE (-Daraqne.logdb.cepengine) | CEP storage | mem/offheap | mem |
JDK_REGEX_STEP_LIMIT (-Daraqne.logdb.regex.jdk_regex_step_limit) | JDK regex step limit | -1 or integer 0 or greater | 300,000,000 |
COUNTER_SLOT (-Daraqne.logdb.counter_slot) | Number of slotted counter slots | Integer | CPU/configuration automatic |
DISCARD_NULL_COL (-Daraqne.logdb.discard_null_column) | Remove null columns | false/true | false |
DISCARD_NULL_GRP (-Daraqne.logdb.discard_null_group) | Remove null groups | false/true | false |
EXEC_QUERY (-Daraqne.logdb.exec_query) | Allow exec/execpip | disabled/enabled | disabled |
LEGACY_STR_MATCH (-Daraqne.logdb.legacy_string_match) | Legacy IP string matching | disabled/enabled | disabled |
COLUMNS_LIMIT (-Daraqne.logdb.max_columns) | CSV column count upper limit | Integer | 10,000 |
LOGDB_PURGE (-Daraqne.logdb.purge) | Allow purge command | disabled/enabled | disabled |
QUERY_POOL_SIZE (-Daraqne.logdb.query_pool_size) | Number of parallel table query cores | Integer | Number of CPUs |
SORT_HEAP_SIZE (-Daraqne.logdb.sort_offheap) | sort offheap size | Size (MB/G) | 100MB |
SORT_PARTITIONS (-Daraqne.logdb.sort_partitions) | Number of sort partitions | Integer | 32 |
TABLE_OPTIMIZER (-Daraqne.logdb.table_scan_optimizer) | Scan optimizer | disabled/enabled | enabled |
UTF8BOM (-Daraqne.logdb.utf8bom) | Add outputcsv BOM | false/true | false |
VALUES_CAP (-Daraqne.logdb.values_capacity) | values() input upper limit | Integer | 100 |
WGET_SIZE_LIMIT (-Daraqne.logdb.wget_max_size) | wget response maximum size | Bytes | 10,485,760 |
CUREVFIT_LIMIT (-Dlogpresso.curvefit.limit) | curvefit input upper limit | Integer | 10,000 |
INSTANT_CACHING (-Dlogpresso.index.instant_caching) | Instant caching | disabled/enabled | enabled |
OLD_FULLTEXT (-Dlogpresso.index.old_fulltext_func) | Keep old full-text search function | disabled/enabled | disabled |
INVERTED_CACHE_SIZE (-Dlogpresso.inverted_cache_size) | Inverted cache size | Bytes | 104,857,600 |
KMEANS_LIMIT (-Dlogpresso.kmeans.limit) | kmeans input upper limit | Integer | 10,000 |
CACHE_RECORD_STATS (-Dlogpresso.log_cache_record_stats) | Table cache statistics | false/true | false |
CACHE_SIZE (-Dlogpresso.log_cache_size) | Table cache size | Bytes | 104,857,600 |
QUERY_RESULT_POOL_SIZE (-Dlogpresso.logstorage.query_result_pool_size) | Temporary result generation threads | 4 - CPU cores | Automatic |
FCST_SERIAL (-Dlogpresso.ml.forecast.serial) | forecast serial execution | f/t | f |
LOF_OPTIMIZER (-Dlogpresso.ml.lof.optimize) | Use LOF optimization | f/t | t |
DETECT_DEADLOCK (-Dlogpresso.query.deadlock_detect) | Deadlock detection | disabled/enabled | enabled |
REPAIR_CHECKDAYS (-Dlogpresso.repair.checkdays) | Integrity check window (days) | Integer/-1 | 2 |
STL_LIMIT (-Dlogpresso.stl.limit) | stl input upper limit | Integer | 1,000 |
ASYNC_POOL_SIZE (-Dlogpresso.stream.async_pool_size) | Async stream pool size | 1 < integer ≤ 100 | Number of CPUs |
STREAMJOIN_BUFFER_SIZE (-Dlogpresso.streamjoin.max_buffer_size) | Stream join buffer | Size (M/G) | 1000M |
SENTRY_LINK_SPEED (-Dlogpresso.sentry.default_link_speed) | Sentry link speed | 10m/100m/1g/10g | 0 |
SENTRY_FLOWCTRL (-Dlogpresso.sentry.disableFlowControl) | Flow control | false/true | false |
SENTRY_HOSTNAME (-Dlogpresso.sentry.hostname) | Sentry host name | String | $(hostname) |
SENTRY_AWS_PROFILE (-Dlogpresso.sentry.logger_provisioning_profile) | Sentry provisioning profile | String (UUID, etc.) | null |
ROOT_ID (-Daraqne.dom.master_account) | Rename root account ID | String | root |
HASHJOINTHRESHOLD (-Daraqne.hashjointhreshold) | Hash join threshold | Integer | 10,000,000 |
VERIFY_SIGN (-Dlogpresso.packman.verify_sign) | Allow unsigned packages | disabled/enabled | enabled |
AWT_HEADLESS (-Djava.awt.headless) | Headless mode | false/true | true |
Notes:
SSH_OPEN/TEL_OPENpass the related properties only when the value is notdisabled.- Some items are commented out in the template and are applied when uncommented.