summaryrefslogtreecommitdiff
path: root/docs/error_reporting.rst
diff options
context:
space:
mode:
authorJonathan Huot <JonathanHuot@users.noreply.github.com>2019-07-19 09:22:21 +0200
committerGitHub <noreply@github.com>2019-07-19 09:22:21 +0200
commitfe9ec057f3cba2f8428ad666ad557d2f77188268 (patch)
treea4b4f4b8567e59f8b0558f2de8786af820cd0c54 /docs/error_reporting.rst
parent9e824cfb0eb36b4d23ab73171b821b1a74ec659c (diff)
parentd7b90fc841694f126ec63500ea8f74330c4672eb (diff)
downloadoauthlib-release-3.0.2.tar.gz
Merge branch 'master' into release-3.0.2release-3.0.2
Diffstat (limited to 'docs/error_reporting.rst')
-rw-r--r--docs/error_reporting.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/error_reporting.rst b/docs/error_reporting.rst
index 705f447..a80287b 100644
--- a/docs/error_reporting.rst
+++ b/docs/error_reporting.rst
@@ -10,16 +10,20 @@ case where that is not true please let us know!
When reporting bugs, especially when they are hard or impossible to reproduce,
it is useful to include logging output. You can enable logging for all
-oauthlib modules by adding a logger to the `oauthlib` namespace.
+oauthlib modules by adding a logger to the `oauthlib` namespace. You might also
+want to enable debugging mode to include request data in output.
.. code-block:: python
import logging
+ import oauthlib
import sys
+ oauthlib.set_debug(True)
log = logging.getLogger('oauthlib')
log.addHandler(logging.StreamHandler(sys.stdout))
log.setLevel(logging.DEBUG)
+
If you are using a library that builds upon OAuthLib please also enable the
logging for their modules, e.g. for `requests-oauthlib`