Monitoring and Health (WIP)

This page documents credential-store readiness checks. Broader readiness, logging management, and audit guidance remains in progress.

Credential Store Readiness

A successful application version check or Compose health check does not establish that stored credentials can be decrypted. Check the credential store before enabling a workflow that consumes a token, and after key configuration changes.

1. As a SENSE System Admin, open Admin Settings → Credentials.
2. Confirm Store Active and the expected Key Version.
3. Check that every previous key still needed by stored rows is LOADED. Resolve any Previous Key Unavailable, Previous Keys Unavailable, Credentials on Previous Key Versions, or Credentials cannot be decrypted warnings.
4. Resolve Key verification incomplete before rotating or removing keys. Verification must complete and the row counts and key warnings must be reviewed before an old key is removed.

The startup log contains a Credential Store availability=… key version=… message for initial key loading. Subsequent verification can detect mismatches, so use the card’s latest status as well as the startup logs. Metadata and status remain readable when the store is unavailable; operations needing the encrypted values are blocked.

Current-Key Failures

Store Unavailable identifies the current-key problem. Correct configuration in the application’s runtime environment, then restart or recreate the application through its deployment workflow. See Configure the Credential Store for input formats and deployment limitations.

Reason	Meaning and action
KEY_MISSING	Neither current-key source is configured. Supply the intended key through one source.
KEY_AMBIGUOUS	Both SENSE_CRED_KEY and SENSE_CRED_KEY_FILE contain a value other than whitespace. Keep exactly one source.
KEY_INVALID	The configured key is malformed or does not decode to exactly 32 bytes. Restore its correctly formatted value.
KEY_VERSION_INVALID	The current key’s version prefix is invalid. Use the positive integer version belonging to that key.
KEY_FILE_UNREADABLE	The application’s process cannot read the selected key file. Check its runtime path, mount, and permissions.
KEY_MISMATCH	No stored row on the current version decrypted with the loaded key. Restore the matching key; do not assign a new key to that existing version.

If deliberately changing keys, follow the rotation procedure. Generating a new key without retaining the matching old keys does not recover encrypted values.

Previous Keys and Row Warnings

Previous-key problems need separate assessment: the current store can remain active while older rows are unreadable.

• Previous Keys Unavailable: both previous-key sources were supplied or the previous-key file could not be read. Correct the source selection or file access. A source-level problem prevents loading the previous-key list.
• Previous Key Unavailable: an entry is INVALID, DUPLICATE, or MISMATCH. Restore the correct versioned entry, remove duplicate version assignments, or restore the matching key. Preserve every distinct key still needed by rows.
• Credentials on Previous Key Versions: review the per-version row counts. A version without a usable matching key is stranded; restore that key before attempting to re-encrypt its rows.
• Credentials cannot be decrypted: individual rows failed authentication. Restore their matching keys or have the credential owner replace affected values from the issuing system, subject to the deployed ownership policy.
• Key verification incomplete: the scan could not read the database. Check database connectivity before rotation.

Counts describe the latest startup or re-encryption verification, rather than continuous monitoring. In status data, verified=true means that scan completed; it does not guarantee that every row decrypted. Review per-version counts, unavailable keys, and undecryptable-row warnings together. After correcting key inputs, restart or recreate the application to load them and run startup verification again.

Related Documentation

• Configure the Credential Store
• Credential store architecture and security
• Credential store and provider recovery

Planned coverage

• Readiness and health visibility.
• Logging management and review.
• Audit and history records.

Additional procedures will be added after their operator workflows and configuration contracts are verified.