feat: make logging configurable

Author: davidramiro

Dockerfile

@@ -0,0 +1,12 @@
+FROM golang:1.22
+
+WORKDIR /app
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . ./
+
+RUN CGO_ENABLED=0 GOOS=linux go build -o /frigabun
+EXPOSE 9595
+
+CMD ["/frigabun"]

config.sample.toml

@@ -1,9 +1,15 @@
 [api]
 port = 9595
+# log /api/status health check endpoint requests
 enableStatusLog = false
+# true for pretty, false for json logging
+prettyLog = true
+# log level, debug/info
+logLevel = "info"
+
 
 [gandi]
-enabled = true
+enabled = false
 baseUrl = "https://dns.api.gandi.net/api/v5"
 ttl = 1800
 apiKey = ""

internal/api/api.go

@@ -35,15 +35,14 @@ func NewUpdateApi(dnsServiceFactory factory.ServiceFactory) *UpdateApi {
 func (u *UpdateApi) HandleUpdateRequest(c echo.Context) error {
 	var request UpdateRequest
 
-	logger := log.With().Str("subdomains", request.Subdomains).Str("domain", request.Domain).Str("IP", request.IP).Logger()
-
 	err := c.Bind(&request)
 	if err != nil {
 		log.Error().Err(err).Msg(ErrCannotParseRequest.Error())
 		return c.String(http.StatusBadRequest, ErrCannotParseRequest.Error())
 	}
 
-	logger.Info().Msg("request received")
+	logger := log.With().Str("subdomains", request.Subdomains).Str("domain", request.Domain).Str("IP", request.IP).Logger()
+	logger.Info().Msg("dns update request received")
 
 	err = validateRequest(request.Domain, request.IP)
 	if err != nil {
@@ -53,14 +52,15 @@ func (u *UpdateApi) HandleUpdateRequest(c echo.Context) error {
 
 	subdomains := strings.Split(request.Subdomains, ",")
 
-	successfulUpdates := 0
+	count := len(subdomains)
 
-	if len(subdomains) == 0 || subdomains[0] == "" {
+	if count == 0 || subdomains[0] == "" {
 		logger.Error().Err(ErrMissingParameter).Msg(ErrMissingParameter.Error())
 		return c.String(http.StatusBadRequest, ErrMissingParameter.Error())
 	}
 
 	for i := range subdomains {
+		logger.Debug().Msgf("handling subdomain %d of %d", i+1, len(subdomains))
 
 		service, err := u.dnsServiceFactory.Find(services.Registrar(request.Registrar))
 		if err != nil {
@@ -80,13 +80,11 @@ func (u *UpdateApi) HandleUpdateRequest(c echo.Context) error {
 			return c.String(http.StatusInternalServerError, err.Error())
 		}
 
-		successfulUpdates++
 	}
 
-	logger.Info().Int("updates", successfulUpdates).Msg("successfully created")
-
-	return c.String(http.StatusOK, fmt.Sprintf("created %d entries for subdomains %s on %s: %s", successfulUpdates, request.Subdomains, request.Domain, request.IP))
+	logger.Info().Int("updates", count).Msg("successfully created")
 
+	return c.String(http.StatusOK, fmt.Sprintf("created %d entries for subdomains %s on %s: %s", count, request.Subdomains, request.Domain, request.IP))
 }
 
 func (u *UpdateApi) HandleStatusCheck(c echo.Context) error {

main.go

@@ -6,9 +6,11 @@ import (
 	"github.com/davidramiro/frigabun/services/factory"
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"
+	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/viper"
 	"strings"
+	"time"
 )
 
 func main() {
@@ -24,7 +26,18 @@ func main() {
 		log.Fatal().Err(err).Msg("could not read config file")
 	}
 
-	log.Info().Msg("setting up server")
+	if viper.GetBool("api.prettyLog") {
+		log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr, TimeFormat: time.RFC3339})
+	}
+
+	switch viper.GetString("api.logLevel") {
+	case "info":
+		zerolog.SetGlobalLevel(zerolog.InfoLevel)
+	case "debug":
+		zerolog.SetGlobalLevel(zerolog.DebugLevel)
+	}
+
+	log.Info().Msg("starting frigabun")
 
 	e := echo.New()
 	e.HideBanner = true

services/cloudflare.go

@@ -68,7 +68,7 @@ func (c *CloudflareDnsUpdateService) UpdateRecord(request *DynDnsRequest) error
 		c.zoneId)
 
 	logger := log.With().Str("func", "UpdateRecord").Str("registrar", "cloudflare").Str("endpoint", endpoint).Str("domain", request.Domain).Str("subdomain", request.Subdomain).Logger()
-	logger.Info().Msg("building update request")
+	logger.Debug().Msg("building update request")
 
 	req, err := http.NewRequest("GET", endpoint, nil)
 
@@ -99,6 +99,7 @@ func (c *CloudflareDnsUpdateService) UpdateRecord(request *DynDnsRequest) error
 	var id string
 
 	if len(r.Errors) == 0 && len(r.Result) > 0 {
+		logger.Debug().Int("entries", len(r.Result)).Msg("comparing entries with update request")
 		for _, e := range r.Result {
 			if e.Name == fmt.Sprintf("%s.%s", request.Subdomain, request.Domain) {
 				id = e.Id
@@ -127,7 +128,7 @@ func (c *CloudflareDnsUpdateService) newRecord(request *DynDnsRequest) error {
 		c.zoneId)
 
 	logger := log.With().Str("func", "newRecord").Str("registrar", "cloudflare").Str("subdomain", cloudflareRequest.Subdomain).Str("endpoint", endpoint).Str("IP", cloudflareRequest.IP).Logger()
-	logger.Info().Msg("building new record request")
+	logger.Debug().Msg("building new record request")
 
 	body, err := json.Marshal(cloudflareRequest)
 	if err != nil {
@@ -157,7 +158,7 @@ func (c *CloudflareDnsUpdateService) newRecord(request *DynDnsRequest) error {
 		return ErrRegistrarRejectedRequest
 	}
 
-	logger.Info().Msg("request for new record successful")
+	logger.Debug().Msg("request for new record successful")
 
 	return nil
 }

services/factory/dns_update_service_factory.go

@@ -2,6 +2,7 @@ package factory
 
 import (
 	"github.com/davidramiro/frigabun/services"
+	"github.com/rs/zerolog/log"
 	"github.com/spf13/viper"
 )
 
@@ -16,11 +17,14 @@ type DnsUpdateServiceFactory struct {
 }
 
 func NewDnsUpdateServiceFactory() (*DnsUpdateServiceFactory, error) {
+	log.Debug().Msg("initializing dns service factory")
+
 	factory := &DnsUpdateServiceFactory{
 		services: make(map[services.Registrar]services.DnsUpdateService),
 	}
 
 	if viper.GetBool("cloudflare.enabled") {
+		log.Debug().Msg("cloudflare enabled, registering")
 		cloudflareService, err := services.NewCloudflareDnsUpdateService(nil)
 		if err != nil {
 			return nil, err
@@ -30,6 +34,7 @@ func NewDnsUpdateServiceFactory() (*DnsUpdateServiceFactory, error) {
 	}
 
 	if viper.GetBool("gandi.enabled") {
+		log.Debug().Msg("gandi enabled, registering")
 		gandiService, err := services.NewGandiDnsUpdateService(nil)
 		if err != nil {
 			return nil, err
@@ -39,6 +44,7 @@ func NewDnsUpdateServiceFactory() (*DnsUpdateServiceFactory, error) {
 	}
 
 	if viper.GetBool("porkbun.enabled") {
+		log.Debug().Msg("porkbun enabled, registering")
 		porkbunService, err := services.NewPorkbunDnsUpdateService(nil)
 		if err != nil {
 			return nil, err
@@ -47,6 +53,10 @@ func NewDnsUpdateServiceFactory() (*DnsUpdateServiceFactory, error) {
 		factory.Register(porkbunService)
 	}
 
+	if len(factory.services) == 0 {
+		log.Fatal().Msg("no services registered, config invalid")
+	}
+
 	return factory, nil
 }
 
@@ -61,6 +71,7 @@ func (df *DnsUpdateServiceFactory) Register(service services.DnsUpdateService) {
 }
 
 func (df *DnsUpdateServiceFactory) Find(registrar services.Registrar) (service services.DnsUpdateService, err error) {
+	log.Debug().Interface("registrar", registrar).Msg("fetching dns service from factory")
 
 	service, ok := df.services[registrar]
 	if !ok {

services/gandi.go

@@ -48,11 +48,6 @@ type GandiApiRequest struct {
 	IPValues  []string `json:"rrset_values"`
 }
 
-type GandiUpdateError struct {
-	Code    int
-	Message string
-}
-
 func (g *GandiDnsUpdateService) UpdateRecord(request *DynDnsRequest) error {
 
 	gandiRequest := &GandiApiRequest{

services/porkbun.go

@@ -60,11 +60,6 @@ type PorkbunQueryResponse struct {
 	} `json:"records"`
 }
 
-type PorkbunUpdateError struct {
-	Code    int
-	Message string
-}
-
 func (p *PorkbunDnsUpdateService) UpdateRecord(request *DynDnsRequest) error {
 
 	porkbunRequest := &PorkbunApiRequest{