Configure Individual Checks

Per-check settings are organized through @ConfigInfo, which provides the configuration file name and YAML path.

How the mapping works

Each check’s @ConfigInfo(fileName=..., path=...) mapping identifies its configuration file and nested YAML path. A shared configuration may cover several checks.

Trace a setting from check to file

  1. Find the check in the FairPlay check reference.
  2. Use its @ConfigInfo file name and YAML path to locate the setting.
  3. Read @CustomKey, comments, and the generated file to confirm the exact key and available values.
  4. Check the setting guide to see whether the change applies on reload or requires a restart.

Why keys are not generated from field names

A YAML key can differ from its Java field name because of @CustomKey, nesting, or migration. Use the generated configuration file and the annotation’s YAML path to find the exact key.

Inventory scope

Some settings are shared across related checks, and not every check has a separate file. Search the check reference and generated YAML before assuming a dedicated configuration file exists.

Browse all documentation