Skip to content

Commit 5a34987

Browse files
Merge pull request #291 from getsentry/document-plug-cookie-scrubber
document cookie scrubber
2 parents 6f9d869 + 40db1c6 commit 5a34987

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/plug.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Optional settings
2020

2121
The function to call before sending the headers of the request to Sentry. It will default to ``Sentry.Plug.default_header_scrubber/1``, which will remove "Authorization" and "Authentication" headers.
2222

23+
.. describe:: cookie_scrubber
24+
25+
The function to call before sending the cookies in the request to Sentry. It will default to ``Sentry.Plug.default_cookie_scrubber/1``, which removes all cookie information.
26+
2327
.. describe:: request_id_header
2428

2529
If you're using Phoenix, Plug.RequestId, or another method to set a request ID response header, and would like to include that information with errors reported by Sentry.Plug, the `:request_id_header` option allows you to set which header key Sentry should check. It will default to "x-request-id", which Plug.RequestId (and therefore Phoenix) also default to.

0 commit comments

Comments
 (0)