adding log files for the server w/ burnettk

.github/workflows/tests.yml

@@ -163,6 +163,13 @@ jobs:
           name: docs
           path: docs/_build
 
+      - name: Upload logs
+        if: failure() && matrix.session == 'tests'
+        uses: "actions/upload-artifact@v3.0.0"
+        with:
+          name: logs
+          path: "./log/*.log"
+
   coverage:
     runs-on: ubuntu-latest
     needs: tests

docker-compose.yml

@@ -39,6 +39,7 @@ services:
       - "7000:7000"
     volumes:
       - ${BPMN_SPEC_ABSOLUTE_DIR:-./../sample-process-models}:/app/process_models
+      - ./log:/app/log
     healthcheck:
       test: curl localhost:7000/v1.0/status --fail
 

src/spiffworkflow_backend/__init__.py

@@ -1,4 +1,5 @@
 """__init__."""
+import logging
 import os
 from typing import Any
 
@@ -72,5 +73,6 @@ def create_app() -> flask.app.Flask:
     app.config["MAIL_APP"] = mail
 
     app.json_encoder = MyJSONEncoder
+    logging.basicConfig(filename="filename.log", level=logging.DEBUG)
 
     return app  # type: ignore

src/spiffworkflow_backend/config/__init__.py

@@ -19,6 +19,24 @@ def setup_logger_for_sql_statements(app: Flask) -> None:
     db_logger.setLevel(db_logger_log_level)
 
 
+# formats:
+#   from: https://www.askpython.com/python-modules/flask/flask-logging
+# %(asctime)s— The timestamp as a string.
+# %(levelname)s—The logging level as a string.
+# %(name)s—The logger name as a string.
+# %(threadname)s—The thread name as a string.
+# %(message)s—The log message.
+def setup_logger(app: Flask) -> None:
+    """Setup_logger."""
+    server_log_file_name = f"log/server_{app.env}.log"
+    formatting = "%(asctime)s - %(levelname)s - %(message)s"
+    logging.basicConfig(
+        filename=server_log_file_name, level=logging.DEBUG, format=formatting
+    )
+
+    setup_logger_for_sql_statements(app)
+
+
 def setup_database_uri(app: Flask) -> None:
     """Setup_database_uri."""
     if os.environ.get("SPIFFWORKFLOW_BACKEND_DATABASE_URI") is None:
@@ -56,7 +74,7 @@ def setup_config(app: Flask) -> None:
     app.config.from_object("spiffworkflow_backend.config.default")
 
     setup_database_uri(app)
-    setup_logger_for_sql_statements(app)
+    setup_logger(app)
 
     env_config_module = "spiffworkflow_backend.config." + app.env
     try: