BREAKING CHANGES: rename LOG_ADDITIONAL_FIELD to LOG_EXTRA_FIELD

Author: gi8lino

README.md

@@ -14,7 +14,7 @@ TACO accepts the following environment variables:
 - `TARGET_NAME`: The name of the target to check (optional, default: inferred from `TARGET_ADDRESS`)\*.
 - `INTERVAL`: The interval between connection attempts (optional, default: `2s`).
 - `DIAL_TIMEOUT`: The timeout for each connection attempt (optional, default: `1s`).
-- `LOG_ADDITIONAL_FIELDS`: Log additional fields (optional, default: `false`).
+- `LOG_EXTRA_FIELDS`: Log additional fields (optional, default: `false`).
 
 **\*** If `TARGET_NAME` is not set, the name will be inferred from the host part of the target address as follows: `postgres.default.svc.cluster.local:5432` will be inferred as `postgres`.
 
@@ -32,7 +32,7 @@ graph TD;
 
 ## Logging
 
-With the `LOG_ADDITIONAL_FIELDS` environment variable set to `true` additional fields will be logged.
+With the `LOG_EXTRA_FIELDS` environment variable set to `true` additional fields will be logged.
 
 ### With additional fields
 
@@ -67,7 +67,7 @@ initContainers:
       # TARGET_NAME inferred from the target address "valkey.default.svc.cluster.local" which is okay for this use case
       # INTERVAL defaults to 2 seconds which is okay for this use case
       # DIAL_TIMEOUT defaults to 1 seconds which is okay for this use case
-      - name: LOG_ADDITIONAL_FIELDS
+      - name: LOG_EXTRA_FIELDS
         value: "true"
   - name: wait-for-postgres
     image: ghcr.io/containeroo/taco:latest

cmd/taco/main.go

@@ -14,34 +14,34 @@ import (
 	"time"
 )
 
-const version = "0.0.25"
+const version = "0.0.26"
 
 const (
-	envTargetName          = "TARGET_NAME"
-	envTargetAddress       = "TARGET_ADDRESS"
-	envInterval            = "INTERVAL"
-	envDialTimeout         = "DIAL_TIMEOUT"
-	envLogAdditionalFields = "LOG_ADDITIONAL_FIELDS"
+	envTargetName     = "TARGET_NAME"
+	envTargetAddress  = "TARGET_ADDRESS"
+	envInterval       = "INTERVAL"
+	envDialTimeout    = "DIAL_TIMEOUT"
+	envLogExtraFields = "LOG_EXTRA_FIELDS"
 )
 
 // Config holds the required environment variables.
 type Config struct {
-	TargetName          string        // The name of the target to check.
-	TargetAddress       string        // The address of the target in the format 'host:port'.
-	Interval            time.Duration // The interval between connection attempts.
-	DialTimeout         time.Duration // The timeout for each connection attempt.
-	LogAdditionalFields bool          // Whether to log the fields in the log message.
+	TargetName     string        // The name of the target to check.
+	TargetAddress  string        // The address of the target in the format 'host:port'.
+	Interval       time.Duration // The interval between connection attempts.
+	DialTimeout    time.Duration // The timeout for each connection attempt.
+	LogExtraFields bool          // Whether to log the fields in the log message.
 }
 
 // parseConfig retrieves and parses the required environment variables.
 // Provides default values if the environment variables are not set.
 func parseConfig(getenv func(string) string) (Config, error) {
 	cfg := Config{
-		TargetName:          getenv(envTargetName),
-		TargetAddress:       getenv(envTargetAddress),
-		Interval:            2 * time.Second, // default interval
-		DialTimeout:         1 * time.Second, // default dial timeout
-		LogAdditionalFields: false,
+		TargetName:     getenv(envTargetName),
+		TargetAddress:  getenv(envTargetAddress),
+		Interval:       2 * time.Second, // default interval
+		DialTimeout:    1 * time.Second, // default dial timeout
+		LogExtraFields: false,
 	}
 
 	if intervalStr := getenv(envInterval); intervalStr != "" {
@@ -60,11 +60,11 @@ func parseConfig(getenv func(string) string) (Config, error) {
 		}
 	}
 
-	if logFieldsStr := getenv(envLogAdditionalFields); logFieldsStr != "" {
+	if logFieldsStr := getenv(envLogExtraFields); logFieldsStr != "" {
 		var err error
-		cfg.LogAdditionalFields, err = strconv.ParseBool(logFieldsStr)
+		cfg.LogExtraFields, err = strconv.ParseBool(logFieldsStr)
 		if err != nil {
-			return Config{}, fmt.Errorf("invalid %s value: %s", envLogAdditionalFields, err)
+			return Config{}, fmt.Errorf("invalid %s value: %s", envLogExtraFields, err)
 		}
 	}
 
@@ -107,7 +107,7 @@ func validateConfig(cfg *Config) error {
 func setupLogger(cfg Config, output io.Writer) *slog.Logger {
 	handlerOpts := &slog.HandlerOptions{}
 
-	if cfg.LogAdditionalFields {
+	if cfg.LogExtraFields {
 		return slog.New(slog.NewTextHandler(output, handlerOpts)).With(
 			slog.String("target_address", cfg.TargetAddress),
 			slog.String("interval", cfg.Interval.String()),

cmd/taco/main_test.go

@@ -17,11 +17,11 @@ func TestParseEnv(t *testing.T) {
 		t.Parallel()
 
 		env := map[string]string{
-			"TARGET_NAME":           "database",
-			"TARGET_ADDRESS":        "localhost:5432",
-			"INTERVAL":              "1s",
-			"DIAL_TIMEOUT":          "1s",
-			"LOG_ADDITIONAL_FIELDS": "true",
+			"TARGET_NAME":      "database",
+			"TARGET_ADDRESS":   "localhost:5432",
+			"INTERVAL":         "1s",
+			"DIAL_TIMEOUT":     "1s",
+			"LOG_EXTRA_FIELDS": "true",
 		}
 
 		getenv := func(key string) string {
@@ -34,11 +34,11 @@ func TestParseEnv(t *testing.T) {
 		}
 
 		expected := Config{
-			TargetName:          "database",
-			TargetAddress:       "localhost:5432",
-			Interval:            1 * time.Second,
-			DialTimeout:         1 * time.Second,
-			LogAdditionalFields: true,
+			TargetName:     "database",
+			TargetAddress:  "localhost:5432",
+			Interval:       1 * time.Second,
+			DialTimeout:    1 * time.Second,
+			LogExtraFields: true,
 		}
 		if !reflect.DeepEqual(cfg, expected) {
 			t.Errorf("Expected %+v, got %+v", expected, cfg)
@@ -89,11 +89,11 @@ func TestParseEnv(t *testing.T) {
 		}
 	})
 
-	t.Run("Invalid LOG_ADDITIONAL_FIELDS", func(t *testing.T) {
+	t.Run("Invalid LOG_EXTRA_FIELDS", func(t *testing.T) {
 		t.Parallel()
 
 		env := map[string]string{
-			"LOG_ADDITIONAL_FIELDS": "tr",
+			"LOG_EXTRA_FIELDS": "tr",
 		}
 
 		getenv := func(key string) string {
@@ -105,7 +105,7 @@ func TestParseEnv(t *testing.T) {
 			t.Error("Expected error but got none")
 		}
 
-		expected := fmt.Sprintf("invalid LOG_ADDITIONAL_FIELDS value: strconv.ParseBool: parsing \"%s\": invalid syntax", env["LOG_ADDITIONAL_FIELDS"])
+		expected := fmt.Sprintf("invalid LOG_EXTRA_FIELDS value: strconv.ParseBool: parsing \"%s\": invalid syntax", env["LOG_EXTRA_FIELDS"])
 		if err.Error() != expected {
 			t.Errorf("Expected output %q but got %q", expected, err.Error())
 		}
@@ -366,11 +366,11 @@ func TestWaitForTarget(t *testing.T) {
 		t.Parallel()
 
 		cfg := Config{
-			TargetName:          "PostgreSQL",
-			TargetAddress:       "localhost:5432",
-			Interval:            50 * time.Millisecond,
-			DialTimeout:         50 * time.Millisecond,
-			LogAdditionalFields: true,
+			TargetName:     "PostgreSQL",
+			TargetAddress:  "localhost:5432",
+			Interval:       50 * time.Millisecond,
+			DialTimeout:    50 * time.Millisecond,
+			LogExtraFields: true,
 		}
 
 		var wg sync.WaitGroup
@@ -677,11 +677,11 @@ func TestRun(t *testing.T) {
 		t.Parallel()
 
 		env := map[string]string{
-			"TARGET_NAME":           "database",
-			"TARGET_ADDRESS":        "localhost:8092",
-			"INTERVAL":              "1s",
-			"DIAL_TIMEOUT":          "1s",
-			"LOG_ADDITIONAL_FIELDS": "true",
+			"TARGET_NAME":      "database",
+			"TARGET_ADDRESS":   "localhost:8092",
+			"INTERVAL":         "1s",
+			"DIAL_TIMEOUT":     "1s",
+			"LOG_EXTRA_FIELDS": "true",
 		}
 
 		getenv := func(key string) string {