docs: Add FastAPI + Uvicorn monitoring example #1103
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Demonstrate native ASGI integration - Include multiprocess guidance Signed-off-by: yuhao <[email protected]>
yuhao541
force-pushed
the
docs/add-fastapi-uvicorn-example
branch
from
4dc211d to
695e0d8
Compare
|
|
||
| app = FastAPI() | ||
|
|
||
| Define metrics with multiprocess aggregation |
There was a problem hiding this comment.
Suggested change
| Define metrics with multiprocess aggregation | |
| # Define metrics with multiprocess aggregation |
| ) | ||
| return make_asgi_app(registry=registry) | ||
|
|
||
| Mount endpoint with trailing slash |
There was a problem hiding this comment.
Suggested change
| Mount endpoint with trailing slash | |
| # Mount endpoint with trailing slash |
| "http_requests_total", | ||
| "Total HTTP requests by endpoint", | ||
| ["endpoint"], | ||
| registry=CollectorRegistry() # Isolated registry |
There was a problem hiding this comment.
Typically we recommend not assigning any registry when using multiprocess. What about just leaving a comment here like # do not assign registry= when using multiprocess mode instead of assigning?
| CPU_USAGE = Gauge( | ||
| "system_cpu_usage_percent", | ||
| "Current CPU utilization percentage (aggregated)", | ||
| multiprocess_mode='livesum' # Critical for worker aggregation |
There was a problem hiding this comment.
Not critical for an example, but livemostrecent is probably the best here to avoid counting the CPU used multiple times.
| ``` | ||
| 2. **Storage Management** | ||
| - Use dedicated volume for `PROMETHEUS_MULTIPROC_DIR` | ||
| - Implement cleanup cron job: |
There was a problem hiding this comment.
Rather than a cron-job it is usually best practice to delete the data (if it exists) when your service restarts. Otherwise some problems with counter resets can occur.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds documentation for monitoring FastAPI applications running with Uvicorn ASGI server.