Add middleware that logs HTTP response time to server console #1214
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.
On this branch, I introduced a new middleware (named
ResponseTimeLoggerMiddleware
), which—when enabled (by setting theIS_RESPONSE_TIME_LOGGING_ENABLED
environment variable totrue
)—prints a line to the console log before the FastAPI application returns a response to Uvicorn. The line says how long the FastAPI application spent processing that request.Details
Here's an example of a line (the first line here) printed by this middleware. The second line is printed by Uvicorn.
Note: My original desire was to append the response to the Uvicorn log line (instead of having an additional line). I didn't figure out how to do that, though, so I went with this approach instead. I think I'd still prefer the other approach, though, long term.
Related issue(s)
Fixes #1212
Related subsystem(s)
docs
directory)Testing
I tested these changes by sending various HTTP requests to the FastAPI application—with and without query strings—and confirming the logs looked the way I wanted.
Documentation
docs
directory)Maintainability
study_id: str
)# TODO
or# FIXME
black
to format all the Python files I created/modified