potyarkin/forgejo-runner-act
1
0
Fork 0
Code Issues Pull requests Activity

refactor: Improve logging of error messages

Browse source 
Logging bare errors might lead to long troubleshooting sessions when error
is not specific enough. This commit adds helpful context messages to
logged errors.

Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>
This commit is contained in:
Vitaliy Potyarkin 2024-12-28 12:52:17 +03:00
parent c024ab3079
commit dbdb5588aa
2 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pkg/artifacts/server.go
View file

@ -300,7 +300,7 @@ func Serve(ctx context.Context, artifactPath string, addr string, port string) c
go func() { go func() {
logger.Infof("Start server on http://%s:%s", addr, port) logger.Infof("Start server on http://%s:%s", addr, port)
if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed { if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
logger.Fatal(err) logger.Fatalf("http listener: %v", err)
} }
}() }()

16
pkg/container/docker_run.go
View file

@ -526,8 +526,9 @@ func (cr *containerReference) extractFromImageEnv(env *map[string]string) common
inspect, _, err := cr.cli.ImageInspectWithRaw(ctx, cr.input.Image) inspect, _, err := cr.cli.ImageInspectWithRaw(ctx, cr.input.Image)
if err != nil { if err != nil {
err = fmt.Errorf("inspect image: %w", err)
logger.Error(err) logger.Error(err)
return fmt.Errorf("inspect image: %w", err) return err
} }
if inspect.Config == nil { if inspect.Config == nil {
@ -536,8 +537,9 @@ func (cr *containerReference) extractFromImageEnv(env *map[string]string) common
imageEnv, err := godotenv.Unmarshal(strings.Join(inspect.Config.Env, "\n")) imageEnv, err := godotenv.Unmarshal(strings.Join(inspect.Config.Env, "\n"))
if err != nil { if err != nil {
err = fmt.Errorf("unmarshal image env: %w", err)
logger.Error(err) logger.Error(err)
return fmt.Errorf("unmarshal image env: %w", err) return err
} }
for k, v := range imageEnv { for k, v := range imageEnv {
@ -709,7 +711,7 @@ func (cr *containerReference) waitForCommand(ctx context.Context, isTerminal boo
return ctx.Err() return ctx.Err()
case err := <-cmdResponse: case err := <-cmdResponse:
if err != nil { if err != nil {
logger.Error(err) logger.Errorf("command response: %v", err)
} }
return nil return nil
@ -754,11 +756,11 @@ func (cr *containerReference) copyDir(dstPath string, srcPath string, useGitIgno
name := tarFile.Name() name := tarFile.Name()
err := tarFile.Close() err := tarFile.Close()
if err != nil && !errors.Is(err, os.ErrClosed) { if err != nil && !errors.Is(err, os.ErrClosed) {
logger.Error(err) logger.Errorf("close tar file: %s: %v", name, err)
} }
err = os.Remove(name) err = os.Remove(name)
if err != nil { if err != nil {
logger.Error(err) logger.Errorf("remove file: %s: %v", name, err)
} }
}(tarFile) }(tarFile)
tw := tar.NewWriter(tarFile) tw := tar.NewWriter(tarFile)
@ -797,6 +799,8 @@ func (cr *containerReference) copyDir(dstPath string, srcPath string, useGitIgno
return err return err
} }
if err := tw.Close(); err != nil { if err := tw.Close(); err != nil {
err = fmt.Errorf("close tar writer: %w", err)
logger.Debug(err)
return err return err
} }
@ -875,7 +879,7 @@ func (cr *containerReference) attach() common.Executor {
_, err = io.Copy(outWriter, out.Reader) _, err = io.Copy(outWriter, out.Reader)
} }
if err != nil { if err != nil {
common.Logger(ctx).Error(err) common.Logger(ctx).Errorf("redirect container output: %v", err)
} }
}() }()
return nil return nil