Completed logging documentation

Author: apetenchea

arangoasync/connection.py

@@ -177,6 +177,9 @@ async def process_request(self, request: Request) -> Response:
         host_index = self._host_resolver.get_host_index()
         for tries in range(self._host_resolver.max_tries):
             try:
+                logger.debug(
+                    f"Sending request to host {host_index} ({tries}): {request}"
+                )
                 resp = await self._http_client.send_request(
                     self._sessions[host_index], request
                 )

docs/index.rst

@@ -67,6 +67,7 @@ Contents
     compression
     errors
     errno
+    logging
 
 **Development**
 

docs/logging.rst

@@ -0,0 +1,30 @@
+Logging
+-------
+
+If if helps to debug your application, you can enable logging to see all the requests sent by the driver to the ArangoDB server.
+
+.. code-block:: python
+
+    import logging
+    from arangoasync import ArangoClient
+    from arangoasync.auth import Auth
+    from arangoasync.logger import logger
+
+    # Set up logging
+    logging.basicConfig(level=logging.DEBUG)
+    logger.setLevel(level=logging.DEBUG)
+
+    # Initialize the client for ArangoDB.
+    async with ArangoClient(hosts="http://localhost:8529") as client:
+        auth = Auth(username="root", password="passwd")
+
+        # Connect to "test" database as root user.
+        db = await client.db("test", auth=auth)
+
+        # Get the API wrapper for "students" collection.
+        students = db.collection("students")
+
+        # Insert a document into the collection.
+        await students.insert({"name": "John Doe", "age": 25})
+
+The insert generates a log message similar to: `DEBUG:arangoasync:Sending request to host 0 (0): <POST /_db/_system/_api/document/students>`.