improve logging

src/entity/api/fraud_prediction_api.py

@@ -1,9 +1,4 @@
 from pydantic import BaseModel
-import logging
-
-# Set up logging
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
 
 class FraudPredictionInput(BaseModel):
     """

src/entity/api/transaction_api.py

@@ -5,7 +5,6 @@ from src.entity.transaction import Transaction
 import logging
 
 # Set up logging
-logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
 class TransactionApi(BaseModel):

src/main.py

@@ -28,19 +28,24 @@ from sqlalchemy.orm import Session
 
 from src.entity.api.transaction_api import TransactionApi
 from src.service.fraud_service import check_for_fraud_api
+from src.service.logging_service import setup_logging
 from src.service.notification_service import send_notification
 from src.repository.common import get_session
 from src.repository.fraud_details_repo import insert_fraud
 from src.repository.transaction_repo import insert_transaction
 
 # ------------------------------------------------------------------------------
+# Configure logging
+setup_logging()
+logger = logging.getLogger(__name__)
 
+# ------------------------------------------------------------------------------
 def provide_connection() -> Generator[Session, None, None]:
     with get_session() as conn:
         yield conn
 
 # ------------------------------------------------------------------------------
-
+# Load environment variables
 load_dotenv()
 FASTAPI_API_KEY = os.getenv("FASTAPI_API_KEY")
 FRAUD_ML_API_KEY = os.getenv("FRAUD_ML_API_KEY")
@@ -123,19 +128,19 @@ async def process_transaction(
         # Insert every single transaction into the database
         transaction = insert_transaction(db, transaction)
     except UniqueViolation as e:
-        logging.error(e)
+        logger.error(e)
         raise HTTPException(
             status_code=HTTP_422_UNPROCESSABLE_ENTITY,
             detail=f"Transaction {transaction.transaction_number} already exists"
         )
     except IntegrityError as e:
-        logging.error(e)
+        logger.error(e)
         raise HTTPException(
             status_code=HTTP_422_UNPROCESSABLE_ENTITY,
             detail=f"Transaction {transaction.transaction_number} is not valid. Check input values."
         )
     except Exception as e:
-        logging.error(e)
+        logger.error(e)
         raise HTTPException(
             status_code=HTTP_500_INTERNAL_SERVER_ERROR,
             detail="An error occurred while processing the transaction. See logs for details."
@@ -176,7 +181,7 @@ async def check_health(session: Annotated[Session, Depends(provide_connection)])
     try:
         session.execute(text("SELECT 1"))
     except Exception as e:
-        logging.error(f"DB check failed: {e}")
+        logger.error(f"DB check failed: {e}")
         return JSONResponse(content={"status": "unhealthy"}, status_code=HTTP_503_SERVICE_UNAVAILABLE)
     
     # Check if the fraud detection API is alive
@@ -187,7 +192,7 @@ async def check_health(session: Annotated[Session, Depends(provide_connection)])
                             })
     
     if response.status_code != HTTP_200_OK:
-        logging.error(f"Fraud detection API check failed: {response.status_code} - {response.text}")
+        logger.error(f"Fraud detection API check failed: {response.status_code} - {response.text}")
         return JSONResponse(content={"status": "unhealthy"}, status_code=HTTP_503_SERVICE_UNAVAILABLE)
     
     return JSONResponse(content={"status": "healthy"}, status_code=HTTP_200_OK)

src/repository/transaction_repo.py

@@ -5,6 +5,7 @@ from sqlalchemy.orm import joinedload
 from typing import Optional
 from src.entity.transaction import Transaction
 
+logger = logging.getLogger(__name__)
 
 def fetch_transaction(db: Connection, transaction_id: int) -> Optional[Transaction]:
     """
@@ -17,7 +18,7 @@ def fetch_transaction(db: Connection, transaction_id: int) -> Optional[Transacti
     if transaction is None:
         raise ValueError(f"Transaction {transaction_id} not found")
     else:
-        logging.info(f"Transaction {transaction_id} found")
+        logger.info(f"Transaction {transaction_id} found")
     
     return transaction
 

src/service/fraud_service.py

@@ -14,7 +14,6 @@ FRAUD_ML_API_KEY = os.getenv("FRAUD_ML_API_KEY")
 FRAUD_ML_PREDICTION_ENDPOINT = os.getenv("FRAUD_ML_PREDICTION_ENDPOINT")
 
 # Configure logging
-logging.basicConfig(level=logging.DEBUG)
 logger = logging.getLogger(__name__)
 
 def check_for_fraud_api(transaction: Transaction) -> Optional[FraudPredictionOutput]:

src/service/logging_service.py

@@ -0,0 +1,41 @@
+import logging
+import logging.config
+
+LOGGING_CONFIG = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'formatters': {
+        'default': {
+            'format': '[%(asctime)s] %(levelname)s in %(name)s: %(message)s',
+        },
+        'verbose': {
+            'format': '[%(asctime)s] %(levelname)s [%(name)s:%(lineno)d] %(message)s',
+        },
+    },
+    'handlers': {
+        'console': {
+            'class': 'logging.StreamHandler',
+            'formatter': 'default',
+        },
+        # Exemple fichier
+        'file': {
+            'class': 'logging.FileHandler',
+            'filename': 'app.log',
+            'formatter': 'verbose',
+        },
+    },
+    'root': {
+        'handlers': ['console', 'file'],
+        'level': 'INFO',
+    },
+    'loggers': {
+        'myapp': {
+            'handlers': ['console'],
+            'level': 'DEBUG',
+            'propagate': False,
+        },
+    }
+}
+
+def setup_logging():
+    logging.config.dictConfig(LOGGING_CONFIG)

src/service/notification_service.py

@@ -10,7 +10,6 @@ from src.repository.transaction_repo import fetch_transaction
 from dotenv import load_dotenv
 
 # Configure logging
-logging.basicConfig(level=logging.DEBUG)
 logger = logging.getLogger(__name__)
 
 # Load environment variables
@@ -57,7 +56,7 @@ def send_notification(transaction_id: int):
                 model_version=transaction.fraud_details.model_version,
             )
 
-        logging.info("Email sent!")
+        logger.info("Email sent!")
 
         # Update the transaction details in the database
         transaction.fraud_details.notification_sent = True
@@ -105,7 +104,7 @@ def _send_with_smtp_server(transaction_number: str,
     msg.set_content(email_body)
 
     # Send the email
-    logging.debug(f"Connecting to SMTP server {SMTP_SERVER} using port {SMTP_PORT}...")
+    logger.debug(f"Connecting to SMTP server {SMTP_SERVER} using port {SMTP_PORT}...")
     with smtplib.SMTP(SMTP_SERVER, SMTP_PORT) as server:
         server.starttls()  # Secure the connection
         server.login(SENDER_EMAIL, SENDER_PASSWORD)