Python FastAPI Uvicorn

Prerequisites

Python 3.6+

Installation

1. Install dependencies:

   pip install elastic-apm

2. Add the highlighted lines below to your project's main.py file:

   import requests
   from fastapi import FastAPI
   from elasticapm.contrib.starlette import ElasticAPM
   
   app = FastAPI()
   app.add_middleware(ElasticAPM)

3. Configure the agent.

   Environment Variables

   ELASTIC_APM_SERVICE_NAME=<app_name>
   # send traces to CubeAPM
   ELASTIC_APM_SERVER_URL=http://<ip_address_of_cubeapm_server>:3130
   # optional settings
   ELASTIC_APM_ENVIRONMENT=myenv
   ELASTIC_APM_SERVICE_VERSION=1.2.3
   ELASTIC_APM_GLOBAL_LABELS=mykey1=myvalue1,mykey2=myvalue2

   Code

   import requests
   from fastapi import FastAPI
   from elasticapm.contrib.starlette import make_apm_client, ElasticAPM
   
   app = FastAPI()
   apm= make_apm_client({
       'SERVICE_NAME': '<app_name>',
       # send traces to CubeAPM
       'SERVER_URL': 'http://<ip_address_of_cubeapm_server>:3130',
       # optional settings
       'ENVIRONMENT': 'myenv',
       'SERVICE_VERSION': '1.2.3',
       'GLOBAL_LABELS': 'mykey1=myvalue1,mykey2=myvalue2',
   })
   app.add_middleware(ElasticAPM)

Sample Application

A working example is available at https://github.com/cubeapm/sample_app_python_fastapi_uvicorn/tree/elastic.

Troubleshooting

The following can be used for debugging:

# Print Elastic agent logs on screen
ELASTIC_APM_LOG_FILE=stdout
# Set Elastic agent log level to debug if needed to see detailed logs.
# Refer to Sample Application for additional requirements.
ELASTIC_APM_LOG_LEVEL=debug