Merge pull request #576 from ExpressionEngine/feature/7.x/error-logging

error logging

Author: TomJaeger

docs/installation/best-practices.md

@@ -15,7 +15,7 @@
 
 ExpressionEngine's system files and directories are typically safe from direct HTTP access on a properly configured server.
 
-However, for increased security we recommend that the `system` folder either be renamed or moved entirely above the public web root folder (commonly named public_html or referred to as simply "webroot") and that admin.php be renamed as well. This document describes the renaming process.
+However, for increased security, we recommend that the `system` folder either be renamed or moved entirely above the public web root folder (commonly named `public_html` or referred to as simply "webroot") and that `admin.php` be renamed as well. This document describes the renaming process.
 
 ## Renaming the System Directory
 

docs/toc_sections/_best_practices_toc.yml

@@ -44,4 +44,6 @@
     - name: Simple Commerce Module
       href: troubleshooting/simple-commerce-module.md
     - name: Error Messages
-      href: troubleshooting/error-messages.md
+      href: troubleshooting/error-messages.md
+    - name: Error Logging
+      href: troubleshooting/error-logging.md

docs/troubleshooting/error-logging.md

@@ -0,0 +1,32 @@
+<!--
+    This source file is part of the open source project
+    ExpressionEngine User Guide (https://github.com/ExpressionEngine/ExpressionEngine-User-Guide)
+
+    @link      https://expressionengine.com/
+    @copyright Copyright (c) 2003-2023, Packet Tide, LLC (https://packettide.com)
+    @license   https://expressionengine.com/license Licensed under Apache License, Version 2.0
+-->
+
+# Error Logging
+
+[TOC]
+
+### Error Logging
+
+When debugging is disabled, there can be situations where PHP errors can cause a white screen, or there can be errors that are completely invisible to the user but result in incorrect execution of a given page.
+
+To find these errors, it is recommended to enable logging in ExpressionEngine.
+
+To enable error logging, you need to do the following:
+
+1. Create a `logs` folder inside your `system/user` folder and make sure it's writable
+2. Open the `config.php` file and add the following config overrides:
+    - [`log_threshold`](general/system-configuration-overrides.md#log_threshold) (required)
+    - [`log_date_format`](general/system-configuration-overrides.md#log_date_format) (optional)
+
+Example:
+```
+    $config['log_date_format'] = 'Y-m-d H:i:s';
+    $config['log_threshold'] = '1';
+```
+After adding the two config file items above, PHP errors, warnings, etc. will be logged to a file with the corresponding date inside the `system/user/logs` folder.