Skip to main content

Introduction​

This document will guide you on how to report PHM state of applications to Platform Health Manager.

Platform Health Management monitors Supervised Entities. Each Supervised Entity maps to whole or part of a Process. The monitoring is active as long as the corresponding Process is active. Platform Health Management provides three kinds of supervisions to monitor a Supervised Entity:

  • Alive Supervision,
  • Deadline Supervision and
  • Logical Supervision.

The PHM supervisions are based on checkpoints which are reported by the Supervised Entity Instance. Following section explain how to integrate the necessary platform PHM reporting modules to the application and how to report checkpoint from applications.

PHM Supervised Entity Checkpoint Reporting​

Make the changes to your application as explained in below steps.

note

Please make sure that you read the PHM checkpointgenerator tool before performing these steps. The steps assumed that you already used the checkpoint generator tool to generate checkpoint header files.

  1. Copy the respective checkpoint header file to current application directory, After generating checkpoint header file using PHM checkpointgenerator tool tool User need to properly move the correct checkpoint header file to application folder for compilation by considering checkpoint belongs to application entity or not. if wrong checkpoint file compiled with application, it will be ignored by PHM as it is not reporting from respective application entity.

  2. Include checkpoint header file in application where you want to report it from.

    #include <ch1_class.hpp>

  3. Create checkpoint class object

    ch1_class phmchkPoint;

  4. call reportCheckpoint method on object to report to PHM

    phmchkPoint.reportCheckPoint();

  5. Usage of all supervision checkpoints are same. User is solo responsible for reporting point in application.

    Alive Supervision: Need to report for every configurable amount of time interval DeadLine Supervision: Need to report start and stop checkpoints from code flow Logical Supervision: Need to report from code flow.

  6. All Supervision will perform at PHM as per configurations provided in phm_configuration.json file