add logging abstraction

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 6.6.2
+
+* Added logging module abstraction. You can now define the logging module to be used by setting the
+  `LOGGING_MODULE` environment variable.
+
 ## 6.6.1
 
 * Upgrade confidant to python 3.10.14

VERSION

@@ -1 +1 @@
-6.6.1
+6.6.2

confidant/app.py

@@ -1,4 +1,4 @@
-import logging
+import importlib
 
 import boto3
 import guard
@@ -17,6 +17,8 @@
     jwks,
 )
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
+
 if not settings.get('DEBUG'):
     boto3.set_stream_logger(level=logging.CRITICAL)
     logging.getLogger('botocore').setLevel(logging.CRITICAL)

confidant/authnz/__init__.py

@@ -1,12 +1,12 @@
-import logging
+import importlib
 
 import kmsauth
 from flask import abort, request, g, make_response
 from flask import url_for
 from functools import wraps
 
 from confidant import settings
-from confidant.utils import stats
+from confidant.utils.stats import stats
 
 from confidant.authnz.errors import (
     UserUnknownError,
@@ -17,6 +17,7 @@
 
 _VALIDATOR = None
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 user_mod = userauth.init_user_auth_class()
 

confidant/authnz/userauth.py

@@ -1,6 +1,6 @@
 import abc
-import logging
 import datetime
+import importlib
 import random
 
 import yaml
@@ -24,6 +24,7 @@
 from confidant.utils.misc import dict_deep_update
 from confidant.authnz import errors
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
 

confidant/clients/__init__.py

@@ -1,8 +1,11 @@
 """Module for accessing services external to Confidant."""
 
 import boto3
-import logging
+import importlib
 
+from confidant import settings
+
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
 CLIENT_CACHE = {}

confidant/encrypted_settings.py

@@ -1,13 +1,15 @@
 import yaml
 import base64
-import logging
+import importlib
 import json
 
 from cryptography.fernet import Fernet
 
 import confidant.clients
+from confidant.settings import LOGGING_MODULE
 from confidant.lib import cryptolib
 
+logging = importlib.import_module(LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
 

confidant/routes/blind_credentials.py

@@ -1,4 +1,4 @@
-import logging
+import importlib
 import uuid
 
 from flask import blueprints, jsonify, request
@@ -18,6 +18,7 @@
 )
 from confidant.models.blind_credential import BlindCredential
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 blueprint = blueprints.Blueprint('blind_credentials', __name__)
 

confidant/routes/certificates.py

@@ -1,4 +1,4 @@
-import logging
+import importlib
 
 from flask import blueprints, jsonify, request
 
@@ -15,6 +15,7 @@
 )
 from confidant.utils import misc
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 blueprint = blueprints.Blueprint('certificates', __name__)
 

confidant/routes/credentials.py

@@ -1,6 +1,6 @@
 import base64
+import importlib
 import json
-import logging
 import re
 import uuid
 
@@ -25,9 +25,11 @@
     webhook,
 )
 from confidant.services.ciphermanager import CipherManager
-from confidant.utils import maintenance, misc, stats
+from confidant.utils import maintenance, misc
+from confidant.utils.stats import stats
 from confidant.utils.dynamodb import decode_last_evaluated_key
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 blueprint = blueprints.Blueprint('credentials', __name__)
 

confidant/routes/jwks.py

@@ -1,14 +1,15 @@
-import logging
+import importlib
 
 from flask import blueprints, jsonify, request
 
-from confidant import authnz
+from confidant import authnz, settings
 from confidant.services.jwkmanager import JWKManager
 from confidant.schema.jwks import jwt_response_schema, JWTResponse, \
     jwks_list_response_schema, JWKSListResponse
 from confidant.settings import ACL_MODULE
 from confidant.utils import misc
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 blueprint = blueprints.Blueprint('jwks', __name__)
 

confidant/routes/saml.py

@@ -1,10 +1,11 @@
-import logging
+import importlib
 
 import flask
 from flask import blueprints, jsonify, request, session
 
 from confidant import authnz, settings
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 blueprint = blueprints.Blueprint('saml', __name__)
 

confidant/routes/services.py

@@ -1,4 +1,4 @@
-import logging
+import importlib
 
 from flask import blueprints, jsonify, request
 from pynamodb.exceptions import DoesNotExist, PutError
@@ -20,9 +20,11 @@
     servicemanager,
     webhook,
 )
-from confidant.utils import maintenance, misc, stats
+from confidant.utils import maintenance, misc
+from confidant.utils.stats import stats
 from confidant.utils.dynamodb import decode_last_evaluated_key
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 blueprint = blueprints.Blueprint('services', __name__)
 

confidant/routes/static_files.py

@@ -1,11 +1,12 @@
 import os
-import logging
+import importlib
 
 from flask import blueprints, current_app, send_from_directory
 from werkzeug.exceptions import NotFound
 
 from confidant import authnz, settings
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 blueprint = blueprints.Blueprint('static_files', __name__)
 

confidant/scripts/archive.py

@@ -1,5 +1,5 @@
 import sys
-import logging
+import importlib
 from datetime import datetime
 
 from flask_script import Command, Option
@@ -8,10 +8,12 @@
 from confidant.models.credential import Credential
 from confidant.services import credentialmanager
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
-logger.addHandler(logging.StreamHandler(sys.stdout))
-logger.setLevel(logging.INFO)
+if settings.LOGGING_MODULE == 'logging':
+    logger.addHandler(logging.StreamHandler(sys.stdout))
+    logger.setLevel(logging.INFO)
 
 
 class ArchiveCredentials(Command):

confidant/scripts/migrate.py

@@ -1,7 +1,8 @@
 import sys
-import logging
+import importlib
 from flask_script import Command
 
+from confidant import settings
 from confidant.models.blind_credential import BlindCredential
 from confidant.models.service import Service
 
@@ -11,9 +12,11 @@
 from pynamodb.constants import STRING_SET
 from pynamodb.models import Model
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
-logger.addHandler(logging.StreamHandler(sys.stdout))
-logger.setLevel(logging.INFO)
+if settings.LOGGING_MODULE == 'logging':
+    logger.addHandler(logging.StreamHandler(sys.stdout))
+    logger.setLevel(logging.INFO)
 
 
 def is_old_unicode_set(values):

confidant/scripts/migrate_bool.py

@@ -1,4 +1,4 @@
-import logging
+import importlib
 import time
 import sys
 
@@ -14,9 +14,11 @@
 
 from confidant import settings
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
-logger.addHandler(logging.StreamHandler(sys.stdout))
-logger.setLevel(logging.INFO)
+if settings.LOGGING_MODULE == 'logging':
+    logger.addHandler(logging.StreamHandler(sys.stdout))
+    logger.setLevel(logging.INFO)
 
 
 class GenericCredential(Model):

confidant/scripts/restore.py

@@ -1,17 +1,19 @@
 import sys
-import logging
+import importlib
 
 from flask_script import Command, Option
 from pynamodb.exceptions import DoesNotExist
 
 from confidant import settings
 from confidant.models.credential import Credential, CredentialArchive
-from confidant.utils import stats
+from confidant.utils.stats import stats
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
-logger.addHandler(logging.StreamHandler(sys.stdout))
-logger.setLevel(logging.INFO)
+if settings.LOGGING_MODULE == 'logging':
+    logger.addHandler(logging.StreamHandler(sys.stdout))
+    logger.setLevel(logging.INFO)
 
 
 class RestoreCredentials(Command):

confidant/scripts/utils.py

@@ -1,5 +1,5 @@
 import sys
-import logging
+import importlib
 from flask_script import Command
 from botocore.exceptions import ClientError
 
@@ -9,10 +9,12 @@
 from confidant.models.service import Service
 from confidant.utils.dynamodb import create_dynamodb_tables
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
-logger.addHandler(logging.StreamHandler(sys.stdout))
-logger.setLevel(logging.INFO)
+if settings.LOGGING_MODULE == 'logging':
+    logger.addHandler(logging.StreamHandler(sys.stdout))
+    logger.setLevel(logging.INFO)
 
 
 class ManageGrants(Command):

confidant/services/certificatemanager.py

@@ -1,6 +1,6 @@
 import datetime
 import hashlib
-import logging
+import importlib
 import time
 
 from cryptography import x509
@@ -13,8 +13,9 @@
 
 import confidant.clients
 from confidant import settings
-from confidant.utils import stats
+from confidant.utils.stats import stats
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
 

confidant/services/ciphermanager.py

@@ -1,11 +1,12 @@
 import base64
 import re
-import logging
+import importlib
 
 from cryptography.fernet import Fernet
 
 from confidant import settings
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
 

confidant/services/credentialmanager.py

@@ -1,15 +1,16 @@
 import copy
 import re
-import logging
+import importlib
 
 from confidant import settings
 from confidant.models.blind_credential import BlindCredential
 from confidant.models.credential import Credential, CredentialArchive
 from confidant.models.service import Service
-from confidant.utils import stats
+from confidant.utils.stats import stats
 from pynamodb.exceptions import DoesNotExist
 
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
 

confidant/services/graphite.py

@@ -1,9 +1,10 @@
 import requests
 import json
-import logging
+import importlib
 
 from confidant import settings
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 
 

confidant/services/iamrolemanager.py

@@ -1,10 +1,11 @@
 import gevent
-import logging
+import importlib
 import random
 
 import confidant.clients
 from confidant import settings
 
+logging = importlib.import_module(settings.LOGGING_MODULE)
 logger = logging.getLogger(__name__)
 ROLES = []