Add section about log settings

pull/144/head
Michael Steenbeek 5 years ago committed by Franco Fichtner
parent 1df969e61c
commit bf4d5986d6

@ -97,9 +97,9 @@ Services
/var/log/squid/cache.log (text)
/var/log/squid/store.log (text)
------------
Circular Log
------------
-------------
Circular Logs
-------------
Most of the core features log to circular log files so they will not grow bigger
than a predefined size. You can tune this value via **System->Settings->Logging**.
@ -117,17 +117,42 @@ or follow the contents via:
clog -f /path/to/log
------
Syslog
------
In **System->Settings->Logging** you can also set a remote log server to send
your log files to. Choose a **Source Address** if needed and fill in the **Remote Syslog Server** field.
Via **Remote Syslog Contents** you can choose which kind of logs to send.
-----------
Plugin Logs
-----------
Many plugins have their own logs. In the UI, they are grouped with the settings of that plugin.
They mostly log to /var/log/ in text format, so you can view or follow them with *tail*.
------------
Log Settings
------------
Log settings can be found at :menuselection:`System --> Settings --> Logging`. The settings are in two groups,
one for local logging and one for remote logging.
An overview of the local settings:
============================================ ====================================================================================================================
Setting Explanation
============================================ ====================================================================================================================
Reverse Display When enabled, the most recent log entry will be displayed on top.
GUI Log Entries to Display Number of log entries displayed in the GUI.
Log File Size (Bytes) Maximum size of circular logs (which most OPNsense log files are)
Log Firewall Default Blocks Turning these off means that only hits for your custom rules will be logged.
Web Server Log If checked, lighttpd errors are displayed in the main system log.
Disable writing log files to the local disk Useful to avoid wearing out flash memory (if used). Remote logging can be used to save the logs instead if desired.
Reset Logs Clear all logs. Note that this will also restart the DHCP server, so make sure any DHCP settings are saved first.
============================================ ====================================================================================================================
An overview of the remote settings:
======================= ===============================================================================================
Setting Explanation
======================= ===============================================================================================
Source Address Which interface to bind to. Select “any” if you want to use a mix of IPv4 and IPv6 servers.
IP Protocol Preferred IP version (it will this first). Will only be used if “Source Address” is not an IP.
Enable Remote Logging Master on/off switch
Remote Syslog Servers IP addresses of remote syslog servers, or IP:port combinations.
Remote Syslog Contents Can be used to selectively log event categories
======================= ===============================================================================================

Loading…
Cancel
Save