Properties reference

Key properties by category — what they do and where to set them.

This page documents commonly-modified Deephaven properties, organized by functional category. For a quick lookup by property name, see the properties index.

Note

This page covers key properties that customers frequently modify. To see all properties and their defaults, export the full files with dhconfig properties export (e.g., dhconfig properties export iris-defaults.prop). Use the Property Inspector to search for specific properties.

System basics

Properties that identify and configure the Deephaven system.

PropertyDefaultSet inDescription
system.nameDeephaveniris-environment.propDisplay name for the system. Shown in the UI to differentiate between multiple instances.
system.typePRODiris-environment.propSystem type: PROD, QA, DEV, SIM, or any custom string.
system.color(unset)iris-environment.propColor for the System Information Bar. Any valid CSS color (hex, rgb, or CSS variable like var(--dh-color-visual-notice)).
server.timezoneAmerica/New_Yorkiris-environment.propDefault timezone for the server.
Calendar.defaultUSNYSEiris-environment.propDefault business calendar.

Controller

Properties for the Persistent Query Controller. See Controller configuration for complete documentation.

PropertyDefaultSet inDescription
PersistentQueryController.port20126iris-endpoints.propController listening port.
PersistentQueryController.maxInboundMessageSizeMiB64iris-environment.propMaximum gRPC message size in MiB.
PersistentQueryController.queryStartThreadPoolCoreSize20iris-environment.propThread pool size for starting queries.
PersistentQueryController.clientLoadBalancingPolicyround_robiniris-environment.propLoad balancing policy for controller clients.

Dispatcher

Properties for the Remote Query Dispatcher. See Dispatcher configuration for complete documentation.

PropertyDefaultSet inDescription
RemoteQueryDispatcher.maxTotalQueryProcessorHeapMB354304iris-environment.propMaximum total heap for all workers on this dispatcher (MiB).
RemoteQueryDispatcher.maxPerWorkerHeapMB(unset)iris-environment.propMaximum heap for any single worker. Defaults to total available.
RemoteQueryDispatcher.workerServerPorts23000-23999 (query), 25000-25999 (merge)iris-environment.propPort range for worker processes.
RemoteQueryDispatcher.workerServerWebsocketPorts24000-24999 (query), 26000-26999 (merge)iris-environment.propPort range for worker websocket connections.
RemoteQueryDispatcher.maxConcurrentStartups10iris-environment.propMaximum queries starting simultaneously.
RemoteQueryDispatcher.allowedGroups*iris-environment.propGroups allowed to start queries on this dispatcher.
RemoteQueryDispatcher.adminGroupsiris-superusersiris-environment.propGroups with admin privileges on the dispatcher.
RemoteQueryDispatcher.reservedAvailableMemoryMB2048iris-environment.propMemory reserved for system use (MiB).
minimumWorkerHeapSizeMB512iris-environment.propMinimum allowed heap size for workers (MiB).

See Worker heap size configuration for detailed heap management guidance.

Web API Server

Properties for the Web API Service. See Web API Service for complete documentation.

PropertyDefaultSet inDescription
Webapi.server.port8123iris-endpoints.propWeb API server port.
Webapi.console.heap.default4iris-environment.propDefault heap size for consoles (GB).
Webapi.persistentquery.heap.default4iris-environment.propDefault heap size for persistent queries (GB).
WebServer.tls.keystore(varies)iris-environment.propPath to TLS keystore for the web server.
WebServer.tls.passphrase.file(varies)iris-environment.propPath to keystore password file.
cors.allowedOrigins(varies)iris-environment.propComma-separated list of allowed CORS origins.

See CORS configuration for CORS setup details.

Authentication

Properties for the Authentication Server.

PropertyDefaultSet inDescription
authentication.server.ssltrueiris-environment.propEnable SSL for auth server connections. Set globally (not in a service stanza) so clients also receive this setting.

The following properties apply only to the Authentication Server. Set these in the [service.name=authentication_server] stanza:

PropertyDefaultSet inDescription
authentication.server.ldap.enabledfalseiris-environment.propEnable LDAP authentication.
authentication.server.acceptplaintextfalseiris-environment.propAccept plaintext connections (not recommended for production).
authentication.server.customauth.enabledtrueiris-environment.propEnable custom authentication provider.
authentication.server.customauth.class(varies)iris-environment.propCustom auth provider class.
authentication.server.logTokenAuditEventstrueiris-environment.propLog token audit events.

See LDAP and SAML for authentication configuration.

Logging

Properties that control logging behavior.

PropertyDefaultSet inDescription
logroot/var/log/deephaveniris-environment.propBase directory for log files.
IrisLogDefaults.logLevelINFOiris-environment.propDefault log level.
IrisLogDefaults.useLogAggregatorServicefalseiris-environment.propSend logs to Log Aggregator Service.
IrisLogDefaults.useDynamicPartitionsfalseiris-environment.propUse dynamic partitions for logs.
UpdatePerformanceTracker.reportingModeDB_ONLYiris-environment.propPerformance tracking mode: NONE, LISTENER_ONLY, DB_ONLY, ALL.
UpdatePerformanceTracker.reportIntervalMillis60000iris-environment.propPerformance report interval (ms).

NIO/Networking

Properties that control NIO networking behavior.

PropertyDefaultSet inDescription
NIO.driver.maxThreadCount400iris-environment.propMaximum NIO driver threads.
NIO.RPC.timeout60000iris-environment.propRPC timeout (ms).
ConnectionMonitor.enabledtrueiris-environment.propEnable connection monitoring.
ConnectionMonitor.heartbeatTriggerMillis300000iris-environment.propHeartbeat trigger interval (ms).
ConnectionMonitor.heartbeatFatalMillis300000iris-environment.propHeartbeat fatal timeout (ms).

File handling

Properties that control file handle management.

PropertyDefaultSet inDescription
TrackedFileHandleFactory.maxOpenFiles4096iris-environment.propMaximum open file handles. Set below ulimit -n.
TrackedFileHandleFactory.fastCyclingThreshold0.20iris-environment.propFraction of capacity triggering cycling warning.

See File handle management for details.

Python/JPY

Properties for Python integration.

PropertyDefaultSet inDescription
jpy.programName(varies by version)iris-environment.propPath to Python executable.
jpy.pythonLib(varies by OS)iris-environment.propPath(s) to Python shared library.
jpy.jpyLib(varies by version)iris-environment.propPath to JPY shared library.
jpy.jdlLib(varies by version)iris-environment.propPath to JDL shared library.

See Custom Python virtual environments for Python setup.

Performance

Properties that affect system performance.

PropertyDefaultSet inDescription
statsdriver.enabledtrueiris-environment.propEnable statistics driver.
allocation.stats.enabledfalseiris-environment.propEnable allocation statistics.
measurement.per_thread_cpufalseiris-environment.propEnable per-thread CPU measurement.
StringUtils.cacheSize65536iris-environment.propString utility cache size.
DataBufferConfiguration.useDirectMemorytrueiris-environment.propUse direct memory for table data (recommended for large data).
DataBufferConfiguration.poolSize(varies)hostconfigTotal size of the buffer pool. Set per service in hostconfig; for workers, derived from PQ heap settings.

See Memory management for buffer pool configuration details.

Core+ specific

Properties specific to Core+ workers. Set these in coreplus-environment.prop.

PropertyDefaultSet inDescription
SessionMonitor.noSessionsTimeoutMillis3000coreplus-environment.propTerminate worker after losing all sessions (ms).
http.session.durationMs75000coreplus-environment.propSession token duration (ms). Core+ uses 75s vs Enterprise 5min.
AuthHandlersio.deephaven.enterprise.dnd.authentication.DheAuthenticationHandlercoreplus-environment.propAuthentication handler class.
authentication.anonymous.warntruecoreplus-environment.propWarn about anonymous authentication.
web.storage.layout.directory/layoutscoreplus-environment.propDirectory for layout storage.
web.storage.notebook.directory/notebookscoreplus-environment.propDirectory for notebook storage.

Core+ security headers

These properties control HTTP security headers for Core+ workers.

PropertyDefaultSet inDescription
http.add.header.Strict-Transport-Security.enabledfalsecoreplus-environment.propEnable HSTS header.
http.add.header.X-Frame-Options.enabledfalsecoreplus-environment.propEnable X-Frame-Options header.
http.add.header.Content-Security-Policy.enabledfalsecoreplus-environment.propEnable CSP header.
http.add.header.X-XSS-Protection.enabledtruecoreplus-environment.propEnable XSS protection header.
http.add.header.X-Content-Type-Options.enabledtruecoreplus-environment.propEnable content type options header.
http.add.header.Referrer-Policy.enabledtruecoreplus-environment.propEnable referrer policy header.

See Hardening technical controls for security configuration.