fix up log file stuff

Author: davidnewhall

.github/workflows/release.yml

@@ -1,17 +1,15 @@
 name: build-and-release
 on:
   push:
-    branches: [ 'main' ]
     tags: [ 'v*.*.*' ]
   pull_request:
-    branches: [ 'main' ]
+    branches: [ 'main', 'unstable' ]
 
 permissions:
   contents: read
 
 jobs:
   release:
-    if: startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main'
     outputs:
       version: ${{ steps.release.outputs.version }}
     name: Make Release Assets
@@ -42,7 +40,7 @@ jobs:
           name: release
           path: release
 
-  deploy-nonpublic-packagecloud:
+  deploy-release-packagecloud:
     if: startsWith(github.ref, 'refs/tags/v')
     needs: release
     name: Deploy Nonpublic PackageCloud
@@ -54,7 +52,23 @@ jobs:
           name: release
       - uses: golift/upload-packagecloud@v1.1
         with:
-          userrepo: golift/nonpublic
+          userrepo: golift/pkgs
+          apitoken: ${{ secrets.PACKAGECLOUD_TOKEN }}
+          packages: .
+          debdists: ubuntu/focal
+  deploy-unstable-packagecloud:
+    if: github.ref == 'refs/heads/unstable'
+    needs: release
+    name: Deploy Unstable PackageCloud
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download release files
+        uses: actions/download-artifact@v8
+        with:
+          name: release
+      - uses: golift/upload-packagecloud@v1.1
+        with:
+          userrepo: golift/unstable
           apitoken: ${{ secrets.PACKAGECLOUD_TOKEN }}
           packages: .
           debdists: ubuntu/focal

README.md

@@ -65,8 +65,9 @@ function socket_put_contents($socket, $outputfile, $line, $host, $length = 8000)
 
 ## Usage
 
-We run this from a Docker container directly on a Synology NAS. Using this image:<br/>
-`ghcr.io/Notifiarr/fogwillow:main`
+We run this from a Docker container directly on a Synology NAS. Using this image:
+
+- `ghcr.io/Notifiarr/fogwillow:main`
 
 Mount `/config` and give it a `/config/fog.conf` file that looks like the
 [example](https://github.com/Notifiarr/fogwillow/blob/main/fog.conf).

fog.conf

@@ -1,6 +1,7 @@
 ## Example Fog Willow config file.
 ## The values below are the defaults.
-#####################################
+## https://github.com/Notifiarr/fogwillow
+############################################
 
 # FW_PASSWORD: If a password is set then clients must send it as a setting.
 password = ""
@@ -12,12 +13,12 @@ flush_interval = "16s"
 group_interval = "4s"
 # FW_OUTPUT_PATH: This is prefixed to whatever comes in over the wire.
 output_path  = "/tmp"
-# FW_LOG_FILE: This should be a full path, probably /config/fog.log.
+# FW_LOG_FILE: This should be a full path, probably /config/fog.log or /etc/fogwillow/fog.log.
 log_file = ""
-# FW_LOG_FILE_MB: Size of each log file.
-log_file_mb = 0
-# FW_LOG_FILES: How many logs files to keep around.
-log_files = 0
+# FW_LOG_FILE_MB: Size of each log file. Default is 0 if this is omitted, rotation disabled.
+log_file_mb = 5
+# FW_LOG_FILES: How many logs files to keep around. Default is 0 if this is omitted, rotation disabled.
+log_files = 30
 # FW_BUFFER_UDP: This is the UDP socket buffer in bytes.
 buffer_udp = 4194304 # 4MB
 # FW_BUFFER_PACKET: This is the size of the read buffer per packet.
@@ -56,6 +57,6 @@ tls_key_path = ""
 # FW_HTTP_SERVER_ACCESS_LOG: Path to the HTTP access log file (Apache Combined format). Leave empty to disable.
 access_log = ""
 # FW_HTTP_SERVER_ACCESS_LOG_MB: Maximum size of each access log file in MB. 0 means unlimited, no file rotation.
-access_log_mb = 4 # 4MB
+access_log_mb = 5 # 5MB
 # FW_HTTP_SERVER_ACCESS_LOG_FILES: Number of rotated access log files to keep. 0 means keep all.
-access_log_files = 10 # 10 files.
+access_log_files = 30 # 30 files.

pkg/fog/start.go

@@ -24,7 +24,6 @@ const (
 	DefaultUDPBuffer    = 1 << 22 // 4MB
 	DefaultPacketBuffer = 1 << 18 // 256KB
 	DefaultChanBuffer   = 1 << 15 // 32 thousand
-	MaxStupidValue      = uint(9999999)
 )
 
 // Config is the input _and_ running data.
@@ -118,32 +117,32 @@ func (c *Config) Start() error {
 // setup makes sure configurations are sound and sane.
 func (c *Config) setup() {
 	// Protect uint->int64 conversions.
-	if c.LogFileMB > MaxStupidValue {
-		c.LogFileMB = MaxStupidValue
+	if c.LogFileMB > httpserver.MaxStupidValue {
+		c.LogFileMB = httpserver.MaxStupidValue
 	}
 
-	if c.LogFiles > MaxStupidValue {
-		c.LogFiles = MaxStupidValue
+	if c.LogFiles > httpserver.MaxStupidValue {
+		c.LogFiles = httpserver.MaxStupidValue
 	}
 
-	if c.HTTPServer.AccessLogMB > MaxStupidValue {
-		c.HTTPServer.AccessLogMB = MaxStupidValue
+	if c.HTTPServer.AccessLogMB > httpserver.MaxStupidValue {
+		c.HTTPServer.AccessLogMB = httpserver.MaxStupidValue
 	}
 
-	if c.HTTPServer.AccessLogFiles > MaxStupidValue {
-		c.HTTPServer.AccessLogFiles = MaxStupidValue
+	if c.HTTPServer.AccessLogFiles > httpserver.MaxStupidValue {
+		c.HTTPServer.AccessLogFiles = httpserver.MaxStupidValue
 	}
 
 	if c.Processors < 1 {
 		c.Processors = 1
-	} else if c.Processors > MaxStupidValue {
-		c.Processors = MaxStupidValue
+	} else if c.Processors > httpserver.MaxStupidValue {
+		c.Processors = httpserver.MaxStupidValue
 	}
 
 	if c.Listeners < 1 {
 		c.Listeners = 1
-	} else if c.Listeners > MaxStupidValue {
-		c.Listeners = MaxStupidValue
+	} else if c.Listeners > httpserver.MaxStupidValue {
+		c.Listeners = httpserver.MaxStupidValue
 	}
 
 	if c.newBuf = buf.NewBuffer; c.BufferPool {

pkg/httpserver/accesslog.go

@@ -14,21 +14,22 @@ const (
 	LogFileMode = 0o644
 	// Apache Combined Log Format: host ident user time "request" status bytes "referer" "user-agent".
 	CombinedLogFormat = `%h %l %u %t "%r" %>s %b "%{Referer}i" "%{User-Agent}i"`
+	MaxStupidValue    = uint(9999999) // for comparing with config.
 )
 
 // newAccessLog creates a rotating access log writer from config.
 // Returns nil when AccessLog is empty, disabling access logging.
 func newAccessLog(config *Config) *rotatorr.Logger {
-	if config.AccessLog == "" || config.AccessLogMB < 0 || config.AccessLogFiles < 0 {
+	if config.AccessLog == "" {
 		return nil
 	}
 
 	return rotatorr.NewMust(&rotatorr.Config{
 		Filepath: config.AccessLog,
-		FileSize: config.AccessLogMB * OneMB,
+		FileSize: int64(config.AccessLogMB * OneMB), //nolint:gosec // size is protected by config.
 		FileMode: LogFileMode,
 		Rotatorr: &timerotator.Layout{
-			FileCount: config.AccessLogFiles,
+			FileCount: int(config.AccessLogFiles), //nolint:gosec // count is protected by config.
 		},
 	})
 }

pkg/httpserver/config.go

@@ -10,8 +10,6 @@ const (
 	DefaultWriteTimeout      = 10 * time.Second
 	DefaultIdleTimeout       = 120 * time.Second
 	DefaultMaxHeaderBytes    = 1 << 16 // 64KB
-	DefaultAccessLogMB       = 1 << 22 // 4MB
-	DefaultAccessLogFiles    = 10      // 10 files
 	OneMB                    = 1 << 20 // 1 MB, used for calculations.
 )
 
@@ -68,11 +66,11 @@ func (c *Config) Setup() {
 		c.MaxHeaderBytes = DefaultMaxHeaderBytes
 	}
 
-	if c.AccessLogFiles == 0 {
-		c.AccessLogFiles = DefaultAccessLogFiles
+	if c.AccessLogFiles > MaxStupidValue {
+		c.AccessLogFiles = MaxStupidValue
 	}
 
-	if c.AccessLogMB == 0 {
-		c.AccessLogMB = DefaultAccessLogMB
+	if c.AccessLogMB > MaxStupidValue {
+		c.AccessLogMB = MaxStupidValue
 	}
 }