logpresso.conf File Properties

Overview

This document describes the options defined in logpresso.conf.

Environment Variables and Launcher Options

The options below control the runtime environment such as JVM memory/GC, ulimit, and paths. They are not mapped to -D system properties (some are used as JVM flags -X, -XX or affect script behavior).

OptionDescriptionAllowed ValuesDefault
ETCDIRConfiguration file directory pathPath$BASEDIR/etc
LOGDIRLog directory pathPath$BASEDIR/log
HOSTNAMEHostname (compatibility)String$(hostname)
ARAQNE_CORE_VERSIONCore version (display/compat)StringUndefined
OPEN_FILE_LIMITProcess open file limitInteger50,240
OPEN_PROC_LIMITProcess count limitInteger50,240
JAVA_HOMEJDK pathPathUndefined
MIN_HEAP_SIZEJVM initial heap sizee.g., 2G2G
MAX_HEAP_SIZEJVM maximum heap sizee.g., 4G4G
MAX_PERMGEN_SIZEPermGen (legacy JDK)e.g., 300M300M
MAX_DIRECT_MEM_SIZEDirect memorye.g., 4G4G
GC_LOG_FILECOUNTNumber of GC log filesInteger10
GC_LOG_FILESIZEMax size per GC log fileSize (e.g., 10240K)10240K
TRIM_NATIVE_HEAP_INTERVALNative heap trim intervalMilliseconds300,000
PIDFILEPID file pathPath/var/run/logpresso/logpresso.pid

Note: TRIM_NATIVE_HEAP_INTERVAL is applied as -XX:TrimNativeHeapInterval on JDK 21 and above. MIN_HEAP_SIZE/MAX_HEAP_SIZE are applied as -Xms/-Xmx respectively.

System Options

The options below are passed by the launcher as system properties (the mapped -D key is shown in parentheses).

OptionDescriptionAllowed ValuesDefault
BASEDIR (-Daraqne.dir)Base installation pathPath/opt/logpresso
CERTDIR (-Daraqne.cert.dir)Certificate/key directoryPathUndefined
CACHEDIR (-Daraqne.cache.dir)Cache directory (components)Path$BASEDIR/cache (recommended)
DATADIR (-Daraqne.data.dir)Data directoryPath$BASEDIR/data
DIAGDIR (-Daraqne.diag.dir)Abnormal termination/memory dump storagePath$BASEDIR/diag
DOWNDIR (-Daraqne.download.dir)Bundle download temporary directoryPath$BASEDIR/download
SFTPDIR (-Daraqne.home.dir)SFTP home directoryPath$BASEDIR/home
PLGNDIR (-Daraqne.plugin.dir)Plugin directoryPath$BASEDIR/plugin
LOGDIR (-Daraqne.log.dir)Log directoryPath$BASEDIR/log
INDEXDIR (-Daraqne.index.dir)Index directoryPath$DATADIR/logpresso-index/online
LOG_API_STATE_DIR (-Daraqne.logapi.state.dir)Log API state directoryPath$DATADIR/araqne-log-api/state
PACKMANDIR (-Daraqne.packman.dir)Package directoryPath$BASEDIR/pkg
PIDFILE (-Daraqne.core.pid_file)PID file pathPath/var/run/logpresso/logpresso.pid
HTTP_404 (-Daraqne.http.404)404 page pathPathPredefined page
HTTP_500 (-Daraqne.http.500)500 page pathPathPredefined page
HTTPD_AES256 (-Daraqne.httpd.aes256)Use strong TLS cipher suitesdisabled/enableddisabled
HTTPD_CORS (-Daraqne.httpd.cors)Enable CORSdisabled/enableddisabled
HTTPD_LOG_PATH (-Daraqne.httpd.log_path)HTTP POST logging pathPath$LOGDIR/httpd
HTTPD_LOG_RETENTION (-Daraqne.httpd.log_days)HTTP log retention daysInteger (days)7
HTTPD_WORKER_POOL (-Daraqne.httpd.max_worker)Web worker thread count4 to CPU core countAuto
HTTPD_XSS_PROTECT (-Daraqne.httpd.xss_protection)XSS protection headerdisabled/enabledenabled
HTTPS_PROTOCOL (-Daraqne.https.protocols)TLS protocol listTLSv1.1/1.2/1.3,...Undefined (null)
SSH_OPEN (-Daraqne.ssh.server)Enable SSH servicedisabled/enableddisabled
SSH_ADDR (-Daraqne.ssh.address)SSH bind addressIPv4127.0.0.1
SSH_PORT (-Daraqne.ssh.port)SSH port1--655357022
SSH_TMOUT (-Daraqne.ssh.timeout)SSH session timeout (ms)Integer600,000
TEL_OPEN (-Daraqne.telnet.server)Telnet servicedisabled/enableddisabled
TEL_ADDR (-Daraqne.telnet.address)Telnet bind addressIPv4127.0.0.1
TEL_PORT (-Daraqne.telnet.port)Telnet port1--655357004
ADM_IP (-Daraqne.dom.admin_trust_hosts)Admin access allowed IPsIPv4 (max 2, comma-separated)Undefined (unlimited)
BLOCK_CC_ADM (-Daraqne.dom.block_concurrent_admin)Block concurrent admin logindisabled/enableddisabled
BLOCK_CC_LOGIN (-Daraqne.dom.block_concurrent_login)Block concurrent logindisabled/enableddisabled
SSO_TMOUT (-Daraqne.sso.timeout)SSO token timeout (ms)Integer3,600,000
LOGKEEPDAY (-Daraqne.log.keepdays)Log retention daysInteger (days)7
TAIL_LIMIT (-Daraqne.log.last_size)logger.tail result limitInteger (<=0 treated as 0)1,000
LOGSTORAGE_REPAIR (-Daraqne.logstorage.repair)Log storage integrity repairdisabled/enabledenabled
MSGBUS_DELAY (-Daraqne.msgbus.delay)Response delay simulation (ms)Integer0
RPC_CLIENT_IOWORKER (-Daraqne.rpc.client.ioworker)RPC client IO workersInteger2
RPC_CLIENT_OIO (-Daraqne.rpc.client.oio)RPC OIO mode (blocking I/O)disabled/enableddisabled
RPC_WORKER (-Daraqne.rpc.max_worker)RPC worker thread limit4--8Auto
REPAIR_FORCECHECK (-Dlogpresso.repair.forcecheck)Force integrity check on next bootfalse/truefalse
LOG_EMPTY_LINE (-Daraqne.logapi.collect_empty_line)Allow empty line collectiondisabled/enableddisabled
LOG_EVICT_MS (-Daraqne.logapi.evict_interval)Collection buffer eviction interval (ms)Integer3,600,000
LOG_WATCHER_MODE (-Daraqne.logapi.watcher)File watch modenaive/nullnull
LOG_NIO_POLL_MS (-Daraqne.nio.poll_interval)NIO polling interval (ms)Integer0
LOG_NIO_POLL_TMOUT (-Daraqne.nio.poll_timeout)NIO polling timeout (ms)Integer100
HP_FTP_FIX (-Dlogpresso.ftp.rotation.useWuFtpFix)WuFtpd compatibility fixfalse/truefalse
JDBC_FETCH (-Dlogpresso.jdbc.fetch_size)DB fetch sizeInteger10,000 (collection) / 5,000 (query)
SNMP_MAX_REPEAT (-Dlogpresso.snmp.bulk_max_repeat)SNMP bulk max-repeatInteger20
SSH_BULK_REQ (-Dlogpresso.ssh.bulk_req)SFTP bulk request countInteger16
ALLOWED_FILE_SCAN_PATHS (-Daraqne.logdb.allowed_file_scan_paths)Allowed local file access pathsPaths (comma-separated)$DATADIR/araqne-logdb/scan,$LOGDIR
LOGDB_ARRAY_CAP (-Daraqne.logdb.array_capacity)array() input limitInteger100
CEPENGINE (-Daraqne.logdb.cepengine)CEP storagemem/offheapmem
JDK_REGEX_STEP_LIMIT (-Daraqne.logdb.regex.jdk_regex_step_limit)JDK regex step limit-1 or integer >= 0300,000,000
COUNTER_SLOT (-Daraqne.logdb.counter_slot)Slotted counter slot countIntegerAuto (CPU/config)
DISCARD_NULL_COL (-Daraqne.logdb.discard_null_column)Discard null columnsfalse/truefalse
DISCARD_NULL_GRP (-Daraqne.logdb.discard_null_group)Discard null groupsfalse/truefalse
EXEC_QUERY (-Daraqne.logdb.exec_query)Allow exec/execpipdisabled/enableddisabled
LEGACY_STR_MATCH (-Daraqne.logdb.legacy_string_match)Legacy IP string matchingdisabled/enableddisabled
COLUMNS_LIMIT (-Daraqne.logdb.max_columns)CSV column count limitInteger10,000
LOGDB_PURGE (-Daraqne.logdb.purge)Allow purge commanddisabled/enableddisabled
QUERY_POOL_SIZE (-Daraqne.logdb.query_pool_size)Parallel table query core countIntegerCPU count
SORT_HEAP_SIZE (-Daraqne.logdb.sort_offheap)Sort offheap sizeSize (MB/G)100MB
SORT_PARTITIONS (-Daraqne.logdb.sort_partitions)Sort partition countInteger32
TABLE_OPTIMIZER (-Daraqne.logdb.table_scan_optimizer)Scan optimizerdisabled/enabledenabled
UTF8BOM (-Daraqne.logdb.utf8bom)Add BOM to outputcsvfalse/truefalse
VALUES_CAP (-Daraqne.logdb.values_capacity)values() input limitInteger100
WGET_SIZE_LIMIT (-Daraqne.logdb.wget_max_size)wget max response sizeBytes10,485,760
CUREVFIT_LIMIT (-Dlogpresso.curvefit.limit)curvefit input limitInteger10,000
INSTANT_CACHING (-Dlogpresso.index.instant_caching)Instant cachingdisabled/enabledenabled
OLD_FULLTEXT (-Dlogpresso.index.old_fulltext_func)Keep legacy fulltext functiondisabled/enableddisabled
INVERTED_CACHE_SIZE (-Dlogpresso.inverted_cache_size)Inverted cache sizeBytes104,857,600
KMEANS_LIMIT (-Dlogpresso.kmeans.limit)kmeans input limitInteger10,000
CACHE_RECORD_STATS (-Dlogpresso.log_cache_record_stats)Table cache statisticsfalse/truefalse
CACHE_SIZE (-Dlogpresso.log_cache_size)Table cache sizeBytes104,857,600
QUERY_RESULT_POOL_SIZE (-Dlogpresso.logstorage.query_result_pool_size)Temporary result creation threads4 to CPU coresAuto
FCST_SERIAL (-Dlogpresso.ml.forecast.serial)forecast serial executionf/tf
LOF_OPTIMIZER (-Dlogpresso.ml.lof.optimize)Use LOF optimizationf/tt
DETECT_DEADLOCK (-Dlogpresso.query.deadlock_detect)Deadlock detectiondisabled/enabledenabled
REPAIR_CHECKDAYS (-Dlogpresso.repair.checkdays)Integrity check window (days)Integer / -12
STL_LIMIT (-Dlogpresso.stl.limit)stl input limitInteger1,000
ASYNC_POOL_SIZE (-Dlogpresso.stream.async_pool_size)Async stream pool size1 < Integer <= 100CPU count
STREAMJOIN_BUFFER_SIZE (-Dlogpresso.streamjoin.max_buffer_size)Stream join bufferSize (M/G)1000M
SENTRY_LINK_SPEED (-Dlogpresso.sentry.default_link_speed)Sentry link speed10m/100m/1g/10g0
SENTRY_FLOWCTRL (-Dlogpresso.sentry.disableFlowControl)Flow controlfalse/truefalse
SENTRY_HOSTNAME (-Dlogpresso.sentry.hostname)Sentry hostnameString$(hostname)
SENTRY_AWS_PROFILE (-Dlogpresso.sentry.logger_provisioning_profile)Sentry provisioning profileString (UUID, etc.)null
ROOT_ID (-Daraqne.dom.master_account)Root account ID renameStringroot
HASHJOINTHRESHOLD (-Daraqne.hashjointhreshold)Hash join thresholdInteger10,000,000
VERIFY_SIGN (-Dlogpresso.packman.verify_sign)Allow unsigned packagesdisabled/enabledenabled
AWT_HEADLESS (-Djava.awt.headless)Headless modefalse/truetrue

Notes:

  • SSH_OPEN/TEL_OPEN only pass the related properties when the value is not disabled.
  • Some entries are commented out in the template and take effect only when uncommented.