From 504f02992ace82a5520bc0ca43d9562c077a06e4 Mon Sep 17 00:00:00 2001
From: Thibault "bui" Koechlin
Date: Sat, 31 Aug 2019 15:32:36 +0200
Subject: Support direct syslog logging

Add the possibility to log directly into the syslog, instead of using php's log system.---
 doc/source/config.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'doc')

diff --git a/doc/source/config.rst b/doc/source/config.rst
index 89e063f..4be8db7 100644
--- a/doc/source/config.rst
+++ b/doc/source/config.rst
@@ -81,6 +81,24 @@ This configuration variable contains parameters that are used by multiple featur
 - ``cookie_env_var``: A environment variable used as part of cookies encryption.
   See the :ref:`relevant documentation <config_cookie-encryption>`
 
+log_media
+^^^^^^^^^
+
+This configuration variable allows to specify how logs should be written,
+either via ``php`` or ``syslog``.
+
+::
+
+  sp.log_media("php");
+  sp.log_media("syslog");
+
+The default value for ``sp.log_media`` is ``php``, to respect the `principle of
+least astonishment
+<https://en.wikipedia.org/wiki/Principle_of_least_astonishment>`__. But since
+it's `possible to modify php's logging system via php
+<https://www.php.net/manual/en/errorfunc.configuration.php>`__, it's
+heavily recommended to use the ``syslog`` option instead.
+
 
 Bugclass-killer features
 ------------------------
-- 
cgit v1.3