Monitoring Python FastAPI
Instana automatically monitors your FastAPI applications. No code changes, configuration changes, redeploys, or process starts are required. Instana AutoTrace webhook automatically instruments and monitors your FastAPI applications. However, if you want to manually instrument your FastAPI applications, you need to install the Instana Python package.
The Instana Python package bundles an ASGI middleware to provide request visibility into your asynchronous applications. FastAPI automatically applies this ASGI middleware to your FastAPI-based applications.
Monitoring methods
To monitor your FastAPI applications, you can either use the Instana AutoTrace webhook or install the Instana Python package.
The following table outlines the features of each method:
| Features | AutoTrace webhook | Instana Python package |
|---|---|---|
| Automatic visibility | Available | Available |
| Code changes | Not required | Not required |
| Redeployment | Not required | Required |
| Process restart | Not required | Required |
| User steps | Not required | Not required |
| Configuration changes | Not required | Not required |
AutoTrace webhook
Instana AutoTrace webhook is the default monitoring method, and you don't need any manual steps to activate monitoring. If you have the AutoTrace webhook installed, it remotely instruments and monitors your FastAPI applications automatically.
For more information about installing Instana AutoTrace webhook, see Installing the Instana AutoTrace webhook.
Instana Python package
You can manually instrument your FastAPI applications by installing the Instana Python package. After the Instana Python package is installed and activated, your FastAPI application is monitored. For more information about installing and activating the package, see Manual installation.
To check which versions of related components are supported, see Supported components and versions.