Health check

The cms-search-boost-health-check module adds an optional health check that alerts when a configured boost references an index field that no longer exists in the codebase.

Installation

Installing this module is the opt-in for the health check. The base cms-search-boost dependency does not include it.

Maven

<!-- Requires Brightspot 4.5 or later. -->
<dependency>
    <groupId>com.brightspot.cms-search-boost</groupId>
    <artifactId>cms-search-boost-health-check</artifactId>
    <version>2.0.0</version>
</dependency>

Gradle

// Requires Brightspot 4.5 or later.
implementation 'com.brightspot.cms-search-boost:cms-search-boost-health-check:2.0.0'

Gradle (Kotlin DSL)

// Requires Brightspot 4.5 or later.
implementation("com.brightspot.cms-search-boost:cms-search-boost-health-check:2.0.0")

How it works

The health check inspects the CMS Search Boost plugin's Default Configuration and every site's configuration for Exact Match, Partial Match, Starts With Match, Newest, and Oldest boosts whose configured Index no longer resolves against the schema. It runs once an hour.

When it finds a stale index, it raises a warning-severity alert against the affected plugin or site. The alert clears automatically once the boost is fixed or removed. These are defaults; an administrator can adjust the severity, the check interval, or disable the check from the CMS Health configuration.

note

CMS Search Boost also removes a stale boost from its configuration the next time that configuration loads or saves, regardless of whether this module is installed. See the Configuration guide for details. This health check exists to surface the problem before someone opens the configuration and notices the warning there.