feature: add logging support ✨

.gitignore

@@ -31,6 +31,10 @@ MANIFEST
 *.manifest
 *.spec
 
+# api logs
+logs/
+*.log
+
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt

app/__init__.py

@@ -1,12 +1,26 @@
 import os
+import logging.config
 
 from flask import Flask
 from flask_cors import CORS
 from flask_sqlalchemy import SQLAlchemy
 from flask_marshmallow import Marshmallow
 from config import CONFIG
 
-basedir = os.path.abspath(os.path.dirname(__file__))
+BASE_DIR = os.path.abspath(os.path.dirname(__file__))
+LOG_FILES_PATH = os.path.split(BASE_DIR)[0] + '/logs'
+
+# Try to create a log folder
+try:
+    if not os.path.exists(LOG_FILES_PATH):
+        os.makedirs(LOG_FILES_PATH)
+except OSError:
+    pass
+
+# load logging config file
+logging.config.fileConfig('config/logging.conf', disable_existing_loggers=False)
+# init file logger
+logger = logging.getLogger('CSSI_REST_API')
 
 db = SQLAlchemy()
 ma = Marshmallow()

config/__init__.py

@@ -0,0 +1 @@
+from .config import CONFIG  # noqa

config/logging.conf

@@ -0,0 +1,33 @@
+[loggers]
+keys=root,cssRestApi
+
+[handlers]
+keys=consoleHandler, fileHandler
+
+[formatters]
+keys=formatter
+
+[logger_root]
+level=DEBUG
+handlers=consoleHandler
+
+[logger_cssRestApi]
+level=DEBUG
+handlers=fileHandler
+qualname=CSSI_REST_API
+propagate=0
+
+[handler_consoleHandler]
+class=StreamHandler
+level=DEBUG
+formatter=formatter
+args=(sys.stdout,)
+
+[handler_fileHandler]
+class=logging.handlers.RotatingFileHandler
+level=DEBUG
+formatter=formatter
+args=('logs/api.log','a+', 5*1024*1024, 2, None, 0)
+
+[formatter_formatter]
+format=%(asctime)s - %(name)s -  %(levelname)-8s - [%(module)s.%(filename)s:%(lineno)d] - %(message)s