update docs

Author: efectn

docs/api/hooks.md

@@ -186,12 +186,31 @@ func main() {
 | `ChildPIDs` | `[]int` | Child process identifiers when preforking. |
 | `ColorScheme` | [`Colors`](https://github.com/gofiber/fiber/blob/main/color.go) | Active color scheme for the startup message. |
 
-### Startup message customization
+### Startup Message Customization
 
-Use `OnPreStartupMessage` to tweak the banner before Fiber prints it, and `OnPostStartupMessage` to run logic after the banner is printed (or skipped):
+Use `OnPreStartupMessage` to tweak the banner before Fiber prints it, and `OnPostStartupMessage` to run logic after the banner is printed (or skipped). You can use some helper functions to customize the banner inside the `OnPreStartupMessage` hook.
 
-- Assign `sm.Header` to override the ASCII art banner. Leave it empty to use the default.
-- Provide `sm.PrimaryInfo` and/or `sm.SecondaryInfo` maps to replace the primary (server URL, handler counts, etc.) and secondary (prefork status, PID, process count) sections.
+```go title="Signatures"
+// AddInfo adds an informational entry to the startup message with "INFO" label.
+func (sm *PreStartupMessageData) AddInfo(key, title, value string, priority ...int)
+
+// AddWarning adds a warning entry to the startup message with "WARNING" label.
+func (sm *PreStartupMessageData) AddWarning(key, title, value string, priority ...int)
+
+// AddError adds an error entry to the startup message with "ERROR" label.
+func (sm *PreStartupMessageData) AddError(key, title, value string, priority ...int)
+
+// EntryKeys returns all entry keys currently present in the startup message.
+func (sm *PreStartupMessageData) EntryKeys() []string
+
+// ResetEntries removes all existing entries from the startup message.
+func (sm *PreStartupMessageData) ResetEntries()
+
+// DeleteEntry removes a specific entry from the startup message by its key.
+func (sm *PreStartupMessageData) DeleteEntry(key string)
+```
+
+- Assign `sm.BannerHeader` to override the ASCII art banner. Leave it empty to use the default banner provided by Fiber.
 - Set `sm.PreventDefault = true` to suppress the built-in banner without affecting other hooks.
 - `PostStartupMessageData` reports whether the banner was skipped via the `Disabled`, `IsChild`, and `Prevented` flags.
 
@@ -210,8 +229,12 @@ func main() {
 
     app.Hooks().OnPreStartupMessage(func(sm *fiber.PreStartupMessageData) error {
         sm.Header = "FOOBER " + sm.Version + "\n-------"
-        sm.PrimaryInfo = fiber.Map{"Git hash": os.Getenv("GIT_HASH")}
-        sm.SecondaryInfo = fiber.Map{"Prefork": sm.Prefork}
+
+        // Optional: you can also remove old entries
+        // sm.ResetEntries()
+
+        sm.AddInfo("git-hash", "Git hash", os.Getenv("GIT_HASH"))
+        sm.AddInfo("prefork", "Prefork", fmt.Sprintf("%v", sm.Prefork), 15)
         return nil
     })
 

docs/whats_new.md

@@ -295,27 +295,41 @@ app.Listen("app.sock", fiber.ListenerConfig{
 })
 ```
 
-- Expanded `ListenData` with versioning, handler, process, and PID metadata, plus dedicated startup message hooks for customization.
+- Expanded `ListenData` with versioning, handler, process, and PID metadata, plus dedicated startup message hooks for customization. Check out the [Hooks](./api/hooks#startup-message-customization) documentation for further details.
 
-```go
-app := fiber.New()
+```go title="Customize the startup message"
+package main
 
-app.Hooks().OnPreStartupMessage(func(sm *fiber.PreStartupMessageData) error {
-    sm.Header = "FOOBER " + sm.Version + "\n-------"
-    sm.PrimaryInfo = fiber.Map{"Git hash": os.Getenv("GIT_HASH")}
-    sm.SecondaryInfo = fiber.Map{"Process count": sm.ProcessCount}
-    // Set sm.PreventDefault = true to suppress the default banner entirely.
-    return nil
-})
+import (
+    "fmt"
+    "os"
 
-app.Hooks().OnPostStartupMessage(func(sm fiber.PostStartupMessageData) error {
-    if !sm.Disabled && !sm.IsChild && !sm.Prevented {
-        log.Println("startup completed")
-    }
-    return nil
-})
+    "github.com/gofiber/fiber/v3"
+)
 
-go app.Listen(":3000")
+func main() {
+    app := fiber.New()
+
+    app.Hooks().OnPreStartupMessage(func(sm *fiber.PreStartupMessageData) error {
+        sm.Header = "FOOBER " + sm.Version + "\n-------"
+
+        // Optional: you can also remove old entries
+        // sm.ResetEntries()
+
+        sm.AddInfo("git-hash", "Git hash", os.Getenv("GIT_HASH"))
+        sm.AddInfo("prefork", "Prefork", fmt.Sprintf("%v", sm.Prefork), 15)
+        return nil
+    })
+
+    app.Hooks().OnPostStartupMessage(func(sm fiber.PostStartupMessageData) error {
+        if !sm.Disabled && !sm.IsChild && !sm.Prevented {
+            fmt.Println("startup completed")
+        }
+        return nil
+    })
+
+    app.Listen(":5000")
+}
 ```
 
 ## 🗺 Router

hooks.go

@@ -59,6 +59,8 @@ const (
 	StartupMessageLevelError
 )
 
+const errString = "ERROR"
+
 // startupMessageEntry represents a single line of startup message information.
 type startupMessageEntry struct {
 	key      string
@@ -90,13 +92,16 @@ type ListenData struct {
 type PreStartupMessageData struct {
 	*ListenData
 
-	Header string
+	// BannerHeader allows overriding the ASCII art banner displayed at startup.
+	BannerHeader string
 
 	entries []startupMessageEntry
 
+	// PreventDefault, when set to true, suppresses the default startup message.
 	PreventDefault bool
 }
 
+// AddInfo adds an informational entry to the startup message with "INFO" label.
 func (sm *PreStartupMessageData) AddInfo(key, title, value string, priority ...int) {
 	pri := -1
 	if len(priority) > 0 {
@@ -106,6 +111,7 @@ func (sm *PreStartupMessageData) AddInfo(key, title, value string, priority ...i
 	sm.addEntry(key, title, value, pri, StartupMessageLevelInfo)
 }
 
+// AddWarning adds a warning entry to the startup message with "WARNING" label.
 func (sm *PreStartupMessageData) AddWarning(key, title, value string, priority ...int) {
 	pri := -1
 	if len(priority) > 0 {
@@ -115,6 +121,7 @@ func (sm *PreStartupMessageData) AddWarning(key, title, value string, priority .
 	sm.addEntry(key, title, value, pri, StartupMessageLevelWarning)
 }
 
+// AddError adds an error entry to the startup message with "ERROR" label.
 func (sm *PreStartupMessageData) AddError(key, title, value string, priority ...int) {
 	pri := -1
 	if len(priority) > 0 {
@@ -124,6 +131,7 @@ func (sm *PreStartupMessageData) AddError(key, title, value string, priority ...
 	sm.addEntry(key, title, value, pri, StartupMessageLevelError)
 }
 
+// EntryKeys returns all entry keys currently present in the startup message.
 func (sm *PreStartupMessageData) EntryKeys() []string {
 	keys := make([]string, 0, len(sm.entries))
 	for _, entry := range sm.entries {
@@ -132,10 +140,25 @@ func (sm *PreStartupMessageData) EntryKeys() []string {
 	return keys
 }
 
+// ResetEntries removes all existing entries from the startup message.
 func (sm *PreStartupMessageData) ResetEntries() {
 	sm.entries = sm.entries[:0]
 }
 
+// DeleteEntry removes a specific entry from the startup message by its key.
+func (sm *PreStartupMessageData) DeleteEntry(key string) {
+	if sm.entries == nil {
+		return
+	}
+
+	for i, entry := range sm.entries {
+		if entry.key == key {
+			sm.entries = append(sm.entries[:i], sm.entries[i+1:]...)
+			return
+		}
+	}
+}
+
 func (sm *PreStartupMessageData) addEntry(key, title, value string, priority int, level StartupMessageLevel) {
 	if sm.entries == nil {
 		sm.entries = make([]startupMessageEntry, 0)
@@ -155,19 +178,6 @@ func (sm *PreStartupMessageData) addEntry(key, title, value string, priority int
 	sm.entries = append(sm.entries, startupMessageEntry{key: key, title: title, value: value, level: level, priority: priority})
 }
 
-func (sm *PreStartupMessageData) DeleteEntry(key string) {
-	if sm.entries == nil {
-		return
-	}
-
-	for i, entry := range sm.entries {
-		if entry.key == key {
-			sm.entries = append(sm.entries[:i], sm.entries[i+1:]...)
-			return
-		}
-	}
-}
-
 func newPreStartupMessageData(listenData *ListenData) *PreStartupMessageData {
 	clone := listenData
 	if len(listenData.ChildPIDs) > 0 {
@@ -181,8 +191,13 @@ func newPreStartupMessageData(listenData *ListenData) *PreStartupMessageData {
 type PostStartupMessageData struct {
 	*ListenData
 
-	Disabled  bool
-	IsChild   bool
+	// Disabled indicates whether the startup message was disabled via configuration.
+	Disabled bool
+
+	// IsChild indicates whether the current process is a child in prefork mode.
+	IsChild bool
+
+	// Prevented indicates whether the startup message was suppressed by a pre-startup hook using PreventDefault property.
 	Prevented bool
 }
 

listen.go

@@ -430,8 +430,8 @@ func (app *App) startupMessage(listenData *ListenData, cfg *ListenConfig) {
 		return
 	}
 
-	if preData.Header != "" {
-		header := preData.Header
+	if preData.BannerHeader != "" {
+		header := preData.BannerHeader
 		fmt.Fprint(out, header)
 		if !strings.HasSuffix(header, "\n") {
 			fmt.Fprintln(out)
@@ -481,7 +481,7 @@ func printStartupEntries(out io.Writer, colors *Colors, entries []startupMessage
 		case StartupMessageLevelWarning:
 			label, color = "WARN", colors.Yellow
 		case StartupMessageLevelError:
-			label, color = "ERROR", colors.Red
+			label, color = errString, colors.Red
 		default:
 			label, color = "INFO", colors.Green
 		}

listen_test.go

@@ -630,7 +630,7 @@ func Test_StartupMessageCustomization(t *testing.T) {
 	listenData := app.prepareListenData(":8080", false, &cfg, nil)
 
 	app.Hooks().OnPreStartupMessage(func(data *PreStartupMessageData) error {
-		data.Header = "FOOBER v98\n-------"
+		data.BannerHeader = "FOOBER v98\n-------"
 
 		data.ResetEntries()
 		data.AddInfo("git_hash", "Git hash", "abc123", 3)

services.go

@@ -141,7 +141,7 @@ func (app *App) logServices(ctx context.Context, out io.Writer, colors *Colors)
 		var stateColor string
 		state, err := srv.State(ctx)
 		if err != nil {
-			state = "ERROR"
+			state = errString
 			stateColor = scheme.Red
 		} else {
 			stateColor = scheme.Blue