Add logging

.env.template

@@ -2,6 +2,9 @@
 FLASK_APP=todo_app/app
 FLASK_ENV=development
 
+LOG_LEVEL=DEBUG
+LOGGLY_TOKEN=
+
 # Change the following values for local development.
 SECRET_KEY=secret-key
 

.travis.yml

@@ -8,7 +8,8 @@ before_deploy:
 - sudo mv terraform /usr/local/bin/
 - rm terraform_"$TF_VERSION"_linux_amd64.zip
 - terraform init
-- terraform apply -var AUTH_CLIENT_ID=$AUTH_CLIENT_ID -var AUTH_CLIENT_SECRET=$AUTH_CLIENT_SECRET -var SECRET_KEY=$SECRET_KEY -auto-approve
+- terraform apply -var AUTH_CLIENT_ID=$AUTH_CLIENT_ID -var AUTH_CLIENT_SECRET=$AUTH_CLIENT_SECRET -var LOGGLY_TOKEN=$LOGGLY_TOKEN
+  -var SECRET_KEY=$SECRET_KEY -auto-approve
 deploy:
   provider: script
   script: bash deploy.sh
@@ -28,3 +29,4 @@ env:
   - secure: XDlwoi/3Cgb2nWPD24/Ioq/RNLr3gQwAgdchSfil7VfAR7k2O+xHGnI50A9caOmoChd4FeIsBdppErX0xNe+nFEddjJlh2JXhUrd2xkf8juv6qVYJ+IoRh2oKWkTSDFxH8y/Om81ycd1NbSJ2g+qCrIPBKFVc0qpYTTlcXf2GoTsUrwMJcHTqoqhhd0QSWRQgiB+IlMQCJ3Ixm2G3Wark0XOSd/TB3W5Jz9+XnKFfIuqiBq7a2UxlBm0fy08tzYd8b+VFtd8nS2rtqwWaTLtpiXyqMJlrwgXsfML05GI3ig1ZoMm8YgvJwIa//C/IYqD/JiwfeIPxFXIekpM+abZXHJhn40I0dEkPBBEcFAvcMxo6b7n3cW8fu2JOZSxmUEwS+FULiLUMrTuxuQHHRh3wJCetrl4QRgvMoVqSfvMUtyrYKGsG+QyczZTVvD6+W9bkH2y4JafJAg0npbxOtvbyPVeDGeK8N9F89z0GoBYxQOubMx8wh5Xj84GCk94trwXsVI0jPffN9r64PS+Tofj7HHosgze3nmcw09a6/yi7akiScWxKiq/NFUgZuVYzcW6LX2nwe6PrGSLQrHCffwCZEg+pvM4xeApQ/rs9XTcmTenA4Ny786TEb+/kkXSFtklvBQs46dBRnCCzOk5LYHimo1B0XZigJ7P/y5XGmQIv30=
   - secure: amUsFIN93YQwaq24tgGMKJgox2/96hL09RDxpXP90PlwuiIlp7V2fBKtdc2g73FwEBffXffK/ZVJCrrn/OvP2qR+PyDQSiaKTs76tVjpWdRTFJbvte3TFX4NPl+XsdCA3UuiwccNRTTJ+OIK1Xzhua2KT/wAFwVkbgdTzSWjVkRymVZJUWm+Nec6H0zuh1DaqCdIV1ZFiKf2CnH4FPJe2kIPX95qTdS203h0uiZjzRnt5asbMNs7CxowISgbTH3hwAQo2YPckWQZbfEEPft8zZWprW/YrW6YQrvFRTiTyydg8qQkMN3ai0bmPTp4Hs+pyFEZWkRaNGqI5r+97en/7X4AEL6R/Yzz1+q3vPE6h7SVAQ39Fxq5NuM2M8eWPUCC35z8SwzAj2UYh5QnrMdIj19J27RhrvQVLOs8ebKUjiRVSB2ZjwwFUBOOQWzCi3DZLpgSj1pR1q/xRC2OUhjLNEMSi1Bwz+/t/QwNVKUG8aJPAVBbsh5M5NKzuNr1Bot+wUhHZX2ZrUAVt2J4SK6g17EmTMz0veNhf8bQ9ezkTIWkkM+IvugJ0XwzMKlDNMFBO32lP/aRm+uZ+3+n/4OZTzSHh3IniwKsIBD5Zegbxjp1IkWk/IGFYEU7PaHZeIQmyo82GzJS0KLg9/2O6e0AcbZBZN0lItNNgIbRHY3yZeg=
   - secure: pifLS+4pJDZmnx1TwSr349RoF0xbQwQLPDTvl6PSUGwnAtFX8s7OyC61hTN247ISl3GdEUml87b7dRZ5zkGy8FaxgRaQFRgo2BJOyvC99sn6DL65Yh5xLn/MZl9xIM6roHBtFtuFBrQco5YLnmV1i8kHD9k3QLMbBke2JSZR2l/l2aFFkM1PDTsNUM0A3w3VvtPrMq8UVyY3H1WNV/h5l4Vf8a1l9sJd8LgcSBuToAGcSFu/EQxC/lIxOdZgUH/4JF/ETw8XbulEqA5aaqsyNsSe+Gtg31YEjbVbF3Pjh70qRc+LFy6nu0hPMN0wfVJBziNIs8QUJ5rQVCBECURzRnkayBUAZuwyeJmGXWsTzf7FZxCRXpJBsOLRIn202dGy26pfMKMoDGXJ5Y29GeLqRPvosvJpTJ/dTQWpztdpS028KpAFN6aKCbM6yBwPfQ2UtXoseJVdkf/NaqNa9luWD2r2blDbZl1mdAkbxkc/wCqtuiIz4E/2GrMPL6rIo7W+axN0rQiqEs2Ai8peSUBw4ZTIux1ZSijvbszX+gp0shiUHfHtxmeao48gIZ3DsZ5Te4YCszY6xYfFbs5clFsio5ZG0A/xdZm971rJK7yfPb5tDXeqBpr5MNNIvjCDujjDLAVY0/VD4+akgTfaXiMwuL6xi++oHNYCzsuutZF5XyA=
+  - secure: bD8qMKX0jBisT6Hw5se5JtnLjVQeUOb2x5ieKeW4/nrjLmK4jh2MyjTvhYWrHzlWa/0y4jmaT1ErNcM1cZngHJtUTVksytea0PMZQfAZOH8p6pvyG2cDrYtbN7YpgnwV8YzI7f7VVd/5P9rNJKwvXDFItune2EYKlXd+HAoINxOUI0h5buYqptU11KXcCutZF4zJAzmkXu/DFSaTNwQuQB+7YRnW3oVacct8xO7626zrigq6BLwGBR8wObPwbW8Fb1ZMAx8eR0dAX1Yuaw1637Rrfu1IJHZFTlSFmnwR2EkL8wOfDIcXyh5BSBPURcSDZrmWip83sg9kKpW1hkR+CfycVT50cywrvkV5R7/RJgrAiOEUPx1P80OPjRIRqDDyHkdaa4sm5w3egpF9yUDo516Jut0vqJy3Um8iamppnbaJ8gkKN0ONt+NUAtEfrUW4+MSrUNKNlOYcHX+yiL88X8X14T/kwMuVQovh11dJS901+5k/183gZx0YAK/Q19cw45Iq2EC9yX0r6hoZmqr1MyBsTGnSRVU30VBdztgGf9Szo/gMB9JHCXbmEwqzr0wFslqj8C43OMBm6+/knu2DId5CTpvvzHDDpEhgfOxtRCqNhVy+H/R3sItxcb1a+OR8FAi/YCTk3V5DisjPVqg1GJz/bmjPL7YPlSsAgQqPBes=

README.md

@@ -28,6 +28,12 @@ You will be provided with a "Client Id" upon creating the application, you need
 $ docker run --name to-do-database -p 27017:27017 -d mongo
 ```
 
+### Setting up Loggly for logging
+
+1. Sign up to Loggly ['here']('https://www.loggly.com/')
+2. Obtain a token from Loggly: Once you've created your account, log in and find the icon for "Logs" in the lefthand menu. Under this, select "Source Setup". Then, on the tabs along the top of the page, select "Customer Tokens". Add a new customer token.
+3. Copy the value and set LOGGLY_TOKEN it in your .env file.
+
 ## Running the App
 
 ### Option 1: Docker

pyproject.toml

@@ -16,6 +16,7 @@ selenium = "^3.141.0"
 pymongo = {extras = ["srv"], version = "^3.11.3"}
 oauthlib = "^3.1.0"
 Flask-Login = "^0.5.0"
+loggly-python-handler = "^1.0.1"
 
 [tool.poetry.dev-dependencies]
 

todo_app/app.py

@@ -4,6 +4,8 @@
 import requests
 from flask_login import LoginManager, login_required, login_user, current_user
 from oauthlib.oauth2 import WebApplicationClient
+from loggly.handlers import HTTPSHandler
+from logging import Formatter
 
 from todo_app.data.mongodb import MongoDB
 from todo_app.user import User
@@ -14,8 +16,17 @@ def create_app():
     app = Flask(__name__)
     app.config['SECRET_KEY'] = os.getenv('SECRET_KEY')
     app.config['LOGIN_DISABLED'] = os.getenv('LOGIN_DISABLED')
+    app.config['LOGGLY_TOKEN'] = os.getenv('LOGGLY_TOKEN')
+    app.logger.setLevel(os.environ.get('LOG_LEVEL', 'DEBUG'))
     database = MongoDB()
 
+    if app.config['LOGGLY_TOKEN'] is not None:
+        handler = HTTPSHandler(f'https://logs-01.loggly.com/inputs/{app.config["LOGGLY_TOKEN"]}/tag/todo-app')
+        handler.setFormatter(
+            Formatter("[%(asctime)s] %(levelname)s in %(module)s: %(message)s")
+            )
+    app.logger.addHandler(handler)
+
     ## Auth Service Setup
     login_manager = LoginManager()
     login_manager.init_app(app)
@@ -46,6 +57,7 @@ def login():
         user_name = user_request_response.json()['login']
         user = User(user_name)
         login_user(user)
+        app.logger.info("USER LOGGED IN: %s", user_name)
         return redirect(url_for('index'))
 
     def writer_required(f):
@@ -71,35 +83,40 @@ def index():
     @writer_required
     def add_item():
         name = request.form['name']
-        database.add_item(name)
+        id = database.add_item(name)
+        app.logger.info("CREATED ITEM: %s" , id)
         return redirect(url_for('index'))
 
 
     @app.route('/items/<id>/start')
     @writer_required
     def start_item(id):
         database.start_item(id)
+        app.logger.info("STARTED ITEM: %s", id)
         return redirect(url_for('index')) 
 
 
     @app.route('/items/<id>/complete')
     @writer_required
     def complete_item(id):
         database.complete_item(id)
+        app.logger.info("COMPLETED ITEM: %s", id)
         return redirect(url_for('index'))
 
 
     @app.route('/items/<id>/uncomplete')
     @writer_required
     def uncomplete_item(id):
         database.uncomplete_item(id)
+        app.logger.info("UNCOMPLETED ITEM: %s", id)
         return redirect(url_for('index')) 
 
 
     @app.route('/items/<id>/delete')
     @writer_required
     def delete_item(id):
         database.delete_item(id)
+        app.logger.info("DELETED ITEM: %s", id)
         return redirect(url_for('index'))
 
 

todo_app/data/mongodb.py

@@ -18,8 +18,7 @@ def get_items(self):
     def add_item(self, name):
         now = datetime.utcnow()
         item = {"name": name, "status": "To Do", "dateLastActivity": now}
-        self.collection.insert_one(item)
-        return
+        return self.collection.insert_one(item).inserted_id
 
     def start_item(self, id):
         return self.set_item_status(id, "Doing")

variables.tf

@@ -24,3 +24,12 @@ variable "MONGODB_DATABASE_NAME" {
   description = "Name of default database"
   default     = "main"
 }
+
+variable "LOG_LEVEL" {
+  description = "Level of logging"
+  default     = "ERROR"
+}
+
+variable "LOGGLY_TOKEN" {
+  description = "Customer access token for loggly subscription"
+}