Chapter 102. Collecting IdM Healthcheck information
Healthcheck has been designed as a manual command line tool which should help you to identify possible problems in Identity Management (IdM).
You can create a collection of logs based on the Healthcheck output with 30-day rotation.
Prerequisites
- The Healthcheck tool is only available on RHEL 8.1 or newer
102.1. Healthcheck in IdM
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.
You can use Healthcheck without obtaining a Kerberos ticket.
Modules are independent
Healthcheck consists of independent modules which check for:
- Replication issues
- Certificate validity
- Certificate authority infrastructure issues
- IdM and Active Directory trust issues
- Correct file permissions and ownership settings
Output formats and destination
You can set the following types of output for Healthcheck to generate by using the output-type
option:
-
json
: Machine-readable output in JSON format (default) -
human
: Human-readable output
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:
- SUCCESS
- The system is configured as expected.
- WARNING
- It is advisable to monitor or evaluate the configuration.
- ERROR
- The system is not configured as expected.
- CRITICAL
- The configuration is not as expected, with a significant potential to impact the functioning of your IdM deployment.
102.2. Log rotation
Log rotation creates a new log file every day and the files are organized by date. The date is included in the filename.
Using log rotation, you can configure the maximum number of log files to be stored. 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.
102.3. Configuring log rotation using the IdM Healthcheck tool
Follow this procedure to configure log rotation with the following utilities:
-
The
systemd
timer -
The
crond
service
The systemd
timer runs the Healthcheck tool periodically and generates the logs. By default, this is set to occur at 4 a.m. every day.
The crond
service is used for log rotation.
The default log name is healthcheck.log
and the rotated logs use the healthcheck.log-YYYYMMDD
format.
Prerequisites
-
You have
root
privileges.
Procedure
Enable a
systemd
timer:systemctl enable ipa-healthcheck.timer
# systemctl enable ipa-healthcheck.timer Created symlink /etc/systemd/system/multi-user.target.wants/ipa-healthcheck.timer -> /usr/lib/systemd/system/ipa-healthcheck.timer.
Copy to Clipboard Copied! Start the
systemd
timer:systemctl start ipa-healthcheck.timer
# systemctl start ipa-healthcheck.timer
Copy to Clipboard Copied! Open the
/etc/logrotate.d/ipahealthcheck
file to configure the number of logs you want to be saved:[...] rotate 30 }
[...] rotate 30 }
Copy to Clipboard Copied! By default, logs are stored for 30 days before they are overwritten by newer logs.
In the same file, configure the path to the file storing the logs.
/var/log/ipa/healthcheck/healthcheck.log { [...]
/var/log/ipa/healthcheck/healthcheck.log { [...]
Copy to Clipboard Copied! By default, logs are saved in the
/var/log/ipa/healthcheck/
directory.- In the same file, configure at what time you want logs to be generated. By default, a log is created daily at 4 a.m.
- Save the file.
Ensure that the
crond
service is enabled and running:systemctl enable crond systemctl start crond
# systemctl enable crond # systemctl start crond
Copy to Clipboard Copied! To start generating logs, start the IdM healthcheck service:
systemctl start ipa-healthcheck
# systemctl start ipa-healthcheck
Copy to Clipboard Copied!
Verification
-
Navigate to the
/var/log/ipa/healthcheck/
directory. - Display the contents of the log file to check if it was created correctly.
102.4. Changing IdM Healthcheck configuration
You can change 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 a log rotation and want to ensure the logs are in a format suitable for automatic analysis, but do not want to set up a new timer.
This Healthcheck feature is only available on RHEL 8.7 and newer.
After the modification, all logs that Healthcheck creates follow the new settings. These settings also apply to any manual execution of Healthcheck.
When running Healthcheck manually, settings in the configuration file take precedence over options specified in the command line. For example, if output_type
is set to human
in the configuration file, specifying json
on the command line has no effect. Any command line options you use that are not specified in the configuration file are applied normally.
102.5. Configuring Healthcheck to change the output logs format
Follow this procedure to 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.
Prerequisites
- Your system is running RHEL 8.7 or later.
-
You have
root
privileges. - You have previously configured log rotation on a timer.
Procedure
-
Open the
/etc/ipahealthcheck/ipahealthcheck.conf
file in a text editor. -
Add options
output_type=human
andall=True
to the[default]
section. - Save and close the file.
Verification
Run Healthcheck manually:
ipa-healthcheck
# ipa-healthcheck
Copy to Clipboard Copied! -
Go to
/var/log/ipa/healthcheck/
and check that the logs are in the correct format.