Replace ping with heartbeat in the code and .ini

Author: diffstorm

.gitignore

@@ -1,6 +1,7 @@
 # This file is used to ignore files which are generated
 # ----------------------------------------------------------------------------
 
+build/
 .svn/
 *~
 *.autosave

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
-## [Unreleased]
+## [1.1.0] - 2024-08-28
+
+Replace ping with heartbeat in the code and .ini
+
+### Changed
+
+- Code, config.ini and test_child.py have been refactored
+
+## [1.0.0] - 2024-06-07
 
 - Initial release

README.md

@@ -27,7 +27,6 @@ This application is particularly useful in environments where multiple processes
 
 ## Configuration File : `config.ini`
 An example configuration file looks like this:
-Note that ping means heartbeat.
 
 ```ini
 [processWatchdog]
@@ -36,34 +35,34 @@ nWdtApps = 4
 
 1_name = Communicator
 1_start_delay = 10
-1_ping_delay = 60
-1_ping_interval = 20
+1_heartbeat_delay = 60
+1_heartbeat_interval = 20
 1_cmd = /usr/bin/python test_child.py 1 crash
 
 2_name = Bot
 2_start_delay = 20
-2_ping_delay = 90
-2_ping_interval = 30
-2_cmd = /usr/bin/python test_child.py 2 noping
+2_heartbeat_delay = 90
+2_heartbeat_interval = 30
+2_cmd = /usr/bin/python test_child.py 2 noheartbeat
 
 3_name = Publisher
 3_start_delay = 35
-3_ping_delay = 70
-3_ping_interval = 16
+3_heartbeat_delay = 70
+3_heartbeat_interval = 16
 3_cmd = /usr/bin/python test_child.py 3 crash
 
 4_name = Alert
 4_start_delay = 35
-4_ping_delay = 130
-4_ping_interval = 13
-4_cmd = /usr/bin/python test_child.py 4 noping
+4_heartbeat_delay = 130
+4_heartbeat_interval = 13
+4_cmd = /usr/bin/python test_child.py 4 noheartbeat
 ```
 
 ### Fields
 - `name` : Name of the application.
 - `start_delay` : Delay in seconds before starting the application.
-- `ping_delay` : Time in seconds to wait before expecting a ping from the application.
-- `ping_interval` : Maximum time period in seconds between pings.
+- `heartbeat_delay` : Time in seconds to wait before expecting a heartbeat from the application.
+- `heartbeat_interval` : Maximum time period in seconds between heartbeats.
 - `cmd` : Command to start the application.
 
 ## Heartbeat Message
@@ -286,18 +285,18 @@ The application generates log files to monitor the status of each managed proces
 Statistics for App 2 Publisher:
 Started at: 2024-06-07 20:17:10
 Crashed at: Never
-Ping reset at: Never
+Heartbeat reset at: Never
 Start count: 7
 Crash count: 0
-Ping reset count: 0
-Ping count: 11937
-Ping count old: 15455
-Average first ping time: 105 seconds
-Maximum first ping time: 107 seconds
-Minimum first ping time: 104 seconds
-Average ping time: 102 seconds
-Maximum ping time: 110 seconds
-Minimum ping time: 102 seconds
+Heartbeat reset count: 0
+Heartbeat count: 11937
+Heartbeat count old: 15455
+Average first heartbeat time: 105 seconds
+Maximum first heartbeat time: 107 seconds
+Minimum first heartbeat time: 104 seconds
+Average heartbeat time: 102 seconds
+Maximum heartbeat time: 110 seconds
+Minimum heartbeat time: 102 seconds
 Magic: A50FAA55
 ```
 
@@ -337,7 +336,6 @@ Use the provided `run.sh` script to start the Process Watchdog application. This
 Or just `./run.sh &` which is recommended.
 
 ## TODO
-- Replace ping with heartbeat in the code and .ini
 - Redesign the apps.c
 - Add CPU & RAM usage to the statistics
 - Create easy-to-use heartbeat libraries

config.ini

@@ -4,21 +4,21 @@ udp_port = 12345
 nWdtApps = 4
 1_name = Communicator
 1_start_delay = 10
-1_ping_delay = 60
-1_ping_interval = 20
+1_heartbeat_delay = 60
+1_heartbeat_interval = 20
 1_cmd = /usr/bin/python test_child.py 1 crash
 2_name = Bot
 2_start_delay = 20
-2_ping_delay = 90
-2_ping_interval = 30
-2_cmd = /usr/bin/python test_child.py 2 noping
+2_heartbeat_delay = 90
+2_heartbeat_interval = 30
+2_cmd = /usr/bin/python test_child.py 2 noheartbeat
 3_name = Publisher
 3_start_delay = 35
-3_ping_delay = 70
-3_ping_interval = 16
+3_heartbeat_delay = 70
+3_heartbeat_interval = 16
 3_cmd = /usr/bin/python test_child.py 3 crash
 4_name = Alert
 4_start_delay = 35
-4_ping_delay = 130
-4_ping_interval = 13
-4_cmd = /usr/bin/python test_child.py 4 noping
+4_heartbeat_delay = 130
+4_heartbeat_interval = 13
+4_cmd = /usr/bin/python test_child.py 4 noheartbeat

src/apps.c

@@ -9,7 +9,7 @@
 
     The application ensures high reliability and availability by continuously monitoring and
     restarting processes as necessary. It also logs various statistics about the monitored
-    processes, including start times, crash times, and ping intervals.
+    processes, including start times, crash times, and heartbeat intervals.
 
     @date 2023-01-01
     @version 1.0
@@ -47,15 +47,15 @@ typedef struct
 {
     // In the ini file
     int start_delay; /**< Delay in seconds before starting the application. */
-    int ping_delay; /**< Time in seconds to wait before expecting a ping from the application. */
-    int ping_interval; /**< Maximum time period in seconds between pings. */
+    int heartbeat_delay; /**< Time in seconds to wait before expecting a heartbeat from the application. */
+    int heartbeat_interval; /**< Maximum time period in seconds between heartbeats. */
     char name[MAX_APP_NAME_LENGTH]; /**< Name of the application. */
     char cmd[MAX_APP_CMD_LENGTH]; /**< Command to start the application. */
     // Not in the ini file
     bool started; /**< Flag indicating whether the application has been started. */
-    bool first_ping; /**< Flag indicating whether the application has sent its first ping. */
+    bool first_heartbeat; /**< Flag indicating whether the application has sent its first heartbeat. */
     int pid; /**< Process ID of the application. */
-    time_t last_ping; /**< Time when the last ping was received from the application. */
+    time_t last_heartbeat; /**< Time when the last heartbeat was received from the application. */
 } Application_t;
 
 static Application_t apps[MAX_APPS]; /**< Array of Application_t structures representing applications defined in the ini file. */
@@ -71,23 +71,23 @@ static int ini_index; /**< Index used to read an array in the ini file. */
 void print_app(int i)
 {
     LOGN("## Application info [%d]", i);
-    LOGN("%d- name         : %s", i, apps[i].name);
-    LOGN("%d- start_delay  : %d", i, apps[i].start_delay);
-    LOGN("%d- ping_delay   : %d", i, apps[i].ping_delay);
-    LOGN("%d- ping_interval: %d", i, apps[i].ping_interval);
-    LOGN("%d- cmd          : %s", i, apps[i].cmd);
-    LOGN("%d- started      : %d", i, apps[i].started);
-    LOGN("%d- first_ping   : %d", i, apps[i].first_ping);
-    LOGN("%d- pid          : %d", i, apps[i].pid);
-    LOGN("%d- last_ping    : %d", i, apps[i].last_ping);
+    LOGN("%d- name              : %s", i, apps[i].name);
+    LOGN("%d- start_delay       : %d", i, apps[i].start_delay);
+    LOGN("%d- heartbeat_delay   : %d", i, apps[i].heartbeat_delay);
+    LOGN("%d- heartbeat_interval: %d", i, apps[i].heartbeat_interval);
+    LOGN("%d- cmd               : %s", i, apps[i].cmd);
+    LOGN("%d- started           : %d", i, apps[i].started);
+    LOGN("%d- first_heartbeat   : %d", i, apps[i].first_heartbeat);
+    LOGN("%d- pid               : %d", i, apps[i].pid);
+    LOGN("%d- last_heartbeat    : %d", i, apps[i].last_heartbeat);
 }
 
 //------------------------------------------------------------------
 
-void update_ping_time(int i)
+void update_heartbeat_time(int i)
 {
-    apps[i].last_ping = time(NULL);
-    LOGD("Ping time updated for %s", apps[i].name);
+    apps[i].last_heartbeat = time(NULL);
+    LOGD("Heartbeat time updated for %s", apps[i].name);
 }
 
 int find_pid(int pid)
@@ -103,39 +103,39 @@ int find_pid(int pid)
     return -1;
 }
 
-time_t get_ping_time(int i)
+time_t get_heartbeat_time(int i)
 {
     time_t t = time(NULL);
-    return t - apps[i].last_ping;
+    return t - apps[i].last_heartbeat;
 }
 
 bool is_timeup(int i)
 {
     bool ret = false;
     time_t t = time(NULL);
 
-    if(t < apps[i].last_ping)
+    if(t < apps[i].last_heartbeat)
     {
-        update_ping_time(i);
+        update_heartbeat_time(i);
     }
 
-    if(t - apps[i].last_ping >= (apps[i].first_ping ? apps[i].ping_interval : apps[i].ping_delay))
+    if(t - apps[i].last_heartbeat >= (apps[i].first_heartbeat ? apps[i].heartbeat_interval : apps[i].heartbeat_delay))
     {
         ret = true;
-        LOGD("Ping time up for %s", apps[i].name);
+        LOGD("Heartbeat time up for %s", apps[i].name);
     }
 
     return ret;
 }
 
-void set_first_ping(int i)
+void set_first_heartbeat(int i)
 {
-    apps[i].first_ping = true;
+    apps[i].first_heartbeat = true;
 }
 
-bool get_first_ping(int i)
+bool get_first_heartbeat(int i)
 {
-    return apps[i].first_ping;
+    return apps[i].first_heartbeat;
 }
 
 //------------------------------------------------------------------
@@ -218,18 +218,18 @@ static int handler(void *user, const char *section, const char *name, const char
             apps[ini_index].start_delay = atoi(value);
         }
 
-        SECTION(ini_index, "ping_delay");
+        SECTION(ini_index, "heartbeat_delay");
 
         if(MATCH(_section, b))
         {
-            apps[ini_index].ping_delay = atoi(value);
+            apps[ini_index].heartbeat_delay = atoi(value);
         }
 
-        SECTION(ini_index, "ping_interval");
+        SECTION(ini_index, "heartbeat_interval");
 
         if(MATCH(_section, b))
         {
-            apps[ini_index].ping_interval = atoi(value);
+            apps[ini_index].heartbeat_interval = atoi(value);
         }
 
         SECTION(ini_index, "cmd"); // this always must be the last one
@@ -332,10 +332,10 @@ void start_application(int i)
     {
         // Parent process
         apps[i].started = true;
-        apps[i].first_ping = false;
+        apps[i].first_heartbeat = false;
         apps[i].pid = pid;
         LOGI("Process %s started (PID %d): %s", apps[i].name, apps[i].pid, apps[i].cmd);
-        update_ping_time(i);
+        update_heartbeat_time(i);
     }
 }
 
@@ -426,7 +426,7 @@ void kill_application(int i)
     if(killed)
     {
         apps[i].started = false;
-        apps[i].first_ping = false;
+        apps[i].first_heartbeat = false;
         apps[i].pid = 0;
     }
 }
@@ -454,8 +454,8 @@ void restart_application(int i)
     }
     else
     {
-        // Update the last_ping time to prevent immediate restart
-        update_ping_time(i);
+        // Update the last_heartbeat time to prevent immediate restart
+        update_heartbeat_time(i);
         // Log that the application has been successfully restarted
         LOGI("Process %s restarted successfully", apps[i].name);
     }

src/apps.h

@@ -9,7 +9,7 @@
 
     The application ensures high reliability and availability by continuously monitoring and
     restarting processes as necessary. It also logs various statistics about the monitored
-    processes, including start times, crash times, and ping intervals.
+    processes, including start times, crash times, and heartbeat intervals.
 
     @date 2023-01-01
     @version 1.0
@@ -46,11 +46,11 @@
 void print_app(int i);
 
 /**
-    @brief Updates the last ping time for the specified application.
+    @brief Updates the last heartbeat time for the specified application.
 
     @param i Index of the application.
 */
-void update_ping_time(int i);
+void update_heartbeat_time(int i);
 
 /**
     @brief Finds the index of an application with the specified process ID.
@@ -61,35 +61,35 @@ void update_ping_time(int i);
 int find_pid(int pid);
 
 /**
-    @brief Gets the elapsed time since the last ping received from the specified application.
+    @brief Gets the elapsed time since the last heartbeat received from the specified application.
 
     @param i Index of the application.
     @return Elapsed time in seconds.
 */
-time_t get_ping_time(int i);
+time_t get_heartbeat_time(int i);
 
 /**
-    @brief Checks if it is time to expect a ping from the specified application.
+    @brief Checks if it is time to expect a heartbeat from the specified application.
 
     @param i Index of the application.
-    @return true if it is time to expect a ping, false otherwise.
+    @return true if it is time to expect a heartbeat, false otherwise.
 */
 bool is_timeup(int i);
 
 /**
-    @brief Sets the flag indicating that the specified application has sent its first ping.
+    @brief Sets the flag indicating that the specified application has sent its first heartbeat.
 
     @param i Index of the application.
 */
-void set_first_ping(int i);
+void set_first_heartbeat(int i);
 
 /**
-    @brief Gets the flag indicating whether the specified application has sent its first ping.
+    @brief Gets the flag indicating whether the specified application has sent its first heartbeat.
 
     @param i Index of the application.
-    @return true if the application has sent its first ping, false otherwise.
+    @return true if the application has sent its first heartbeat, false otherwise.
 */
-bool get_first_ping(int i);
+bool get_first_heartbeat(int i);
 
 /**
     @brief Sets the path to the ini file.

src/filecmd.c

@@ -9,7 +9,7 @@
 
     The application ensures high reliability and availability by continuously monitoring and
     restarting processes as necessary. It also logs various statistics about the monitored
-    processes, including start times, crash times, and ping intervals.
+    processes, including start times, crash times, and heartbeat intervals.
 
     @date 2023-01-01
     @version 1.0