From a6c3988b789f3198d9a7cecf5b94522cc1735a6a Mon Sep 17 00:00:00 2001 From: Adam Warner Date: Sat, 5 Sep 2020 14:26:11 +0100 Subject: [PATCH 1/3] /var/log/ -> /var/log/pihole/ Signed-off-by: Adam Warner --- docs/core/pihole-command.md | 2 +- docs/ftldns/configfile.md | 2 +- docs/ftldns/in-depth.md | 2 +- docs/regex/overview.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/core/pihole-command.md b/docs/core/pihole-command.md index ba48daa..d0281b9 100644 --- a/docs/core/pihole-command.md +++ b/docs/core/pihole-command.md @@ -80,7 +80,7 @@ Help Command | N/A Script Location | [`/opt/pihole/piholeLogFlush.sh`](https://github.com/pi-hole/pi-hole/blob/master/advanced/Scripts/piholeLogFlush.sh) Example Usage | [`pihole flush`](https://discourse.pi-hole.net/t/the-pihole-command-with-examples/738#flushing-the-log) -When invoked manually, this command will allow you to empty Pi-hole's log, which is located at `/var/log/pihole.log`. The command also serves to rotate the log daily, if the `logrotate` application is installed. +When invoked manually, this command will allow you to empty Pi-hole's log, which is located at `/var/log/pihole/pihole.log`. The command also serves to rotate the log daily, if the `logrotate` application is installed. ### Reconfigure diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md index adf8718..f90045c 100644 --- a/docs/ftldns/configfile.md +++ b/docs/ftldns/configfile.md @@ -250,7 +250,7 @@ Specify the path and filename of FTL's SQLite3 long-term database. Setting this ### File options -#### `LOGFILE=/var/log/pihole-FTL.log` {#file_LOGFILE data-toc-label='Log file'} +#### `LOGFILE=/var/log/pihole/pihole-FTL.log` {#file_LOGFILE data-toc-label='Log file'} The location of FTL's log file. If you want to move the log file to a different place, also consider [this FAQ article](https://discourse.pi-hole.net/t/moving-the-pi-hole-log-to-another-location-device/2041). diff --git a/docs/ftldns/in-depth.md b/docs/ftldns/in-depth.md index 570d765..44aa76b 100644 --- a/docs/ftldns/in-depth.md +++ b/docs/ftldns/in-depth.md @@ -18,7 +18,7 @@ Command-line arguments can be arbitrarily combined, e.g. `pihole-FTL debug test` ## File locations -- `/var/log/pihole-FTL.log` log file +- `/var/log/pihole/pihole-FTL.log` log file - `/run/pihole-FTL.pid` PID file - `/run/pihole-FTL.port` file containing port on which `FTL` is listening - `/run/pihole/FTL.sock` Unix socket diff --git a/docs/regex/overview.md b/docs/regex/overview.md index 5822ae4..25c9fb9 100644 --- a/docs/regex/overview.md +++ b/docs/regex/overview.md @@ -32,7 +32,7 @@ DEBUG_REGEX=true in your `/etc/pihole/pihole-FTL.conf` and restart `pihole-FTL` to enable or disable this mode. -Once the debugging mode is enabled, each match will be logged to `/var/log/pihole-FTL.log` in the following format: +Once the debugging mode is enabled, each match will be logged to `/var/log/pihole/pihole-FTL.log` in the following format: ```text [2018-07-17 17:40:51.304] Regex blacklist (DB ID 15) >> MATCH: "whatever.twitter.com" vs. "((^)|(\.))twitter\." From 900d82b5939c2df9dfa4a8c88dc4846f912da8ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20K=C3=B6nig?= Date: Thu, 12 May 2022 22:18:26 +0200 Subject: [PATCH 2/3] Fix location in new doc files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Christian König --- docs/ftldns/cache_dump.md | 2 +- docs/ftldns/configfile.md | 2 +- docs/ftldns/dnsmasq_warn.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/ftldns/cache_dump.md b/docs/ftldns/cache_dump.md index defa63e..fe89952 100644 --- a/docs/ftldns/cache_dump.md +++ b/docs/ftldns/cache_dump.md @@ -1,6 +1,6 @@ ## Cache dump interpretation -The `dnsmasq` core embedded into `pihole-FTL` prints a dump of the current cache content into the mail log file (default location `/var/log/pihole.log`) when receiving `SIGUSR1`, e.g. by +The `dnsmasq` core embedded into `pihole-FTL` prints a dump of the current cache content into the mail log file (default location `/var/log/pihole/pihole.log`) when receiving `SIGUSR1`, e.g. by ``` bash sudo killall -USR1 pihole-FTL diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md index f90045c..ab4702d 100644 --- a/docs/ftldns/configfile.md +++ b/docs/ftldns/configfile.md @@ -39,7 +39,7 @@ The default settings for FTL's rate-limiting are to permit no more than `1000` q It is important to note that rate-limiting is happening on a *per-client* basis. Other clients can continue to use FTL while rate-limited clients are short-circuited at the same time. For this setting, both numbers, the maximum number of queries within a given time, **and** the length of the time interval (seconds) have to be specified. For instance, if you want to set a rate limit of 1 query per hour, the option should look like `RATE_LIMIT=1/3600`. -The time interval is relative to when FTL has finished starting (start of the daemon + possible delay by DELAY_STARTUP) then it will advance in steps of the rate-limiting interval. If a client reaches the maximum number of queries it will be blocked until **the end of the current interval**. This will be logged to `/var/log/pihole-FTL.log`, e.g. `Rate-limiting 10.0.1.39 for at least 44 seconds`. If the client continues to send queries while being blocked already and this number of queries during the blocking exceeds the limit the client will continue to be blocked **until the end of the next interval** (`pihole-FTL.log` will contain lines like `Still rate-limiting 10.0.1.39 as it made additional 5007 queries`). As soon as the client requests less than the set limit, it will be unblocked (`Ending rate-limitation of 10.0.1.39`). +The time interval is relative to when FTL has finished starting (start of the daemon + possible delay by DELAY_STARTUP) then it will advance in steps of the rate-limiting interval. If a client reaches the maximum number of queries it will be blocked until **the end of the current interval**. This will be logged to `/var/log/pihole/pihole-FTL.log`, e.g. `Rate-limiting 10.0.1.39 for at least 44 seconds`. If the client continues to send queries while being blocked already and this number of queries during the blocking exceeds the limit the client will continue to be blocked **until the end of the next interval** (`pihole-FTL.log` will contain lines like `Still rate-limiting 10.0.1.39 as it made additional 5007 queries`). As soon as the client requests less than the set limit, it will be unblocked (`Ending rate-limitation of 10.0.1.39`). Rate-limiting may be disabled altogether by setting `RATE_LIMIT=0/0` (this results in the same behavior as before FTL v5.7). diff --git a/docs/ftldns/dnsmasq_warn.md b/docs/ftldns/dnsmasq_warn.md index b515aa0..6dcbfd3 100644 --- a/docs/ftldns/dnsmasq_warn.md +++ b/docs/ftldns/dnsmasq_warn.md @@ -1,6 +1,6 @@ # Known `dnsmasq` warnings -Warnings commonly seen in `dnsmasq`'s log file (`/var/log/pihole.log`) and the Pi-hole diagnosis system. +Warnings commonly seen in `dnsmasq`'s log file (`/var/log/pihole/pihole.log`) and the Pi-hole diagnosis system. !!! warning "ignoring zone transfer request from `ADDRESS`" @@ -145,7 +145,7 @@ Warnings commonly seen in `dnsmasq`'s log file (`/var/log/pihole.log`) and the P The configured maximum number of concurrent DNS queries for a given server is reached. The system is either very busy at the moment or not receiving queries from the configured upstream. Check your connectivity or the upstream DNS server status. - The warning can also be printed when being spammed with an excessive amount of duplicates or when the upstream server never replies for specific domains. Check your logs and try to identify similarities between the query directly preceding this warning and earlier queries in `/var/log/pihole.log`. Try to find out if your upstream does maybe never reply to specific domains and fix this. + The warning can also be printed when being spammed with an excessive amount of duplicates or when the upstream server never replies for specific domains. Check your logs and try to identify similarities between the query directly preceding this warning and earlier queries in `/var/log/pihole/pihole.log`. Try to find out if your upstream does maybe never reply to specific domains and fix this. This warning is printed at most once every five seconds (per upstream server) to help mitigate unlimited log file growth. From bfe529cf25da3aa8938c547bf34904568af6a1ab Mon Sep 17 00:00:00 2001 From: DL6ER Date: Sun, 3 Jul 2022 20:31:07 +0200 Subject: [PATCH 3/3] Change FTL's default log file path from /var/log/pihole/pihole-FTL.log to /var/log/pihole/FTL.log Signed-off-by: DL6ER --- docs/ftldns/configfile.md | 6 +++--- docs/ftldns/in-depth.md | 2 +- docs/regex/overview.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md index ab4702d..daa1aac 100644 --- a/docs/ftldns/configfile.md +++ b/docs/ftldns/configfile.md @@ -39,7 +39,7 @@ The default settings for FTL's rate-limiting are to permit no more than `1000` q It is important to note that rate-limiting is happening on a *per-client* basis. Other clients can continue to use FTL while rate-limited clients are short-circuited at the same time. For this setting, both numbers, the maximum number of queries within a given time, **and** the length of the time interval (seconds) have to be specified. For instance, if you want to set a rate limit of 1 query per hour, the option should look like `RATE_LIMIT=1/3600`. -The time interval is relative to when FTL has finished starting (start of the daemon + possible delay by DELAY_STARTUP) then it will advance in steps of the rate-limiting interval. If a client reaches the maximum number of queries it will be blocked until **the end of the current interval**. This will be logged to `/var/log/pihole/pihole-FTL.log`, e.g. `Rate-limiting 10.0.1.39 for at least 44 seconds`. If the client continues to send queries while being blocked already and this number of queries during the blocking exceeds the limit the client will continue to be blocked **until the end of the next interval** (`pihole-FTL.log` will contain lines like `Still rate-limiting 10.0.1.39 as it made additional 5007 queries`). As soon as the client requests less than the set limit, it will be unblocked (`Ending rate-limitation of 10.0.1.39`). +The time interval is relative to when FTL has finished starting (start of the daemon + possible delay by DELAY_STARTUP) then it will advance in steps of the rate-limiting interval. If a client reaches the maximum number of queries it will be blocked until **the end of the current interval**. This will be logged to `/var/log/pihole/FTL.log`, e.g. `Rate-limiting 10.0.1.39 for at least 44 seconds`. If the client continues to send queries while being blocked already and this number of queries during the blocking exceeds the limit the client will continue to be blocked **until the end of the next interval** (`FTL.log` will contain lines like `Still rate-limiting 10.0.1.39 as it made additional 5007 queries`). As soon as the client requests less than the set limit, it will be unblocked (`Ending rate-limitation of 10.0.1.39`). Rate-limiting may be disabled altogether by setting `RATE_LIMIT=0/0` (this results in the same behavior as before FTL v5.7). @@ -250,7 +250,7 @@ Specify the path and filename of FTL's SQLite3 long-term database. Setting this ### File options -#### `LOGFILE=/var/log/pihole/pihole-FTL.log` {#file_LOGFILE data-toc-label='Log file'} +#### `LOGFILE=/var/log/pihole/FTL.log` {#file_LOGFILE data-toc-label='Log file'} The location of FTL's log file. If you want to move the log file to a different place, also consider [this FAQ article](https://discourse.pi-hole.net/t/moving-the-pi-hole-log-to-another-location-device/2041). @@ -324,7 +324,7 @@ Print information about ARP table processing: How long did parsing take, whether #### `DEBUG_REGEX=false|true` {#debug_regex data-toc-label='Regular expressions'} -Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`. +Controls if *FTL*DNS should print extended details about regex matching into `FTL.log`. **[More details](../regex/overview.md)** diff --git a/docs/ftldns/in-depth.md b/docs/ftldns/in-depth.md index 44aa76b..7d06026 100644 --- a/docs/ftldns/in-depth.md +++ b/docs/ftldns/in-depth.md @@ -18,7 +18,7 @@ Command-line arguments can be arbitrarily combined, e.g. `pihole-FTL debug test` ## File locations -- `/var/log/pihole/pihole-FTL.log` log file +- `/var/log/pihole/FTL.log` log file - `/run/pihole-FTL.pid` PID file - `/run/pihole-FTL.port` file containing port on which `FTL` is listening - `/run/pihole/FTL.sock` Unix socket diff --git a/docs/regex/overview.md b/docs/regex/overview.md index 25c9fb9..1e1d135 100644 --- a/docs/regex/overview.md +++ b/docs/regex/overview.md @@ -32,7 +32,7 @@ DEBUG_REGEX=true in your `/etc/pihole/pihole-FTL.conf` and restart `pihole-FTL` to enable or disable this mode. -Once the debugging mode is enabled, each match will be logged to `/var/log/pihole/pihole-FTL.log` in the following format: +Once the debugging mode is enabled, each match will be logged to `/var/log/pihole/FTL.log` in the following format: ```text [2018-07-17 17:40:51.304] Regex blacklist (DB ID 15) >> MATCH: "whatever.twitter.com" vs. "((^)|(\.))twitter\."