add worker name option and use it in logs and metrics, update tests

caddy/caddy.go

@@ -44,6 +44,8 @@ func init() {
 }
 
 type workerConfig struct {
+	// Name for the worker
+	Name string `json:"name,omitempty"`
 	// FileName sets the path to the worker script.
 	FileName string `json:"file_name,omitempty"`
 	// Num sets the number of workers to start.
@@ -95,7 +97,7 @@ func (f *FrankenPHPApp) Start() error {
 		frankenphp.WithPhpIni(f.PhpIni),
 	}
 	for _, w := range f.Workers {
-		opts = append(opts, frankenphp.WithWorkers(repl.ReplaceKnown(w.FileName, ""), w.Num, w.Env, w.Watch))
+		opts = append(opts, frankenphp.WithWorkers(w.Name, repl.ReplaceKnown(w.FileName, ""), w.Num, w.Env, w.Watch))
 	}
 
 	frankenphp.Shutdown()
@@ -209,6 +211,11 @@ func (f *FrankenPHPApp) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
 				for d.NextBlock(1) {
 					v := d.Val()
 					switch v {
+					case "name":
+						if !d.NextArg() {
+							return d.ArgErr()
+						}
+						wc.Name = d.Val()
 					case "file":
 						if !d.NextArg() {
 							return d.ArgErr()
@@ -242,14 +249,23 @@ func (f *FrankenPHPApp) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
 							wc.Watch = append(wc.Watch, d.Val())
 						}
 					}
+				}
 
-					if wc.FileName == "" {
-						return errors.New(`the "file" argument must be specified`)
-					}
+				if wc.FileName == "" {
+					return errors.New(`the "file" argument must be specified`)
+				}
+
+				if frankenphp.EmbeddedAppPath != "" && filepath.IsLocal(wc.FileName) {
+					wc.FileName = filepath.Join(frankenphp.EmbeddedAppPath, wc.FileName)
+				}
 
-					if frankenphp.EmbeddedAppPath != "" && filepath.IsLocal(wc.FileName) {
-						wc.FileName = filepath.Join(frankenphp.EmbeddedAppPath, wc.FileName)
+				if wc.Name == "" {
+					// let worker initialization validate if the FileName is valid or not
+					name, _ := fastabs.FastAbs(wc.FileName)
+					if name == "" {
+						name = wc.FileName
 					}
+					wc.Name = name
 				}
 
 				f.Workers = append(f.Workers, wc)

caddy/caddy_test.go

@@ -10,12 +10,12 @@ import (
 	"sync"
 	"testing"
 
+	"github.com/caddyserver/caddy/v2"
+	"github.com/caddyserver/caddy/v2/caddytest"
 	"github.com/dunglas/frankenphp"
+	"github.com/dunglas/frankenphp/internal/fastabs"
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/stretchr/testify/require"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddytest"
 )
 
 var testPort = "9080"
@@ -431,6 +431,8 @@ func TestWorkerMetrics(t *testing.T) {
 	}
 	`, "caddyfile")
 
+	workerName, _ := fastabs.FastAbs("../testdata/index.php")
+
 	// Make some requests
 	for i := 0; i < 10; i++ {
 		wg.Add(1)
@@ -467,29 +469,116 @@ func TestWorkerMetrics(t *testing.T) {
 	# TYPE frankenphp_busy_threads gauge
 	frankenphp_busy_threads 2
 
-	# HELP frankenphp_testdata_index_php_busy_workers Number of busy PHP workers for this worker
-	# TYPE frankenphp_testdata_index_php_busy_workers gauge
-	frankenphp_testdata_index_php_busy_workers 0
+	# HELP frankenphp_busy_workers Number of busy PHP workers for this worker
+	# TYPE frankenphp_busy_workers gauge
+	frankenphp_busy_workers{worker="` + workerName + `"} 0
 
-	# HELP frankenphp_testdata_index_php_total_workers Total number of PHP workers for this worker
-	# TYPE frankenphp_testdata_index_php_total_workers gauge
-	frankenphp_testdata_index_php_total_workers 2
+	# HELP frankenphp_total_workers Total number of PHP workers for this worker
+	# TYPE frankenphp_total_workers gauge
+	frankenphp_total_workers{worker="` + workerName + `"} 2
 
-	# HELP frankenphp_testdata_index_php_worker_request_count
-	# TYPE frankenphp_testdata_index_php_worker_request_count counter
-	frankenphp_testdata_index_php_worker_request_count 10
+	# HELP frankenphp_worker_request_count
+	# TYPE frankenphp_worker_request_count counter
+	frankenphp_worker_request_count{worker="` + workerName + `"} 10
+
+	# HELP frankenphp_ready_workers Running workers that have successfully called frankenphp_handle_request at least once
+	# TYPE frankenphp_ready_workers gauge
+	frankenphp_ready_workers{worker="` + workerName + `"} 2
+	`
+
+	ctx := caddy.ActiveContext()
+	require.NoError(t,
+		testutil.GatherAndCompare(
+			ctx.GetMetricsRegistry(),
+			strings.NewReader(expectedMetrics),
+			"frankenphp_total_threads",
+			"frankenphp_busy_threads",
+			"frankenphp_busy_workers",
+			"frankenphp_total_workers",
+			"frankenphp_worker_request_count",
+			"frankenphp_ready_workers",
+		))
+}
+
+func TestNamedWorkerMetrics(t *testing.T) {
+	var wg sync.WaitGroup
+	tester := caddytest.NewTester(t)
+	tester.InitServer(`
+	{
+		skip_install_trust
+		admin localhost:2999
+		http_port `+testPort+`
+		https_port 9443
 
-	# HELP frankenphp_testdata_index_php_ready_workers Running workers that have successfully called frankenphp_handle_request at least once
-	# TYPE frankenphp_testdata_index_php_ready_workers gauge
-	frankenphp_testdata_index_php_ready_workers 2
+		frankenphp {
+			worker {
+				name my_app
+				file ../testdata/index.php
+				num 2
+			}
+		}
+	}
 
-	# HELP frankenphp_testdata_index_php_worker_crashes Number of PHP worker crashes for this worker
-	# TYPE frankenphp_testdata_index_php_worker_crashes counter
-	frankenphp_testdata_index_php_worker_crashes 0
+	localhost:`+testPort+` {
+		route {
+			php {
+				root ../testdata
+			}
+		}
+	}
+	`, "caddyfile")
 
-	# HELP frankenphp_testdata_index_php_worker_restarts Number of PHP worker restarts for this worker
-	# TYPE frankenphp_testdata_index_php_worker_restarts counter
-	frankenphp_testdata_index_php_worker_restarts 0
+	// Make some requests
+	for i := 0; i < 10; i++ {
+		wg.Add(1)
+		go func(i int) {
+			tester.AssertGetResponse(fmt.Sprintf("http://localhost:"+testPort+"/index.php?i=%d", i), http.StatusOK, fmt.Sprintf("I am by birth a Genevese (%d)", i))
+			wg.Done()
+		}(i)
+	}
+	wg.Wait()
+
+	// Fetch metrics
+	resp, err := http.Get("http://localhost:2999/metrics")
+	if err != nil {
+		t.Fatalf("failed to fetch metrics: %v", err)
+	}
+	defer resp.Body.Close()
+
+	// Read and parse metrics
+	metrics := new(bytes.Buffer)
+	_, err = metrics.ReadFrom(resp.Body)
+	if err != nil {
+		t.Fatalf("failed to read metrics: %v", err)
+	}
+
+	cpus := fmt.Sprintf("%d", frankenphp.MaxThreads)
+
+	// Check metrics
+	expectedMetrics := `
+	# HELP frankenphp_total_threads Total number of PHP threads
+	# TYPE frankenphp_total_threads counter
+	frankenphp_total_threads ` + cpus + `
+
+	# HELP frankenphp_busy_threads Number of busy PHP threads
+	# TYPE frankenphp_busy_threads gauge
+	frankenphp_busy_threads 2
+
+	# HELP frankenphp_busy_workers Number of busy PHP workers for this worker
+        # TYPE frankenphp_busy_workers gauge
+        frankenphp_busy_workers{worker="my_app"} 0
+
+	# HELP frankenphp_total_workers Total number of PHP workers for this worker
+	# TYPE frankenphp_total_workers gauge
+	frankenphp_total_workers{worker="my_app"} 2
+
+	# HELP frankenphp_worker_request_count
+	# TYPE frankenphp_worker_request_count counter
+	frankenphp_worker_request_count{worker="my_app"} 10
+
+	# HELP frankenphp_ready_workers Running workers that have successfully called frankenphp_handle_request at least once
+	# TYPE frankenphp_ready_workers gauge
+	frankenphp_ready_workers{worker="my_app"} 2
 	`
 
 	ctx := caddy.ActiveContext()
@@ -499,13 +588,12 @@ func TestWorkerMetrics(t *testing.T) {
 			strings.NewReader(expectedMetrics),
 			"frankenphp_total_threads",
 			"frankenphp_busy_threads",
-			"frankenphp_testdata_index_php_busy_workers",
-			"frankenphp_testdata_index_php_total_workers",
-			"frankenphp_testdata_index_php_worker_request_count",
-			"frankenphp_testdata_index_php_worker_crashes",
-			"frankenphp_testdata_index_php_worker_restarts",
-			"frankenphp_testdata_index_php_ready_workers",
-		))
+			"frankenphp_busy_workers",
+			"frankenphp_total_workers",
+			"frankenphp_worker_request_count",
+			"frankenphp_ready_workers",
+		),
+	)
 }
 
 func TestAutoWorkerConfig(t *testing.T) {
@@ -532,6 +620,8 @@ func TestAutoWorkerConfig(t *testing.T) {
 	}
 	`, "caddyfile")
 
+	workerName, _ := fastabs.FastAbs("../testdata/index.php")
+
 	// Make some requests
 	for i := 0; i < 10; i++ {
 		wg.Add(1)
@@ -569,29 +659,21 @@ func TestAutoWorkerConfig(t *testing.T) {
 	# TYPE frankenphp_busy_threads gauge
 	frankenphp_busy_threads ` + workers + `
 
-	# HELP frankenphp_testdata_index_php_busy_workers Number of busy PHP workers for this worker
-	# TYPE frankenphp_testdata_index_php_busy_workers gauge
-	frankenphp_testdata_index_php_busy_workers 0
-
-	# HELP frankenphp_testdata_index_php_total_workers Total number of PHP workers for this worker
-	# TYPE frankenphp_testdata_index_php_total_workers gauge
-	frankenphp_testdata_index_php_total_workers ` + workers + `
-
-	# HELP frankenphp_testdata_index_php_worker_request_count
-	# TYPE frankenphp_testdata_index_php_worker_request_count counter
-	frankenphp_testdata_index_php_worker_request_count 10
+	# HELP frankenphp_busy_workers Number of busy PHP workers for this worker
+	# TYPE frankenphp_busy_workers gauge
+	frankenphp_busy_workers{worker="` + workerName + `"} 0
 
-	# HELP frankenphp_testdata_index_php_ready_workers Running workers that have successfully called frankenphp_handle_request at least once
-	# TYPE frankenphp_testdata_index_php_ready_workers gauge
-	frankenphp_testdata_index_php_ready_workers ` + workers + `
+	# HELP frankenphp_total_workers Total number of PHP workers for this worker
+	# TYPE frankenphp_total_workers gauge
+	frankenphp_total_workers{worker="` + workerName + `"} ` + workers + `
 
-	# HELP frankenphp_testdata_index_php_worker_crashes Number of PHP worker crashes for this worker
-	# TYPE frankenphp_testdata_index_php_worker_crashes counter
-	frankenphp_testdata_index_php_worker_crashes 0
+	# HELP frankenphp_worker_request_count
+	# TYPE frankenphp_worker_request_count counter
+	frankenphp_worker_request_count{worker="` + workerName + `"} 10
 
-	# HELP frankenphp_testdata_index_php_worker_restarts Number of PHP worker restarts for this worker
-	# TYPE frankenphp_testdata_index_php_worker_restarts counter
-	frankenphp_testdata_index_php_worker_restarts 0
+	# HELP frankenphp_ready_workers Running workers that have successfully called frankenphp_handle_request at least once
+	# TYPE frankenphp_ready_workers gauge
+	frankenphp_ready_workers{worker="` + workerName + `"} ` + workers + `
 	`
 
 	ctx := caddy.ActiveContext()
@@ -601,12 +683,10 @@ func TestAutoWorkerConfig(t *testing.T) {
 			strings.NewReader(expectedMetrics),
 			"frankenphp_total_threads",
 			"frankenphp_busy_threads",
-			"frankenphp_testdata_index_php_busy_workers",
-			"frankenphp_testdata_index_php_total_workers",
-			"frankenphp_testdata_index_php_worker_request_count",
-			"frankenphp_testdata_index_php_worker_crashes",
-			"frankenphp_testdata_index_php_worker_restarts",
-			"frankenphp_testdata_index_php_ready_workers",
+			"frankenphp_busy_workers",
+			"frankenphp_total_workers",
+			"frankenphp_worker_request_count",
+			"frankenphp_ready_workers",
 		))
 }
 

frankenphp.go

@@ -253,7 +253,7 @@ func calculateMaxThreads(opt *opt) (int, int, int, error) {
 			// https://github.com/dunglas/frankenphp/issues/126
 			opt.workers[i].num = maxProcs
 		}
-		metrics.TotalWorkers(w.fileName, w.num)
+		metrics.TotalWorkers(w.name, w.num)
 
 		numWorkers += opt.workers[i].num
 	}

frankenphp_test.go

@@ -9,7 +9,6 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/dunglas/frankenphp/internal/fastabs"
 	"io"
 	"log"
 	"mime/multipart"
@@ -27,6 +26,8 @@ import (
 	"sync"
 	"testing"
 
+	"github.com/dunglas/frankenphp/internal/fastabs"
+
 	"github.com/dunglas/frankenphp"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -64,7 +65,7 @@ func runTest(t *testing.T, test func(func(http.ResponseWriter, *http.Request), *
 
 	initOpts := []frankenphp.Option{frankenphp.WithLogger(opts.logger)}
 	if opts.workerScript != "" {
-		initOpts = append(initOpts, frankenphp.WithWorkers(testDataDir+opts.workerScript, opts.nbWorkers, opts.env, opts.watch))
+		initOpts = append(initOpts, frankenphp.WithWorkers("workerName", testDataDir+opts.workerScript, opts.nbWorkers, opts.env, opts.watch))
 	}
 	initOpts = append(initOpts, opts.initOpts...)
 

go.mod

@@ -20,6 +20,7 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dolthub/maphash v0.1.0 // indirect
 	github.com/gammazero/deque v1.0.0 // indirect
+	github.com/kylelemons/godebug v1.1.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect

go.sum

@@ -16,6 +16,8 @@ github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
 github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
+github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
 github.com/maypok86/otter v1.2.4 h1:HhW1Pq6VdJkmWwcZZq19BlEQkHtI8xgsQzBVXJU0nfc=
 github.com/maypok86/otter v1.2.4/go.mod h1:mKLfoI7v1HOmQMwFgX4QkRk23mX6ge3RDvjdHOWG4R4=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=