Home

Healthcheck

Healthcheck service is run to verify the health of your Unravel installation. Healthcheck is enabled by default and runs automatically in the backdrop to ensure that all the Unravel services are running and in a good state. You can set email alerts to receive the healthcheck reports. By default, Healthcheck services are run automatically every hour. The interval period for running Healthcheck services can be configured.

Healthcheck can be disabled and re-enabled if required.

Running Healthcheck

After all the configurations are set, you can run the healthcheck as follows:

  • Run healthcheck:

    <Unravel installation directory>/unravel/manager healthcheck

  • Run only a specific check:

    <Unravel installation directory>/unravel/manager healthcheck <check_name>

  • Run healthcheck for a specific tag:

    <Unravel installation directory>/unravel/manager healthcheck tagname

  • Skip a specific check when running healthcheck: 

    <Unravel installation directory>/unravel/manager healthcheck ~checkname

  • Skip a specific tag when running healthcheck:

    <Unravel installation directory>/unravel/manager healthcheck ~tagname

Setting intervals for running Healthcheck reports

  1. Stop Unravel

    <Unravel installation directory>/unravel/manager stop

  2. Change the Healthcheck interval period as follows:

    <Unravel installation directory>/unravel/manager config healthcheck period <time in seconds>

##For example:
opt/unravel-install/unravel/manager config healthcheck period 1234 
The interval between healthcheck reports is set to 1234 seconds.

  3. Apply the changes.

    <Unravel installation directory>/unravel/manager config apply

  4. Start Unravel

    <Unravel installation directory>/unravel/manager start

Viewing the Healthcheck reports

The Healthcheck reports are available in a tar tile at <Unravel_installation_directory>/unravel/data/healthcheck location. When you untar the file, the following results are shown:

  • global: Contains configurations, system, and statistics-related data files.

  • healthcheck.log: contains log messages.

  • healthcheck.report.txt: contains the Healthcheck report, which is the same as the console output.

  • healthcheck.yaml: contains all the collected (gather/check) details.

  • services: contains services-related data files.

You can run manager healthcheck help command to view the list of checks in the healthcheck report.

Setting Healthcheck email alerts

Before setting the Healthcheck email alerts, ensure that the email alert settings are already configured.

  1. Stop Unravel

    <Unravel installation directory>/unravel/manager stop

  2. Set the Healthcheck email alerts. 

    <Unravel installation directory>/unravel/manager config healthcheck alerts <frequency>

    You can set the frequency of receiving the email alerts to any of the following options:

    • never: Never send automatic reports.

    • always: Send automatic reports always.

    • error-only: Send healthcheck reports only when issues are detected.

  3. Apply the changes.

    <Unravel installation directory>/unravel/manager config apply

  4. Start Unravel

    <Unravel installation directory>/unravel/manager start
Disable/re-enable Healthcheck service

  1. Stop Unravel

    <Unravel installation directory>/unravel/manager stop

  2. Disable Healthcheck service

    <Unravel installation directory>/unravel/manager service disable healthcheck --permanent

    Re-enable Healthcheck service

    <Unravel installation directory>/unravel/manager service enable healthcheck --permanent

  3. Apply the changes.

    <Unravel installation directory>/unravel/manager config apply

  4. Start Unravel

    <Unravel installation directory>/unravel/manager start
In this section: