Skip to content

feat(platform-api): include user-agent in access logs #3277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
renuka-fernando wants to merge 1 commit into
base: platform-api/v0.10.x
Choose a base branch
from
Open

feat(platform-api): include user-agent in access logs #3277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions platform-api/src/internal/server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,8 +328,11 @@ func StartPlatformAPIServer(cfg *config.Server, slogger *slog.Logger) (*Server,
gin.SetMode(gin.ReleaseMode)
}

// Setup router
router := gin.Default()
// Setup router. Use gin.New() with explicit middleware (instead of gin.Default())
// so the access log can include the request User-Agent.
router := gin.New()
router.Use(gin.LoggerWithFormatter(accessLogFormatter))
router.Use(gin.Recovery())

// Configure and apply CORS middleware first (before auth middleware)
corsConfig := cors.DefaultConfig()
Expand Down Expand Up @@ -445,6 +448,26 @@ func StartPlatformAPIServer(cfg *config.Server, slogger *slog.Logger) (*Server,
}, nil
}

// accessLogFormatter mirrors gin's default access-log format (without color)
// and appends the request's User-Agent so the client is identified in the logs.
func accessLogFormatter(param gin.LogFormatterParams) string {
latency := param.Latency
if latency > time.Minute {
latency = latency.Truncate(time.Second)
}

return fmt.Sprintf("[GIN] %v | %3d | %13v | %15s | %-7s %#v | %q\n%s",
param.TimeStamp.Format("2006/01/02 - 15:04:05"),
param.StatusCode,
latency,
param.ClientIP,
param.Method,
param.Path,
param.Request.UserAgent(),
param.ErrorMessage,
)
}

// demoMode reports whether APIP_DEMO_MODE is enabled.
// Defaults to true when the variable is unset.
func demoMode() bool {
Expand Down