cyclops icon indicating copy to clipboard operation
cyclops copied to clipboard

Add a button for Deployment/Statefulset logs

Open petar-cvit opened this issue 1 year ago • 12 comments

Is your feature request related to a problem? Please describe. We recently implemented an endpoint for fetching aggregated logs for Deployments and Statefulsets. It would be useful to add a button for viewing logs on Deployments and Statefulsets.

Here is the modal for viewing logs on Deployment logs. The scope of the issue is to add a button on the Deployment level that would fetch logs from /resources/deployments/:namespace/:deployment/:container/logs

petar-cvit avatar May 05 '24 20:05 petar-cvit

Hey @yuvarajrece. Can you link the PR and the issue by commenting closes #257 to it? Also, can you rename the PR to be more descriptive?

petar-cvit avatar May 08 '24 16:05 petar-cvit

Hi @petar-cvit, would you assign this issue to me? Thanks!

doncicuto avatar Jun 11 '24 10:06 doncicuto

Sure @doncicuto

petar-cvit avatar Jun 16 '24 00:06 petar-cvit

Hi @petar-cvit, I've some doubts about the current backend implementation for Deployment/Statefulset logs

I assume that you want Cyclops UI to show all the logs for every single container for every pod found in the deployment/statefulset. This would be the screenshot for the button to check that the UI would be fine:

image

Right now I've readded the following endpoints that were removed by @hanshal101 (accidentally in a subsequent PR) :

h.router.GET("/resources/deployments/:namespace/:deployment/:container/logs", modulesController.GetDeploymentLogs)
h.router.GET("/resources/statefulsets/:namespace/:name/:container/logs", modulesController.GetStatefulSetsLogs)

The thing is that the endpoint requires to pass the name of the container that you want to get the logs. I've no problem to use the first container for the first pod in the deployment, but you'd miss the rest of the logs.

In summary, I'd like to know if you're ok with getting only the logs of the first container for the first pod in the deployment or you want to show all the logs something like https://github.com/stern/stern provides.

If you prefer the second then the backend should be modified in order to get logs for all the containers and pods and therefore the container name would not be passed to the endpoint. In this case maybe it'd be better to create a new issue and either @hanshal101 or me would make the needed changes to the backend.

Just let me know which path should I follow. Thanks!

doncicuto avatar Jun 17 '24 11:06 doncicuto

I was thinking of having the same approach as with pod logs. Pod logs show different containers in different tabs. Could we do that? Screenshot 2024-06-17 at 14 03 56

But yeah, you should add these back

h.router.GET("/resources/deployments/:namespace/:deployment/:container/logs", modulesController.GetDeploymentLogs)
h.router.GET("/resources/statefulsets/:namespace/:name/:container/logs", modulesController.GetStatefulSetsLogs)

petar-cvit avatar Jun 17 '24 12:06 petar-cvit

Thanks @petar-cvit, I'm preparing the changes for the PR right now

doncicuto avatar Jun 19 '24 09:06 doncicuto

New Quest! image New Quest!

A new Quest has been launched in @cyclops-ui’s repo. Merge a PR that solves this issue to loot the Quest and earn your reward.


Some loot has been stashed in this issue to reward the solver!

🗡 Comment @quest-bot embark to check-in for this Quest and start solving the issue. Other solvers will be notified!

⚔️ When you submit a PR, comment @quest-bot loot #257 to link your PR to this Quest.

Questions? Check out the docs.

quest-bot[bot] avatar Oct 06 '24 11:10 quest-bot[bot]

I would like to work on this @petar-cvit

k0msenapati avatar Oct 08 '24 16:10 k0msenapati

@quest-bot embark

k0msenapati avatar Oct 08 '24 16:10 k0msenapati

@quest-bot embark

Sheikh-Abubaker avatar Oct 18 '24 17:10 Sheikh-Abubaker

@Sheikh-Abubaker has embarked on their Quest. 🗡

  • @Sheikh-Abubaker has been on GitHub since 2022.
  • They have merged 40 public PRs in that time.
  • Their swords are blessed with Shell and Smarty magic ✨
  • They have contributed to this repo before.

This is not an assignment to the issue. Please check the repo’s contribution guidelines before submitting a PR.

Questions? Check out the docs.

quest-bot[bot] avatar Oct 18 '24 17:10 quest-bot[bot]

🧚 @Sheikh-Abubaker has submitted PR https://github.com/cyclops-ui/cyclops/issues/660 and is claiming the loot.

Keep up the pace, or you'll be left in the shadows.

Questions? Check out the docs.

quest-bot[bot] avatar Oct 28 '24 20:10 quest-bot[bot]