Closed jwhitlock closed 4 months ago
I decided to use dockerflow
instead of dockerflow.checks.register
in the sample logging config. This should have the same effect, but allow moving files around or catching logs from other locations. I also fixed the name of RequestIdLogFilter
in the example.
Thanks @jwhitlock for the contribution 👏
We will have to postpone the review for a few days 🙏
Thanks @leplatrem, I've applied the changes, including RequestIdLogFilter
across the project. I've been focused on the Django docs, I see others are better about updating all the docs.
traceparent
does look interesting to me. I'd want to see how GCP implements it before making it the default, and maybe talk to the SREs about how we'd integrate it.
Thank you!
This refreshes the Django docs, and adds some information that may be useful.
__version__
,__heartbeat__
and__lbheartbeat__
views. In mozilla/fx-private-relay PR #4345, we removed some duplicate versions of the views that were not called because of the middleware.dockerflow.checks.register
. This is how you can see what checks are failing ifDEBUG=False
.DEBUG=False
.dockerflow
to the sample logging configuration. Without this (and without aroot
handler), these logs are discarded, making it impossible to debug heartbeat issues.MIDDLEWARE_CLASSES
, which was removed in Django 2.0 in 2017.SECURE_REDIRECT_EXEMPT
for Kubernetes deployments.DEBUG
, to document how it affects what checks heartbeat runs, and the data included in the heartbeat response.DOCKERFLOW_HEARTBEAT_FAILED_STATUS_CODE
, previously mentioned in the heartbeat view sectionDOCKERFLOW_REQUEST_ID_HEADER_NAME
, previously mentioned in the "Requests Correlation ID" section. Add why you may want to change it for different deployment environments.DOCKERFLOW_SUMMARY_LOG_QUERYSTRING
, previously mentioned in the Logging section.DOCKERFLOW_VERSION_CALLBACK
down to alphabetical orderSILENCED_SYSTEM_CHECKS
, used but not previously documented.BASE_DIR
, since there is no Django docs, because Django maintainers say that is a constant, not a setting (https://code.djangoproject.com/ticket/31387).