Configure high availability notifications#

Starburst control plane sends in-app notifications for coordinator high availability (HA) events. Each notification includes a View clusters link to the Clusters page.

Note

Coordinator HA notifications are visible only to users with the admin role.

Configure which events trigger notifications with the notification.ha.event-types-enabled property in the config.properties file of the control plane. The value is a comma-separated list of event types. The value you set replaces the default list rather than adding to it. Set it to an empty value to disable HA notifications entirely.

By default, the control plane sends notifications for the following event types:

  • COORDINATOR_HA_FAILOVER_STARTED

  • COORDINATOR_HA_FAILOVER_COMPLETED

  • COORDINATOR_HA_FAILOVER_NO_CANDIDATES

  • COORDINATOR_HA_GONE

  • COORDINATOR_HA_RESTORED

  • COORDINATOR_HA_ELECTION_NO_CANDIDATES

Additional event types are available:

  • COORDINATOR_HA_REGISTERED

  • COORDINATOR_HA_HEALTH_CHECK_FAILED

  • COORDINATOR_HA_HEALTH_CHECK_RECOVERED

  • COORDINATOR_HA_HEALTH_CHECK_INSTANCE_ID_MISMATCH

  • COORDINATOR_HA_ELECTION_STARTED

  • COORDINATOR_HA_ELECTION_COMPLETED

  • COORDINATOR_HA_URI_CHANGED

  • COORDINATOR_HA_DECOMMISSIONED

  • COORDINATOR_HA_ENFORCE_ONE_ACTIVE_TRIGGERED

  • COORDINATOR_HA_UNKNOWN_ACTION

For example, the following configuration sends notifications only when a failover starts or completes:

notification.ha.event-types-enabled=COORDINATOR_HA_FAILOVER_STARTED,COORDINATOR_HA_FAILOVER_COMPLETED

Note

The notification.ha.event-types property has been removed. Use notification.ha.event-types-enabled instead.