get_task_process_tree

MonitorApi.get_task_process_tree(task_id, *, backlog=100, max_messages=200)

Return process tree metric messages for a specific task.

Collects up to max_messages process-tree snapshots and returns them all at once. Use stream_task_process_tree() if you want to react to each snapshot as it arrives.

Return type:

list[MonitorMessage]

Parameters:

task_idstr

The task identifier to query.

backlogint, optional

Number of historical messages to request on connect. The default is 100.

max_messagesint or None, optional

Upper bound on messages to collect. The default is 200. If None, collect until interrupted or the server closes the connection.

Returns:

list[MonitorMessage]

List of process-tree message dicts as returned by the server.