From 39f4cbc7fe7d6788db33ae380a69b9ddaaf39c52 Mon Sep 17 00:00:00 2001 From: Carla Schroder Date: Mon, 17 Aug 2015 12:59:50 -0700 Subject: [PATCH] rewrite logging page --- .../logging_configuration.rst | 52 ++++++++----------- 1 file changed, 22 insertions(+), 30 deletions(-) diff --git a/admin_manual/configuration_server/logging_configuration.rst b/admin_manual/configuration_server/logging_configuration.rst index 7ac21fb9e..199eaa6f3 100644 --- a/admin_manual/configuration_server/logging_configuration.rst +++ b/admin_manual/configuration_server/logging_configuration.rst @@ -1,46 +1,40 @@ +===================== Logging Configuration ===================== -To get an idea of how the current status of an ownCloud system is or to -solve issues log information is a good point to start with. ownCloud allows -the way, and which depth of information should be logged to be configured. + +Use your ownCloud log to review system status, or to help debug problems. You may adjust logging levels, and choose between using the ownCloud log or your syslog. Parameters ---------- -First you need to decide in which way logging should be done. You can -choose between the two options **owncloud** and **syslog**. Then you need -to configure the log level which directly influences how much information -will be logged. You can choose between: -* **0**: DEBUG -* **1**: INFO -* **2**: WARN -* **3**: ERROR -* **4**: FATAL +Logging levels range from **DEBUG**, which logs all activity, to **ERROR**, which logs only errors. -The most detailed information will be written if **0** (DEBUG) is set, the -least information will be written if **3** (ERROR) is set. Keep in mind that -it might slow down the whole system if too detailed logging has been -configured. By default the log level is set to **2** (WARN). +* **0**: DEBUG: All activity; the most detailed logging. +* **1**: INFO: Activity such as user logins and file activities, warning, errors, and fatal errors. +* **2**: WARN: Operations succeed, but with warnings of potential problems, plus errors and fatal errors. +* **3**: ERROR: An operation fails, but other services and operations continue. +* **4** FATAL: The server stops. -These parameters can be set in the :file:`config/config.php` +By default the log level is set to **2** (WARN).. Use **DEBUG** when you have a problem to diagnose, and then reset your log level to a less-verbose level as **DEBUG** outputs a lot of information, and can affect your server performance. + +Logging level parameters are set in the :file:`config/config.php`, or on the Admin page of your ownCloud Web GUI. ownCloud ~~~~~~~~ -All log information will be written to a separate log file which can be -viewed using the log menu in the admin menu of ownCloud. By default a log -file named **owncloud.log** will be created in the directory which has -been configured by the **datadirectory** parameter. -The desired date format can optionally be defined using the **logdateformat**. -By default the `PHP date function`_ parameter "*c*" is used and therefore the +All log information will be written to a separate log file which can be +viewed using the log viewer on your Admin page. By default, a log +file named **owncloud.log** will be created in the directory which has +been configured by the **datadirectory** parameter in :file:`config/config.php`. + +The desired date format can optionally be defined using the **logdateformat** parameter in :file:`config/config.php`. +By default the `PHP date function`_ parameter "*c*" is used, and therefore the date/time is written in the format "*2013-01-10T15:20:25+02:00*". By using the -date format in the example the date/time format will be written in the format +date format in the example below, the date/time format will be written in the format "*January 10, 2013 15:20:25*". .. code-block:: php - "owncloud", "logfile" => "owncloud.log", "loglevel" => "3", @@ -48,16 +42,14 @@ date format in the example the date/time format will be written in the format syslog ~~~~~~ -All log information will be sent to the default syslog daemon of a system. + +All log information will be sent to your default syslog daemon. .. code-block:: php - "syslog", "logfile" => "", "loglevel" => "3", .. _PHP date function: http://www.php.net/manual/en/function.date.php -