Skip to content
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.

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

Replace debug with log-level flag #440

Merged
merged 9 commits into from
Oct 16, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
22 changes: 16 additions & 6 deletions cmd/agent/agent.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,6 @@ func loop(c *cli.Context) error {
hostname, _ = os.Hostname()
}

if c.BoolT("debug") {
zerolog.SetGlobalLevel(zerolog.DebugLevel)
} else {
zerolog.SetGlobalLevel(zerolog.WarnLevel)
}

if c.Bool("pretty") {
log.Logger = log.Output(
zerolog.ConsoleWriter{
Expand All @@ -64,6 +58,22 @@ func loop(c *cli.Context) error {
)
}

if c.BoolT("debug") {
log.Warn().Msg("--debug is deprecated, use --log-level instead")
zerolog.SetGlobalLevel(zerolog.DebugLevel)
}

if c.IsSet("log-level") {
logLevel := c.String("log-level")
lvl, err := zerolog.ParseLevel(logLevel)
if err != nil {
log.Fatal().Msgf("unknown logging level: %s", logLevel)
}
zerolog.SetGlobalLevel(lvl)
} else {
zerolog.SetGlobalLevel(zerolog.WarnLevel)
}
6543 marked this conversation as resolved.
Show resolved Hide resolved
jolheiser marked this conversation as resolved.
Show resolved Hide resolved

counter.Polling = c.Int("max-procs")
counter.Running = 0

Expand Down
5 changes: 5 additions & 0 deletions cmd/agent/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ var flags = []cli.Flag{
Name: "debug",
Usage: "enable agent debug mode",
},
cli.StringFlag{
EnvVar: "WOODPECKER_LOG_LEVEL",
Name: "log-level",
Usage: "set logging level",
},
cli.BoolFlag{
EnvVar: "WOODPECKER_DEBUG_PRETTY",
Name: "pretty",
Expand Down
5 changes: 5 additions & 0 deletions cmd/server/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ var flags = []cli.Flag{
Name: "debug",
Usage: "enable server debug mode",
},
cli.StringFlag{
EnvVar: "WOODPECKER_LOG_LEVEL",
Name: "log-level",
Usage: "set logging level",
},
cli.BoolFlag{
EnvVar: "WOODPECKER_DEBUG_PRETTY",
Name: "pretty",
Expand Down
25 changes: 17 additions & 8 deletions cmd/server/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,6 @@ import (

func loop(c *cli.Context) error {

// debug level if requested by user
// TODO: format output & options to switch to json aka. option to add channels to send logs to
if c.Bool("debug") {
zerolog.SetGlobalLevel(zerolog.DebugLevel)
} else {
zerolog.SetGlobalLevel(zerolog.WarnLevel)
}

if c.Bool("pretty") {
log.Logger = log.Output(
zerolog.ConsoleWriter{
Expand All @@ -69,6 +61,23 @@ func loop(c *cli.Context) error {
)
}

// debug level if requested by user
// TODO: format output & options to switch to json aka. option to add channels to send logs to
if c.Bool("debug") {
log.Warn().Msg("--debug is deprecated, use --log-level instead")
zerolog.SetGlobalLevel(zerolog.DebugLevel)
} else {
zerolog.SetGlobalLevel(zerolog.WarnLevel)
}
anbraten marked this conversation as resolved.
Show resolved Hide resolved
if c.IsSet("log-level") {
logLevel := c.String("log-level")
lvl, err := zerolog.ParseLevel(logLevel)
if err != nil {
log.Fatal().Msgf("unknown logging level: %s", logLevel)
}
zerolog.SetGlobalLevel(lvl)
}
anbraten marked this conversation as resolved.
Show resolved Hide resolved
jolheiser marked this conversation as resolved.
Show resolved Hide resolved

if c.String("server-host") == "" {
log.Fatal().Msg("WOODPECKER_HOST is not properly configured")
}
Expand Down
31 changes: 31 additions & 0 deletions server/api/z.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@
package api

import (
"net/http"

"github.com/gin-gonic/gin"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"

"github.com/woodpecker-ci/woodpecker/server/store"
"github.com/woodpecker-ci/woodpecker/version"
Expand All @@ -37,3 +41,30 @@ func Version(c *gin.Context) {
"version": version.String(),
})
}

// LogLevel endpoint returns the current logging level
func LogLevel(c *gin.Context) {
c.JSON(200, gin.H{
"log-level": zerolog.GlobalLevel().String(),
})
}

// SetLogLevel endpoint allows setting the logging level via API
func SetLogLevel(c *gin.Context) {
logLevel := struct {
LogLevel string `json:"log-level"`
}{}
if err := c.Bind(&logLevel); err != nil {
c.AbortWithError(http.StatusBadRequest, err)
return
}

lvl, err := zerolog.ParseLevel(logLevel.LogLevel)
if err != nil {
c.AbortWithError(http.StatusBadRequest, err)
return
}

log.Log().Msgf("log level set to %s", lvl.String())
zerolog.SetGlobalLevel(lvl)
}
7 changes: 7 additions & 0 deletions server/router/router.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,13 @@ func Load(serveHTTP func(w http.ResponseWriter, r *http.Request), middleware ...
e.GET("/version", api.Version)
e.GET("/healthz", api.Health)

logLevel := e.Group("/log-level")
{
logLevel.Use(session.MustAdmin())
logLevel.GET("", api.LogLevel)
logLevel.POST("", api.SetLogLevel)
}

jolheiser marked this conversation as resolved.
Show resolved Hide resolved
apiRoutes(e)

return e
Expand Down