Flask Tracing

Learn how to set up highlight.io tracing for your Flask app.

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

# or with pip pip install highlight-io

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__) # `instrument_logging=True` sets up logging instrumentation. # if you do not want to send logs or are using `loguru`, pass `instrument_logging=False` H = highlight_io.H( "<YOUR_PROJECT_ID>", integrations=[FlaskIntegration()], instrument_logging=True, service_name="my-flask-app", service_version="git-sha", environment="production", )

4

Verify your installation.

Check that your installation is valid by visiting one your Flask views in your browser.

@app.route("/hello") def hello(): return "<h1>Hello world</h1>" if __name__ == "__main__": app.run()

5

Verify your backend traces are being recorded.

Visit the highlight traces portal and check that backend traces are coming in.