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

Show routable / readiness state in the cf app command #3350

Open
maxmoehl opened this issue Jan 7, 2025 · 2 comments
Open

Show routable / readiness state in the cf app command #3350

maxmoehl opened this issue Jan 7, 2025 · 2 comments

Comments

@maxmoehl
Copy link
Member

maxmoehl commented Jan 7, 2025

What's the user value of this feature request?

Right now readiness checks can be configured via the manifest but the CLI doesn't give any indication whether an application is ready. This causes confusion as the app is unreachable (404: route not found) but in the CLI it is shown as running with no indication of anything being wrong.

Who is the functionality for?

Users pushing apps with readiness checks.

How often will this functionality be used by the user?

Often, every time the readiness of app instances needs to be inspected.

Who else is affected by the change?

Operators who troubleshoot issues reported by users, anyone who might be parsing the output of the cf app command.

Is your feature request related to a problem? Please describe.

Yes, it is tedious to use cf curls to find the processes and list their stats to view the routable state.

Describe the solution you'd like

An additional column in the process table to view the readiness / routable state:

$ cf app my-app
Showing health and status for app my-app in org my-org / space my-space as [email protected]...

name:              my-app
requested state:   started
routes:            my-app.cf.example.com
[...]

     state     since                  ready   cpu    memory          disk            logging             cpu entitlement   details
#0   running   2025-01-07T09:11:53Z   true    2.1%   16.2M of 128M   36.9M of 256M   0B/s of unlimited   106.9%

Describe alternatives you've considered

An additional command but that seems unnecessary for just viewing such information.

Additional context

RFC0020 Readiness Healthchecks
CC v3 API: The process stats object

I'm willing to provide a PR for this.

@maxmoehl
Copy link
Member Author

maxmoehl commented Jan 7, 2025

I've built a POC in my fork at feat/add-ready-column.

@maxmoehl
Copy link
Member Author

maxmoehl commented Jan 7, 2025

I just noticed that the RFC contains an example on how to implement this part:

     state     routable   since                  cpu    memory          disk         logging            details
#0   running   yes        2023-06-27T15:07:14Z   0.6%   46.8M of 192M   179M of 1G   0/s of unlimited
#1   running   no         2023-06-27T15:11:43Z   0.0%   0 of 0          0 of 0       0/s of 0/s
#2   running   yes        2023-06-27T15:11:43Z   0.0%   0 of 192M       0 of 1G      0/s of 0/s

I deviated a little bit because the wording around this feature is all "ready" / "readiness" and suddenly showing "routable" seems odd to me. I've also placed it after the since column as to my understanding the since refers to the value in state and is independent of the readiness.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant