Merge pull request #12 from aleyipsoftwire/exercise-13

Exercise 13

Author: aleyipsoftwire

.env.template

@@ -3,3 +3,5 @@
 FLASK_APP=todo_app/app
 
 MONGODB_PRIMARY_CONNECTION_STRING=<DELIBERATELY MISSING>
+LOGGLY_TOKEN=<DELIBERATELY MISSING>
+LOG_LEVEL=<DELIBERATELY MISSING>

.env.test

@@ -3,4 +3,3 @@
 FLASK_APP=todo_app/app
 
 MONGODB_PRIMARY_CONNECTION_STRING=mongodb://fakemongo.com
-

Dockerfile

@@ -11,11 +11,13 @@ RUN curl -sSL https://install.python-poetry.org | python3 -
 
 # Install dependencies
 WORKDIR /app
+
 COPY poetry.lock pyproject.toml /app/
-RUN poetry config virtualenvs.create false --local && poetry install --no-interaction --no-ansi
 
 COPY todo_app /app/todo_app
 
+RUN poetry config virtualenvs.create false --local && poetry install --no-interaction --no-ansi
+
 EXPOSE 8000
 
 FROM base AS test

README.md

@@ -181,3 +181,9 @@ We are enforcing HTTPS with Azure App service.
 
 Azure Cosmos DB is encrypted at rest and in transport.
 See https://learn.microsoft.com/en-us/azure/cosmos-db/database-encryption-at-rest for more details.
+
+## Logging
+
+Minimum level of shown logs can be configured by the `LOG_LEVEL` env var.
+
+Populate the `LOGGLY_TOKEN` env var for logs to be sent to Loggly.

poetry.lock

@@ -14,8 +14,7 @@ gunicorn = "^21.2.0"
 pymongo = "^4.8.0"
 mongomock = "^4.2.0.post1"
 safety = "^3.2.9"
-
-[tool.poetry.dev-dependencies]
+loggly-python-handler = "^1.0.1"
 
 [build-system]
 requires = ["poetry>=0.12"]

pyproject.toml

@@ -1,4 +1,8 @@
+import os
+from logging import Formatter
+
 from flask import Flask, redirect, render_template, request
+from loggly.handlers import HTTPSHandler
 
 from todo_app.data.models import ViewModel
 from todo_app.data.mongo_items import get_mongo_items, add_mongo_item, update_mongo_item_status, ItemStatus
@@ -7,15 +11,29 @@
 def create_app():
     app = Flask(__name__)
 
+    app.logger.setLevel(os.getenv("LOG_LEVEL", "ERROR"))
+
+    if os.getenv('LOGGLY_TOKEN') is not None:
+        print(f'https://logs-01.loggly.com/inputs/{os.getenv("LOGGLY_TOKEN")}/tag/todo-app')
+        handler = HTTPSHandler(f'https://logs-01.loggly.com/inputs/{os.getenv("LOGGLY_TOKEN")}/tag/todo-app')
+        handler.setFormatter(Formatter("[%(asctime)s] %(levelname)s in %(module)s: %(message)s"))
+        app.logger.addHandler(handler)
+
     @app.route('/')
     def index():
         items = get_mongo_items()
+
+        app.logger.info(f'Found {len(items)} items')
+
         item_view_model = ViewModel(items)
         return render_template('index.html', view_model=item_view_model)
 
     @app.route('/add', methods=['POST'])
     def add():
         title = request.form.get('title')
+
+        app.logger.info(f'Adding new item: {title}')
+
         add_mongo_item(title)
         return redirect('/')
 
@@ -24,8 +42,15 @@ def update_status():
         item_id = request.form.get('item_id')
         status = request.form.get('status')
 
+        app.logger.info(f'Updating status of item {item_id} to {status}')
+
         update_mongo_item_status(item_id, ItemStatus(status))
 
         return redirect('/')
 
+    @app.errorhandler(Exception)
+    def handle_exception(e):
+        app.logger.warning(f'Exception: {e}')
+        return e
+
     return app