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

Capture and expose debug (log) information on release failure #219

Merged
merged 2 commits into from
Mar 25, 2021

Conversation

hiddeco
Copy link
Member

@hiddeco hiddeco commented Feb 15, 2021

  • Enable devel flag to get richer debug information from Helm
  • Buffer n last log lines for the action
  • Include the log information in the failure event when the install or upgrade fails

Fixes #218.

@hiddeco hiddeco added area/helm Helm related issues and pull requests area/ux In pursuit of a delightful user experience enhancement New feature or request labels Feb 15, 2021
@stefanprodan
Copy link
Member

@hiddeco may I suggest we buffer the log lines after eliminating duplicates? This way an ingress/lb/volume being stuck will not pollute the event.

@stefanprodan
Copy link
Member

I would prioritize this to trim down the support burden, users can’t figure out why releases are failing when wait times out.

@hiddeco hiddeco force-pushed the debug-wait-logs branch 5 times, most recently from 774c0cf to 12322e3 Compare March 24, 2021 10:47
@hiddeco hiddeco marked this pull request as ready for review March 24, 2021 10:47
Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Thanks @hiddeco

@@ -328,14 +328,14 @@ func (r *HelmReleaseReconciler) reconcileRelease(ctx context.Context,
// Fail if install retries are exhausted.
if hr.Spec.GetInstall().GetRemediation().RetriesExhausted(hr) {
err = fmt.Errorf("install retries exhausted")
return v2.HelmReleaseNotReady(hr, released.Reason, released.Message), err
return v2.HelmReleaseNotReady(hr, released.Reason, err.Error()), err
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This (and the change below) are required because otherwise the long error message will still end up in the Ready condition.

It will also make the error more visible to users, as I know from providing support to people that it is a bit hidden at the moment.

This provides richer debugging information for wait timeouts, e.g.

```
wait.go:225: [debug] Service does not have load balancer ingress IP
address: deis/deis-builder
wait.go:225: [debug] Service does not have load balancer ingress IP
address: deis/deis-builder
```

Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco merged commit 8d65639 into main Mar 25, 2021
@hiddeco hiddeco deleted the debug-wait-logs branch March 25, 2021 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/helm Helm related issues and pull requests area/ux In pursuit of a delightful user experience enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Capture and expose debug (log) information on wait timeout
2 participants