Ready-to-use APM backend service and middleware to monitor your FastAPI applications.

OpenAPM leverages FastAPI middlewares and background tasks easily retrieve performance information on your HTTP request processing.

You can find more information in the documentation, then use it as follows:

# Define your model
from openapm.middlewares import FastAPIMiddleware
from fastapi import FastAPI

app = FastAPI()
app.add_middleware(FastAPIMiddleware(endpoint="https://your-apm-endpoint.com"))

Python 3.11 (or higher) and pip/conda are required to install OpenAPM.

You can install the last stable release of the package using pypi as follows:

pip install openapm

Alternatively, if you wish to use the latest features of the project that haven't made their way to a release yet, you can install the package from source:

git clone https://github.com/frgfm/openapm.git
pip install -e openapm/.

The full package documentation is available here for detailed specifications.

If you wish to cite this project, feel free to use this BibTeX reference:

@misc{openapm2024,
    title={OpenAPM: lightweight APM for FastAPI backend applications},
    author={François-Guillaume Fernandez},
    year={2024},
    month={November},
    publisher = {GitHub},
    howpublished = {\url{https://github.com/frgfm/openapm}}
}

Feeling like extending the range of supported backend framework? Or perhaps submitting a new metric capture? Any sort of contribution is greatly appreciated!

You can find a short guide in CONTRIBUTING to help grow this project!

Distributed under the Apache 2.0 License. See LICENSE for more information.