Skip to content

Document how custom checks should report failures - #190

Merged
dbaseqp merged 1 commit into
dbaseqp:mainfrom
tire-fire:docs/check-failure-messages
Nov 8, 2026
Merged

dbaseqp merged 1 commit into
dbaseqp:mainfrom
tire-fire:docs/check-failure-messages

Conversation

@tire-fire

Copy link
Copy Markdown
Contributor

Adds a "Failure Messages" section to docs/custom-checks.md on writing check output that a blue team can act on:

  • one message per step, naming the component and where it runs
  • expected versus got
  • pass on the service's own error text
  • one condition per message, so two causes never share a message

It also notes that the debug output teams see (only with ShowDebugToBlueTeam) includes the check's command line, credentials included.

@dbaseqp
dbaseqp merged commit 02f9ec9 into dbaseqp:main Nov 8, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants