Skip to content

fix(check): improve format of errors on multiple checks #466

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.

Sign up for GitHub

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

Merged
gacevicljubisa merged 2 commits into from
Mar 3, 2025
Merged

fix(check): improve format of errors on multiple checks #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9e1594
fix(check): improve format of errors on multiple checks
gacevicljubisa Mar 3, 2025
3cfa346
fix(check): improve log when check is starting
gacevicljubisa Mar 3, 2025
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
100 changes: 75 additions & 25 deletions pkg/check/runner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,39 +91,40 @@ func (c *CheckRunner) Run(ctx context.Context, checks []string) error {
})
}

type errorCheck struct {
check string
err error
}

var errors []errorCheck
checkResults := make([]checkResult, 0, len(validatedChecks))
hasFailures := false

// run checks
for _, check := range validatedChecks {
c.logger.WithField("type", check.typeName).Infof("running check: %s", check.name)
c.logger.Debugf("check options: %+v", check.options)

if err := check.Run(ctx, c.cluster); err != nil {
c.logger.WithField("type", check.typeName).Errorf("check '%s' failed: %v", check.name, err)
errors = append(errors, errorCheck{
check: check.name,
err: fmt.Errorf("check %s failed: %w", check.name, err),
})
c.logger.WithFields(map[string]interface{}{
"type": check.typeName,
"options": fmt.Sprintf("%+v", check.options),
}).Infof("running check: %s", check.name)

err := check.Run(ctx, c.cluster)
if err != nil {
hasFailures = true
c.logger.WithFields(map[string]interface{}{
"type": check.typeName,
"error": err,
}).Errorf("'%s' check failed", check.name)
} else {
c.logger.WithField("type", check.typeName).Infof("%s check completed successfully", check.name)
c.logger.WithField("type", check.typeName).Infof("'%s' check completed successfully", check.name)
}

// append check result
checkResults = append(checkResults, checkResult{
check: check.name,
err: err,
timestamp: time.Now(),
})
}

if len(errors) == 1 {
return errors[0].err
} else if len(errors) > 1 {
var errStrings []string
for _, e := range errors {
errStrings = append(errStrings, fmt.Sprintf("[%s]: {%v}", e.check, e.err))
c.logger.Errorf("%s: %v", e.check, e.err)
}
return fmt.Errorf("multiple checks failed: %s", strings.Join(errStrings, "; "))
if hasFailures {
return formatErrorReport(checkResults)
}

c.logger.WithField("total_checks", len(checkResults)).Info("All checks completed successfully")
return nil
}

Expand Down Expand Up @@ -166,3 +167,52 @@ func createChildContext(ctx context.Context, timeout *time.Duration) (context.Co
}
return context.WithCancel(ctx)
}

type checkResult struct {
check string
err error
timestamp time.Time
}

func formatErrorReport(results []checkResult) error {
var failedChecks []string
var failedDetails []string

// if there is only one error, return it directly
if len(results) == 1 {
return results[0].err
}

for _, result := range results {
if result.err != nil {
failedChecks = append(failedChecks, result.check)
failedDetails = append(failedDetails, result.DetailString())
}
}

totalChecks := len(results)
failedCount := len(failedChecks)

return fmt.Errorf("CHECK_FAILED | %d/%d checks failed | Checks: %s | %s",
failedCount,
totalChecks,
strings.Join(failedChecks, ","),
strings.Join(failedDetails, " | "))
}

func (e checkResult) String() string {
if e.err != nil {
return fmt.Sprintf("%s: %v", e.check, e.err)
}
return fmt.Sprintf("%s: success", e.check)
}

func (e checkResult) DetailString() string {
timestamp := e.timestamp.Format("2006-01-02T15:04:05")
if e.err != nil {
return fmt.Sprintf(`{"check":"%s","time":"%s","error":"%v"}`,
e.check, timestamp, e.err)
}
return fmt.Sprintf(`{"check":"%s","time":"%s","status":"success"}`,
e.check, timestamp)
}
8 changes: 4 additions & 4 deletions pkg/stamper/stamper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ func (s *Client) Create(ctx context.Context, duration time.Duration, depth uint1
s.log.WithFields(map[string]interface{}{
"duration": duration,
"depth": depth,
}).Infof("creating postage batch on nodes")
}).Info("creating postage batch on nodes")

nodes, err := s.getNodes(ctx)
if err != nil {
Expand All @@ -125,7 +125,7 @@ func (s *Client) Dilute(ctx context.Context, usageThreshold float64, dilutionDep
s.log.WithFields(map[string]interface{}{
"usageThreshold": usageThreshold,
"dilutionDepth": dilutionDepth,
}).Infof("diluting postage batch on nodes")
}).Info("diluting postage batch on nodes")

nodes, err := s.getNodes(ctx)
if err != nil {
Expand All @@ -148,7 +148,7 @@ func (s *Client) Set(ctx context.Context, ttlThreshold time.Duration, topupTo ti
"topupTo": topupTo,
"usageThreshold": usageThreshold,
"dilutionDepth": dilutionDepth,
}).Infof("setting topup and dilution on postage batch on nodes")
}).Info("setting topup and dilution on postage batch on nodes")

nodes, err := s.getNodes(ctx)
if err != nil {
Expand All @@ -174,7 +174,7 @@ func (s *Client) Topup(ctx context.Context, ttlThreshold time.Duration, topupTo
s.log.WithFields(map[string]interface{}{
"ttlThreshold": ttlThreshold,
"topupTo": topupTo,
}).Infof("topup postage batch on nodes")
}).Info("topup postage batch on nodes")

nodes, err := s.getNodes(ctx)
if err != nil {
Expand Down