Added prometheus_fastapi_instrumentator

HIRO-MicroDataCenters-BV · Feb 29, 2024 · 3708332 · 3708332
1 parent e037ce4
commit 3708332
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -208,6 +208,10 @@ Usage example:
 act push -j deploy --secret-file my.secrets
 ```
 
+## Prometheus metrics
+The application includes prometheus-fastapi-instrumentator for monitoring performance and analyzing its operation. It automatically adds an endpoint `/metrics` where you can access application metrics for Prometheus. These metrics include information about request counts, request execution times, and other important indicators of application performance.
+More on that at (Prometheus FastAPI Instrumentator)[https://github.com/trallnag/prometheus-fastapi-instrumentator]
+
 ## Classy-FastAPI
 Classy-FastAPI allows you to easily do dependency injection of 
 object instances that should persist between FastAPI routes invocations,

diff --git a/app/main.py b/app/main.py
@@ -2,6 +2,7 @@
 
 from fastapi import FastAPI
 from fastapi.openapi.utils import get_openapi
+from prometheus_fastapi_instrumentator import Instrumentator
 
 from . import example, items
 
@@ -32,5 +33,8 @@ def openapi(self) -> Dict[str, Any]:
 app = CustomFastAPI()
 
 
+Instrumentator().instrument(app).expose(app)
+
+
 app.include_router(example.router)
 app.include_router(items.routes.router)
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,6 +18,7 @@ python = "^3.10"
 fastapi = "^0.109"
 uvicorn = "^0.26"
 classy-fastapi = "^0.6.1"
+prometheus-fastapi-instrumentator = "^6.1.0"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.6"