diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index c1afaad050..cb6b40afa0 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -622,9 +622,40 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth <literal>logging</literal> section - This section controls NetworkManager's logging. Any - settings here are overridden by the - and command-line options. + + This section controls NetworkManager's logging. + Logging is very important to understand what NetworkManager is doing. + When you report a bug, do not unnecessarily filter or limit the log file. + Just enable level=TRACE and domains=ALL + to collect everything. + + + + Any settings here are overridden by the + and command-line options. + Logging can also be reconfigured at runtime with + nmcli general logging level "$LEVEL" domains "$DOMAINS". + However, often it is interesting to get a complete log from the + start. Especially, when debugging an issue, enable debug logging + in NetworkManager.conf and restart the service to enable verbose logging + early on. + + + + NetworkManager's logging aims not to contain private sensitive data + and you should be fine sharing the debug logs. Still, there will + be IP addresses and your network setup, if you consider that private + then review the log before sharing. Do not mangle the logfile in + a way that distorts the meaning too much. + + + + NetworkManager uses syslog or systemd-journald, depending on configuration. + In any case, debug logs are verbose and might be rate limited + or filtered by the logging daemon. For systemd-journald, see + RateLimitIntervalSec and RateLimitBurst + in journald.conf manual for how to disable that. + @@ -633,18 +664,33 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth The default logging verbosity level. One of OFF, ERR, WARN, INFO, - DEBUG, TRACE. The ERR - level logs only critical errors. WARN logs warnings that may - reflect operation. INFO logs various informational messages that - are useful for tracking state and operations. DEBUG enables - verbose logging for debugging purposes. TRACE enables even more - verbose logging then DEBUG level. Subsequent levels also log - all messages from earlier levels; thus setting the log level - to INFO also logs error and warning messages. + DEBUG, TRACE, + in order of verbosity. + + + OFF disables all logging. INFO + is the default verbosity for regular operation. TRACE + is for debugging. + + + The other levels are in most cases not useful. For example, DEBUG + is between TRACE and INFO, but it's too + verbose for regular operation and lacks possibly interesting messages for debugging. + Almost always, when debugging an issue or reporting a bug, collect full + level TRACE logs to get the full picture. + + domains - The following log domains are available: + + Filter the messages by their topic. When debugging + an issue, it's better to collect all logs (ALL domain) + upfront. The unnecessary parts can always be ignored + later. + + In the uncommon case to tune out certain topics, the following log + domains are available: PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, @@ -655,7 +701,12 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth ALL, DEFAULT, DHCP, IP. You can specify per-domain log level overrides by adding a colon and a log level to any domain. E.g., - "WIFI:DEBUG,WIFI_SCAN:OFF". + "WIFI:DEBUG,WIFI_SCAN:OFF". + Another example is ALL,VPN_PLUGIN:TRACE + to enable all the logging there is (see about VPN_PLUGIN + below). + + Domain descriptions: