From e5c11e8f8a0c546438c38e3b786953434657bfd0 Mon Sep 17 00:00:00 2001 From: Ron DuPlain Date: Sun, 28 Oct 2018 16:38:51 -0400 Subject: [PATCH] Clarify log format usage of header & environment (#1907) --- docs/source/settings.rst | 11 ++++++++--- gunicorn/config.py | 11 ++++++++--- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/source/settings.rst b/docs/source/settings.rst index b77983c6..b9bd56de 100644 --- a/docs/source/settings.rst +++ b/docs/source/settings.rst @@ -181,11 +181,16 @@ T request time in seconds D request time in microseconds L request time in decimal seconds p process ID -{Header}i request header -{Header}o response header -{Variable}e environment variable +{header}i request header +{header}o response header +{variable}e environment variable =========== =========== +Use lowercase for header and environment variable names, and put +``{...}x`` names inside ``%(...)s``. For example:: + + %({x-forwarded-for}i)s + .. _errorlog: errorlog diff --git a/gunicorn/config.py b/gunicorn/config.py index d9efc485..59524316 100644 --- a/gunicorn/config.py +++ b/gunicorn/config.py @@ -1241,10 +1241,15 @@ class AccessLogFormat(Setting): D request time in microseconds L request time in decimal seconds p process ID - {Header}i request header - {Header}o response header - {Variable}e environment variable + {header}i request header + {header}o response header + {variable}e environment variable =========== =========== + + Use lowercase for header and environment variable names, and put + ``{...}x`` names inside ``%(...)s``. For example:: + + %({x-forwarded-for}i)s """