LinuxMonitor 1.3.4__tar.gz → 1.3.7__tar.gz

{linuxmonitor-1.3.4 → linuxmonitor-1.3.7/LinuxMonitor.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: LinuxMonitor
-Version: 1.3.4
+Version: 1.3.7
 Summary: Get information and warning status of Linux server like service, port, ping, ssl certificate, disk/folder/cpu/ram/swap usage, ip connection, ... (Python and shell library, Linux ONLY)
 Home-page: https://github.com/QuentinCG/Linux-Monitor-Python-Library
 Author: Quentin Comte-Gaz
@@ -54,6 +54,7 @@ List of 'check' functionalities:
   - Check certificates expiration and validity
   - Check last user connections IPs
   - Check uptime (to inform if the server has been rebooted)
+  - Check custom commands
 
 Additionnal functionalities:
   - Get hostname, OS details, kernel version, server datetime, uptime
@@ -62,6 +63,7 @@ Additionnal functionalities:
   - Kill a process by PID
   - Reboot server
   - Restart/stop a service
+  - Execute custom commands
 
 ## How to install (python script and shell)
 
@@ -150,6 +152,15 @@ python3 -m linuxmonitor --kill_process PID_HERE --config_file config-example.jso
 
 # Restart the entire server
 python3 -m linuxmonitor --reboot_server --config_file config-example.json --nodebug
+
+# List all custom commands
+python3 -m linuxmonitor --list_commands --config_file config-example.json --nodebug
+
+# Execute a custom commands
+python3 -m linuxmonitor --execute_command CUSTOM_COMMAND_HERE --config_file config-example.json --nodebug
+
+# Execute all custom commands
+python3 -m linuxmonitor --execute_all_commands --config_file config-example.json --nodebug
 ```
 
 ## How to use in python script

{linuxmonitor-1.3.4/LinuxMonitor.egg-info → linuxmonitor-1.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: LinuxMonitor
-Version: 1.3.4
+Version: 1.3.7
 Summary: Get information and warning status of Linux server like service, port, ping, ssl certificate, disk/folder/cpu/ram/swap usage, ip connection, ... (Python and shell library, Linux ONLY)
 Home-page: https://github.com/QuentinCG/Linux-Monitor-Python-Library
 Author: Quentin Comte-Gaz
@@ -54,6 +54,7 @@ List of 'check' functionalities:
   - Check certificates expiration and validity
   - Check last user connections IPs
   - Check uptime (to inform if the server has been rebooted)
+  - Check custom commands
 
 Additionnal functionalities:
   - Get hostname, OS details, kernel version, server datetime, uptime
@@ -62,6 +63,7 @@ Additionnal functionalities:
   - Kill a process by PID
   - Reboot server
   - Restart/stop a service
+  - Execute custom commands
 
 ## How to install (python script and shell)
 
@@ -150,6 +152,15 @@ python3 -m linuxmonitor --kill_process PID_HERE --config_file config-example.jso
 
 # Restart the entire server
 python3 -m linuxmonitor --reboot_server --config_file config-example.json --nodebug
+
+# List all custom commands
+python3 -m linuxmonitor --list_commands --config_file config-example.json --nodebug
+
+# Execute a custom commands
+python3 -m linuxmonitor --execute_command CUSTOM_COMMAND_HERE --config_file config-example.json --nodebug
+
+# Execute all custom commands
+python3 -m linuxmonitor --execute_all_commands --config_file config-example.json --nodebug
 ```
 
 ## How to use in python script

{linuxmonitor-1.3.4 → linuxmonitor-1.3.7}/README.md

@@ -26,6 +26,7 @@ List of 'check' functionalities:
   - Check certificates expiration and validity
   - Check last user connections IPs
   - Check uptime (to inform if the server has been rebooted)
+  - Check custom commands
 
 Additionnal functionalities:
   - Get hostname, OS details, kernel version, server datetime, uptime
@@ -34,6 +35,7 @@ Additionnal functionalities:
   - Kill a process by PID
   - Reboot server
   - Restart/stop a service
+  - Execute custom commands
 
 ## How to install (python script and shell)
 
@@ -122,6 +124,15 @@ python3 -m linuxmonitor --kill_process PID_HERE --config_file config-example.jso
 
 # Restart the entire server
 python3 -m linuxmonitor --reboot_server --config_file config-example.json --nodebug
+
+# List all custom commands
+python3 -m linuxmonitor --list_commands --config_file config-example.json --nodebug
+
+# Execute a custom commands
+python3 -m linuxmonitor --execute_command CUSTOM_COMMAND_HERE --config_file config-example.json --nodebug
+
+# Execute all custom commands
+python3 -m linuxmonitor --execute_all_commands --config_file config-example.json --nodebug
 ```
 
 ## How to use in python script

{linuxmonitor-1.3.4 → linuxmonitor-1.3.7}/linuxmonitor/__main__.py

@@ -28,6 +28,9 @@ def main() -> None:
     parser.add_argument('--ports', action='store_true', help='🔒 Check ports 🔒')
     parser.add_argument('--list_processes', action='store_true', help='📋 List active processes 📋')
     parser.add_argument('--kill_process', type=int, help='🚫 Stop a process by PID 🚫')
+    parser.add_argument('--list_commands', action='store_true', help='📋 List all available commands 📋')
+    parser.add_argument('execute_command', type=str, help='📋 Execute a command 📋')
+    parser.add_argument('execute_all_commands', type=str, help='📋 Execute all commands 📋')
 
     parser.add_argument('--debug', action='store_true', help='Enable debug mode')
     parser.add_argument('--nodebug', action='store_true', help='Disable all logs')
@@ -150,6 +153,24 @@ def main() -> None:
         out_msg: str = monitoring.get_all_services(is_private=True)
         print(out_msg)
 
+    if args.list_commands:
+        handled = True
+        print("Listing all available commands...")
+        out_msg: str = asyncio.run(monitoring.list_commands(is_private=True))
+        print(out_msg)
+
+    if args.execute_command is not None:
+        handled = True
+        print(f"Executing command: {args.execute_command}...")
+        out_msg: str = asyncio.run(monitoring.execute_command(is_private=True, command_name=args.execute_command))
+        print(out_msg)
+
+    if args.execute_all_commands is not None:
+        handled = True
+        print(f"Executing all commands...")
+        out_msg: str = asyncio.run(monitoring.execute_all_commands(is_private=True))
+        print(out_msg)
+
     if args.ports:
         handled = True
         print("Checking ports...")

{linuxmonitor-1.3.4 → linuxmonitor-1.3.7}/linuxmonitor/linuxmonitor.py

@@ -33,7 +33,7 @@ __email__ = "quentin@comte-gaz.com"
 __license__ = "MIT License"
 __copyright__ = "Copyright Quentin Comte-Gaz (2024)"
 __python_version__ = "3.+"
-__version__ = "1.3.4 (2024/09/19)"
+__version__ = "1.3.7 (2024/09/19)"
 __status__ = "Usable for any Linux project"
 
 import json
@@ -182,7 +182,47 @@ class LinuxMonitor:
 
     #region Execute Command
 
-    async def execute_and_verify(self, command: str, display_name: str, show_only_std_and_exception: bool, timeout_in_sec: Optional[int] = None, display_only_if_critical: bool = False, check_also_stdout_not_containing: Optional[str] = None) -> Tuple[Optional[bool], str]:
+    def _json_to_md(self, json_string: str, level: int = 0) -> str:
+        """
+        Convert a JSON string into a Markdown representation.
+
+        Parameters:
+            json_string (str): The input JSON string.
+            level (int): The current indentation level (default is 0).
+
+        Returns:
+            str: The resulting Markdown formatted string.
+        """
+        md: str = ""
+        indent: str = "  " * level  # type: ignore # Indentation for markdown headings
+
+        # Parse the JSON string to a Python object
+        try:
+            data = json.loads(json_string)
+        except json.JSONDecodeError as e:
+            return f"Error parsing JSON: {str(e)}"
+
+        # Helper function to convert the parsed JSON to markdown
+        def process_data(data, level: int) -> None: # type: ignore
+            nonlocal md  # Declare md as nonlocal so it can be modified
+            indent = "  " * level
+
+            if isinstance(data, dict):
+                for key, value in data.items(): # type: ignore
+                    md += f"{indent}- {key}\n"
+                    process_data(value, level + 1) # type: ignore
+            elif isinstance(data, list):
+                for index, item in enumerate(data): # type: ignore
+                    md += f"{indent}- Item {index + 1}\n"
+                    process_data(item, level + 1) # type: ignore
+            else:
+                md += f"{indent}  - {data}\n"
+
+        process_data(data, level)
+
+        return md
+
+    async def execute_and_verify(self, command: str, display_name: str, show_only_std_and_exception: bool, timeout_in_sec: Optional[int] = None, display_only_if_critical: bool = False, check_also_stdout_not_containing: Optional[str] = None, is_stdout_json: bool=False) -> Tuple[Optional[bool], str]:
         """
         Execute a shell command asynchronously and verify its correct execution.
 
@@ -211,11 +251,11 @@ class LinuxMonitor:
             except asyncio.TimeoutError:
                 logging.warning(msg=f"Timeout expired for {display_name} (command: {command})")
                 process.kill()
-                return None, f"⚠️ **Error {display_name}**:\n- Failed to execute the command in less than {timeout_in_sec} seconds)"
+                return None, f"  - ⚠️ **Error {display_name}**:\n    - Failed to execute the command in less than {timeout_in_sec} seconds)"
         except Exception as e:
             # Failed to execute the command
             if not show_only_std_and_exception:
-                out_msg = f"⚠️ **Error {display_name}**:\n```sh\n{e}\n```"
+                out_msg = f"  - ⚠️ **Error {display_name}**:\n```sh\n{e}\n```"
             else:
                 out_msg = f"```sh\n{e}\n```"
             logging.exception(msg=out_msg)
@@ -234,24 +274,27 @@ class LinuxMonitor:
         if res == False:
             # Command returned an error code
             if not show_only_std_and_exception:
-                out_msg = f"❌ **Error {display_name}**\n"
+                out_msg = f"  - ❌ **Error {display_name}**\n"
             out_msg += f"  - Error code: `{returncode}`"
 
             if stderr_str != "":
                 out_msg += f"\n  - Error log:\n```sh\n{stderr_str}\n```"
 
             if stdout_str != "":
-                out_msg += f"\n  - Info:\n```sh\n{stdout_str}\n```"
+                msg_stout: str = stdout_str
+                if is_stdout_json:
+                    msg_stout = self._json_to_md(stdout_str)
+                out_msg += f"\n  - Info:\n```sh\n{msg_stout}\n```"
         elif res == None:
             # Command timed out
             if not show_only_std_and_exception:
-                out_msg = f"⚠️ **Error {display_name}**\n"
-            out_msg += f"- Failed to wait for the command to finish (due to timeout of {timeout_in_sec} seconds)"
+                out_msg = f"  - ⚠️ **Error {display_name}**\n"
+            out_msg += f"  - Failed to wait for the command to finish (due to timeout of {timeout_in_sec} seconds)"
         else:
             # Command executed successfully
             if not display_only_if_critical:
                 if not show_only_std_and_exception:
-                    out_msg = f"✅ **{display_name} executed successfully**"
+                    out_msg = f"  - ✅ **{display_name} executed successfully**"
 
         if res == True:
             logging.info(msg=f"Command {display_name} (command {command}) executed successfully")
@@ -274,6 +317,10 @@ class LinuxMonitor:
         """
         logging.info(msg="Rebooting the server...")
         _, out_msg = await self.execute_and_verify(command="sudo /sbin/reboot", display_name="Server reboot", show_only_std_and_exception=False, timeout_in_sec=None, display_only_if_critical=False)
+
+        if out_msg != "":
+            out_msg = f"# 🔄 Reboot 🔄\n{out_msg}"
+
         return out_msg
 
     #endregion
@@ -963,7 +1010,7 @@ class LinuxMonitor:
                 return out_msg
 
             if not force_restart and not service.get('auto_restart', False):
-                out_msg = f"⚠️ **Service {service_name} can be restarted only manually** (change configuration if needed)."
+                out_msg = f"⚠️ **Service {display_name} can be restarted only manually** (change configuration if needed)."
                 logging.error(msg=out_msg)
                 return out_msg
 
@@ -1809,6 +1856,126 @@ class LinuxMonitor:
 
     #endregion
 
+    #region Commands
+
+    async def _execute_command(self, command: str, display_name: str, show_content_if_success: bool, show_content_if_issue: bool, is_content_json: bool, timeout_in_sec: int, display_only_if_critical: bool) -> str:
+        try:
+            out_msg: str = ""
+
+            # Execute the command
+            start_time: float = time.time()
+            res, res_msg = await self.execute_and_verify(command=command, display_name=display_name, show_only_std_and_exception=True, timeout_in_sec=timeout_in_sec, display_only_if_critical=display_only_if_critical, is_stdout_json=is_content_json)
+            end_time: float = time.time()
+
+            if res == True:
+                readable_duration: str = "{:.2f}".format(end_time - start_time)
+                out_msg = f"✅ **{display_name} executed with success** in {readable_duration}sec."
+                logging.info(msg=out_msg)
+
+                if show_content_if_success:
+                    out_msg += f"\n{res_msg}"
+
+            elif res == False:
+                out_msg = f"⚠️ **{display_name} failed to execute**."
+                logging.warning(msg=out_msg)
+
+                if show_content_if_issue:
+                    out_msg += f"\n{res_msg}"
+
+            else:
+                out_msg = f"⚠️ **{display_name} expired**."
+                logging.warning(msg=out_msg)
+
+            return out_msg
+        except Exception as e:
+            out_msg = f"⚠️ **Error while executing {display_name}**:\n```sh\n{e}\n```"
+            logging.exception(msg=out_msg)
+            return out_msg
+
+    async def execute_command(self, is_private: bool, command_name: str) -> str:
+        try:
+            out_msg: str = ""
+            display_name: str = command_name
+            for command_config_key in self.config['commands'].keys():
+                if self.config['commands'][command_config_key]['command'] == command_name:
+                    display_name = self.config['commands'][command_config_key]['display_name']
+                    command: str = self.config['commands'][command_config_key]['command']
+                    is_private_cmd: bool = self.config['commands'][command_config_key]['is_private']
+
+                    if is_private or is_private == is_private_cmd:
+                        show_content_if_success: bool = self.config['commands'][command_config_key].get('show_content_if_success', False)
+                        show_content_if_issue: bool = self.config['commands'][command_config_key].get('show_content_if_issue', False)
+                        is_content_json: bool = self.config['commands'][command_config_key].get('is_content_json', False)
+                        timeout_in_sec: int = self.config['commands'][command_config_key].get('timeout_in_sec', 10)
+
+                        res: str = await self._execute_command(command=command, display_name=display_name, show_content_if_success=show_content_if_success, show_content_if_issue=show_content_if_issue, is_content_json=is_content_json, timeout_in_sec=timeout_in_sec, display_only_if_critical=False)
+                        if res != "":
+                            if out_msg != "":
+                                out_msg += "\n"
+                            out_msg += f"{res}"
+                    else:
+                        out_msg = f"⚠️ **Command {display_name} is not allowed**"
+                        logging.warning(msg=out_msg)
+
+                    if out_msg != "":
+                        out_msg = f"# 📜 Command {display_name} 📜\n{out_msg}"
+
+                    return out_msg
+
+            out_msg = f"⚠️ **Command {display_name} not found**"
+            logging.warning(msg=out_msg)
+            return out_msg
+        except Exception as e:
+            return f"⚠️ **Error executing command {command_name}**:\n```sh\n{e}\n```"
+
+    async def execute_all_commands(self, is_private: bool, is_scheduled_tasks_for_issues: bool=False, is_scheduled_tasks_for_infos: bool=False, display_only_if_critical: bool=False) -> str:
+        try:
+            out_msg: str = ""
+
+            for command_config_key in self.config['commands'].keys():
+                if is_private or is_private == self.config['commands'][command_config_key]['is_private']:
+                    display_name: str = self.config['commands'][command_config_key]['display_name']
+                    command: str = self.config['commands'][command_config_key]['command']
+                    show_content_if_success: bool = self.config['commands'][command_config_key].get('show_content_if_success', False)
+                    show_content_if_issue: bool = self.config['commands'][command_config_key].get('show_content_if_issue', False)
+                    is_content_json: bool = self.config['commands'][command_config_key].get('is_content_json', False)
+                    timeout_in_sec: int = self.config['commands'][command_config_key].get('timeout_in_sec', 10)
+
+                    if is_scheduled_tasks_for_issues and not self.config['commands'][command_config_key].get('execute_in_scheduled_tasks_for_issues', False):
+                        continue
+                    if is_scheduled_tasks_for_infos and not self.config['commands'][command_config_key].get('execute_in_scheduled_tasks_for_infos', False):
+                        continue
+
+                    res: str = await self._execute_command(command=command, display_name=display_name, show_content_if_success=show_content_if_success, show_content_if_issue=show_content_if_issue, is_content_json=is_content_json, timeout_in_sec=timeout_in_sec, display_only_if_critical=display_only_if_critical)
+                    if res != "":
+                        if out_msg != "":
+                            out_msg += "\n"
+                        out_msg += f"{res}"
+
+            if out_msg != "":
+                out_msg = f"# 📜 Commands 📜\n{out_msg}"
+
+            return out_msg
+        except Exception as e:
+            return f"⚠️ **Error executing commands**:\n```sh\n{e}\n```"
+
+    async def list_commands(self, is_private: bool) -> str:
+        try:
+            out_msg: str = "# 📜 Commands 📜\n"
+            for command_config_key in self.config['commands'].keys():
+                if is_private or is_private == self.config['commands'][command_config_key]['is_private']:
+                    display_name: str = self.config['commands'][command_config_key]['display_name']
+                    out_msg += f"- {display_name}\n"
+
+            logging.info(msg=out_msg)
+            return out_msg
+        except Exception as e:
+            out_msg = f"⚠️ **Error listing commands**:\n```sh\n{e}\n```"
+            logging.exception(msg=out_msg)
+            return out_msg
+
+    #endregion
+
     #region Scheduled Tasks
 
     async def schedule_task(self, handle_error_message: Callable[[str], Awaitable[None]], is_private: bool) -> None:
@@ -1839,6 +2006,7 @@ class LinuxMonitor:
         datetime_last_user_logins_error_displayed: Optional[datetime] = None
         datetime_last_port_error_displayed: Optional[datetime] = None
         datetime_last_services_error_displayed: Optional[datetime] = None
+        datetime_last_commands_error_displayed: Optional[datetime] = None
         need_to_check_uptime: bool = True # No need to check uptime every time (since once ok, it can't be wrong)
 
         if not self.start_scheduled_tasks_immediately:
@@ -1997,6 +2165,27 @@ class LinuxMonitor:
                 else:
                     logging.info(msg="- ✅ All ports are OK.")
 
+                # Commands
+                msg = await self.execute_all_commands(is_private=is_private, is_scheduled_tasks_for_issues=True, is_scheduled_tasks_for_infos=False, display_only_if_critical=True)
+                if msg != "":
+                    logging.warning(msg=msg)
+                    if datetime_last_commands_error_displayed is None or ((datetime.now() - datetime_last_commands_error_displayed).total_seconds() > self.max_duration_seconds_showing_same_error_again_in_scheduled_tasks):
+                        if out_msg != "":
+                            out_msg += "\n"
+                        out_msg += msg
+                        datetime_last_commands_error_displayed = datetime.now()
+                    else:
+                        logging.warning(msg="Commands critical but already notified less than 12 hours ago, not notifying...")
+                elif datetime_last_commands_error_displayed is not None:
+                    msg="✅ **Commands returned to normal state**"
+                    logging.info(msg=msg)
+                    if out_msg != "":
+                        out_msg += "\n"
+                    out_msg += msg
+                    datetime_last_commands_error_displayed = None
+                else:
+                    logging.info(msg="- ✅ All commands are OK.")
+
                 # User logins
                 if is_private:
                     msg = self.check_all_recent_user_logins(display_only_if_critical=True)
@@ -2206,6 +2395,13 @@ class LinuxMonitor:
                         out_msg += "\n"
                     out_msg += msg
 
+                # Commands
+                msg = await self.execute_all_commands(is_private=is_private, is_scheduled_tasks_for_issues=False, is_scheduled_tasks_for_infos=True, display_only_if_critical=False)
+                if msg != "":
+                    if out_msg != "":
+                        out_msg += "\n"
+                    out_msg += msg
+
                 # User logins
                 if is_private:
                     msg = self.check_all_recent_user_logins(display_only_if_critical=False)

{linuxmonitor-1.3.4 → linuxmonitor-1.3.7}/setup.py

@@ -6,7 +6,7 @@ with io.open(file='README.md', mode='r', encoding='utf-8') as readme_file:
 
 setup(
     name="LinuxMonitor",
-    version="1.3.4",
+    version="1.3.7",
     description="Get information and warning status of Linux server like service, port, ping, ssl certificate, disk/folder/cpu/ram/swap usage, ip connection, ... (Python and shell library, Linux ONLY)",
     long_description=readme,
     long_description_content_type="text/markdown",