Feature: CLI list deployments shows health for each entry #1594

izaaklauer · 2021-06-03T22:26:17Z

Previously, running waypoint deployment list would attach the most recent health check of any kind to the most recent deployment. With this change, we display the health of each deployment listed.

Example:

In writing this, I realize that our ListStatusReports endpoint lists all status reports for all resources, with no way to filter to a specific resource or recency limit. We'll probably need to enhance that pretty soon as we build up more report types and volume.

Also it's a big protobuf diff, but it should get us back to the the code produced by the version of protoc locked in by go.mod.

izaaklauer · 2021-06-03T22:54:01Z

internal/core/app_status_report.go

@@ -345,6 +344,9 @@ func (op *statusReportOperation) Do(
 return nil, status.Errorf(codes.FailedPrecondition, "unsupported status operation type")
 }

+ // Add the time generated to the outer status report
+ realMsg.TimeGenerated = report.TimeGenerated


This feels like something the UI will likely want to include (cc @jgwhite ), so I added it to the top level StatusReport. It also means we don't need to dig into the lower-level status report in the CLI at all anymore.

Yes, this is going to be super helpful in the UI too.

jgwhite

Works great!

One small comment on naming consistency, but otherwise looks good to me.

jgwhite · 2021-06-04T10:02:35Z

internal/cli/deployment_list.go

+ for _, statusReport := range statusReportsResp.StatusReports {
+ if deploymentTargetId, ok := statusReport.TargetId.(*pb.StatusReport_DeploymentId); ok {
+ if deploymentTargetId.DeploymentId == b.Id {
+ switch statusReport.Health.HealthStatus {


Happy to see we’re switching on the outer HealthStatus rather than the SDK’s Health enum.

internal/server/proto/server.proto

internal/cli/deployment_list.go

krantzinator

Excited to have this! I had a couple questions and one nit.

internal/cli/deployment_list.go

krantzinator · 2021-06-04T15:00:23Z

internal/core/app_status_report.go

@@ -345,6 +344,9 @@ func (op *statusReportOperation) Do(
 return nil, status.Errorf(codes.FailedPrecondition, "unsupported status operation type")
 }

+ // Add the time generated to the outer status report
+ realMsg.GeneratedTime = report.TimeGenerated


:chefs-kiss:

Why is one AB and the other BA (A = "Generated" B = "Time")?

Renaming fields is backwards compatible in proto so should we rename fields?

Good catch...yeah these should be named the same.

Ha, I actually just changed this after @jgwhite caught that many similar time fields that the server returns are in the AB order, and it might be better to be consistent with other server fields than with the sdk field that we're mirroring: #1594 (comment)

If renaming fields is backwards compatible, fixing the SDK field may be the way to go.

realMsg.GeneratedTime was added in this PR so we should match the naming from the SDK.

https://github.com/hashicorp/waypoint/pull/1594/files#diff-08cc775443acf74b3ff82990db5a6a1dc18774b7701d3851dad9ff91e5947b37R2381

Ah, I noticed Jamies comment. We could flip them in the SDK if it doesn't break backwards compatibility. It's too bad this wasn't caught sooner 😄

briancain

Sweeeet, thanks for the fix izaak 😄 A couple of minor comments from me and some +1s on the other feedback given 👍🏻

internal/cli/deployment_list.go

internal/server/proto/server.proto

briancain

@izaaklauer I think we should fix the GeneratedTime = TimeGenerated issue here. We should either flip it back to TimeGenerated on the copied convenience server proto var to match the option in the raw report (and be a little inconsistent), or try to fix the name on the SDK side if it doesn't break backwards compatibility so it is consistent with other parts of the API. If we do change it, it'd be good to get it in a 0.4.1 before anyone really builds anything on top of this to reduce major breaking changes.

Matches our convention of other time values. Prerequisite for hashicorp/waypoint#1594 (discussion hashicorp/waypoint#1594 (review))

izaaklauer · 2021-06-09T12:11:24Z

PR to rename the time field in waypoint-plugin-sdk: hashicorp/waypoint-plugin-sdk#35. I tested using that change in a new server with an old version of the CLI and vice-versa, and the backwards compatibility works! Once the sdk change is merged, I'll update this pr to include it.

briancain · 2021-06-09T14:44:47Z

Nice @izaaklauer ! You'll probably also need to update all of the plugins to use the new variable too when they finish generating a report, right? Maybe that can be done in a new PR when we update the SDK version this project is using.

In writing this, I realize that our ListStatusReports endpoing lists _all_ status reports for all resources, with no way to filter. We'll probably need to enhance that pretty soon as we build up more report types and volume. Also it looks like this is a big protobuf diff. The existing generated code has "unknown" protobuf version, so i'm not sure what version I need to revert to to make it match.

Co-authored-by: Jamie White <jamie@jgwhite.co.uk>

Regenerated protobufs

Previously, if a plugin does not return status reports, we would say "Unknown Status", which is a bit wordy and also conflicts with the "UNKNOWN" official status, where a plugin _has tried_ to get status and is explicitly returning unknown. "n/a" kind of implies that the very concept of health doesn't apply to some deployments, which isn't right either, but it's the least-worst thing I can think of.

Also looping in Rae's fix (https://github.com/hashicorp/waypoint/pull/1596/files)

izaaklauer · 2021-06-09T15:11:41Z

Nice @izaaklauer ! You'll probably also need to update all of the plugins to use the new variable too when they finish generating a report, right? Maybe that can be done in a new PR when we update the SDK version this project is using.

The other plugin changes weren't too big and addresses this feedback, so I looped it in here. We are now consistently using <thing>_time naming convention.

izaaklauer · 2021-06-09T18:58:18Z

Note that because with this change we're recording and reading GeneratedTime from the outer protobuf, and reading HealthStatus from the outer protobuf. We used to read these from the inner sdk pb.any protobuf. This means that deployment list commands with this release will not show a time or health for old status reports. Example:

(deployment 3 was made with 0.4.0, and 4 with this new version. Note that 3 is missing health info).

The UI is also unaffected, because it doesn't inspect the inner sdk proto.

With the current implementation of health checks, health is only determined immediately after a deployment, and is most valuable at that point, so losing that historical health check data in this CLI view may be acceptable. The next deployment that anyone runs after upgrading waypoint will show health on deployment list.

I would argue that it's not worth the complexity to check the SDK proto in the case where the outer proto is blank, but I'm not wedded to that opinion.

briancain

⏳

izaaklauer changed the title ~~CLI list deployments shows health for each entry~~ Feature: CLI list deployments shows health for each entry Jun 3, 2021

github-actions bot added the core label Jun 3, 2021

vercel bot temporarily deployed to Preview June 3, 2021 22:51 Inactive

izaaklauer commented Jun 3, 2021

View reviewed changes

izaaklauer requested a review from a team June 3, 2021 22:54

jgwhite reviewed Jun 4, 2021

View reviewed changes

vercel bot temporarily deployed to Preview June 4, 2021 12:20 Inactive

vercel bot temporarily deployed to Preview June 4, 2021 12:24 Inactive

izaaklauer force-pushed the bug/deploy-list-status branch from fbc6cd3 to c672e93 Compare June 4, 2021 12:26

vercel bot temporarily deployed to Preview June 4, 2021 12:26 Inactive

izaaklauer force-pushed the bug/deploy-list-status branch from c672e93 to 2999ee0 Compare June 4, 2021 12:36

vercel bot temporarily deployed to Preview June 4, 2021 12:36 Inactive

izaaklauer force-pushed the bug/deploy-list-status branch from 2999ee0 to 34e69f2 Compare June 4, 2021 12:37

vercel bot temporarily deployed to Preview June 4, 2021 12:37 Inactive

krantzinator added the backport/0.4.x label Jun 4, 2021

krantzinator reviewed Jun 4, 2021

View reviewed changes

internal/cli/deployment_list.go Outdated Show resolved Hide resolved

krantzinator reviewed Jun 4, 2021

View reviewed changes

vercel bot temporarily deployed to Preview June 4, 2021 15:14 Inactive

briancain suggested changes Jun 4, 2021

View reviewed changes

internal/cli/deployment_list.go Outdated Show resolved Hide resolved

internal/server/proto/server.proto Outdated Show resolved Hide resolved

vercel bot temporarily deployed to Preview June 4, 2021 15:48 Inactive

izaaklauer force-pushed the bug/deploy-list-status branch from 4c3d1b4 to 2bdb354 Compare June 4, 2021 15:54

vercel bot temporarily deployed to Preview June 4, 2021 15:54 Inactive

vercel bot temporarily deployed to Preview June 4, 2021 16:00 Inactive

vercel bot temporarily deployed to Preview June 4, 2021 16:06 Inactive

izaaklauer requested a review from briancain June 7, 2021 13:01

briancain reviewed Jun 7, 2021

View reviewed changes

izaaklauer force-pushed the bug/deploy-list-status branch from 0a05710 to aa9b2cb Compare June 7, 2021 17:09

vercel bot temporarily deployed to Preview June 7, 2021 17:09 Inactive

izaaklauer added a commit to hashicorp/waypoint-plugin-sdk that referenced this pull request Jun 9, 2021

Rename TimeGenerated -> GeneratedTime

1a33fdd

Matches our convention of other time values. Prerequisite for hashicorp/waypoint#1594 (discussion hashicorp/waypoint#1594 (review))

izaaklauer mentioned this pull request Jun 9, 2021

Rename TimeGenerated -> GeneratedTime hashicorp/waypoint-plugin-sdk#35

Merged

izaaklauer and others added 9 commits June 9, 2021 10:53

changelog

6358475

Update internal/server/proto/server.proto

93b45df

Co-authored-by: Jamie White <jamie@jgwhite.co.uk>

Change TimeGenerated to GeneratedTime to match convention

f2f1355

Regenerated protobufs

Testing the timestamp change

45572ea

Protobuf comments and field order

2716ae6

Also looping in Rae's fix (https://github.com/hashicorp/waypoint/pull/1596/files)

Re-adding some error handling

498c3e3

Fixing import order

ddb18b4

izaaklauer force-pushed the bug/deploy-list-status branch from aa9b2cb to ddb18b4 Compare June 9, 2021 14:55

vercel bot temporarily deployed to Preview June 9, 2021 14:55 Inactive

vercel bot temporarily deployed to Preview June 9, 2021 15:06 Inactive

github-actions bot added plugin plugin/docker plugin/k8s plugin/nomad labels Jun 9, 2021

izaaklauer requested a review from briancain June 9, 2021 15:12

Use new sdk version with GeneratedTime

565d7ae

izaaklauer force-pushed the bug/deploy-list-status branch from 3064757 to 565d7ae Compare June 9, 2021 15:15

vercel bot temporarily deployed to Preview June 9, 2021 15:15 Inactive

izaaklauer added the core/sdk label Jun 9, 2021

briancain approved these changes Jun 9, 2021

View reviewed changes

izaaklauer merged commit 88f1bd1 into main Jun 10, 2021

izaaklauer deleted the bug/deploy-list-status branch June 10, 2021 12:47

hc-github-team-waypoint mentioned this pull request Jun 10, 2021

Backport of Feature: CLI list deployments shows health for each entry into release/0.4.x #1634

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: CLI list deployments shows health for each entry #1594

Feature: CLI list deployments shows health for each entry #1594

izaaklauer commented Jun 3, 2021 •

edited

Loading

izaaklauer Jun 3, 2021

jgwhite Jun 4, 2021

jgwhite left a comment

jgwhite Jun 4, 2021

krantzinator left a comment

krantzinator Jun 4, 2021

mitchellh Jun 4, 2021

briancain Jun 4, 2021

izaaklauer Jun 4, 2021

izaaklauer Jun 4, 2021

briancain Jun 4, 2021

briancain Jun 4, 2021

briancain left a comment

briancain left a comment

izaaklauer commented Jun 9, 2021

briancain commented Jun 9, 2021

izaaklauer commented Jun 9, 2021 •

edited

Loading

izaaklauer commented Jun 9, 2021

briancain left a comment

Feature: CLI list deployments shows health for each entry #1594

Feature: CLI list deployments shows health for each entry #1594

Conversation

izaaklauer commented Jun 3, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jgwhite left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krantzinator left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

briancain left a comment

Choose a reason for hiding this comment

briancain left a comment

Choose a reason for hiding this comment

izaaklauer commented Jun 9, 2021

briancain commented Jun 9, 2021

izaaklauer commented Jun 9, 2021 • edited Loading

izaaklauer commented Jun 9, 2021

briancain left a comment

Choose a reason for hiding this comment

izaaklauer commented Jun 3, 2021 •

edited

Loading

izaaklauer commented Jun 9, 2021 •

edited

Loading