Skip to content

Commit

Permalink
Fix name of RequestIdLogFilter
Browse files Browse the repository at this point in the history
  • Loading branch information
jwhitlock committed Apr 16, 2024
1 parent 3bda2ff commit f432027
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/django.rst
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ Requests Correlation ID

A unique request ID is read from the ``X-Request-ID`` request header, and a UUID4 value is generated if unset.

Leveraging the ``RequestIdFilter`` in logging configuration as shown above will add a ``rid`` field into the ``Fields`` entry of all log messages.
Leveraging the ``RequestIdLogFilter`` in logging configuration as shown above will add a ``rid`` field into the ``Fields`` entry of all log messages.

The header name to obtain the request ID can be
`customized in settings <DOCKERFLOW_REQUEST_ID_HEADER_NAME>`_:
Expand Down
4 changes: 2 additions & 2 deletions docs/fastapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ for at least the ``request.summary`` logger:
},
'filters': {
'request_id': {
'()': 'dockerflow.logging.RequestIdFilter',
'()': 'dockerflow.logging.RequestIdLogFilter',
},
},
'handlers': {
Expand Down Expand Up @@ -346,7 +346,7 @@ Requests Correlation ID

A unique request ID is read from the ``X-Request-ID`` request header, and a UUID4 value is generated if unset.

Leveraging the ``RequestIdFilter`` in logging configuration as shown above will add a ``rid`` field into the ``Fields`` entry of all log messages.
Leveraging the ``RequestIdLogFilter`` in logging configuration as shown above will add a ``rid`` field into the ``Fields`` entry of all log messages.

The header name to obtain the request ID can be customized in settings:

Expand Down
4 changes: 2 additions & 2 deletions docs/flask.rst
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ for at least the ``request.summary`` logger::
},
'filters': {
'request_id': {
'()': 'dockerflow.logging.RequestIdFilter',
'()': 'dockerflow.logging.RequestIdLogFilter',
},
},
'handlers': {
Expand Down Expand Up @@ -486,7 +486,7 @@ Requests Correlation ID

A unique request ID is read from the ``X-Request-ID`` request header, and a UUID4 value is generated if unset.

Leveraging the ``RequestIdFilter`` in logging configuration as shown above will add a ``rid`` field into the ``Fields`` entry of all log messages.
Leveraging the ``RequestIdLogFilter`` in logging configuration as shown above will add a ``rid`` field into the ``Fields`` entry of all log messages.

The header name to obtain the request ID can be customized in settings:

Expand Down
4 changes: 2 additions & 2 deletions docs/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ this::
},
'filters': {
'request_id': {
'()': 'dockerflow.logging.RequestIdFilter',
'()': 'dockerflow.logging.RequestIdLogFilter',
},
},
'handlers': {
Expand Down Expand Up @@ -90,7 +90,7 @@ thing as the dictionary based configuratio above:
keys = request_id
[filter_request_id]
class = dockerflow.logging.RequestIdFilter
class = dockerflow.logging.RequestIdLogFilter
[logger_root]
level = INFO
Expand Down
4 changes: 2 additions & 2 deletions docs/sanic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ for at least the ``request.summary`` logger::
},
'filters': {
'request_id': {
'()': 'dockerflow.logging.RequestIdFilter',
'()': 'dockerflow.logging.RequestIdLogFilter',
},
},
'handlers': {
Expand Down Expand Up @@ -485,7 +485,7 @@ Requests Correlation ID

A unique request ID is read from the ``X-Request-ID`` request header, and a UUID4 value is generated if unset.

Leveraging the ``RequestIdFilter`` in logging configuration as shown above will add a ``rid`` field into the ``Fields`` entry of all log messages.
Leveraging the ``RequestIdLogFilter`` in logging configuration as shown above will add a ``rid`` field into the ``Fields`` entry of all log messages.

The header name to obtain the request ID can be customized in settings:

Expand Down

0 comments on commit f432027

Please sign in to comment.