]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[doc]: Update logging cookbook to mention domain socket configuration in a recipe...
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Thu, 20 Feb 2025 14:09:15 +0000 (14:09 +0000)
committerGitHub <noreply@github.com>
Thu, 20 Feb 2025 14:09:15 +0000 (14:09 +0000)
Doc/howto/logging-cookbook.rst

index 3cd2f1d96a7b34cd12fd199957b3353ae8666800..f08f45179980f308914e0f445ac99730574d6425 100644 (file)
@@ -825,9 +825,9 @@ To test these files, do the following in a POSIX environment:
    which will lead to records being written to the log.
 
 #. Inspect the log files in the :file:`run` subdirectory. You should see the
-   most recent log lines in files matching the pattern :file:`app.log*`. They won't be in
-   any particular order, since they have been handled concurrently by different
-   worker processes in a non-deterministic way.
+   most recent log lines in files matching the pattern :file:`app.log*`. They
+   won't be in any particular order, since they have been handled concurrently
+   by different worker processes in a non-deterministic way.
 
 #. You can shut down the listener and the web application by running
    ``venv/bin/supervisorctl -c supervisor.conf shutdown``.
@@ -835,6 +835,19 @@ To test these files, do the following in a POSIX environment:
 You may need to tweak the configuration files in the unlikely event that the
 configured ports clash with something else in your test environment.
 
+The default configuration uses a TCP socket on port 9020. You can use a Unix
+Domain socket instead of a TCP socket by doing the following:
+
+#. In :file:`listener.json`, add a ``socket`` key with the path to the domain
+   socket you want to use. If this key is present, the listener listens on the
+   corresponding domain socket and not on a TCP socket (the ``port`` key is
+   ignored).
+
+#. In :file:`webapp.json`, change the socket handler configuration dictionary
+   so that the ``host`` value is the path to the domain socket, and set the
+   ``port`` value to ``null``.
+
+
 .. currentmodule:: logging
 
 .. _context-info: