pi-hole/docs
1
0
Fork 0
mirror of https://github.com/pi-hole/docs.git synced 2024-12-06 19:27:12 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Improve debug TOC

Browse Source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2020-08-15 14:27:24 +02:00
parent a8f8e837ee
commit 5a4b2d8f7c
1 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ftldns/configfile.md
+17 -17
View File
@@ -151,43 +151,43 @@ Specify path and filename of FTL's SQLite3 gravity database. This database conta
### Debugging options
#### `DEBUG_ALL=false|true` {#debug_all data-toc-label='Debug All'}
#### `DEBUG_ALL=false|true` {#debug_all data-toc-label='All'}
Enable all debug flags. If this is set to true, all other debug config options are ignored.
#### `DEBUG_DATABASE=false|true` {#debug_database data-toc-label='Debug Database'}
#### `DEBUG_DATABASE=false|true` {#debug_database data-toc-label='Database'}
Print debugging information about database actions. This prints performed SQL statements as well as some general information such as the time it took to store the queries and how many have been saved to the database.
#### `DEBUG_NETWORKING=false|true` {#debug_networking data-toc-label='Debug networking'}
#### `DEBUG_NETWORKING=false|true` {#debug_networking data-toc-label='Networking'}
Prints a list of the detected interfaces on the startup of `pihole-FTL`. Also, prints whether these interfaces are IPv4 or IPv6 interfaces.
#### `DEBUG_LOCKS=false|true` {#debug_locks data-toc-label='Debug Locks'}
#### `DEBUG_LOCKS=false|true` {#debug_locks data-toc-label='Locks'}
Print information about shared memory locks. Messages will be generated when waiting, obtaining, and releasing a lock.
#### `DEBUG_QUERIES=false|true` {#debug_queries data-toc-label='Debug Queries'}
#### `DEBUG_QUERIES=false|true` {#debug_queries data-toc-label='Queries'}
Print extensive query information (domains, types, replies, etc.). This has always been part of the legacy `debug` mode of `pihole-FTL`.
#### `DEBUG_FLAGS=false|true` {#debug_flags data-toc-label='Debug Flags'}
#### `DEBUG_FLAGS=false|true` {#debug_flags data-toc-label='Flags'}
Print flags of queries received by the DNS hooks. Only effective when `DEBUG_QUERIES` is enabled as well.
#### `DEBUG_SHMEM=false|true` {#debug_shmem data-toc-label='Debug Shared Memory'}
#### `DEBUG_SHMEM=false|true` {#debug_shmem data-toc-label='Shared Memory'}
Print information about shared memory buffers. Messages are either about creating or enlarging shmem objects or string injections.
#### `DEBUG_GC=false|true` {#debug_gc data-toc-label='Debug GC'}
#### `DEBUG_GC=false|true` {#debug_gc data-toc-label='Garbage Collection'}
Print information about garbage collection (GC): What is to be removed, how many have been removed and how long did GC take.
#### `DEBUG_ARP=false|true` {#debug_arp data-toc-label='Debug ARP'}
#### `DEBUG_ARP=false|true` {#debug_arp data-toc-label='Neighbor parsing'}
Print information about ARP table processing: How long did parsing take, whether read MAC addresses are valid, and if the `macvendor.db` file exists.
#### `DEBUG_REGEX=false|true` {#debug_regex data-toc-label='Debug REGEX'}
#### `DEBUG_REGEX=false|true` {#debug_regex data-toc-label='REGEX'}
Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`.<br>
Due to legacy reasons, we also support the following setting to be used for enabling the same functionality:<br>
@@ -195,31 +195,31 @@ Due to legacy reasons, we also support the following setting to be used for enab
Note that if one of them is set to `true`, the other one cannot be used to disable this setting again.<br>
**[More details](regex/overview.md)**
#### `DEBUG_API=false|true` {#debug_api data-toc-label='Debug Telnet'}
#### `DEBUG_API=false|true` {#debug_api data-toc-label='Telnet'}
Print extra debugging information during telnet API calls. Currently only used to send extra information when getting all queries.
#### `DEBUG_OVERTIME=false|true` {#debug_overtime data-toc-label='Debug overTime'}
#### `DEBUG_OVERTIME=false|true` {#debug_overtime data-toc-label='Over Time Data'}
Print information about overTime memory operations, such as initializing or moving overTime slots.
#### `DEBUG_EXTBLOCKED=false|true` {#debug_extblocked data-toc-label='Debug externally blocked'}
#### `DEBUG_EXTBLOCKED=false|true` {#debug_extblocked data-toc-label='Externally blocked queries'}
Print information about why FTL decided that certain queries were recognized as being externally blocked.
#### `DEBUG_CAPS=false|true` {#debug_caps data-toc-label='Debug Linux capabilities'}
#### `DEBUG_CAPS=false|true` {#debug_caps data-toc-label='Linux capabilities'}
Print information about capabilities granted to the pihole-FTL process. The current capabilities are printed on receipt of `SIGHUP`, i.e., the current set of capabilities can be queried without restarting `pihole-FTL` (by setting `DEBUG_CAPS=true` and thereafter sending `killall -HUP pihole-FTL`).
#### `DEBUG_DNSMASQ_LINES=false|true` {#debug_dnsmasq_lines data-toc-label='Debug dnsmasq lines'}
#### `DEBUG_DNSMASQ_LINES=false|true` {#debug_dnsmasq_lines data-toc-label='Analyze dnsmasq log lines'}
Print file and line causing a `dnsmasq` event into FTL's log files. This is handy to implement additional hooks missing from FTL.
#### `DEBUG_VECTORS=false|true` {#debug_vectors data-toc-label='Debug vectors'}
#### `DEBUG_VECTORS=false|true` {#debug_vectors data-toc-label='Vectors'}
FTL uses dynamically allocated vectors for various tasks. This config option enables extensive debugging information such as information about allocation, referencing, deletion, and appending.
#### `DEBUG_RESOLVER=false|true` {#debug_resolver data-toc-label='Debug resolver'}
#### `DEBUG_RESOLVER=false|true` {#debug_resolver data-toc-label='Resolver details'}
Extensive information about hostname resolution like which DNS servers are used in the first and second hostname resolving tries (only affecting internally generated PTR queries).