Added daily file logging feature

Author: tiagoepr

README.md

@@ -70,11 +70,11 @@ python setup.py install
 ## Run as
 ### Command Line
 ```sh
-http2mllp localhost --mllp_port 2575
+http2mllp localhost 
 
 mllp2http http://localhost:8000
 
-https2mllp localhost --mllp_port 2575
+https2mllp localhost
 
 mllp2https https://localhost:8000
 ```
@@ -99,11 +99,11 @@ docker build -t tiagoepr/mllp-https .
 Run as:
 
 ```sh
-docker run -it -p 8000:8000 --rm tiagoepr/mllp-https http2mllp host.docker.internal --mllp_port 2575
+docker run -it -p 8000:8000 --rm tiagoepr/mllp-https http2mllp host.docker.internal
 
 docker run -it -p 2575:2575 --rm tiagoepr/mllp-https mllp2http http://host.docker.internal:8000
 
-docker run -it -p 8000:8000 --rm tiagoepr/mllp-https https2mllp host.docker.internal --mllp_port 2575  (See note below about SSL certificate)
+docker run -it -p 8000:8000 --rm tiagoepr/mllp-https https2mllp host.docker.internal (See note below about SSL certificate)
 
 docker run -it -p 2575:2575 --rm tiagoepr/mllp-https mllp2https https://host.docker.internal:8000    
 ```
@@ -117,7 +117,7 @@ docker cp [LOCAL/PATH/TO/ssl] [container_id]:/usr/local/lib/python3.10/site-pack
 where [LOCAL/PATH/TO/ssh] is the path for the folder containing the certfile.crt and keyfile.key and [container_id] should be replaced by the container ID which is running.
 <br>Now, on the container bash, run the command:
 ```sh
-docker run -it -p 8000:8000 --rm tiagoepr/mllp-https https2mllp host.docker.internal --mllp_port 2575 --certfile /usr/local/lib/python3.7/site-packages/mllp_http_https/ssl/certfile.crt --keyfile /usr/local/lib/python3.7/site-packages/mllp_http_https/ssl/keyfile.key
+docker run -it -p 8000:8000 --rm tiagoepr/mllp-https https2mllp host.docker.internal --certfile /usr/local/lib/python3.7/site-packages/mllp_http_https/ssl/certfile.crt --keyfile /usr/local/lib/python3.7/site-packages/mllp_http_https/ssl/keyfile.key
 ```
 ## Usage
 
@@ -192,7 +192,7 @@ environment variables:
 
 ### https2mllp
 ```
-usage: https2mllp [-h] [-H HOST] [-p PORT] [--username USERNAME] [--password PASSWORD] [--keep-alive KEEP_ALIVE] [--log-level {error,warn,info}] [--log-file LOG_FILE] [--mllp-keep-alive MLLP_KEEP_ALIVE]
+usage: https2mllp [-h] [-H HOST] [-p PORT] [--username USERNAME] [--password PASSWORD] [--keep-alive KEEP_ALIVE] [--log-level {error,warn,info}] [--log-folder LOG_FOLDER] [--mllp-keep-alive MLLP_KEEP_ALIVE]
                   [--mllp-max-messages MLLP_MAX_MESSAGES] [--mllp-release {1}] [--timeout TIMEOUT] [--content-type CONTENT_TYPE] [--mllp_port MLLP_PORT] [--certfile CERTFILE] [--keyfile KEYFILE] [--mllp_parser {True,False}] [-v]
                   mllp_url
 
@@ -214,7 +214,7 @@ optional arguments:
   --keep-alive KEEP_ALIVE
                         keep-alive in milliseconds, or unlimited if -1. (default: 0)
   --log-level {error,warn,info}
-  --log-file LOG_FILE   Path to file where the logs will be placed. If not provided logging will be done on command window. (default: None)
+  --log-folder LOG_FOLDER   Path to folder where the logs will be placed. If not provided logging will be done on command window. (default: None)
   --mllp-keep-alive MLLP_KEEP_ALIVE
                         keep-alive in milliseconds, or unlimited if -1. (default: 10000)
   --mllp-max-messages MLLP_MAX_MESSAGES
@@ -235,7 +235,7 @@ optional arguments:
 ### mllp2https
 
 ```
-usage: mllp2https [-h] [-H HOST] [-p PORT] [--username USERNAME] [--password PASSWORD] [--content-type CONTENT_TYPE] [--log-level {error,warn,info}] [--log-file LOG_FILE] [--mllp-release {1}] [--timeout TIMEOUT] [--verify {False,True}]
+usage: mllp2https [-h] [-H HOST] [-p PORT] [--username USERNAME] [--password PASSWORD] [--content-type CONTENT_TYPE] [--log-level {error,warn,info}] [--log-folder LOG_FOLDER] [--mllp-release {1}] [--timeout TIMEOUT] [--verify {False,True}]
                   [-v]
                   https_url
 
@@ -253,7 +253,7 @@ optional arguments:
   --content-type CONTENT_TYPE
                         HTTPS Content-Type header (default: application/hl7-v2; charset=utf-8)
   --log-level {error,warn,info}
-  --log-file LOG_FILE   Path to file where the logs will be placed. If not provided logging will be done on command window. (default: None)
+  --log-folder LOG_FOLDER   Path to folder where the logs will be placed. If not provided logging will be done on command window. (default: None)
   --mllp-release {1}    MLLP release version (default: 1)
   --timeout TIMEOUT     Timeout in milliseconds (default: 0)
   --verify {False,True}

mllp_http_https/https2mllp.py

@@ -11,14 +11,12 @@
 import ssl
 import threading
 import time
-from base64 import b64encode
 from datetime import datetime, timezone
 
 from .mllp import send_mllp, parse_mllp
 
 logger = logging.getLogger(__name__)
 
-
 class MllpClientOptions:
     def __init__(self, keep_alive, max_messages, timeout):
         # self.address = address
@@ -230,6 +228,7 @@ def do_POST(self):
 
 
 def serve(address, options, mllp_address, mllp_options):
+
     # MLLP Client for dealing with the MLLP TCP connection
     client = MllpClient(mllp_address, mllp_options)
 

mllp_http_https/log2file.py

@@ -0,0 +1,87 @@
+### By Tiago Rodrigues
+### Sectra Iberia, Aug 2022
+### Script to manage the logging
+
+
+import logging
+import logging.handlers as handlers
+from time import sleep
+from threading import Thread
+import os
+import sys
+import datetime
+
+
+# Generates and manages the logs files
+class Log2File:
+    def __init__(self, file_name, folder_path, log_level_str, number_of_days_log=1):
+        self.file_name = file_name
+        self.folder_path = folder_path
+        self.log_level_str = log_level_str
+        self.number_of_days_log = number_of_days_log
+
+    def log_level(self, arg):
+        if arg == "error":
+            return logging.ERROR
+        elif arg == "warn":
+            return logging.WARNING
+        elif arg == "info":
+            return logging.INFO
+
+    def new_log(self):
+        formatter = logging.Formatter(
+            fmt="%(asctime)s [%(levelname)s] %(name)s %(message)s"
+        )
+        level = self.log_level(self.log_level_str)
+
+        logger = logging.getLogger()
+        logger.setLevel(level)
+
+        filename = self.folder_path + "\\" + self.file_name
+        log_handler = handlers.TimedRotatingFileHandler(filename, when='D', interval=self.number_of_days_log)
+        log_handler.setFormatter(formatter)
+
+        logger.addHandler(log_handler)
+
+
+# Looks and deletes old
+class LogMonitor:
+    def __init__(self, number_of_days_check, folder_path):
+        self.daemon = Thread(target=self.background_task, args=(number_of_days_check,), daemon=True, name='LogControl')
+        self.folder_path = folder_path
+
+    # task that runs at a fixed interval
+    def background_task(self, interval_days):
+        interval_sec = interval_days * 24 * 60 * 60  # Days to sec
+
+        # run forever
+        while True:
+            # block for the interval
+            sleep(interval_sec)
+
+            # perform the task
+            N = interval_days
+            if not os.path.exists(self.folder_path):
+                print("Please provide valid path")
+                sys.exit(1)
+            if os.path.isfile(self.folder_path):
+                print("Please provide dictionary path")
+                sys.exit(2)
+            today = datetime.datetime.now()
+            for each_file in os.listdir(self.folder_path):
+                if each_file[len(each_file) - 4:len(each_file)] != ".log":
+                    each_file_path = os.path.join(self.folder_path, each_file)
+                    if os.path.isfile(each_file_path):
+                        datetime_str = each_file[len(each_file) - 19:len(each_file)]
+
+                        file_cre_date = datetime.datetime.strptime(datetime_str, '%Y-%m-%d_%H-%M-%S')
+                        # file_cre_date = datetime.datetime.fromtimestamp(os.path.getctime(each_file_path))
+
+                        dif_days = (today - file_cre_date).days
+                        if dif_days > N:
+                            os.remove(each_file_path)
+                            print(each_file_path, dif_days)
+
+    def start(self):
+        self.daemon.start()
+        pass

mllp_http_https/main.py

@@ -1,8 +1,9 @@
 import argparse
 import datetime
 import logging
+import logging.handlers as handlers
 import urllib.parse
-from .version import __version__
+from mllp_http_https.version import __version__
 
 
 class ArgumentFormatter(
@@ -135,6 +136,7 @@ def http2mllp():
         pass
 
 
+
 def mllp2http():
     parser = argparse.ArgumentParser(
         "mllp2http",
@@ -233,7 +235,7 @@ def https2mllp():
     )
     parser.add_argument(
         "--mllp_port",
-        default=2575,
+        default="2575",
         type=int,
         help="MLLP PORT",
     )
@@ -274,9 +276,9 @@ def https2mllp():
         default="info",
     )
     parser.add_argument(
-        "--log-file",
+        "--log-folder",
         default=None,
-        help="Path to file where the logs will be placed. If not provided logging will be done on command window."
+        help="Path to folder where the logs will be placed. If not provided logging will be done on command window."
     )
     parser.add_argument(
         "--mllp-keep-alive",
@@ -340,13 +342,24 @@ def https2mllp():
 
     import mllp_http_https.https2mllp
 
-    # If log_file is provided, logs will be written in file. Otherwise, will be written on console.
-    if args.log_file:
-        logging.basicConfig(
-            filename=args.log_file,
-            format="%(asctime)s [%(levelname)s] %(name)s %(message)s",
-            level=log_level(args.log_level),
+    # If log_folder is provided, logs will be written in file. Otherwise, will be written on console.
+    if args.log_folder:
+        import mllp_http_https.log2file
+        log = mllp_http_https.log2file.Log2File(
+            file_name="https2mllp.log",
+            folder_path=args.log_folder,
+            log_level_str=args.log_level,
+            number_of_days_log=1,
+        )
+        log.new_log()
+
+        # Start additional thread to delete old logs
+        log_monitor = mllp_http_https.log2file.LogMonitor(
+            number_of_days_check=30,
+            folder_path=args.log_folder,
         )
+        log_monitor.start()
+
     else:
         logging.basicConfig(
             format="%(asctime)s [%(levelname)s] %(name)s %(message)s",
@@ -370,6 +383,7 @@ def https2mllp():
     )
 
     try:
+        # Start the serving on the main thread
         mllp_http_https.https2mllp.serve(
             address=(
                 args.host,
@@ -435,9 +449,9 @@ def mllp2https():
         default="info",
     )
     parser.add_argument(
-        "--log-file",
+        "--log-folder",
         default=None,
-        help="Path to file where the logs will be placed. If not provided logging will be done on command window."
+        help="Path to folder where the logs will be placed. If not provided logging will be done on command window."
     )
     parser.add_argument(
         "--mllp-release",
@@ -466,13 +480,29 @@ def mllp2https():
 
     import mllp_http_https.mllp2https
 
-    # If log_file is provided, logs will be written in file. Otherwise, will be written on console.
-    if args.log_file:
-        logging.basicConfig(
-            filename=args.log_file,
-            format="%(asctime)s [%(levelname)s] %(name)s %(message)s",
-            level=log_level(args.log_level),
+    # If log_folder is provided, logs will be written in file. Otherwise, will be written on console.
+    if args.log_folder:
+        import mllp_http_https.log2file
+        log = mllp_http_https.log2file.Log2File(
+            file_name="mllp2https.log",
+            folder_path=args.log_folder,
+            log_level_str=args.log_level,
+            number_of_days_log=1,
         )
+        log.new_log()
+
+        # Start additional thread to delete old logs
+        log_monitor = mllp_http_https.log2file.LogMonitor(
+            number_of_days_check=30,
+            folder_path=args.log_folder,
+        )
+        log_monitor.start()
+
+        # logging.basicConfig(
+        #     filename=args.log_file,
+        #     format="%(asctime)s [%(levelname)s] %(name)s %(message)s",
+        #     level=log_level(args.log_level),
+        # )
     else:
         logging.basicConfig(
             format="%(asctime)s [%(levelname)s] %(name)s %(message)s",

mllp_http_https/version.py

@@ -1 +1 @@
-__version__ = "1.2.35"
+__version__ = "1.2.36"