Project

General

Profile

Feature #36953

Umbrella #36938: Middleware task progress

Return progress for debug file creation

Added by Erin Clark over 1 year ago. Updated 8 months ago.

Status:
Done
Priority:
No priority
Assignee:
Brandon Schneider
Category:
Middleware
Target version:
Estimated time:
Severity:
Medium
Reason for Closing:
Reason for Blocked:
Needs QA:
No
Needs Doc:
No
Needs Merging:
No
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:

Description

Creating a debug file can take a long time, would it be possible for the middleware to return a percentage so the user knows that the task is doing something.

------- William's description below -----

Currently debug file generation happens on legacy UI code, two things need to happen here:

1. Code to generate debug has to be moved from UI to middlewared, making legacy UI call middleware (it needs to be a job method).

2. Generating debug has to be changed (its a shell script program) to be more verbose while running:
  a. we need to first calculate the amount of modules that are going to run
  b. before each module runs we need to print the percentage of modules that have ran so far and what the modules does, e.g.
    0%: generating system information
    5%: running disk latency script
  c. on middlewared we will run that script reading the stdout and parsing each line, updating the job progress with percent and description

Risk
This is a high risk task since it touches a critical piece of the software which is providing debug from customer to diagnose issues without requiring calls.

Acceptance Criteria
Once this is completely we will be able to check out progress of save debug using middlewared websocket call. Code will be necessary in the new UI to show the changes.


Related issues

Copied to FreeNAS - Feature #76225: Show progress for debug file creation in new UIPassed Testing

Associated revisions

Revision 81e41d14 (diff)
Added by Brandon Schneider 10 months ago

feat(system/debug): Report progress via the job This PR introduces parsing the stdout of ixdiagnose to provide progress on the debug creation. ixdiagnose changes --- - Add -p flag to print to stdout instead of piping to the tmpfile freenas-debug ---- - We now print ** PERCENT%: DESCRIPTION for each debug task requested Ticket: #36953

Revision edf46a18 (diff)
Added by Brandon Schneider 10 months ago

feat(system/debug): Report progress via the job (#2618) This PR introduces parsing the stdout of ixdiagnose to provide progress on the debug creation. ixdiagnose changes --- - Add -p flag to print to stdout instead of piping to the tmpfile freenas-debug ---- - We now print ** PERCENT%: DESCRIPTION for each debug task requested Ticket: #36953

History

#1 Updated by William Grzybowski over 1 year ago

  • Description updated (diff)
  • Assignee changed from William Grzybowski to Brandon Schneider
  • Severity changed from New to Medium

#2 Updated by William Grzybowski over 1 year ago

  • Description updated (diff)

#3 Updated by William Grzybowski over 1 year ago

  • Description updated (diff)

#4 Updated by William Grzybowski over 1 year ago

  • Description updated (diff)

#5 Updated by Brandon Schneider over 1 year ago

  • Status changed from Unscreened to Not Started

#6 Updated by Brandon Schneider over 1 year ago

  • Status changed from Not Started to In Progress

#7 Updated by Bug Clerk 10 months ago

  • Status changed from In Progress to Ready for Testing

#8 Updated by Bug Clerk 10 months ago

  • Target version changed from 11.3 to 11.3-BETA1

#9 Updated by Dru Lavigne 10 months ago

  • Needs Merging changed from Yes to No

#10 Updated by Dru Lavigne 10 months ago

  • Copied to Feature #76225: Show progress for debug file creation in new UI added

#11 Updated by Bonnie Follweiler 10 months ago

This has been assigned to Zackary Welch

#12 Updated by William Grzybowski 10 months ago

  • Status changed from Ready for Testing to Passed Testing
  • Needs QA changed from Yes to No

This can only be tested in related ticket.

#13 Updated by Dru Lavigne 10 months ago

  • Status changed from Passed Testing to Done
  • Needs Doc changed from Yes to No

#14 Updated by Dru Lavigne 8 months ago

  • Target version changed from 11.3-BETA1 to 11.3-ALPHA1

Also available in: Atom PDF