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

feat: Create a CLI command to output a job schedule trace #19

Merged
merged 1 commit into from
Dec 19, 2023

Conversation

mwiebe
Copy link
Contributor

@mwiebe mwiebe commented Sep 3, 2023

What was the problem/requirement? (What/Why)

Understanding the behavior of the Deadline Cloud scheduler is important to help guide its development and to help customers understand how effectively it is working on their behalf. Something that could visualize the entire schedule produced for a job would help.

What was the solution? (How)

  • Write a new CLI command that queries all the session and session action data from runing a job, and writes both a high level summary and optionally a trace json file that can be opened with the https://ui.perfetto.dev tracing UI.
  • While at it, added the --priority option to deadline bundle submit

What is the impact of this change?

Using this tool, we can evaluate how well the scheduler is working.

How was this change tested?

Ran it on some jobs, inspected the output.

Was this change documented?

Yes, it's in the CLI help. I marked it as EXPERIMENTAL, as we'll likely want to modify this over time.

Is this a breaking change?

No

@mwiebe mwiebe requested a review from a team as a code owner September 3, 2023 05:36
@mwiebe mwiebe force-pushed the markw/tracing-output branch 7 times, most recently from c0bd6de to a586f96 Compare September 11, 2023 22:35
@mwiebe mwiebe force-pushed the markw/tracing-output branch from a586f96 to c8add2f Compare September 22, 2023 05:54
@mwiebe mwiebe force-pushed the markw/tracing-output branch 5 times, most recently from 116a0ca to ba950b6 Compare December 13, 2023 06:21
@jusiskin jusiskin self-requested a review December 19, 2023 16:11
Copy link
Contributor

@jusiskin jusiskin left a comment

Choose a reason for hiding this comment

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

Just one small possible typo in an error message.

Another concern is not having tests for the trace file generation, but I see we have a comment about that being a large effort and the “EXPERIMENTAL” warning is mentioned in the command-line help so that it’s clear this is not fully supported. On that basis, I'm okay with the change.

src/deadline/client/cli/_groups/job_group.py Outdated Show resolved Hide resolved
 * While at it, added the --priority, --max-failed-tasks-count, and
   --max-retries-per-task options to `deadline bundle submit`
 * Add a really simple test of the new command

Signed-off-by: Mark Wiebe <[email protected]>
Signed-off-by: Mark Wiebe <[email protected]>
@mwiebe mwiebe force-pushed the markw/tracing-output branch from ba950b6 to 1dabf26 Compare December 19, 2023 17:50
@mwiebe mwiebe merged commit 4ace7c1 into mainline Dec 19, 2023
18 checks passed
@mwiebe mwiebe deleted the markw/tracing-output branch December 19, 2023 22:05
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

Successfully merging this pull request may close these issues.

4 participants