Backend: Error Monitoring
Go
JS
Python
Backend: Logging
Fullstack Frameworks
Next.JS
Self Host & Local Dev
Menu
Using highlight.io with Python Flask
Learn how to set up highlight.io on your Python Flask backend API.
1
Setup your frontend Highlight snippet with tracingOrigins.
Make sure that you followed the fullstack mapping guide.
H.init("<YOUR_PROJECT_ID>", {
tracingOrigins: ['localhost', 'example.myapp.com/backend'],
networkRecording: {
enabled: true,
recordHeadersAndBody: true,
},
});
2
Install the highlight-io python package.
Download the package from pypi and save it to your requirements. If you use a zip or s3 file upload to publish your function, you will want to make sure highlight-io is part of the build.
poetry add highlight-io[Flask]
# or with pip
pip install highlight-io[Flask]3
Initialize the Highlight SDK.
Setup the SDK to with the Flask integration.
from flask import Flask
import highlight_io
from highlight_io.integrations.flask import FlaskIntegration
app = Flask(__name__)
H = highlight_io.H("YOUR_PROJECT_ID", integrations=[FlaskIntegration()], record_logs=True)4
Verify your installation.
Check that your installation is valid by throwing an error. Add the following code to your Flask app and start the Flask server. Visit http://127.0.0.1:5000/hello in your browser. You should see a DivideByZero error in the Highlight errors page within a few moments.
import logging
import random
import time
from flask import Flask
import highlight_io
from highlight_io.integrations.flask import FlaskIntegration
app = Flask(__name__)
H = highlight_io.H("YOUR_PROJECT_ID", integrations=[FlaskIntegration()], record_logs=True)
@app.route("/hello")
def hello():
return f"<h1>bad idea { 5/0 }</h1>"
if __name__ == "__main__":
app.run()5
Set up logging.
With the Python SDK, your logs are reported automatically from builtin logging methods. See the Python logging setup guide for more details.