mirror of https://github.com/opnsense/docs
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
159 lines
8.3 KiB
ReStructuredText
159 lines
8.3 KiB
ReStructuredText
==============
|
|
System Logging
|
|
==============
|
|
|
|
When troubleshooting problems with your firewall, it is very likely you have to check
|
|
the logs available on your system. In the UI of OPNsense, the log files are generally grouped
|
|
with the settings of the component they belong to. The log files can be found here:
|
|
|
|
------
|
|
System
|
|
------
|
|
|
|
============================= =================================================== =============================================================
|
|
**System Log** :menuselection:`System --> Log Files --> General` *Most of all system related events go here*
|
|
**Backend / config daemon** :menuselection:`System --> Log Files --> Backend` *Here you can find logs for config generation of API usage*
|
|
**Web GUI** :menuselection:`System --> Log Files --> Web GUI` *Lighttpd, the webserver of OPNsense itself, logs here*
|
|
**Firmware** :menuselection:`System --> Firmware --> Log File` *Updates from the packaging system go here*
|
|
**Gateways** :menuselection:`System --> Gateways --> Log File` *Lists Dpinger gateway tracking related log messages*
|
|
**Routing** :menuselection:`System --> Routes --> Log File` *Routing changes or interface events*
|
|
============================= =================================================== =============================================================
|
|
|
|
.. Note::
|
|
Log files on file system:
|
|
/var/log/system.log (clog)
|
|
/var/log/configd.log (clog)
|
|
/var/log/lighttpd.log (clog)
|
|
/var/log/pkg.log (clog)
|
|
/var/log/gateways.log (clog) Note: By default gateway monitoring is disabled, so the log will be empty.
|
|
/var/log/routing.log (clog)
|
|
|
|
----------
|
|
Interfaces
|
|
----------
|
|
|
|
==================== ============================================================== ===================================================================
|
|
**Wireless** :menuselection:`Interfaces --> Wireless --> Log File` *When using wireless features of OPNsense you find the logs here*
|
|
**Point-to-Point** :menuselection:`Interfaces --> Point-to-Point --> Log File` *PPP dialup logs like PPPoE are found here*
|
|
==================== ============================================================== ===================================================================
|
|
|
|
.. Note::
|
|
Log files on file system:
|
|
/var/log/wireless.log (clog)
|
|
/var/log/ppps.log (clog)
|
|
|
|
--------
|
|
Firewall
|
|
--------
|
|
|
|
================ ======================================================== =============================================================================
|
|
**Live View** :menuselection:`Firewall --> Log Files --> Live View` *View firewall logs in realtime, smart filtering can be applied*
|
|
**Plain View** :menuselection:`Firewall --> Log Files --> Plain View` *Just the plain contents how **pf** logs into **filter.log** *
|
|
================ ======================================================== =============================================================================
|
|
|
|
.. Note::
|
|
Log files on file system:
|
|
/var/log/filter.log (clog)
|
|
|
|
---
|
|
VPN
|
|
---
|
|
|
|
================= =============================================== =====================================
|
|
**IPsec Log** :menuselection:`VPN --> IPsec --> Log File` *Everything around IPsec goes here*
|
|
**OpenVPN Log** :menuselection:`VPN --> OpenVPN --> Log File` *OpenVPN logs everything here*
|
|
================= =============================================== =====================================
|
|
|
|
.. Note::
|
|
Log files on file system:
|
|
/var/log/ipsec.log (clog)
|
|
/var/log/openvpn.log (clog)
|
|
|
|
--------
|
|
Services
|
|
--------
|
|
|
|
========================= ================================================================ =============================================
|
|
**Captive Portal** :menuselection:`Services --> Captive Portal --> Log File` *Events from Captive Portal go here*
|
|
**DHCPv4** :menuselection:`Services --> DHCPv4 --> Log File` *DHCP events get logged here*
|
|
**Dnsmasq DNS** :menuselection:`Services --> Dnsmasq DNS --> Log File` *The DNSmasq Forwarder logs*
|
|
**HAProxy** :menuselection:`Services --> HAProxy --> Log File` *The logs of the Reverse Proxy*
|
|
**Intrusion Detection** :menuselection:`Services --> Intrusion Detection --> Log File` *Suricata Logs are here*
|
|
**Network Time** :menuselection:`Services --> Network Time --> Log File` *NTP daemon logs*
|
|
**Unbound DNS** :menuselection:`Services --> Unbound DNS --> Log File` *Unbound resolver logs can be found here*
|
|
**Web Proxy** :menuselection:`Services --> Web Proxy --> Log File` *Squid access.log, store.log and cache.log*
|
|
========================= ================================================================ =============================================
|
|
|
|
.. Note::
|
|
Log files on file system:
|
|
/var/log/portalauth.log (clog)
|
|
/var/log/dhcpd.log (clog)
|
|
/var/log/dnsmasq.log (clog)
|
|
/var/log/haproxy.log (clog)
|
|
/var/log/ntpd.log (clog)
|
|
/var/log/suricata.log (clog)
|
|
/var/log/resolver.log (clog)
|
|
/var/log/squid/access.log (text)
|
|
/var/log/squid/cache.log (text)
|
|
/var/log/squid/store.log (text)
|
|
|
|
-------------
|
|
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 :menuselection:`System --> Settings --> Logging`.
|
|
There, you can also disable the writing of logs to disk or reset them all.
|
|
|
|
You can view the contents via CLI with:
|
|
|
|
.. code-block:: sh
|
|
|
|
clog /path/to/log
|
|
|
|
or follow the contents via:
|
|
|
|
.. code-block:: sh
|
|
|
|
clog -f /path/to/log
|
|
|
|
-----------
|
|
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
|
|
======================= ===============================================================================================
|
|
Enable Remote Logging Master on/off switch
|
|
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.
|
|
Remote Syslog Servers IP addresses of remote syslog servers, or IP:port combinations.
|
|
Remote Syslog Contents Can be used to selectively log event categories
|
|
======================= ===============================================================================================
|