Skip to main content

A plug-and-play performance monitoring tool for FastAPI with a real-time dashboard.

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

FastAPI Performance Monitor

A simple, plug-and-play performance monitoring tool for FastAPI applications
that provides real-time metrics and a dashboard with zero configuration.

CI PyPI version PyPI - Python Version PyPI - License


→ 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_performance_monitor-0.1.3.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastapi_performance_monitor-0.1.3-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_performance_monitor-0.1.3.tar.gz.

File metadata

File hashes

Hashes for fastapi_performance_monitor-0.1.3.tar.gz
Algorithm Hash digest
SHA256 08ab8d8cd3cdd472f0246a96c6d1e3213add62a37a06e0626c8bd726a92e473a
MD5 079d545a9b1b229bbd7ae1c53b70ac3e
BLAKE2b-256 ea182011656fd100997abf582d6eb51b26fe2324abda0bd9da0f11df76390120

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_performance_monitor-0.1.3.tar.gz:

Publisher: publish.yml on parhamdavari/fastapi-performance-monitor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fastapi_performance_monitor-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_performance_monitor-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 37d619c5577716c476427a5ec431e8f589229b635b8811cf7f89f2ab6347dbf9
MD5 3fa1dd50cc407184659adcfc9a47683b
BLAKE2b-256 ae51d044bea96755389140c4706625402572058cd0cd3dfddab87b7ba201e4eb

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_performance_monitor-0.1.3-py3-none-any.whl:

Publisher: publish.yml on parhamdavari/fastapi-performance-monitor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page