feat: JSON logging for Gunicorn #3672
Conversation
khvn26
requested review from
a team and
gagantrivedi
and removed request for
a team
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
api
| "thread_name": record.threadName, | ||
| } | ||
|
|
||
| def format(self, record: logging.LogRecord) -> str: |
There was a problem hiding this comment.
The docstring of this function is now out of date.
| class GunicornJsonLogger(GunicornLogger): | ||
| def setup(self, cfg: Config) -> None: | ||
| super().setup(cfg) | ||
| if settings.LOG_FORMAT == "json": |
There was a problem hiding this comment.
If it's not set to JSON then the logger won't really be a JSON logger, right? It's weird to let it operate as a normal logger with the name of the class GunicornJsonLogger
There was a problem hiding this comment.
Renamed to GunicornJsonCapableLogger.
| - `ACCESS_LOG_LOCATION`: The location to store web logs generated by Gunicorn if running as a Docker container. If not | ||
| set, no logs will be stored. If set to `-` the logs will be sent to `stdout`. |
There was a problem hiding this comment.
If not set, no logs will be stored.
I think if no logs will be stored then stdout will actually be used, which is what we should say here, no?
There was a problem hiding this comment.
Thanks! Updated the docs.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3672 +/- ##
==========================================
- Coverage 95.86% 95.84% -0.02%
==========================================
Files 1099 1099
Lines 34422 34428 +6
==========================================
- Hits 33000 32999 -1
- Misses 1422 1429 +7 ☔ View full report in Codecov by Sentry. |
This reverts commit 3ce1754.
Thanks for submitting a PR! Please check the boxes below:
pre-committo check lintingdocs/if required so people know about the feature!Changes
This PR does the following:
gunicorn.conf.pyfile. This allows users to override Gunicorn settings using theGUNICORN_CMD_ARGSenvironment variable.GunicornAccessLogJsonFormatterandGunicornJsonLoggerto make Gunicorn respect theLOG_FORMATsetting.ACCESS_LOG_FORMATenvironment variable.make servenow configures Gunicorn withgunicorn.conf.py.Closes #3637.
How did you test this code?
Ran
make servelocally withLOG_FORMAT,ACCESS_LOG_FORMATandACCESS_LOG_LOCATIONset to various values.