doc/08-advanced-topics.md: Reference CheckResult state #10421
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reference the Check Result State Mapping table for the CheckResult state field. This table covers both Service and Host states while the prior documentation string only covered Services. This change is useful since there are different kinds of states for Hosts when using the Icinga 2 API. For one, there is a "normalized" version of 0 for UP and 1 for DOWN. Then there is the exit code version for 0/1 for UP and 2/3 for DOWN. Unfortunately, often this depends on the context and sometimes even intermingles. To make it obvious which kind of state one can expect for a CheckResult object, I have linked to the already existing documentation section.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference the Check Result State Mapping table for the CheckResult state field. This table covers both Service and Host states while the prior documentation string only covered Services.
This change is useful since there are different kinds of states for Hosts when using the Icinga 2 API. For one, there is a "normalized" version of 0 for UP and 1 for DOWN. Then there is the exit code version for 0/1 for UP and 2/3 for DOWN. Unfortunately, often this depends on the context and sometimes even intermingles.
To make it obvious which kind of state one can expect for a CheckResult object, I have linked to the already existing documentation section.