→ Getting Started

Installation

pip install fastapi-performance-monitor

Usage

In your main application file, import and apply add_performance_monitor to your FastAPI app instance.

# main.py
from fastapi import FastAPI
from fastapi_performance_monitor import add_performance_monitor

app = FastAPI()

# Add this single line to enable the monitor
add_performance_monitor(app)

@app.get("/")
def read_root():
    return {"message": "Hello World"}

→ Endpoints

Once your application is running, the following endpoints will be available:

• Dashboard: http://localhost:8000/performance
• Metrics: http://localhost:8000/health/metrics

The dashboard provides a user-friendly interface to view the metrics, while the JSON endpoint allows for programmatic access, perfect for integrating with alerting or other monitoring systems.