ORGANIZATION¶

These areas of the system to check can be logically grouped together. This grouping is called a source. A source consists of one or more checks.

A check is as atomic as possible to limit the scope and complexity and provide a yes/no answer on whether that particular configuration is correct.

Each check will return a result, either a result of WARNING, ERROR or CRITICAL or SUCCESS. Returning SUCCESS tells you that the check was done and was deemed correct. This should help track when the last time something was examined.

Upon failure the output will include the source and check that detected the failure along with a message and name/value pairs indicating the problem. It may very well be that the check can't make a final determination and generally defaults to WARNING if it can't be sure so that it can be examined.

IMPLEMENTATION DETAILS¶

There is no need for users to authenticate and get a ticket in advance for ipa-healthcheck to work. Existing tickets will not be used as ipa-healthcheck will leverage the host keytab and use a temporary credential cache.

COMMANDS¶

--list-sources

Display a list of the available sources and the checks associated with those sources.

OPTIONAL ARGUMENTS¶

--config=FILE

The configuration file to use. If an empty string is passed in then no configuration file is loaded. The default is /etc/ipahealthcheck/ipahealthcheck.conf.

--source=SOURCE

Execute checks within the named source, or all sources in the given namespace.

--check=CHECK

Execute this particular check within a source. The exact source must also be specified via --source.

--output-type=TYPE

Set the output type. Supported variants are human, json, and prometheus. The default is json.

--failures-only

Exclude SUCCESS results on output. If stdin is a tty then this will default to True. In all other cases it defaults to False.

--all

Report all results.

--severity=SEVERITY

Only report errors in the requested severity of SUCCESS, WARNING, ERROR or CRITICAL. This can be provided multiple times to search on multiple levels.

--verbose

Generate verbose output.

--debug

Generate additional debugging output.

JSON OUTPUT¶

The results are displayed as a list of result messages for each check executed in JSON format. This could be input for a monitoring system.

--output-file=FILENAME

Write the output to this filename rather than stdout.

--input-file=FILENAME

Read the results of a previous run and re-display them.

--indent=INDENT

Pretty-print the JSON with this indention level. This can make the output more human-readable.

HUMAN-READABLE OUTPUT¶

The results are displayed in a more human-readable format.

--input-file=FILENAME

Take as input a JSON results output and convert it to a more human-readable form.

PROMETHEUS OUTPUT¶

The results are displayed in the Prometheus text metric exposition format.

--input-file=FILENAME

Uses the JSON-formatted results output as metrics source.

--metric-prefix=PREFIX

Prefix to use for metric names.