Skip to content
Release: Australia · Updated: 2026-05-21 · Official documentation · View source

Hermes Settings page

The Hermes Settings page is a centralized interface that enables Hermes administrators and maintenance users to monitor and control the configuration properties that govern the Hermes Messaging Service.

Access to the Hermes Settings page is role-based. The page displays the configurable properties to authorized users, along with descriptions, default values, and validation rules that help avoid misconfiguration. All configuration changes are traceable through built-in audit logging.

RoleAccess
maintHas full visibility and edit access to all settings, including lower-level infrastructure properties.
hermes_adminCan view and modify a defined subset of properties relevant to topic management, Apache Kafka integration, and operational configuration.

Key benefits

  • View current and default values of all Hermes Messaging Service properties in one place.
  • Update values through a validated interface that enforces allowed ranges and formats.
  • Access descriptions that explain how each setting affects Hermes Messaging Service functionality.
  • Track changes to settings to support troubleshooting.

Settings categories

The Hermes Messaging Service Settings page organizes properties into the categories listed in the following table.

CategoryDescription
Client ConnectionGoverns heartbeat polling intervals and timeout durations for cluster-side connectivity.
Health StatusDefines socket connection and read timeouts used by the Hermes Messaging Service Service Status monitor.
High Availability and FailoverControls automatic failover behavior when health failures are detected.
IP Access ControlEnables or disables the IP ACL publishing mechanism and sets the publishing interval.
Kafka IntegrationControls topic manager timeouts, consumer and producer polling durations, retry limits, cache sizes, and metrics collection flags.
Logging and Health MetricsToggles debug logging and broker certificate expiration monitoring.
System ResourcesConfigures Hermes Messaging Service service cache limits and usage metrics batch query size.
TokensManages token cache capacity, thread access limits, and idle eviction timing.
Topic ManagementControls topic cache size, cache idle time, thread limits, maximum partitions, and Topic Inspector display behavior.

Background jobs

Each settings category links to one or more background jobs that operate with the configurable properties. These jobs perform automated maintenance tasks such as heartbeat monitoring, metrics collection, metadata updates, cache cleanup, and IP ACL publishing. Jobs can be enabled, turned off, or have their intervals adjusted through the settings interface where applicable.

For a list of Hermes Messaging Service background jobs, see Hermes background jobs.

Implementation

The Hermes Messaging Service Settings page uses a Static Typed Wrapper approach (HermesGlideProperty) to define and expose settings. Each property holds its own validator, and validation rules are enforced at the point of change via setOrThrow(). This facilitates type safety at compile time, embedded validation, and reliable property management.

For information about viewing and modifying Hermes Messaging Service settings, see Managing Hermes settings.