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

Summary endpoint. #215

Open
claymcleod opened this issue Sep 23, 2024 · 3 comments
Open

Summary endpoint. #215

claymcleod opened this issue Sep 23, 2024 · 3 comments
Milestone

Comments

@claymcleod
Copy link

I'd consider adding a summary endpoint that summarizes the state of all of the tasks submitted to the server—this way, if you just want to get the counts in each state, you don't have to iterate over the entire collection of tasks (saving server bandwidth and time overall).

@uniqueg
Copy link
Contributor

uniqueg commented Sep 28, 2024

What's the use case exactly? Would you imagine this as an admin endpoint (total counts for tasks submitted by all users) or a user-specific one (total counts for tasks submitted by a given user)? If the former is fine for your use case and we don't consider these counts sensitive, we could add it to the service info in the same way WES does:

            system_state_counts:
              type: object
              additionalProperties:
                type: integer
                format: int64

Not sure what happened to the description. Seems they got inadvertently lost between 1.0.0 and 1.0.1. Anyway, it used to be:

The system statistics, key is the statistic, value is the count of runs in that state. See the State enum for the possible keys.

@claymcleod
Copy link
Author

Oh, that's a good question. Most of my thoughts (including this one) are going to be from a user's perspective. Here, the goal would essentially be to facilitate a dashboard of "my" jobs in a particular TES server that I run locally.

We prototyped something like this in our biohackathon here: https://github.com/stjude-biohackathon/KIDS24-team15/tree/main/tes-dashboard.

@uniqueg
Copy link
Contributor

uniqueg commented Oct 3, 2024

Fair enough. Probably something to discuss with WES. Any other dashboarding/stats features you can think of? Could perhaps be addressed/discussed together.

@vsmalladi vsmalladi added this to the Next milestone Oct 31, 2024
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

3 participants