Skip to content

doc: Explain icingadb built-in check#10683

Merged
oxzi merged 1 commit intomasterfrom
docs-10-itl-icingadb-explain
Feb 5, 2026
Merged

doc: Explain icingadb built-in check#10683
oxzi merged 1 commit intomasterfrom
docs-10-itl-icingadb-explain

Conversation

@oxzi
Copy link
Copy Markdown
Member

@oxzi oxzi commented Jan 8, 2026

Briefly explain what the built-in icingadb check actually checks and what outputs one can expect. This does not contain every possible check output, but touches the different topics the check verifies.

References Icinga/icingadb#1009.

@oxzi oxzi added this to the 2.16.0 milestone Jan 8, 2026
@oxzi oxzi added the area/documentation End-user or developer help label Jan 8, 2026
@cla-bot cla-bot bot added the cla/signed label Jan 8, 2026
Comment on lines +118 to +119
- The Redis backlog does not accumulate (_redis backlog_).
- The relational database backlog does not accumulate (_database backlog_).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These could be a bit more elaborate. They currently explain x by saying x again :)

I had to peek into the source code myself to correctly say what this means exactly, so here's the summary:

  • Redis backlog means how old is the oldest query in our queue that wasn't processed by Redis yet (i.e. Icinga 2 is generating more queries than it can send to Redis).
  • Database backlog means something similar for information that was already written to Redis and is supposed to be forwarded to the relational DB, but hasn't made it there yet. This affects history (so the history tabs might show the most recent information) and runtime updates (newly created objects might not show up yet, or object attributes may be outdated, the latter is mostly relevant for filters in Icinga DB Web as they are only done in SQL, not Redis).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Back then, I only skimmed the code to identify different kinds of errors. I have enriched the two latest points with your suggestions.

Briefly explain what the built-in icingadb check actually checks and
what outputs one can expect. This does not contain every possible check
output, but touches the different topics the check verifies.

References Icinga/icingadb#1009.
@oxzi oxzi force-pushed the docs-10-itl-icingadb-explain branch from 1f30ba7 to afc3485 Compare February 4, 2026 14:43
@oxzi oxzi requested a review from julianbrost February 4, 2026 14:45
@oxzi oxzi merged commit 303b46b into master Feb 5, 2026
28 checks passed
@oxzi oxzi deleted the docs-10-itl-icingadb-explain branch February 5, 2026 07:40
@yhabteab yhabteab mentioned this pull request Apr 1, 2026
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation End-user or developer help cla/signed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants