optional json struct log

Author: charmingduchess

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "nypl_py_utils"
-version = "1.7.0"
+version = "1.8.0"
 authors = [
   { name="Aaron Friedman", email="aaronfriedman@nypl.org" },
 ]
@@ -38,6 +38,9 @@ kms-client = [
     "boto3>=1.26.5",
     "botocore>=1.29.5"
 ]
+log_helper = [
+    "structlog>=25.4.0"
+]
 mysql-client = [
     "mysql-connector-python>=8.0.32"
 ]
@@ -78,7 +81,7 @@ research-catalog-identifier-helper = [
     "requests>=2.28.1"
 ]
 development = [
-    "nypl_py_utils[avro-client,kinesis-client,kms-client,mysql-client,oauth2-api-client,postgresql-client,redshift-client,s3-client,secrets-manager-client,sftp-client,config-helper,obfuscation-helper,patron-data-helper,research-catalog-identifier-helper]",
+    "nypl_py_utils[avro-client,kinesis-client,kms-client,mysql-client,oauth2-api-client,postgresql-client,redshift-client,s3-client,secrets-manager-client,sftp-client,config-helper,obfuscation-helper,patron-data-helper,research-catalog-identifier-helper,log_helper]",
     "flake8>=6.0.0",
     "freezegun>=1.2.2",
     "mock>=4.0.3",

src/nypl_py_utils/functions/log_helper.py

@@ -1,3 +1,5 @@
+import structlog
+
 import logging
 import os
 import sys
@@ -10,8 +12,37 @@
     'critical': logging.CRITICAL
 }
 
+# Configure structlog to be machine-readable first and foremost
+# while still making it easy for humans to parse
+# End result (without additional bindings) is JSON like this:
+#
+# { "logger": "module param"
+#   "message": "this is a test log event",
+#  "level": "info",
+#  "timestamp": "2023-11-01 18:50:47"}
+#
+def get_structlog(module):
+    structlog.configure(
+        processors=[
+            structlog.processors.add_log_level,
+            structlog.processors.TimeStamper(fmt="iso"),
+            structlog.processors.EventRenamer("message"),
+            structlog.processors.JSONRenderer(),
+        ],
+        context_class=dict,
+        logger_factory=structlog.PrintLoggerFactory(),
+    )
+
+    # Import this to get an immutable common logger with the above format- you can further use
+    #
+    # custom_logger = common_logger.bind(some_key=some_value)
+    #
+    # to create your own logger with custom fields persisted on top of common ones.
+    #
+    # See https://www.structlog.org/en/stable/bound-loggers.html
+    return structlog.get_logger(module)
 
-def create_log(module):
+def standard_logger (module):
     logger = logging.getLogger(module)
     if logger.hasHandlers():
         logger.handlers = []
@@ -28,5 +59,10 @@ def create_log(module):
     console_log.setFormatter(formatter)
 
     logger.addHandler(console_log)
-
     return logger
+
+def create_log(module, json=False):
+    if(json):
+        return get_structlog()
+    else:
+        return standard_logger(module)