mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2025-01-03 14:18:42 +00:00
Code Issues Projects Releases Wiki Activity

Clean up logging (#3161)

Browse source 
- use `Err` method instead of format strings
- use `Msg` if no format string is used
This commit is contained in:
qwerty287 2024-01-10 20:57:12 +01:00 committed by GitHub
parent 12c40eb957
commit 00df53e941
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 47 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
agent/rpc/client_grpc.go
View file

@ -89,7 +89,7 @@ func (c *client) Next(ctx context.Context, f rpc.Filter) (*rpc.Workflow, error)
// https://github.com/woodpecker-ci/woodpecker/issues/717#issuecomment-1049365104 // https://github.com/woodpecker-ci/woodpecker/issues/717#issuecomment-1049365104
log.Trace().Err(err).Msg("grpc: to many keepalive pings without sending data") log.Trace().Err(err).Msg("grpc: to many keepalive pings without sending data")
} else { } else {
log.Err(err).Msgf("grpc error: done(): code: %v: %s", status.Code(err), err) log.Error().Err(err).Msgf("grpc error: done(): code: %v", status.Code(err))
} }
switch status.Code(err) { switch status.Code(err) {
@ -136,7 +136,7 @@ func (c *client) Wait(ctx context.Context, id string) (err error) {
break break
} }
log.Err(err).Msgf("grpc error: wait(): code: %v: %s", status.Code(err), err) log.Error().Err(err).Msgf("grpc error: wait(): code: %v", status.Code(err))
switch status.Code(err) { switch status.Code(err) {
case case
@ -177,7 +177,7 @@ func (c *client) Init(ctx context.Context, id string, state rpc.State) (err erro
break break
} }
log.Err(err).Msgf("grpc error: init(): code: %v: %s", status.Code(err), err) log.Error().Err(err).Msgf("grpc error: init(): code: %v", status.Code(err))
switch status.Code(err) { switch status.Code(err) {
case case
@ -218,7 +218,7 @@ func (c *client) Done(ctx context.Context, id string, state rpc.State) (err erro
break break
} }
log.Err(err).Msgf("grpc error: done(): code: %v: %s", status.Code(err), err) log.Error().Err(err).Msgf("grpc error: done(): code: %v", status.Code(err))
switch status.Code(err) { switch status.Code(err) {
case case
@ -252,7 +252,7 @@ func (c *client) Extend(ctx context.Context, id string) (err error) {
break break
} }
log.Err(err).Msgf("grpc error: extend(): code: %v: %s", status.Code(err), err) log.Error().Err(err).Msgf("grpc error: extend(): code: %v", status.Code(err))
switch status.Code(err) { switch status.Code(err) {
case case
@ -293,7 +293,7 @@ func (c *client) Update(ctx context.Context, id string, state rpc.State) (err er
break break
} }
log.Err(err).Msgf("grpc error: update(): code: %v: %s", status.Code(err), err) log.Error().Err(err).Msgf("grpc error: update(): code: %v", status.Code(err))
switch status.Code(err) { switch status.Code(err) {
case case
@ -332,7 +332,7 @@ func (c *client) Log(ctx context.Context, logEntry *rpc.LogEntry) (err error) {
break break
} }
log.Err(err).Msgf("grpc error: log(): code: %v: %s", status.Code(err), err) log.Error().Err(err).Msgf("grpc error: log(): code: %v", status.Code(err))
switch status.Code(err) { switch status.Code(err) {
case case

6
cli/internal/util.go
View file

@ -44,16 +44,16 @@ func NewClient(c *cli.Context) (woodpecker.Client, error) {
// if no server url is provided we can default // if no server url is provided we can default
// to the hosted Woodpecker service. // to the hosted Woodpecker service.
if len(server) == 0 { if len(server) == 0 {
return nil, fmt.Errorf("Error: you must provide the Woodpecker server address") return nil, fmt.Errorf("you must provide the Woodpecker server address")
} }
if len(token) == 0 { if len(token) == 0 {
return nil, fmt.Errorf("Error: you must provide your Woodpecker access token") return nil, fmt.Errorf("you must provide your Woodpecker access token")
} }
// attempt to find system CA certs // attempt to find system CA certs
certs, err := x509.SystemCertPool() certs, err := x509.SystemCertPool()
if err != nil { if err != nil {
log.Error().Msgf("failed to find system CA certs: %v", err) log.Error().Err(err).Msg("failed to find system CA certs")
} }
tlsConfig := &tls.Config{ tlsConfig := &tls.Config{
RootCAs: certs, RootCAs: certs,

4
cmd/agent/agent.go
View file

@ -62,7 +62,7 @@ func run(c *cli.Context) error {
if c.Bool("healthcheck") { if c.Bool("healthcheck") {
go func() { go func() {
if err := http.ListenAndServe(c.String("healthcheck-addr"), nil); err != nil { if err := http.ListenAndServe(c.String("healthcheck-addr"), nil); err != nil {
log.Error().Msgf("cannot listen on address %s: %v", c.String("healthcheck-addr"), err) log.Error().Err(err).Msgf("cannot listen on address %s", c.String("healthcheck-addr"))
} }
}() }()
} }
@ -210,7 +210,7 @@ func run(c *cli.Context) error {
err := client.ReportHealth(ctx) err := client.ReportHealth(ctx)
if err != nil { if err != nil {
log.Err(err).Msgf("Failed to report health") log.Err(err).Msg("Failed to report health")
return return
} }

4
cmd/server/setup.go
View file

@ -64,9 +64,9 @@ func setupStore(c *cli.Context) (store.Store, error) {
if driver == "sqlite3" { if driver == "sqlite3" {
if datastore.SupportedDriver("sqlite3") { if datastore.SupportedDriver("sqlite3") {
log.Debug().Msgf("server has sqlite3 support") log.Debug().Msg("server has sqlite3 support")
} else { } else {
log.Debug().Msgf("server was built without sqlite3 support!") log.Debug().Msg("server was built without sqlite3 support!")
} }
} }

4
pipeline/backend/kubernetes/kubernetes.go
View file

@ -99,13 +99,13 @@ func configFromCliContext(ctx context.Context) (*config, error) {
// Unmarshal label and annotation settings here to ensure they're valid on startup // Unmarshal label and annotation settings here to ensure they're valid on startup
if labels := c.String("backend-k8s-pod-labels"); labels != "" { if labels := c.String("backend-k8s-pod-labels"); labels != "" {
if err := yaml.Unmarshal([]byte(labels), &config.PodLabels); err != nil { if err := yaml.Unmarshal([]byte(labels), &config.PodLabels); err != nil {
log.Error().Msgf("could not unmarshal pod labels '%s': %s", c.String("backend-k8s-pod-labels"), err) log.Error().Err(err).Msgf("could not unmarshal pod labels '%s'", c.String("backend-k8s-pod-labels"))
return nil, err return nil, err
} }
} }
if annotations := c.String("backend-k8s-pod-annotations"); annotations != "" { if annotations := c.String("backend-k8s-pod-annotations"); annotations != "" {
if err := yaml.Unmarshal([]byte(c.String("backend-k8s-pod-annotations")), &config.PodAnnotations); err != nil { if err := yaml.Unmarshal([]byte(c.String("backend-k8s-pod-annotations")), &config.PodAnnotations); err != nil {
log.Error().Msgf("could not unmarshal pod annotations '%s': %s", c.String("backend-k8s-pod-annotations"), err) log.Error().Err(err).Msgf("could not unmarshal pod annotations '%s'", c.String("backend-k8s-pod-annotations"))
return nil, err return nil, err
} }
} }

2
pipeline/backend/kubernetes/pod.go
View file

@ -258,7 +258,7 @@ func resourceList(resources map[string]string) (v1.ResourceList, error) {
resName := v1.ResourceName(key) resName := v1.ResourceName(key)
resVal, err := resource.ParseQuantity(val) resVal, err := resource.ParseQuantity(val)
if err != nil { if err != nil {
return nil, fmt.Errorf("resource request '%v' quantity '%v': %w", key, val, err) return nil, fmt.Errorf("resource request '%s' quantity '%s': %w", key, val, err)
} }
requestResources[resName] = resVal requestResources[resName] = resVal
} }

2
pipeline/backend/local/local.go
View file

@ -235,7 +235,7 @@ func (e *local) DestroyStep(_ context.Context, _ *types.Step, _ string) error {
// DestroyWorkflow the pipeline environment. // DestroyWorkflow the pipeline environment.
func (e *local) DestroyWorkflow(_ context.Context, _ *types.Config, taskUUID string) error { func (e *local) DestroyWorkflow(_ context.Context, _ *types.Config, taskUUID string) error {
log.Trace().Str("taskUUID", taskUUID).Msgf("delete workflow environment") log.Trace().Str("taskUUID", taskUUID).Msg("delete workflow environment")
state, err := e.getState(taskUUID) state, err := e.getState(taskUUID)
if err != nil { if err != nil {

16
server/api/login.go
View file

@ -44,17 +44,17 @@ func HandleAuth(c *gin.Context) {
_store := store.FromContext(c) _store := store.FromContext(c)
_forge := server.Config.Services.Forge _forge := server.Config.Services.Forge
// when dealing with redirects we may need to adjust the content type. I // when dealing with redirects, we may need to adjust the content type. I
// cannot, however, remember why, so need to revisit this line. // cannot, however, remember why, so need to revisit this line.
c.Writer.Header().Del("Content-Type") c.Writer.Header().Del("Content-Type")
tmpuser, err := _forge.Login(c, c.Writer, c.Request) tmpuser, err := _forge.Login(c, c.Writer, c.Request)
if err != nil { if err != nil {
log.Error().Msgf("cannot authenticate user. %s", err) log.Error().Err(err).Msg("cannot authenticate user")
c.Redirect(http.StatusSeeOther, server.Config.Server.RootPath+"/login?error=oauth_error") c.Redirect(http.StatusSeeOther, server.Config.Server.RootPath+"/login?error=oauth_error")
return return
} }
// this will happen when the user is redirected by the forge as // this will happen when the forge redirects the user as
// part of the authorization workflow. // part of the authorization workflow.
if tmpuser == nil { if tmpuser == nil {
return return
@ -101,7 +101,7 @@ func HandleAuth(c *gin.Context) {
// insert the user into the database // insert the user into the database
if err := _store.CreateUser(u); err != nil { if err := _store.CreateUser(u); err != nil {
log.Error().Msgf("cannot insert %s. %s", u.Login, err) log.Error().Err(err).Msgf("cannot insert %s", u.Login)
c.Redirect(http.StatusSeeOther, server.Config.Server.RootPath+"/login?error=internal_error") c.Redirect(http.StatusSeeOther, server.Config.Server.RootPath+"/login?error=internal_error")
return return
} }
@ -137,7 +137,7 @@ func HandleAuth(c *gin.Context) {
} }
if err := _store.UpdateUser(u); err != nil { if err := _store.UpdateUser(u); err != nil {
log.Error().Msgf("cannot update %s. %s", u.Login, err) log.Error().Err(err).Msgf("cannot update %s", u.Login)
c.Redirect(http.StatusSeeOther, server.Config.Server.RootPath+"/login?error=internal_error") c.Redirect(http.StatusSeeOther, server.Config.Server.RootPath+"/login?error=internal_error")
return return
} }
@ -145,7 +145,7 @@ func HandleAuth(c *gin.Context) {
exp := time.Now().Add(server.Config.Server.SessionExpires).Unix() exp := time.Now().Add(server.Config.Server.SessionExpires).Unix()
tokenString, err := token.New(token.SessToken, u.Login).SignExpires(u.Hash, exp) tokenString, err := token.New(token.SessToken, u.Login).SignExpires(u.Hash, exp)
if err != nil { if err != nil {
log.Error().Msgf("cannot create token for %s. %s", u.Login, err) log.Error().Msgf("cannot create token for %s", u.Login)
c.Redirect(http.StatusSeeOther, server.Config.Server.RootPath+"/login?error=internal_error") c.Redirect(http.StatusSeeOther, server.Config.Server.RootPath+"/login?error=internal_error")
return return
} }
@ -157,7 +157,7 @@ func HandleAuth(c *gin.Context) {
continue continue
} }
if err != nil { if err != nil {
log.Error().Msgf("cannot list repos for %s. %s", u.Login, err) log.Error().Err(err).Msgf("cannot list repos for %s", u.Login)
c.Redirect(http.StatusSeeOther, "/login?error=internal_error") c.Redirect(http.StatusSeeOther, "/login?error=internal_error")
return return
} }
@ -173,7 +173,7 @@ func HandleAuth(c *gin.Context) {
perm.UserID = u.ID perm.UserID = u.ID
perm.Synced = time.Now().Unix() perm.Synced = time.Now().Unix()
if err := _store.PermUpsert(perm); err != nil { if err := _store.PermUpsert(perm); err != nil {
log.Error().Msgf("cannot update permissions for %s. %s", u.Login, err) log.Error().Err(err).Msgf("cannot update permissions for %s", u.Login)
c.Redirect(http.StatusSeeOther, "/login?error=internal_error") c.Redirect(http.StatusSeeOther, "/login?error=internal_error")
return return
} }

2
server/api/org.go
View file

@ -140,7 +140,7 @@ func LookupOrg(c *gin.Context) {
} else if !user.Admin { } else if !user.Admin {
perm, err := server.Config.Services.Membership.Get(c, user, org.Name) perm, err := server.Config.Services.Membership.Get(c, user, org.Name)
if err != nil { if err != nil {
log.Error().Msgf("Failed to check membership: %v", err) log.Error().Err(err).Msg("Failed to check membership")
c.Status(http.StatusInternalServerError) c.Status(http.StatusInternalServerError)
return return
} }

2
server/api/repo.go
View file

@ -576,7 +576,7 @@ func repairRepo(c *gin.Context, repo *model.Repo, withPerms, skipOnErr bool) {
if !skipOnErr { if !skipOnErr {
c.AbortWithStatus(http.StatusNotFound) c.AbortWithStatus(http.StatusNotFound)
} }
log.Error().Err(err).Msgf("could not get user on repo repair") log.Error().Err(err).Msg("could not get user on repo repair")
} else { } else {
_ = c.AbortWithError(http.StatusInternalServerError, err) _ = c.AbortWithError(http.StatusInternalServerError, err)
} }

8
server/api/stream.go
View file

@ -160,7 +160,7 @@ func LogStreamSSE(c *gin.Context) {
} }
pl, err := _store.GetPipelineNumber(repo, pipeline) pl, err := _store.GetPipelineNumber(repo, pipeline)
if err != nil { if err != nil {
log.Debug().Msgf("stream cannot get pipeline number: %v", err) log.Debug().Err(err).Msg("stream cannot get pipeline number")
logWriteStringErr(io.WriteString(rw, "event: error\ndata: pipeline not found\n\n")) logWriteStringErr(io.WriteString(rw, "event: error\ndata: pipeline not found\n\n"))
return return
} }
@ -173,7 +173,7 @@ func LogStreamSSE(c *gin.Context) {
} }
step, err := _store.StepLoad(stepID) step, err := _store.StepLoad(stepID)
if err != nil { if err != nil {
log.Debug().Msgf("stream cannot get step number: %v", err) log.Debug().Err(err).Msg("stream cannot get step number")
logWriteStringErr(io.WriteString(rw, "event: error\ndata: process not found\n\n")) logWriteStringErr(io.WriteString(rw, "event: error\ndata: process not found\n\n"))
return return
} }
@ -197,12 +197,12 @@ func LogStreamSSE(c *gin.Context) {
context.Background(), context.Background(),
) )
log.Debug().Msgf("log stream: connection opened") log.Debug().Msg("log stream: connection opened")
defer func() { defer func() {
cancel(nil) cancel(nil)
close(logc) close(logc)
log.Debug().Msgf("log stream: connection closed") log.Debug().Msg("log stream: connection closed")
}() }()
go func() { go func() {

2
server/grpc/auth_server.go
View file

@ -69,7 +69,7 @@ func (s *WoodpeckerAuthServer) getAgent(agentID int64, agentToken string) (*mode
agent.Capacity = -1 agent.Capacity = -1
err := s.store.AgentCreate(agent) err := s.store.AgentCreate(agent)
if err != nil { if err != nil {
log.Err(err).Msgf("Error creating system agent: %s", err) log.Error().Err(err).Msg("Error creating system agent")
return nil, err return nil, err
} }
return agent, nil return agent, nil

2
server/grpc/rpc.go
View file

@ -212,7 +212,7 @@ func (s *RPC) Init(c context.Context, id string, state rpc.State) error {
Pipeline: *currentPipeline, Pipeline: *currentPipeline,
}) })
if err != nil { if err != nil {
log.Error().Err(err).Msgf("could not marshal JSON") log.Error().Err(err).Msg("could not marshal JSON")
return return
} }
s.pubsub.Publish(message) s.pubsub.Publish(message)

5
server/pipeline/restart.go
View file

@ -41,9 +41,8 @@ func Restart(ctx context.Context, store store.Store, lastPipeline *model.Pipelin
// fetch the old pipeline config from the database // fetch the old pipeline config from the database
configs, err := store.ConfigsForPipeline(lastPipeline.ID) configs, err := store.ConfigsForPipeline(lastPipeline.ID)
if err != nil { if err != nil {
msg := fmt.Sprintf("failure to get pipeline config for %s. %s", repo.FullName, err) log.Error().Err(err).Msgf("failure to get pipeline config for %s", repo.FullName)
log.Error().Msgf(msg) return nil, &ErrNotFound{Msg: fmt.Sprintf("failure to get pipeline config for %s. %s", repo.FullName, err)}
return nil, &ErrNotFound{Msg: msg}
} }
for _, y := range configs { for _, y := range configs {

2
server/plugins/encryption/tink_keyset.go
View file

@ -37,7 +37,7 @@ func (svc *tinkEncryptionService) loadKeyset() error {
defer func(file *os.File) { defer func(file *os.File) {
err = file.Close() err = file.Close()
if err != nil { if err != nil {
log.Err(err).Msgf(logTemplateTinkFailedClosingKeysetFile, svc.keysetFilePath) log.Error().Err(err).Msgf(logTemplateTinkFailedClosingKeysetFile, svc.keysetFilePath)
} }
}(file) }(file)

4
server/plugins/encryption/tink_keyset_watcher.go
View file

@ -48,13 +48,13 @@ func (svc *tinkEncryptionService) handleFileEvents() {
log.Warn().Msgf(logTemplateTinkKeysetFileChanged, event.Name) log.Warn().Msgf(logTemplateTinkKeysetFileChanged, event.Name)
err := svc.rotate() err := svc.rotate()
if err != nil { if err != nil {
log.Fatal().Err(err).Msgf(errMessageFailedRotatingEncryption) //nolint:forbidigo log.Fatal().Err(err).Msg(errMessageFailedRotatingEncryption) //nolint:forbidigo
} }
return return
} }
case err, ok := <-svc.keysetFileWatcher.Errors: case err, ok := <-svc.keysetFileWatcher.Errors:
if !ok { if !ok {
log.Fatal().Err(err).Msgf(errMessageTinkKeysetFileWatchFailed) //nolint:forbidigo log.Fatal().Err(err).Msg(errMessageTinkKeysetFileWatchFailed) //nolint:forbidigo
} }
} }
} }

2
server/queue/persistent.go
View file

@ -78,7 +78,7 @@ func (q *persistentQueue) Poll(c context.Context, agentID int64, f FilterFn) (*m
if task != nil { if task != nil {
log.Debug().Msgf("pull queue item: %s: remove from backup", task.ID) log.Debug().Msgf("pull queue item: %s: remove from backup", task.ID)
if derr := q.store.TaskDelete(task.ID); derr != nil { if derr := q.store.TaskDelete(task.ID); derr != nil {
log.Error().Msgf("pull queue item: %s: failed to remove from backup: %s", task.ID, derr) log.Error().Err(derr).Msgf("pull queue item: %s: failed to remove from backup", task.ID)
} else { } else {
log.Debug().Msgf("pull queue item: %s: successfully removed from backup", task.ID) log.Debug().Msgf("pull queue item: %s: successfully removed from backup", task.ID)
} }

7
server/router/middleware/session/repo.go
View file

@ -23,6 +23,7 @@ import (
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/rs/zerolog/log" "github.com/rs/zerolog/log"
"go.woodpecker-ci.org/woodpecker/v2/server" "go.woodpecker-ci.org/woodpecker/v2/server"
"go.woodpecker-ci.org/woodpecker/v2/server/model" "go.woodpecker-ci.org/woodpecker/v2/server/model"
@ -73,7 +74,7 @@ func SetRepo() gin.HandlerFunc {
} }
// debugging // debugging
log.Debug().Err(err).Msgf("Cannot find repository %s.", fullName) log.Debug().Err(err).Msgf("Cannot find repository %s", fullName)
if user == nil { if user == nil {
c.AbortWithStatus(http.StatusUnauthorized) c.AbortWithStatus(http.StatusUnauthorized)
@ -112,8 +113,8 @@ func SetPerm() gin.HandlerFunc {
var err error var err error
perm, err = _store.PermFind(user, repo) perm, err = _store.PermFind(user, repo)
if err != nil { if err != nil {
log.Error().Msgf("Error fetching permission for %s %s. %s", log.Error().Err(err).Msgf("Error fetching permission for %s %s",
user.Login, repo.FullName, err) user.Login, repo.FullName)
} }
if time.Unix(perm.Synced, 0).Add(time.Hour).Before(time.Now()) { if time.Unix(perm.Synced, 0).Add(time.Hour).Before(time.Now()) {
_repo, err := server.Config.Services.Forge.Repo(c, user, repo.ForgeRemoteID, repo.Owner, repo.Name) _repo, err := server.Config.Services.Forge.Repo(c, user, repo.ForgeRemoteID, repo.Owner, repo.Name)

2
server/router/middleware/session/user.go
View file

@ -147,7 +147,7 @@ func MustOrgMember(admin bool) gin.HandlerFunc {
perm, err := server.Config.Services.Membership.Get(c, user, org.Name) perm, err := server.Config.Services.Membership.Get(c, user, org.Name)
if err != nil { if err != nil {
log.Error().Msgf("Failed to check membership: %v", err) log.Error().Err(err).Msg("Failed to check membership")
c.String(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError)) c.String(http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
c.Abort() c.Abort()
return return

4
server/web/config.go
View file

@ -54,7 +54,7 @@ func Config(c *gin.Context) {
"json": func(v any) string { "json": func(v any) string {
a, err := json.Marshal(v) a, err := json.Marshal(v)
if err != nil { if err != nil {
log.Error().Err(err).Msgf("could not marshal JSON") log.Error().Err(err).Msg("could not marshal JSON")
return "" return ""
} }
return string(a) return string(a)
@ -65,7 +65,7 @@ func Config(c *gin.Context) {
tmpl := template.Must(template.New("").Funcs(funcMap).Parse(configTemplate)) tmpl := template.Must(template.New("").Funcs(funcMap).Parse(configTemplate))
if err := tmpl.Execute(c.Writer, configData); err != nil { if err := tmpl.Execute(c.Writer, configData); err != nil {
log.Error().Err(err).Msgf("could not execute template") log.Error().Err(err).Msg("could not execute template")
c.AbortWithStatus(http.StatusInternalServerError) c.AbortWithStatus(http.StatusInternalServerError)
return return
} }