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

rabbit: add docs on rabbit_datamovements #279

Merged
merged 1 commit into from
Oct 1, 2024
Merged
Changes from all commits
Commits
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
rabbit: add docs on rabbit_datamovements
Problem: there is no documentation for the rabbit_datamovements KVS
entry.

Add docs.
jameshcorbett committed Oct 1, 2024
commit a19b1d44d83035f0656aa2a853f8444da2e30d5a
26 changes: 23 additions & 3 deletions tutorials/lab/rabbit.rst
Original file line number Diff line number Diff line change
@@ -98,9 +98,13 @@ in a batch script:
Additional Attributes of Rabbit Jobs
------------------------------------

In order to help users understand how much time various parts of a rabbit job take,
Flux adds a handful of attributes to each rabbit job. The attributes a rabbit job
may have are, in order:
All rabbit jobs have some extra data stored on them to help with debugging and to
help account for time spent on various stages.

Timing Attributes
~~~~~~~~~~~~~~~~~

The timing attributes a rabbit job may have are, in order:

#. ``rabbit_proposal_timing``: time it takes for DWS to process the job's #DW strings
and provide a breakdown of the resources required to Flux.
@@ -129,6 +133,9 @@ to mount on the compute nodes. Fetch the timing for a state by running, e.g. for
If the job does not have the timing for a state, for instance because it has not
completed the state yet, expect to see an error like ``flux-job: No such file or directory``.

Debugging Attributes
~~~~~~~~~~~~~~~~~~~~

All rabbit jobs also have a ``rabbit_workflow`` attribute that stores high-level but
technical information about the status of the rabbit job. Fetch the data (which is
in JSON format) with ``flux job info ${jobid} rabbit_workflow``, potentially
@@ -140,3 +147,16 @@ can be singled out with
.. code-block:: bash

flux job info ${jobid} rabbit_workflow | jq .status.message

If that is still unhelpful, try displaying more information:

.. code-block:: bash

flux job info ${jobid} rabbit_workflow | jq .status

In addition, rabbit jobs *may* have an attribute storing a small collection of
information about data movement. Fetch it with

.. code-block:: bash

flux job info ${jobid} rabbit_datamovements | jq .