worker

get resource usage per runnable and worker group over a time window (require devops role)

Changed on
get/workers/runnable_stats

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workers/runnable_stats
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Query parameters

window_secsinteger

how far back to read, in seconds (defaults to one day, capped at the 30-day retention)

worker_groupstring

only the jobs run by this worker group

workspacestring

only the jobs of this workspace

order_by'total_duration' | 'max_memory' | 'cpu'

what the rows are ranked by, descending (default: total_duration)

limitinteger

number of rows to return (default 100, at most 1000)

Response

resource usage per runnable and worker group, heaviest first

workspace_idstring required
runnable_pathstring required

path of the script or flow step; <adhoc> gathers previews and other runs without a stable path

worker_groupstring required
job_countinteger required
total_duration_msinteger required
max_memory_peakinteger required

highest peak memory of a job, in kB

sum_memory_peakinteger required

sum of the peak memory of the jobs that have one, in kB

memory_sample_countinteger required

number of jobs that have a peak memory reading

total_cpu_msinteger required

Changes