Merge pull request #555 from hubmapconsortium/yuanzhou/log

Yuanzhou/log

Author: yuanzhou

.gitignore

@@ -10,6 +10,9 @@ venv-entity-api
 #Mac DS Store files
 .DS_Store
 
+# Ignore docker env file
+docker/.env
+
 # Ignore copied files
 docker/entity-api/src
 docker/entity-api/VERSION

docker/docker-compose.yml

@@ -34,6 +34,13 @@ services:
       - "./entity-api/nginx/conf.d:/etc/nginx/conf.d"
     networks:
       - gateway_hubmap
+    # Send docker logs to AWS CloudWatch
+    logging: 
+      driver: awslogs
+      options:
+        awslogs-region: us-east-1
+        awslogs-group: entity-api-docker-logs
+        awslogs-stream: ${LOG_STREAM}
 
 networks:
   # This is the network created by gateway to enable communicaton between multiple docker-compose projects

docker/example.env

@@ -0,0 +1 @@
+LOG_STREAM=DEV

src/app.py

@@ -43,29 +43,15 @@
 # Root logger configuration
 global logger
 
+# Set logging format and level (default is warning)
+# All the API logging is forwarded to the uWSGI server and gets written into the log file `log/uwsgi-entity-api.log`
+# Log rotation is handled via logrotate on the host system with a configuration file
+# Do NOT handle log file and rotation via the Python logging to avoid issues with multi-worker processes
+logging.basicConfig(format='[%(asctime)s] %(levelname)s in %(module)s: %(message)s', level=logging.DEBUG, datefmt='%Y-%m-%d %H:%M:%S')
+
 # Use `getLogger()` instead of `getLogger(__name__)` to apply the config to the root logger
 # will be inherited by the sub-module loggers
-try:
-    logger = logging.getLogger()
-    logger.setLevel(logging.DEBUG) # logger.setLevel(logging.INFO)
-
-    # All the API logging is gets written into the same log file
-    # The uWSGI logging for each deployment disables the request logging
-    # but still captures the 4xx and 5xx errors to the file `log/uwsgi-entity-api.log`
-    # Log rotation is handled via logrotate on the host system with a configuration file
-    # Do NOT handle log file and rotation via the Python logging to avoid issues with multi-worker processes
-    log_file_handler = logging.FileHandler('../log/entity-api-' + time.strftime("%m-%d-%Y-%H-%M-%S") + '.log')
-    log_file_handler.setFormatter(logging.Formatter('[%(asctime)s] %(levelname)s in %(module)s: %(message)s'))
-    logger.addHandler(log_file_handler)
-except Exception as e:
-    print("Error setting up global log file.")
-    print(str(e))
-
-try:
-    logger.info("logger initialized")
-except Exception as e:
-    print("Error opening log file during startup")
-    print(str(e))
+logger = logging.getLogger()
 
 # Specify the absolute path of the instance folder and use the config file relative to the instance path
 app = Flask(__name__, instance_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'instance'), instance_relative_config = True)

src/uwsgi.ini

@@ -5,13 +5,9 @@ chdir = /usr/src/app/src
 # Application's callbale
 module = wsgi:application
 
-# Disable request logging due to it doesn't work with the Python logging level
-# This also improves the performance
-# We still want to log the 4xx and 5xx errors to the file
-disable-logging = true
-log-4xx = true
-log-5xx = true
-logto = /usr/src/app/log/uwsgi-entity-api.log
+# Delegate the logging to the master process 
+# Send logs to stdout instead of file so docker picks it up and writes to AWS CloudWatch
+log-master=true
 
 # Master with 16 worker processes (based on CPU number)
 master = true