feat: optionally log /healthcheck, fixes #55

Signed-off-by: Chris Gianelloni <[email protected]>

Author: wolf31o2

config.yaml.example

@@ -8,6 +8,11 @@ logging:
   # This can also be set via the LOGGING_LEVEL environment variable
   level: info
 
+  # Health checks
+  #
+  # This can also be set via the LOGGING_HEALTHCHECKS environment variable
+  healthchecks: false
+
 api:
   # Listen address for the API
   #

internal/api/api.go

@@ -43,16 +43,21 @@ func Start(cfg *config.Config) error {
 	router := gin.New()
 	// Catch panics and return a 500
 	router.Use(gin.Recovery())
+	// Standard logging
+	logger := logging.GetLogger()
 	// Access logging
 	accessLogger := logging.GetAccessLogger()
+	skipPaths := []string{}
+	if cfg.Logging.Healthchecks {
+		skipPaths = append(skipPaths, "/healthcheck")
+		logger.Infof("disabling access logs for /healthcheck")
+	}
 	router.Use(ginzap.GinzapWithConfig(accessLogger, &ginzap.Config{
 		TimeFormat: time.RFC3339,
 		UTC: true,
-		SkipPaths: []string{"/healthcheck"},
+		SkipPaths: skipPaths,
 	}))
 	router.Use(ginzap.RecoveryWithZap(accessLogger, true))
-	// Standard logging
-	logger := logging.GetLogger()
 
 	// Create a healthcheck (before metrics so it's not instrumented)
 	router.GET("/healthcheck", handleHealthcheck)

internal/config/config.go

@@ -18,7 +18,8 @@ type Config struct {
 }
 
 type LoggingConfig struct {
-	Level string `yaml:"level" envconfig:"LOGGING_LEVEL"`
+	Healthchecks bool   `yaml:"healthchecks" envconfig:"LOGGING_HEALTHCHECKS"`
+	Level        string `yaml:"level" envconfig:"LOGGING_LEVEL"`
 }
 
 type ApiConfig struct {
@@ -47,7 +48,8 @@ type NodeConfig struct {
 // Singleton config instance with default values
 var globalConfig = &Config{
 	Logging: LoggingConfig{
-		Level: "info",
+		Level:        "info",
+		Healthchecks: false,
 	},
 	Api: ApiConfig{
 		ListenAddress:  "",