hpcflow.sdk.monitoring.status.collect#

hpcflow.sdk.monitoring.status.collect(app, workflow_ref=None, ref_type=None, max_recent=None, no_update=False, include_summary=True, template_names=None, progress=None, include_missing=False, on_update=None, ignore_scheduler_interval=False)#

Collect active submissions and a limited recent inactive history.

Resolve an optional workflow ID, registered name, or path, then apply exact template-name filtering before scheduler queries and the inactive-history limit. Comma-separated IDs select multiple workflows and are validated before queries. Missing workflow paths are hidden before querying schedulers or applying history limits unless include_missing is True. Their registry references remain available for inspection and cancellation. An explicit unregistered path can recover submission parts from its workflow. Active and unknown records precede inactive records and do not consume max_recent slots. None uses show_max_recent for the general overview, but includes all matching history when a workflow reference is supplied.

Refresh action summaries only for selected records when include_summary is True, reusing terminal caches and a persistent run/parent index. Fresh scheduler queued/waiting observations can supply nonterminal states without loading EARs or workflows; running and missing/unknown parents use store reads. Inspection failures remain visible as accessibility information rather than hiding the submission. no_update prevents all registry/cache writes, including new scheduler snapshots. Existing scheduler snapshots may still be reused. Scheduler snapshots use show_scheduler_min_interval (20 seconds) unless explicitly bypassed. Otherwise merge observations with concurrent registry changes and retention. Return invocation-owned snapshots, without live workflow or scheduler objects. on_update receives initial placeholders, scheduler results, and each ready row. It performs no additional collection or scheduler queries. Read different workflows with at most four workers; submissions sharing a workflow remain sequential. Publish ready rows and call progress callbacks on the caller thread.

Parameters:
  • app (BaseApp)

  • include_summary (bool)

  • template_names (Sequence[str] | str | None)

  • progress (Callable[[str], None] | None)

  • include_missing (bool)

  • on_update (Callable[[CollectionProgress], None] | None)

  • ignore_scheduler_interval (bool)

Return type:

list[SubmissionRecord]