Merge pull request #5 from zcsadmin/feat/add_logging_filter

feat: add endpoint filter

Author: mithenks

README.md

@@ -63,27 +63,7 @@ from zcs.core.logger import ZcsLogging
 
 ## Local development
 
-### Run library tests
-
-If you want to run libraray tests against your local docker development environment, you can run:
-
-```bash
-./run.sh -t
-```
-
-### Run tests in a dist docker image
-
-To be sure that anything is going the right way, you can run the library tests against a dist docker image. This will assure that anything is working properly in a fresh installed environment.
-
-```bash
-./run.sh -i
-```
-
-### Other commands and help
-
-```bash
-./run.sh -h
-```
+See [Local Development](./docs/LOCAL_DEVELOPMENT.md).
 
 ## Support
 

app/src/zcs/core/logger/__init__.py

@@ -1 +1,2 @@
-from .logger import ZcsLogging as ZcsLogging
+from .logger import ZcsLogging as ZcsLogging
+from .endpoint_filter import EndpointFilter as EndpointFilter

app/src/zcs/core/logger/endpoint_filter.py

@@ -0,0 +1,26 @@
+"""
+Define a custom logging filter that can be used to ignore endpoint access logs.
+"""
+import logging
+from typing import List
+
+
+class EndpointFilter(logging.Filter):
+    """Custom filter class to ignore endpoint access logs"""
+
+    def __init__(self, endpoints: List[str] = ["/health", "/metrics", "/info"]):
+        self.__endpoints = endpoints
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """
+        Determine if a message should be ignored.
+
+        Returns:
+            bool - False if the message should be ignored, True if not
+        """
+
+        for endpoint in self.__endpoints:
+            if record.getMessage().find(f"GET {endpoint}") != -1:
+                return False
+
+        return True

app/src/zcs/core/logger/logger.py

@@ -1,13 +1,14 @@
 import json
 import logging
 
-from zcs.core.exception import ZcsException 
+from zcs.core.exception import ZcsException
 
 old_factory = logging.getLogRecordFactory()
 
+
 def record_factory(*args, **kwargs):
     record = old_factory(*args, **kwargs)
-    
+
     record.error_code = None
     if args[4] and isinstance(args[4], ZcsException):
         record.error_code = args[4].get_error_code()
@@ -20,11 +21,13 @@ def record_factory(*args, **kwargs):
                 record.original_exception = arg
                 if isinstance(arg, ZcsException):
                     record.error_code = arg.get_error_code()
-    
+
     return record
 
+
 logging.setLogRecordFactory(record_factory)
 
+
 class CloudJsonFormatter(logging.Formatter):
     def format(self, record):
 
@@ -50,13 +53,14 @@ def format(self, record):
         }
         return json.dumps(log_record)
 
+
 class ConsoleCustomFormatter(logging.Formatter):
 
-    def __init__(self, verbose = False):
+    def __init__(self, verbose=False):
         super().__init__()
-        
+
         set_grey = "\x1b[38;20m"
-        set_green = "\x1b[32;20m"
+        # set_green = "\x1b[32;20m"
         set_yellow = "\x1b[33;20m"
         set_red = "\x1b[31;20m"
         set_bold_red = "\x1b[31;1m"
@@ -79,6 +83,7 @@ def format(self, record):
         formatter = self.FORMATTERS.get(record.levelno)
         return formatter.format(record)
 
+
 class ZcsLogging:
 
     def __init__(self, enable_cloud_logging: bool = True, log_level: str = logging.INFO):
@@ -101,8 +106,8 @@ def __init__(self, enable_cloud_logging: bool = True, log_level: str = logging.I
             p_logger.setLevel(self.__log_level)
             if len(p_logger.handlers) == 0:
                 continue
-            p_logger.handlers = [ custom_handler ]
-        
+            p_logger.handlers = [custom_handler]
+
         zcs_handler = logging.StreamHandler()
         if enable_cloud_logging:
             zcs_handler.setFormatter(CloudJsonFormatter())
@@ -112,7 +117,7 @@ def __init__(self, enable_cloud_logging: bool = True, log_level: str = logging.I
         # Set log level and handler for the root logger
         logging.basicConfig(
             level=self.__log_level,
-            handlers=[ zcs_handler ]
+            handlers=[zcs_handler]
         )
 
     def get_logger(self):

docs/LOCAL_DEVELOPMENT.md

@@ -0,0 +1,23 @@
+# Local development
+
+## Run library tests
+
+If you want to run library tests against your local docker development environment, you can run:
+
+```bash
+./run.sh -t
+```
+
+## Run tests in a dist docker image
+
+To be sure that anything is going the right way, you can run the library tests against a dist docker image. This will assure that anything is working properly in a fresh installed environment.
+
+```bash
+./run.sh -i
+```
+
+## Other commands and help
+
+```bash
+./run.sh -h
+```