Hermes Settings page

  • Release version: Australia
  • Updated May 21, 2026
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Hermes Settings page

    The Hermes Settings page provides a centralized, role-based interface for Hermes administrators and maintenance users to monitor and control configuration properties of the Hermes Messaging Service. It consolidates all configurable settings, showing current and default values, descriptions, and validation rules to prevent misconfiguration. All changes are audit logged to support troubleshooting and accountability.

    Show full answer Show less

    Role-Based Access

    • maint: Full visibility and edit access to all settings, including low-level infrastructure properties.
    • hermesadmin: View and modify a subset of properties related to topic management, Kafka integration, and operational configuration.

    Key Features

    • View and update Hermes Messaging Service settings through a validated interface enforcing allowed ranges and formats.
    • Descriptions clarify how each setting impacts service functionality.
    • Audit logging tracks all configuration changes.
    • Settings are organized into specific categories for easier management.

    Settings Categories

    • Client Connection: Manages heartbeat polling intervals and cluster connectivity timeouts.
    • Health Status: Defines socket connection and read timeouts for service status monitoring.
    • High Availability and Failover: Controls automatic failover behavior during health failures.
    • IP Access Control: Enables/disables IP ACL publishing and sets publishing intervals.
    • Kafka Integration: Configures topic manager timeouts, polling durations, retry limits, cache sizes, and metrics flags.
    • Logging and Health Metrics: Toggles debug logging and certificate expiration monitoring.
    • System Resources: Sets service cache limits and batch query sizes for usage metrics.
    • Tokens: Manages token cache capacity, thread access, and idle eviction timing.
    • Topic Management: Controls topic cache size, thread limits, maximum partitions, and display settings for Topic Inspector.

    Background Jobs

    Each settings category is linked to background jobs that automate maintenance tasks such as heartbeat monitoring, metrics collection, metadata updates, cache cleanup, and IP ACL publishing. Users can enable, disable, or adjust job intervals directly via the settings interface where applicable.

    Implementation Details

    The settings page is implemented using a Static Typed Wrapper approach (HermesGlideProperty), which ensures type safety and embedded validation at the time of change through setOrThrow() method. This approach guarantees reliable property management and validation enforcement.

    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.

    Table 1. Role-based access to Hermes Messaging Service Settings
    Role Access
    maint Has full visibility and edit access to all settings, including lower-level infrastructure properties.
    hermes_admin Can 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.

    Table 2. Settings categories
    Category Description
    Client Connection Governs heartbeat polling intervals and timeout durations for cluster-side connectivity.
    Health Status Defines socket connection and read timeouts used by the Hermes Messaging Service Service Status monitor.
    High Availability and Failover Controls automatic failover behavior when health failures are detected.
    IP Access Control Enables or disables the IP ACL publishing mechanism and sets the publishing interval.
    Kafka Integration Controls topic manager timeouts, consumer and producer polling durations, retry limits, cache sizes, and metrics collection flags.
    Logging and Health Metrics Toggles debug logging and broker certificate expiration monitoring.
    System Resources Configures Hermes Messaging Service service cache limits and usage metrics batch query size.
    Tokens Manages token cache capacity, thread access limits, and idle eviction timing.
    Topic Management Controls 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.