Monitor: ecmwf.properties¶

The Monitor's ecmwf.properties configures its Master connection, HTTPS web interface, status calculations, login presentation and display defaults. This reference includes options omitted from the shipped file, not just the template's assignments.

See also the Master and Data Mover references. The Master's schedulers and the Mover's portal are configured in their own processes, not here.

File location and overrides¶

The source template is etc/monitor/conf/ecmwf.properties. Its RPM path is /usr/local/ecpds/monitor/conf/ecmwf.properties; the launcher selects it with the ecmwf.properties JVM property.

Use /etc/ecpds/monitor.cnf or the container/service environment for launcher values such as the Master address, listener ports and keystore password. ${...} placeholders in the template reference JVM properties or other sections; they are not arbitrary environment-variable substitutions.

The final #include "${monitor.etc}/ecmwf.properties" loads local overrides, normally from /etc/ecpds/monitor/ecmwf.properties. It is already an active directive despite its leading #. The include must not refer back to the same file. See the configuration syntax and loading rules.

For example, a local override can change display preferences without copying the complete template:

[MonitorPlugin]
productsToShowCount=15
productsToShowPeriod=72
authMode=password,otp

[Server]
globeImageryCacheDir=/var/lib/ecpds/monitor/globe-imagery
globeLabelsCacheDir=/var/lib/ecpds/monitor/globe-labels

Create persistent cache directories with write access for the Monitor service account. Restart the Monitor after configuration changes unless the relevant feature explicitly supports live updates.

Reading this reference¶

Code fallback is the reader's value when an option is absent; shipped value is the explicit template assignment. A dash means no assignment. Multiple fallbacks are listed separately where consumers differ. null means no fallback value, and is not a promise that the option is optional. Java expressions indicate context-dependent defaults; links identify their readers. Credentials are not reproduced.

Rows marked template entry have no direct literal reader in this process's reviewed sources. A template reference or shared entry is not necessarily an active Monitor setting; named-socket and open-map readers are described below.

Names are case-sensitive. Use explicit suffixes such as 30s or 5m for duration-reading options: bare configured durations are hours. Plain numeric options have their own units. In particular:

Important distinctions¶

[Monitor] activated controls external monitoring integration. It does not enable or disable the browser UI. [MonitorPlugin] statusCalculator controls background status calculations.

authMode chooses which credential methods the login form displays (password, otp or password,otp). It does not disable server-side authentication or configure the OTP provider. See TOTP Authentication.

wantClientAuth=yes asks for optional TLS client certificates; it does not require clients to present one. The retained template flags checkIsSecure and production have no direct readers in the current Monitor implementation; they must not be treated as HTTPS enforcement or security-hardening switches. See TLS Certificates.

The Monitor uses both [MonitorPlugin] and selected [HttpPlugin] settings: the latter controls shared Jetty sizing and HTTP/2 settings. TLS stores can also be overridden by [HttpPluginSSL].

[Server] eventRepository and [StorageRepository] eventSize/eventDelay are retained shared template entries, not controls for the Master's event journal. Configure operational-event export and journaling on the Master, not the Monitor.

Option catalogue¶

This includes web UI readers and the shared infrastructure used by the Monitor. Optional integrations do not become active merely because their options are listed. File-content settings take a path when configured; their fallback is content, not a path.

[AssistantService]¶

Optional document-grounded assistant and Ollama models. Paths select the document corpus and local RAG index; model names must exist on the configured Ollama service. Listing these settings does not deploy a model server.

[CallBack]¶

Exported callback endpoint. serverFactory and clientFactory are Java socket-factory classes. This section also accepts the named socket overrides described below.

[DestinationActionForm]¶

Initial values for new/editable Destination forms, not retroactive changes to existing database records. Frequency and inactivity values use the form's millisecond representation; counts and size limits retain the Destination field semantics.

[ECauthModule]¶

ECauth connection and host-list cache. Durations control connection timeout, refresh polling, refresh frequency and cached-entry lifetime. Credentials here identify the ECauth service account.

[ECpds]¶

Remote Master registry host and port for the Monitor's management/data connection.

[ECpdsClient]¶

ECpds socket-client read timeout in milliseconds. This is distinct from the server-side plugin timeout.

[ECpdsPlugin]¶

Master ECpds listener and request-processing behaviour. checkPort requires a privileged client source port when enabled. SocketSoTimeout applies to accepted request sockets in milliseconds. resetDataTransferSchedulesByGroup resets schedules on group completion. The section also accepts named socket options.

[ExecutorManager]¶

Opt-in virtual-thread execution for the shared executor. This is not a general scheduler concurrency limit.

[HostActionForm]¶

Initial form values for Host creation/editing. Boolean form values use on/off; frequency values are milliseconds. These do not rewrite existing Hosts.

[HostBean]¶

Host display/transfer-rate calculations. The defaults can be derived from the current transfer's sent-byte counters and duration; source links distinguish the calculation paths.

[HttpPlugin]¶

Jetty listener, pool, protocol and portal settings. Thread limits are counts; idleThreadsTimeout and idleTimeout are milliseconds; buffer/header limits are bytes. http/https=-1 leaves that connector disabled. On Movers, S3 skew is seconds and S3 request limits are bytes; CORS and DNS mappings apply to portal paths. On the Monitor, only the shared Jetty/HTTP2 readers listed here apply; its HTTPS listener is in [MonitorPlugin].

[HttpPluginSSL]¶

Optional explicit HTTPS store configuration. If this section exists, keyStorePath and keyStorePassword must be supplied: the normal [Security] fallback branch is not used. Trust-store values default to the selected key store; store type defaults to PKCS12.

[InterruptibleRMIServerSideSocket]¶

Cleanup interval for server-side interruptible RMI socket state, in minutes.

[InterruptibleRMISocket]¶

Interruptible RMI stream-buffer pooling. Buffer size is bytes and buffer TTL is minutes.

[Login]¶

Component identity, registration credential and addresses. root defaults to the hostname in normal service readers. Several utility readers use their own hostname/service fallback, so removing identity settings is not recommended. External/internal addresses are primarily consumed through template references and named socket sections.

[MasterManager]¶

Monitor-side cache of Master metadata. Enabling it reduces remote lookups but depends on callback/cache synchronization.

[Monitor]¶

External service-status integration, independent of the web monitoring UI. activated enables it, debug logs submissions and dontSend suppresses delivery. delay is a duration: the template's bare 120 means 120 hours, whereas the code fallback is five minutes.

[MonitorPlugin]¶

Monitor HTTPS, status calculation, display and directory-integration options. Watchdogs are minutes; refresh is milliseconds; product look-ahead is hours; product event age is days; maxFormContentSize is bytes. Product counts limit the normal display window, with grouped entries handled separately. LDAP settings are used by the optional directory lookup, not by the password/OTP form selector.

[Other]¶

Shared utilities. buffer is an I/O buffer size in bytes; ticketWaitDuration is a raw millisecond timeout. ecauthTokenCache enables token caching. dontCheckIp bypasses the provider's client-address check during subscription. tmp is retained in templates; the launcher separately sets the JVM temporary directory.

[PluginList]¶

Template-defined configuration; see the reader links for its consuming component.

[Ports]¶

Template port substitutions. Most keys are only referenced by listener sections and therefore have no independent code default. ecpds also has a direct client-reader fallback.

[RMIClientSocketFactory]¶

Template-defined configuration; see the reader links for its consuming component.

[RMIServerSocketFactory]¶

Template-defined configuration; see the reader links for its consuming component.

[ResourceTracker]¶

Shared runtime-resource diagnostics. defaultDebugFrequency counts resource-close events between debug reports; it is not a time interval.

[ScriptManager]¶

JavaScript/Graal engine settings. runningTimeout and longRunningTime are milliseconds. resourceLimits=0 leaves the statement limit disabled. Shared engines, compilation and virtual-thread execution are independent switches.

[Security]¶

Authentication, secret protection, socket TLS and optional HTTPS store defaults. SSL store readers can fall back to JVM javax.net.ssl.* properties; HTTPS has its own fallback path. JCE settings protect stored secrets and are not HTTPS cipher settings. checkCertificates=no disables certificate checks. See the TLS and control-channel guides before changing these values.

[Server]¶

Per-process service switches and local paths. Master readers enable schedulers/repositories; Mover readers enable its own repositories/accounting. dontRecord* suppresses management-action history, not native telemetry globally. Globe cache settings belong to the Monitor. providerMBeanTimeout is milliseconds; topology probe timeout is a duration.

[SessionCache]¶

Shared session cache logging and minimum pause (milliseconds). Debug frequency is a diagnostic event-count interval.

[SocketConfig]¶

Defaults for sockets. Buffers are bytes (-1 leaves OS defaults), timeouts are milliseconds, backlog is pending connections, and keepAlive is TCP keepalive rather than application connection pooling. Named socket sections override these values; see the complete named-option list below.

[StorageRepository]¶

Asynchronous persistence. *Size means storage-worker thread count, not queue capacity or batch size. *Delay, idle waits and ticket timeouts are milliseconds. *MaxAuthorisedSize caps repository entries (0 leaves the cap unset). Options only apply to repository types instantiated by this process.

[StreamPlug]¶

Shared stream-copy buffer size in bytes.

[TOTP]¶

OTP authentication provider configuration, including token endpoint, separate password/passcode client credentials, grant type and expected HTTP status. active=false disables this provider path; the login-form selector does not enable it.

[ThreadService]¶

Shared thread runtime. Virtual threads are opt-in; debugThreadLocal enables thread-local diagnostics.

Named socket sections¶

SocketConfig.load reads the following keys from a component's named section. Common section names for this service are CallBack, RMIServerSocketFactory, RMIClientSocketFactory and MonitorPlugin (the latter uses the socket configuration for its bind address, not every raw-socket option). A transfer module or plugin must actually use that socket implementation for its settings to apply; Jetty HTTP listeners and third-party transfer clients do not automatically honour every low-level socket option.

Basic options inherit the values in [SocketConfig] shown above; the advanced TCP options from tcpCongestion onward default to unset and are read from the named section, not from the global [SocketConfig] defaults. Advanced options depend on OS/socket support. Caller-supplied addresses, ports and module/Host settings may override socket defaults.

Constructed HTTPS/TLS keys¶

The HTTPS helper constructs [Security] SSL<Key> names and otherwise consults the corresponding javax.net.ssl.<key> JVM property. Its actual keys are SSLKeyStore, SSLKeyStorePassword, SSLKeyStoreType, SSLTrustStorePath, SSLTrustStorePassword and SSLTrustStoreType.

SSLTrustStorePath is the HTTPS helper's spelling; the generic socket TLS reader separately uses SSLTrustStore. Do not assume these are aliases. The explicit [HttpPluginSSL] map takes precedence over the HTTPS helper's normal store-selection branch. MQTT uses [Security] SSLKeyStore and SSLKeyStorePassword through its own helper.

Plugin and module families¶

[PluginList] is an open map of plugin names to definitions:

[PluginList]
name=implementation.Class@/path/to/plugin,option=value

The library path and per-plugin options depend on the plugin. Server plugins support maxConnections and inverseResolution; deleting or adding a plugin definition changes which services start. These are options inside the value, not new top-level ecmwf.properties groups. See Plugin Infrastructure.

[ECtrans] is an open family of global transfer-option defaults, with keys module.option (for example, ftp.passive). Its option set is defined by ECtransOptions and the selected module, not a fixed list of literal Cnf keys. Entity/transfer setup values can override these defaults. The complete option/default references are:

• ECtrans common options and the protocol pages under Transfer Modules.
• Host options, Destination options, Web User options and Data User options.

These entity options are not interchangeable with service sections. Some options are only meaningful for a particular module or execution role.