From 48906071307d79df356379fe6e05a73b0c65d9d4 Mon Sep 17 00:00:00 2001
From: Miguel Grinberg <miguel.grinberg@gmail.com>
Date: Fri, 9 Oct 2020 16:31:04 +0100
Subject: [PATCH] Added troubleshooting section to the documentation

---
 docs/client.rst | 23 +++++++++++++++++++++++
 docs/server.rst | 23 +++++++++++++++++++++++
 2 files changed, 46 insertions(+)

diff --git a/docs/client.rst b/docs/client.rst
index 80c66ca..bb83b31 100644
--- a/docs/client.rst
+++ b/docs/client.rst
@@ -299,3 +299,26 @@ Or for ``asyncio``::
 
 The single argument passed to the method is the number of seconds to sleep
 for.
+
+Debugging and Troubleshooting
+-----------------------------
+
+To help you debug issues, the client can be configured to output logs to the
+terminal::
+
+    import socketio
+
+    # standard Python
+    sio = socketio.Client(logger=True, engineio_logger=True)
+
+    # asyncio
+    sio = socketio.AsyncClient(logger=True, engineio_logger=True)
+
+The ``logger`` argument controls logging related to the Socket.IO protocol,
+while ``engineio_logger`` controls logs that originate in the low-level
+Engine.IO transport. These arguments can be set to ``True`` to output logs to
+``stderr``, or to an object compatible with Python's ``logging`` package
+where the logs should be emitted to. A value of ``False`` disables logging.
+
+Logging can help identify the cause of connection problems, unexpected
+disconnections and other issues.
diff --git a/docs/server.rst b/docs/server.rst
index 9c28c01..8fe9cd1 100644
--- a/docs/server.rst
+++ b/docs/server.rst
@@ -565,6 +565,29 @@ example::
     # emit an event
     external_sio.emit('my event', data={'foo': 'bar'}, room='my room')
 
+Debugging and Troubleshooting
+-----------------------------
+
+To help you debug issues, the server can be configured to output logs to the
+terminal::
+
+    import socketio
+
+    # standard Python
+    sio = socketio.Server(logger=True, engineio_logger=True)
+
+    # asyncio
+    sio = socketio.AsyncServer(logger=True, engineio_logger=True)
+
+The ``logger`` argument controls logging related to the Socket.IO protocol,
+while ``engineio_logger`` controls logs that originate in the low-level
+Engine.IO transport. These arguments can be set to ``True`` to output logs to
+``stderr``, or to an object compatible with Python's ``logging`` package
+where the logs should be emitted to. A value of ``False`` disables logging.
+
+Logging can help identify the cause of connection problems, 400 responses,
+bad performance and other issues.
+
 .. _deployment-strategies:
 
 Deployment Strategies