Python App

H.init("<YOUR_PROJECT_ID>", {
    tracingOrigins: ['localhost', 'example.myapp.com/backend'],
    networkRecording: {
      enabled: true,
      recordHeadersAndBody: true,
    },
  });

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

Initialize the Highlight SDK.

Setup the SDK.

import highlight_io

H = highlight_io.H("YOUR_PROJECT_ID", record_logs=True)

Verify your installation.

Check that your installation is valid by throwing an error. Try raising an exception somewhere in your code. You should see a DivideByZero error in the Highlight errors page within a few moments.

import logging
import random
import time

import highlight_io

H = highlight_io.H("YOUR_PROJECT_ID", record_logs=True)


def main():
    with H.trace():
        logging.info('hello, world!', {'favorite_number': 7})
        return f"<h1>bad idea { 5/0 }</h1>"


if __name__ == "__main__":
    main()

Verify your backend logs are being recorded.

With the Python SDK, your logs are reported automatically from the builtin logging methods (as long as record_logs=True is provided to the highlight_io.H constructor). Visit the highlight logs portal and check that backend logs are coming in.

Python Logging in Go