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

refactor/status #431

Closed
wants to merge 76 commits into from
Closed
Show file tree
Hide file tree
Changes from 49 commits
Commits
Show all changes
76 commits
Select commit Hold shift + click to select a range
67fd6d2
fix error for user with gpus per task field
bgunnar5 Jan 19, 2023
5f8a593
begin work on merlin status changes
bgunnar5 Jan 20, 2023
189fb43
fix issue with --spec flag on stop-workers cmd
bgunnar5 Jan 24, 2023
705fcd8
all flags for stop-workers now work and added ignores for e2e test ou…
bgunnar5 Jan 24, 2023
6ced784
add ability to print queue info with --queues flag on merlin info cmd
bgunnar5 Jan 24, 2023
db4787d
Merge branch 'main' of https://github.com/bgunnar5/merlin into refact…
bgunnar5 Jan 24, 2023
2b2c699
modify CHANGELOG
bgunnar5 Jan 24, 2023
2a0d7d4
move current merlin status to merlin info --queues
bgunnar5 Jan 25, 2023
bd97b46
add MERLIN_STATUS file and begin work on status updating
bgunnar5 Jan 30, 2023
5b5395b
update certain cmds to use queue_tag rather than hard coded value
bgunnar5 Feb 7, 2023
0c27397
refactor worker launch process & create dedicated status worker launch
bgunnar5 Feb 10, 2023
cd060e1
added mapping getters to MerlinSpec object
bgunnar5 Mar 1, 2023
0f2583e
pass study name through to Step object
bgunnar5 Mar 1, 2023
c274714
create new celery task to update statuses
bgunnar5 Mar 1, 2023
e81f279
groundwork for displaying the status of a study
bgunnar5 Mar 2, 2023
6dc1422
modify changelog for status revamp and add myself as a contributor
bgunnar5 Mar 2, 2023
7dafe61
merge in changes from 1.10.0 release
bgunnar5 Apr 15, 2023
bb84b34
allow for prompt-less low lvl display
bgunnar5 Apr 28, 2023
ff687b9
majority of the work for condensing status files
bgunnar5 Apr 28, 2023
284a622
resolve an issue after rebasing
bgunnar5 Apr 28, 2023
b58a9f8
fix merge conflict
bgunnar5 Apr 28, 2023
25b3335
add color blind assistance
bgunnar5 May 3, 2023
f63271b
add docs for new status command
bgunnar5 May 4, 2023
1fbd910
add status support for local runs
bgunnar5 May 9, 2023
8bc020b
refactor file condensing to remove filelocks
bgunnar5 May 11, 2023
3a7a522
refactor some status flags/display code
bgunnar5 May 11, 2023
884945a
add ability to dump status to csv
bgunnar5 May 12, 2023
6929808
add ability to dump to json and create Dumper object
bgunnar5 May 24, 2023
95694dc
add documentation for dumping status
bgunnar5 May 24, 2023
a8e500c
integrate Maestro's display using the rich library
bgunnar5 Jun 19, 2023
f4496b4
add filter by return code functionality
bgunnar5 Jun 21, 2023
cfe4479
add filelocks to status condensing and fix celery warning
bgunnar5 Jun 22, 2023
ecddb49
shift old status to queue-info and add some additional functionality …
bgunnar5 Jun 22, 2023
591b398
switch status to OOP and from .txt to .json files
bgunnar5 Jul 5, 2023
333d733
run fix-style and fix flake8 issues
bgunnar5 Jul 6, 2023
8339ea5
re-order command output in docs for status
bgunnar5 Jul 6, 2023
856bcea
fix CHANGELOG conflicts from merge with develop
bgunnar5 Jul 6, 2023
cb87588
fix pylint errors with new changes
bgunnar5 Jul 6, 2023
85f4b06
fix an issue with race conditions when condensing status files
bgunnar5 Jul 7, 2023
34d074d
fix issue with output path when running from another dir
bgunnar5 Jul 7, 2023
9ac7f77
split status command into two arguments
bgunnar5 Jul 11, 2023
6060fb5
fix error with replace that was breaking tests
bgunnar5 Jul 11, 2023
f60df9b
fix merge conflict when pulling from develop
bgunnar5 Jul 11, 2023
7b6ba46
clean up unused code and comments
bgunnar5 Jul 12, 2023
f600163
update CHANGELOG
bgunnar5 Jul 12, 2023
bc8fb9a
minor fixes and log additions
bgunnar5 Jul 13, 2023
93d6f40
fix lint errors
bgunnar5 Jul 13, 2023
cb82e1f
add docs for status, detailed-status, and queue-info commands
bgunnar5 Jul 13, 2023
8c9eeca
add Jeremy's suggestions and some stuff to help with testing status
bgunnar5 Jul 20, 2023
0b1f8ec
add tests for merlin status
bgunnar5 Jul 20, 2023
1dc6108
add detailed-status tests
bgunnar5 Jul 25, 2023
bfee1b3
first attempt at getting pytest to work
bgunnar5 Jul 25, 2023
bed7b68
fix pylint issue with detailed-status tests and add copyright message…
bgunnar5 Jul 25, 2023
053ef31
reformat json files in test library
bgunnar5 Jul 25, 2023
80d6253
reformat how parameters are stored in the status.json file
bgunnar5 Jul 26, 2023
8e535f3
move dump test functionality to shared file
bgunnar5 Jul 26, 2023
e04daf1
add dump tests with filters for detailed-status
bgunnar5 Jul 26, 2023
d1fd9ca
update docs to accommodate new status.json file renaming changes
bgunnar5 Jul 26, 2023
84d43a3
remove tabulate_info function to try to fix test problems
bgunnar5 Jul 26, 2023
694d8f4
fix pylint issues with newest changes
bgunnar5 Jul 26, 2023
60fc5d9
second attempt at fixing tests on github
bgunnar5 Jul 26, 2023
8c19c82
fix cyclic imports to hopefully fix github ci
bgunnar5 Jul 26, 2023
015f71b
moving broker/results_backend config imports inside functions
bgunnar5 Jul 26, 2023
6e509fc
move another config import inside a function
bgunnar5 Jul 26, 2023
a404c43
first attempt at modifying dirname so github ci works
bgunnar5 Jul 26, 2023
bb55e05
add class setup/teardown to modify expanded yaml for status tests
bgunnar5 Jul 26, 2023
1a2c476
make csv dump test ignore the order of output
bgunnar5 Jul 26, 2023
0f7bf0b
move queue-info related code from router to celeryadapter
bgunnar5 Aug 14, 2023
4ce11e1
add tests for queue-related functions in celeryadapter
bgunnar5 Aug 14, 2023
fa4699b
update docs to accommodate --specification to --spec change
bgunnar5 Aug 14, 2023
b907adf
update CHANGELOG
bgunnar5 Aug 14, 2023
91384ba
merge v1.10.2 into this branch
bgunnar5 Aug 14, 2023
af8bf04
small changes to wording in CHANGELOG
bgunnar5 Aug 14, 2023
acba79e
change port used for unit tests redis server
bgunnar5 Aug 15, 2023
2fd01d3
starting work on porting celeryadapter tests to integration suite
bgunnar5 Aug 17, 2023
645a444
do some more conversion from unittest to pytest syntax
bgunnar5 Aug 17, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,66 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- A bug where when the output path contained a variable that was overridden, the overridden variable was not changed in the output_path

### Added
- Tests for ensuring `$(MERLIN_SPEC_ORIGINAL_TEMPLATE)`, `$(MERLIN_SPEC_ARCHIVED_COPY)`, and `$(MERLIN_SPEC_EXECUTED_RUN)` are stored correctly
- A new command `merlin queue-info` that will print the status of your celery queues
- By default this will only pull information from active queues
- There are options to look for specific queues (`--specific-queues`), queues defined in certain spec files (`--specification`; this is the same functionality as the past `merlin status` command), and queues attached to certain steps (`--steps`)
- There is also an option to dump this info to an output file (`--dump`)
- A new command `merlin detailed-status` that displays task-by-task status information about your study
- This has options to filter by return code, task queues, task statuses, and workers
- You can set a limit on the number of tasks to display
- There are 3 options to modify the output display
- A pdf download format for the docs
- A new page titled `Monitoring Studies` in the docs to explain the new commands and the new status command
- Two new command entries in the `Command Line` page of the docs for the `queue-info` and `detailed-status` commands
- New file `merlin/study/status.py` dedicated to work relating to the status command
- Contains the Status and DetailedStatus classes
- New file `merlin/study/status_renderers.py` dedicated to formatting the output for the task-by-task display
- New file `merlin/common/dumper.py` containing a Dumper object to help dump output to outfiles
- Study name and parameter info now stored in the DAG and MerlinStep objects
- Added functions to `merlin/display.py` that help display status information:
- `display_task_by_task_status` handles the display for the `merlin detailed-status` command
- `display_summary` handles the display for the `merlin status` command
- `display_progress_bar` generates and displays a progress bar
- Added new methods to the MerlinSpec class:
- get_worker_step_map()
- get_queue_step_relationship()
- get_tasks_per_step()
- get_step_param_map()
- Added methods to the MerlinStepRecord class to mark status changes for tasks as they run (follows Maestro's StepRecord format mostly)
- Added methods to the Step class:
- establish_params()
- name_no_params()
- Added a property paramater_labels to the MerlinStudy class
- Added two new utility functions:
- dict_deep_merge() that deep merges two dicts into one
- ws_time_to_td() that converts a workspace timestring (YYYYMMDD-HHMMSS) to a datetime object
- A new task `condense_status_files` to be called when sets of samples finish
- Added a celery config setting `worker_cancel_long_running_tasks_on_connection_loss` since this functionality is about to change in the next version of celery
- Tests for ensuring `$(MERLIN_SPEC_ORIGINAL_TEMPLATE)`, `$(MERLIN_SPEC_ARCHIVED_COPY)`, and `$(MERLIN_SPEC_EXECUTED_RUN)` are stored correctly
- Tests for cli substitutions

### Changed
- Reformatted the entire "merlin status" command
- Now accepts both spec files and workspace directories as arguments
- e.g. "merlin status hello.yaml" and "merlin status hello_20230228-111920/" both work
- Removed the --steps flag
- Replaced the --csv flag with the --dump flag
- This will make it easier in the future to adopt more file types to dump to
- Moved previous functionality to the new `merlin queue-info` command
- New functionality:
- Shows step_by_step progress bar for tasks
- Displays a summary of task statuses below the progress bar
- Reformatted the status command section in the `Command Line` page of the docs
- The ProvenanceYAMLFileHasRegex condition for integration tests now saves the study name and spec file name as attributes instead of just the study name
- This lead to minor changes in 3 tests ("local override feature demo", "local pgen feature demo", and "remote feature demo") with what we pass to this specific condition
- Updated scikit-learn requirement for the openfoam_wf_singularity example
- Uncommented Latex support in the docs configuration to get pdf builds working
- Split the `add_chains_to_chord` function in `merlin/common/tasks.py` into two functions:
- `get_1d_chain` which converts a 2D list of chains into a 1D list
- `launch_chain` which launches the 1D chain
- query_celery_queues() in `merlin/study/celeryadapter.py` now uses with statements to open connection and channel to ensure they close
- Removed the `dump_status` function from `merlin/router.py` since dumping is now handled in the new Status object
- Pulled the needs_merlin_expansion() method out of the Step class and made it a function instead

## [1.10.1]
### Fixed
Expand Down
Binary file added docs/images/detailed-status/ascii-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/disable-pager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/disable-theme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/dump-csv.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/dump-json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/filter-max-tasks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/filter-prompt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/filter-steps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/filter-workers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/inside-pager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/layout-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/max-tasks-prompt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/outside-pager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/detailed-status/prompt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/queue-info/active-queues.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/queue-info/dump-csv.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/queue-info/dump-json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/queue-info/no-active-queues.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/queue-info/specific-queues-active.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/queue-info/specification-option.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/queue-info/steps-option.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/status/cb-help.png
Binary file added docs/images/status/multiple-studies.png
Binary file added docs/images/status/status.png
21 changes: 21 additions & 0 deletions docs/source/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,24 @@ td {
.underline {
text-decoration: underline;
}
.red {
color:#d55e00;
}
.orange {
color:#e69f00;
}
.yellow {
color:#f0e442;
}
.green {
color:#009e74;
}
.blue {
color:#0072b2;
}
.light-blue {
color: #56b3e9;
}
.grey {
color: #666666;
}
34 changes: 17 additions & 17 deletions docs/source/_static/custom.js
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
function addCopyButtonToCode(){
// get all code elements
var allCodeBlocksElements = $( "div.highlight pre" );
// get all code elements
var allCodeBlocksElements = $( "div.highlight pre" );

// For each element, do the following steps
allCodeBlocksElements.each(function(ii) {
// define a unique id for this element and add it
var currentId = "codeblock" + (ii + 1);
$(this).attr('id', currentId);
// For each element, do the following steps
allCodeBlocksElements.each(function(ii) {
// define a unique id for this element and add it
var currentId = "codeblock" + (ii + 1);
$(this).attr('id', currentId);

// create a button that's configured for clipboard.js
// point it to the text that's in this code block
// add the button just after the text in the code block w/ jquery
var clipButton = '<button class="btn copybtn" data-clipboard-target="#' + currentId + '"><img src="https://clipboardjs.com/assets/images/clippy.svg" width="13" alt="Copy to clipboard"></button>';
$(this).after(clipButton);
});
// create a button that's configured for clipboard.js
// point it to the text that's in this code block
// add the button just after the text in the code block w/ jquery
var clipButton = '<button class="btn copybtn" data-clipboard-target="#' + currentId + '"><img src="https://clipboardjs.com/assets/images/clippy.svg" width="13" alt="Copy to clipboard"></button>';
$(this).after(clipButton);
});

// tell clipboard.js to look for clicks that match this query
new Clipboard('.btn');
// tell clipboard.js to look for clicks that match this query
new Clipboard('.btn');
}

$(document).ready(function () {
// Once the DOM is loaded for the page, attach clipboard buttons
addCopyButtonToCode();
// Once the DOM is loaded for the page, attach clipboard buttons
addCopyButtonToCode();
});
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
# 'sphinx.ext.autodoc',
# 'sphinx.ext.intersphinx',
# ]
extensions = ["sphinx.ext.autodoc"]
extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosectionlabel"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down
3 changes: 2 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,12 @@ For more details, check out the rest of the documentation.
Need help? `merlin@llnl.gov <merlin@llnl.gov>`_

.. toctree::
:maxdepth: 2
:maxdepth: 3

tutorial
getting_started
faq
merlin_monitoring
merlin_commands
merlin_workflows
merlin_specification
Expand Down
195 changes: 185 additions & 10 deletions docs/source/merlin_commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@ skip during execution of a workflow.

The ``--local`` option will run tasks sequentially in your current shell.

.. _merlin-run:

Run the workflow (``merlin run``)
---------------------------------
Expand Down Expand Up @@ -385,22 +386,196 @@ shown below.
merlin monitor


Status (``merlin status``)
--------------------------
View Queue Information (``merlin queue-info``)
----------------------------------------------
List queue statistics (name of the queue, number of tasks in this queue, and number of connected workers to this queue). For more
information see :ref:`Monitoring Studies`.

Usage:

.. code:: bash

$ merlin status <input.yaml> [--steps <steps>] [--vars <VARIABLES=<VARIABLES>>] [--csv <csv file>] [--task_server celery]
$ merlin queue-info [--dump <csv or json file>] [--specification <spec_file.yaml>] [--specific-queues <queue name(s)>] [--steps <step name(s)>] [--task_server celery] [--vars <VARIABLES=<VARIABLES>>]

.. list-table:: Options
:widths: 20 20 40 20
:header-rows: 1

* - Name
- Type
- Description
- Default
* - -h, --help
- boolean
- Show a help message and exit
- False
* - --dump
- filename
- Dump the queue information to a file. Provide the filename (must be .csv or .json).
- None
* - --specification
- filename
- Path to a Merlin YAML spec file. This will only display information for queues defined in this spec file.
This is the same behavior as the status command before Merlin version 1.11.0 was released.
- None
* - --specific-queues
- string
- Display queue stats for specific queues you list here
- None
* - --steps
- string
- The specific steps in the YAML file you want to query the queues of. This option MUST be used with the --specification option.
- "all"
* - --task_server
- string
- Task server type. WARNING: the only supported task server at the moment is celery.
- celery
* - --vars
- string
- Specify desired Merlin variable values to override those found in the specification. Space-delimited. Example: '--vars
LEARN=path/to/new_learn.py EPOCHS=3'
- None


Status Summary (``merlin status``)
----------------------------------
Display a summary of the status of a study. For more information see :ref:`Monitoring Studies`.

Usage:

Use the ``--steps`` option to identify specific steps in the specification that you want to query.
.. code:: bash

The ``--vars`` option will specify desired Merlin variable values to override
those found in the specification. The list is space-delimited and should be given after
the input yaml file.
``Example: --vars LEARN=path/to/new_learn.py EPOCHS=3``
$ merlin status <input.yaml OR output_study/> [--cb-help] [--dump <csv or json file>] [--no-prompts] [--task_server celery] [--vars <VARIABLES=<VARIABLES>>]

.. list-table:: Options
:widths: 20 20 40 20
:header-rows: 1

* - Name
- Type
- Description
- Default
* - -h, --help
- boolean
- Show a help message and exit
- False
* - --cb-help
- boolean
- Colorblind help; uses different symbols to represent different statuses
- False
* - --dump
- filename
- Dump the status to a file. Provide the filename (must be .csv or .json).
- None
* - --no-prompts
- boolean
- Ignore any prompts provided. This will default to the latest study if you provide a spec file rather than a study workspace.
- False
* - --task_server
- string
- Task server type. WARNING: the only supported task server at the moment is celery.
- celery
* - --vars
- string
- Specify desired Merlin variable values to override those found in the specification. Space-delimited. Example: '--vars
LEARN=path/to/new_learn.py EPOCHS=3'
- None

Detailed Status (``merlin detailed-status``)
--------------------------------------------
Display the task-by-task status of a study. For more information see :ref:`Monitoring Studies`.

Usage:

The ``--csv`` option takes in a filename, to dump status reports to.
.. code:: bash

$ merlin detailed-status <input.yaml OR output_study/> [--dump <csv or json file>] [--task_server celery] [--vars <VARIABLES=<VARIABLES>>] [--max-tasks <max num tasks to display>] [--return-code <return code(s)>] [--steps <step(s)>] [--task-queues <task queue(s)>] [--task-status <task status(es)>] [--workers <worker(s)>]S [--disable-pager] [--disable-theme] [--layout <layout>] [--no-prompts]

.. list-table:: General Options
:widths: 20 20 40 20
:header-rows: 1

* - Name
- Type
- Description
- Default
* - -h, --help
- boolean
- Show a help message and exit
- False
* - --dump
- filename
- Dump the status to a file. Provide the filename (must be .csv or .json).
- None
* - --task_server
- string
- Task server type. WARNING: the only supported task server at the moment is celery.
- celery
* - --vars
- string
- Specify desired Merlin variable values to override those found in the specification. Space-delimited. Example: '--vars
LEARN=path/to/new_learn.py EPOCHS=3'
- None

.. list-table:: Filter Options
:widths: 20 20 40 20
:header-rows: 1

* - Filter Name
- Type
- Description
- Default
* - --max-tasks
- integer
- Sets a limit on how many tasks can be displayed
- None
* - --return-code
- choice (SUCCESS \| SOFT_FAIL \| HARD_FAIL \| STOP_WORKERS \| RETRY \| DRY_SUCCESS \| UNRECOGNIZED)
- Filter which tasks to display based on their return code
- None
* - --steps
- string
- Filter which tasks to display based on the steps they're associated with
- "all"
* - --task-queues
- string
- Filter which tasks to display based on the task queue they're in
- None
* - --task-status
- choice (INITIALIZED \| RUNNING \| FINISHED \| FAILED \| CANCELLED \| DRY_RUN \| UNKNOWN)
- Filter which tasks to display based on their status
- None
* - --workers
- string
- Filter which tasks to display based on which workers are processing them
- None

.. list-table:: Display Options
:widths: 20 20 40 20
:header-rows: 1

* - Name
- Type
- Description
- Default
* - --disable-pager
- boolean
- Turn off the pager functionality when viewing the status
- False
* - --disable-theme
- boolean
- Turn off styling for the status layout (If you want styling but it's not working, try modifying the MANPAGER or PAGER environment
variables to be 'less -r'; i.e. export MANPAGER='less -r')
- False
* - --layout
- choice (table \| default)
- Alternate status layouts
- default
* - --no-prompts
- boolean
- Ignore any prompts provided. This will default to the latest study if you provide a spec file rather than a study workspace.
- False

The only currently available option for ``--task_server`` is celery, which is the default when this flag is excluded.


.. _stop-workers:
Expand Down
Loading