Chapter 1. Installing and running the IdM Healthcheck tool

The Healthcheck command line tool in Identity Management (IdM) helps find issues that can impact the performance of your IdM environment. Using Healthcheck, you can identify an issue in advance so that you can correct it before it becomes critical.

Modules are independent

Healthcheck consists of independent modules which check for:

Output formats and destination

You can set the following types of output for Healthcheck to generate by using the output-type option:

You can specify a file to store the output by using the --output-file option.

Results

Each Healthcheck module returns one of the following results:

You can install the IdM Healthcheck tool to help find issues that can impact the performance of your IdM environment.

You can execute Healthcheck tests either manually on the CLI or automatically by using a timer. You can manually run IdM Healthcheck tests from the command line to diagnose and monitor the health of your environment.

You can configure IdM Healthcheck to run on a schedule. This includes configuring the systemd timer to run the Healthcheck tool periodically and generate the logs and the crond service to ensure log rotation.

The default log name is healthcheck.log and the rotated logs use the healthcheck.log-YYYYMMDD format.

Log rotation creates a new log file every day and the files are organized by date. The date is included in the filename.

By using log rotation, you can configure the maximum number of log files to store. If this number is exceeded, the newest file replaces the oldest one. For example, if the maximum rotation number is thirty, the thirty-first log file replaces the first, that is the oldest one.

Log rotation reduces voluminous log files and organizes them. This helps you analyze the logs.

You can change Identity Management (IdM) Healthcheck settings by adding the desired command line options to the /etc/ipahealthcheck/ipahealthcheck.conf file. This can be useful when, for example, you configured log rotation previously and now want to ensure the logs are in a format suitable for automatic analysis, but do not want to set up a new timer.

After you change the settings, all Healthcheck logs will use them, even when you run Healthcheck manually.

You can configure Healthcheck with a timer already configured. In this example, you re-configure Healthcheck to start producing logs in a human-readable format and to also include successful results instead of only errors.