Workflow traces
Manage workflow execution (pipeline run) traces.
Path and query parameters
Name | Type | Location | Req/Opt | Description |
|---|---|---|---|---|
| integer | query | Optional | Workspace numeric identifier |
| string | path | Required | Workflow string identifier |
Request body parameters
Name | Type | Req/Opt | Description |
|---|---|---|---|
CreateTrace | Create workflow execution trace | ||
launchId | string | Optional | Deprecated legacy alias for |
sessionId | string | Optional | Nextflow session identifier used to correlate subsequent trace updates. |
runName | string | Optional | Workflow run name reported by Nextflow. |
projectName | string | Optional | Pipeline or project name reported by Nextflow. |
repository | string | Optional | Source repository URL or path for the workflow project. |
workflowId | string | Optional | Existing workflow string identifier to associate with this trace create request. |
UpdateTraceBegin | Signal workflow execution start | ||
launchId | string | Optional | Deprecated legacy field. If provided, Seqera Platform treats the trace as originating from a Platform-managed launch. |
workflow | object | Optional | |
workflow.requiresAttention | boolean | Optional | If |
workflow.status | string | Optional | |
workflow.ownerId | integer | Optional | Numeric identifier of the workflow owner. |
workflow.repository | string | Optional | Source repository URL or path for the workflow project. |
workflow.id | string | Optional | Workflow string identifier. |
workflow.submit | string | Required | Timestamp when the workflow was submitted. |
workflow.start | string | Optional | Timestamp when workflow execution started. |
workflow.complete | string | Optional | Timestamp when workflow execution completed. |
workflow.dateCreated | string | Optional | Timestamp when the workflow record was created. |
workflow.lastUpdated | string | Optional | Timestamp when the workflow record was last updated. |
workflow.runName | string | Required | Workflow run name. Must be unique within the session. |
workflow.sessionId | string | Required | Nextflow session identifier for the workflow run. |
workflow.profile | string | Optional | Nextflow profile or profile selection used for the run. |
workflow.workDir | string | Required | Workflow work directory path. |
workflow.commitId | string | Optional | Source control commit identifier for the workflow run. |
workflow.userName | string | Required | Username reported for the workflow owner. |
workflow.scriptId | string | Optional | Internal script or pipeline identifier associated with the run. |
workflow.revision | string | Optional | Source control revision, branch, or tag used for the run. |
workflow.commandLine | string | Required | Full command line used to launch the workflow. |
workflow.projectName | string | Required | Pipeline or project name reported by Nextflow. |
workflow.scriptName | string | Optional | Main workflow script filename. |
workflow.launchId | string | Optional | Legacy launch identifier associated with the workflow. |
workflow.configFiles | array | Optional | Array of configuration files used for the workflow run. |
workflow.params | object | Optional | Workflow input parameter map. |
workflow.configText | string | Optional | Inline Nextflow configuration text used for the run. |
workflow.manifest | object | Optional | |
workflow.manifest.nextflowVersion | string | Optional | Nextflow version declared by the pipeline manifest. |
workflow.manifest.defaultBranch | string | Optional | Default source control branch declared by the manifest. |
workflow.manifest.version | string | Optional | Pipeline version declared by the manifest. |
workflow.manifest.homePage | string | Optional | Pipeline homepage URL declared by the manifest. |
workflow.manifest.gitmodules | string | Optional | Comma-separated git submodule paths declared by the manifest. |
workflow.manifest.description | string | Optional | Pipeline description declared by the manifest. |
workflow.manifest.name | string | Optional | Pipeline name declared by the manifest. |
workflow.manifest.mainScript | string | Optional | Main workflow script filename declared by the manifest. |
workflow.manifest.author | string | Optional | Pipeline author declared by the manifest. |
workflow.manifest.icon | string | Optional | Relative path or URL for the pipeline icon. |
workflow.nextflow | object | Optional | |
workflow.nextflow.version | string | Optional | Nextflow runtime version used for the workflow run. |
workflow.nextflow.build | string | Optional | Nextflow build identifier. |
workflow.nextflow.timestamp | string | Optional | Timestamp associated with the reported Nextflow build. |
workflow.stats | object | Optional | |
workflow.stats.computeTimeFmt | string | Optional | Human-readable total compute time across workflow tasks. |
workflow.stats.cachedCount | integer | Optional | Number of cached tasks. |
workflow.stats.failedCount | integer | Optional | Number of failed tasks. |
workflow.stats.ignoredCount | integer | Optional | Number of ignored tasks. |
workflow.stats.succeedCount | integer | Optional | Number of successful tasks. |
workflow.stats.cachedCountFmt | string | Optional | Human-readable cached task count. |
workflow.stats.succeedCountFmt | string | Optional | Human-readable successful task count. |
workflow.stats.failedCountFmt | string | Optional | Human-readable failed task count. |
workflow.stats.ignoredCountFmt | string | Optional | Human-readable ignored task count. |
workflow.stats.cachedPct | number | Optional | Percentage of tasks satisfied from cache. |
workflow.stats.failedPct | number | Optional | Percentage of tasks that failed. |
workflow.stats.succeedPct | number | Optional | Percentage of tasks that succeeded. |
workflow.stats.ignoredPct | number | Optional | Percentage of tasks that were ignored. |
workflow.stats.cachedDuration | integer | Optional | Aggregate duration in milliseconds for cached tasks. |
workflow.stats.failedDuration | integer | Optional | Aggregate duration in milliseconds for failed tasks. |
workflow.stats.succeedDuration | integer | Optional | Aggregate duration in milliseconds for successful tasks. |
workflow.fusion | object | Optional | |
workflow.fusion.enabled | boolean | Optional | If |
workflow.fusion.version | string | Optional | Fusion version reported for the workflow run. |
workflow.wave | object | Optional | |
workflow.wave.enabled | boolean | Optional | If |
workflow.errorMessage | string | Optional | Summarized task error message associated with the workflow failure. |
workflow.errorReport | string | Optional | Detailed error report associated with the workflow failure. |
workflow.deleted | boolean | Optional | If |
workflow.projectDir | string | Optional | Local project directory used for the workflow run. |
workflow.homeDir | string | Optional | Home directory used by the workflow runtime. |
workflow.container | string | Optional | Workflow-level container image. |
workflow.containerEngine | string | Optional | Container engine used for workflow execution. |
workflow.scriptFile | string | Optional | Resolved path to the executed workflow script. |
workflow.launchDir | string | Optional | Directory from which the workflow was launched. |
workflow.duration | integer | Optional | Total workflow duration in milliseconds. |
workflow.exitStatus | integer | Optional | Final workflow exit status code. |
workflow.resume | boolean | Optional | If |
workflow.success | boolean | Optional | If |
workflow.logFile | string | Optional | Path to the workflow log file. |
workflow.outFile | string | Optional | Path to the workflow standard output file. |
workflow.operationId | string | Optional | Internal operation identifier associated with the workflow launch. |
processNames | array | Optional | Array of process names discovered in the workflow definition. |
towerLaunch | boolean | Optional | If |
UpdateTraceComplete | Signal workflow execution completion | ||
workflow | object | Optional | |
workflow.requiresAttention | boolean | Optional | If |
workflow.status | string | Optional | |
workflow.ownerId | integer | Optional | Numeric identifier of the workflow owner. |
workflow.repository | string | Optional | Source repository URL or path for the workflow project. |
workflow.id | string | Optional | Workflow string identifier. |
workflow.submit | string | Required | Timestamp when the workflow was submitted. |
workflow.start | string | Optional | Timestamp when workflow execution started. |
workflow.complete | string | Optional | Timestamp when workflow execution completed. |
workflow.dateCreated | string | Optional | Timestamp when the workflow record was created. |
workflow.lastUpdated | string | Optional | Timestamp when the workflow record was last updated. |
workflow.runName | string | Required | Workflow run name. Must be unique within the session. |
workflow.sessionId | string | Required | Nextflow session identifier for the workflow run. |
workflow.profile | string | Optional | Nextflow profile or profile selection used for the run. |
workflow.workDir | string | Required | Workflow work directory path. |
workflow.commitId | string | Optional | Source control commit identifier for the workflow run. |
workflow.userName | string | Required | Username reported for the workflow owner. |
workflow.scriptId | string | Optional | Internal script or pipeline identifier associated with the run. |
workflow.revision | string | Optional | Source control revision, branch, or tag used for the run. |
workflow.commandLine | string | Required | Full command line used to launch the workflow. |
workflow.projectName | string | Required | Pipeline or project name reported by Nextflow. |
workflow.scriptName | string | Optional | Main workflow script filename. |
workflow.launchId | string | Optional | Legacy launch identifier associated with the workflow. |
workflow.configFiles | array | Optional | Array of configuration files used for the workflow run. |
workflow.params | object | Optional | Workflow input parameter map. |
workflow.configText | string | Optional | Inline Nextflow configuration text used for the run. |
workflow.manifest | object | Optional | |
workflow.manifest.nextflowVersion | string | Optional | Nextflow version declared by the pipeline manifest. |
workflow.manifest.defaultBranch | string | Optional | Default source control branch declared by the manifest. |
workflow.manifest.version | string | Optional | Pipeline version declared by the manifest. |
workflow.manifest.homePage | string | Optional | Pipeline homepage URL declared by the manifest. |
workflow.manifest.gitmodules | string | Optional | Comma-separated git submodule paths declared by the manifest. |
workflow.manifest.description | string | Optional | Pipeline description declared by the manifest. |
workflow.manifest.name | string | Optional | Pipeline name declared by the manifest. |
workflow.manifest.mainScript | string | Optional | Main workflow script filename declared by the manifest. |
workflow.manifest.author | string | Optional | Pipeline author declared by the manifest. |
workflow.manifest.icon | string | Optional | Relative path or URL for the pipeline icon. |
workflow.nextflow | object | Optional | |
workflow.nextflow.version | string | Optional | Nextflow runtime version used for the workflow run. |
workflow.nextflow.build | string | Optional | Nextflow build identifier. |
workflow.nextflow.timestamp | string | Optional | Timestamp associated with the reported Nextflow build. |
workflow.stats | object | Optional | |
workflow.stats.computeTimeFmt | string | Optional | Human-readable total compute time across workflow tasks. |
workflow.stats.cachedCount | integer | Optional | Number of cached tasks. |
workflow.stats.failedCount | integer | Optional | Number of failed tasks. |
workflow.stats.ignoredCount | integer | Optional | Number of ignored tasks. |
workflow.stats.succeedCount | integer | Optional | Number of successful tasks. |
workflow.stats.cachedCountFmt | string | Optional | Human-readable cached task count. |
workflow.stats.succeedCountFmt | string | Optional | Human-readable successful task count. |
workflow.stats.failedCountFmt | string | Optional | Human-readable failed task count. |
workflow.stats.ignoredCountFmt | string | Optional | Human-readable ignored task count. |
workflow.stats.cachedPct | number | Optional | Percentage of tasks satisfied from cache. |
workflow.stats.failedPct | number | Optional | Percentage of tasks that failed. |
workflow.stats.succeedPct | number | Optional | Percentage of tasks that succeeded. |
workflow.stats.ignoredPct | number | Optional | Percentage of tasks that were ignored. |
workflow.stats.cachedDuration | integer | Optional | Aggregate duration in milliseconds for cached tasks. |
workflow.stats.failedDuration | integer | Optional | Aggregate duration in milliseconds for failed tasks. |
workflow.stats.succeedDuration | integer | Optional | Aggregate duration in milliseconds for successful tasks. |
workflow.fusion | object | Optional | |
workflow.fusion.enabled | boolean | Optional | If |
workflow.fusion.version | string | Optional | Fusion version reported for the workflow run. |
workflow.wave | object | Optional | |
workflow.wave.enabled | boolean | Optional | If |
workflow.errorMessage | string | Optional | Summarized task error message associated with the workflow failure. |
workflow.errorReport | string | Optional | Detailed error report associated with the workflow failure. |
workflow.deleted | boolean | Optional | If |
workflow.projectDir | string | Optional | Local project directory used for the workflow run. |
workflow.homeDir | string | Optional | Home directory used by the workflow runtime. |
workflow.container | string | Optional | Workflow-level container image. |
workflow.containerEngine | string | Optional | Container engine used for workflow execution. |
workflow.scriptFile | string | Optional | Resolved path to the executed workflow script. |
workflow.launchDir | string | Optional | Directory from which the workflow was launched. |
workflow.duration | integer | Optional | Total workflow duration in milliseconds. |
workflow.exitStatus | integer | Optional | Final workflow exit status code. |
workflow.resume | boolean | Optional | If |
workflow.success | boolean | Optional | If |
workflow.logFile | string | Optional | Path to the workflow log file. |
workflow.outFile | string | Optional | Path to the workflow standard output file. |
workflow.operationId | string | Optional | Internal operation identifier associated with the workflow launch. |
metrics | array | Optional | Array of aggregated per-process workflow metrics reported at completion. |
metrics[].id | integer | Optional | Workflow metrics numeric identifier. |
metrics[].process | string | Required | Workflow process name for this metrics row. |
metrics[].cpu | object | Optional | |
metrics[].cpu.warnings | array | Optional | Array of sanitization or truncation warnings associated with this metric sample. |
metrics[].cpu.mean | number | Optional | Mean value for the sampled metric. |
metrics[].cpu.min | number | Optional | Minimum value for the sampled metric. |
metrics[].cpu.q1 | number | Optional | First quartile value for the sampled metric. |
metrics[].cpu.q2 | number | Optional | Median value for the sampled metric. |
metrics[].cpu.q3 | number | Optional | Third quartile value for the sampled metric. |
metrics[].cpu.max | number | Optional | Maximum value for the sampled metric. |
metrics[].cpu.minLabel | string | Optional | Task label associated with the minimum sampled value. |
metrics[].cpu.maxLabel | string | Optional | Task label associated with the maximum sampled value. |
metrics[].cpu.q1Label | string | Optional | Task label associated with the first quartile sampled value. |
metrics[].cpu.q2Label | string | Optional | Task label associated with the median sampled value. |
metrics[].cpu.q3Label | string | Optional | Task label associated with the third quartile sampled value. |
metrics[].mem | object | Optional | |
metrics[].mem.warnings | array | Optional | Array of sanitization or truncation warnings associated with this metric sample. |
metrics[].mem.mean | number | Optional | Mean value for the sampled metric. |
metrics[].mem.min | number | Optional | Minimum value for the sampled metric. |
metrics[].mem.q1 | number | Optional | First quartile value for the sampled metric. |
metrics[].mem.q2 | number | Optional | Median value for the sampled metric. |
metrics[].mem.q3 | number | Optional | Third quartile value for the sampled metric. |
metrics[].mem.max | number | Optional | Maximum value for the sampled metric. |
metrics[].mem.minLabel | string | Optional | Task label associated with the minimum sampled value. |
metrics[].mem.maxLabel | string | Optional | Task label associated with the maximum sampled value. |
metrics[].mem.q1Label | string | Optional | Task label associated with the first quartile sampled value. |
metrics[].mem.q2Label | string | Optional | Task label associated with the median sampled value. |
metrics[].mem.q3Label | string | Optional | Task label associated with the third quartile sampled value. |
metrics[].vmem | object | Optional | |
metrics[].vmem.warnings | array | Optional | Array of sanitization or truncation warnings associated with this metric sample. |
metrics[].vmem.mean | number | Optional | Mean value for the sampled metric. |
metrics[].vmem.min | number | Optional | Minimum value for the sampled metric. |
metrics[].vmem.q1 | number | Optional | First quartile value for the sampled metric. |
metrics[].vmem.q2 | number | Optional | Median value for the sampled metric. |
metrics[].vmem.q3 | number | Optional | Third quartile value for the sampled metric. |
metrics[].vmem.max | number | Optional | Maximum value for the sampled metric. |
metrics[].vmem.minLabel | string | Optional | Task label associated with the minimum sampled value. |
metrics[].vmem.maxLabel | string | Optional | Task label associated with the maximum sampled value. |
metrics[].vmem.q1Label | string | Optional | Task label associated with the first quartile sampled value. |
metrics[].vmem.q2Label | string | Optional | Task label associated with the median sampled value. |
metrics[].vmem.q3Label | string | Optional | Task label associated with the third quartile sampled value. |
metrics[].time | object | Optional | |
metrics[].time.warnings | array | Optional | Array of sanitization or truncation warnings associated with this metric sample. |
metrics[].time.mean | number | Optional | Mean value for the sampled metric. |
metrics[].time.min | number | Optional | Minimum value for the sampled metric. |
metrics[].time.q1 | number | Optional | First quartile value for the sampled metric. |
metrics[].time.q2 | number | Optional | Median value for the sampled metric. |
metrics[].time.q3 | number | Optional | Third quartile value for the sampled metric. |
metrics[].time.max | number | Optional | Maximum value for the sampled metric. |
metrics[].time.minLabel | string | Optional | Task label associated with the minimum sampled value. |
metrics[].time.maxLabel | string | Optional | Task label associated with the maximum sampled value. |
metrics[].time.q1Label | string | Optional | Task label associated with the first quartile sampled value. |
metrics[].time.q2Label | string | Optional | Task label associated with the median sampled value. |
metrics[].time.q3Label | string | Optional | Task label associated with the third quartile sampled value. |
metrics[].reads | object | Optional | |
metrics[].reads.warnings | array | Optional | Array of sanitization or truncation warnings associated with this metric sample. |
metrics[].reads.mean | number | Optional | Mean value for the sampled metric. |
metrics[].reads.min | number | Optional | Minimum value for the sampled metric. |
metrics[].reads.q1 | number | Optional | First quartile value for the sampled metric. |
metrics[].reads.q2 | number | Optional | Median value for the sampled metric. |
metrics[].reads.q3 | number | Optional | Third quartile value for the sampled metric. |
metrics[].reads.max | number | Optional | Maximum value for the sampled metric. |
metrics[].reads.minLabel | string | Optional | Task label associated with the minimum sampled value. |
metrics[].reads.maxLabel | string | Optional | Task label associated with the maximum sampled value. |
metrics[].reads.q1Label | string | Optional | Task label associated with the first quartile sampled value. |
metrics[].reads.q2Label | string | Optional | Task label associated with the median sampled value. |
metrics[].reads.q3Label | string | Optional | Task label associated with the third quartile sampled value. |
metrics[].writes | object | Optional | |
metrics[].writes.warnings | array | Optional | Array of sanitization or truncation warnings associated with this metric sample. |
metrics[].writes.mean | number | Optional | Mean value for the sampled metric. |
metrics[].writes.min | number | Optional | Minimum value for the sampled metric. |
metrics[].writes.q1 | number | Optional | First quartile value for the sampled metric. |
metrics[].writes.q2 | number | Optional | Median value for the sampled metric. |
metrics[].writes.q3 | number | Optional | Third quartile value for the sampled metric. |
metrics[].writes.max | number | Optional | Maximum value for the sampled metric. |
metrics[].writes.minLabel | string | Optional | Task label associated with the minimum sampled value. |
metrics[].writes.maxLabel | string | Optional | Task label associated with the maximum sampled value. |
metrics[].writes.q1Label | string | Optional | Task label associated with the first quartile sampled value. |
metrics[].writes.q2Label | string | Optional | Task label associated with the median sampled value. |
metrics[].writes.q3Label | string | Optional | Task label associated with the third quartile sampled value. |
metrics[].cpuUsage | object | Optional | |
metrics[].cpuUsage.warnings | array | Optional | Array of sanitization or truncation warnings associated with this metric sample. |
metrics[].cpuUsage.mean | number | Optional | Mean value for the sampled metric. |
metrics[].cpuUsage.min | number | Optional | Minimum value for the sampled metric. |
metrics[].cpuUsage.q1 | number | Optional | First quartile value for the sampled metric. |
metrics[].cpuUsage.q2 | number | Optional | Median value for the sampled metric. |
metrics[].cpuUsage.q3 | number | Optional | Third quartile value for the sampled metric. |
metrics[].cpuUsage.max | number | Optional | Maximum value for the sampled metric. |
metrics[].cpuUsage.minLabel | string | Optional | Task label associated with the minimum sampled value. |
metrics[].cpuUsage.maxLabel | string | Optional | Task label associated with the maximum sampled value. |
metrics[].cpuUsage.q1Label | string | Optional | Task label associated with the first quartile sampled value. |
metrics[].cpuUsage.q2Label | string | Optional | Task label associated with the median sampled value. |
metrics[].cpuUsage.q3Label | string | Optional | Task label associated with the third quartile sampled value. |
metrics[].memUsage | object | Optional | |
metrics[].memUsage.warnings | array | Optional | Array of sanitization or truncation warnings associated with this metric sample. |
metrics[].memUsage.mean | number | Optional | Mean value for the sampled metric. |
metrics[].memUsage.min | number | Optional | Minimum value for the sampled metric. |
metrics[].memUsage.q1 | number | Optional | First quartile value for the sampled metric. |
metrics[].memUsage.q2 | number | Optional | Median value for the sampled metric. |
metrics[].memUsage.q3 | number | Optional | Third quartile value for the sampled metric. |
metrics[].memUsage.max | number | Optional | Maximum value for the sampled metric. |
metrics[].memUsage.minLabel | string | Optional | Task label associated with the minimum sampled value. |
metrics[].memUsage.maxLabel | string | Optional | Task label associated with the maximum sampled value. |
metrics[].memUsage.q1Label | string | Optional | Task label associated with the first quartile sampled value. |
metrics[].memUsage.q2Label | string | Optional | Task label associated with the median sampled value. |
metrics[].memUsage.q3Label | string | Optional | Task label associated with the third quartile sampled value. |
metrics[].timeUsage | object | Optional | |
metrics[].timeUsage.warnings | array | Optional | Array of sanitization or truncation warnings associated with this metric sample. |
metrics[].timeUsage.mean | number | Optional | Mean value for the sampled metric. |
metrics[].timeUsage.min | number | Optional | Minimum value for the sampled metric. |
metrics[].timeUsage.q1 | number | Optional | First quartile value for the sampled metric. |
metrics[].timeUsage.q2 | number | Optional | Median value for the sampled metric. |
metrics[].timeUsage.q3 | number | Optional | Third quartile value for the sampled metric. |
metrics[].timeUsage.max | number | Optional | Maximum value for the sampled metric. |
metrics[].timeUsage.minLabel | string | Optional | Task label associated with the minimum sampled value. |
metrics[].timeUsage.maxLabel | string | Optional | Task label associated with the maximum sampled value. |
metrics[].timeUsage.q1Label | string | Optional | Task label associated with the first quartile sampled value. |
metrics[].timeUsage.q2Label | string | Optional | Task label associated with the median sampled value. |
metrics[].timeUsage.q3Label | string | Optional | Task label associated with the third quartile sampled value. |
progress | object | Optional | |
progress.pending | integer | Optional | Number of tasks currently pending execution. |
progress.submitted | integer | Optional | Number of tasks submitted to the executor or scheduler. |
progress.running | integer | Optional | Number of tasks currently running. |
progress.succeeded | integer | Optional | Number of tasks completed successfully. |
progress.cached | integer | Optional | Number of tasks satisfied from cache. |
progress.failed | integer | Optional | Number of tasks that failed. |
progress.aborted | integer | Optional | Number of tasks that were aborted. |
progress.stored | integer | Optional | Number of tasks whose results were stored without execution. |
progress.ignored | integer | Optional | Number of tasks ignored by the workflow logic. |
progress.retries | integer | Optional | Number of task retries attempted so far. |
progress.loadCpus | integer | Optional | Current aggregate CPU load across running tasks. |
progress.loadMemory | integer | Optional | Current aggregate memory load across running tasks. |
progress.peakRunning | integer | Optional | Highest number of concurrently running tasks observed so far. |
progress.peakCpus | integer | Optional | Peak aggregate CPU load observed so far. |
progress.peakMemory | integer | Optional | Peak aggregate memory load observed so far. |
progress.processes | array | Optional | Array of per-process progress breakdowns. |
progress.processes[].index | integer | Optional | Stable order index for the process within the workflow summary. |
progress.processes[].name | string | Optional | Workflow process name. |
progress.processes[].pending | integer | Optional | Number of pending tasks for this process. |
progress.processes[].submitted | integer | Optional | Number of submitted tasks for this process. |
progress.processes[].running | integer | Optional | Number of running tasks for this process. |
progress.processes[].succeeded | integer | Optional | Number of successful tasks for this process. |
progress.processes[].cached | integer | Optional | Number of cached tasks for this process. |
progress.processes[].failed | integer | Optional | Number of failed tasks for this process. |
progress.processes[].aborted | integer | Optional | Number of aborted tasks for this process. |
progress.processes[].stored | integer | Optional | Number of stored tasks for this process. |
progress.processes[].ignored | integer | Optional | Number of ignored tasks for this process. |
progress.processes[].retries | integer | Optional | Number of retries for tasks in this process. |
progress.processes[].terminated | boolean | Optional | If |
progress.processes[].loadCpus | integer | Optional | Current aggregate CPU load for this process. |
progress.processes[].loadMemory | integer | Optional | Current aggregate memory load for this process. |
progress.processes[].peakRunning | integer | Optional | Peak number of concurrently running tasks for this process. |
progress.processes[].peakCpus | integer | Optional | Peak aggregate CPU load observed for this process. |
progress.processes[].peakMemory | integer | Optional | Peak aggregate memory load observed for this process. |
UpdateTraceHeartbeat | Signal workflow execution heartbeat | ||
progress | object | Optional | |
progress.pending | integer | Optional | Number of tasks currently pending execution. |
progress.submitted | integer | Optional | Number of tasks submitted to the executor or scheduler. |
progress.running | integer | Optional | Number of tasks currently running. |
progress.succeeded | integer | Optional | Number of tasks completed successfully. |
progress.cached | integer | Optional | Number of tasks satisfied from cache. |
progress.failed | integer | Optional | Number of tasks that failed. |
progress.aborted | integer | Optional | Number of tasks that were aborted. |
progress.stored | integer | Optional | Number of tasks whose results were stored without execution. |
progress.ignored | integer | Optional | Number of tasks ignored by the workflow logic. |
progress.retries | integer | Optional | Number of task retries attempted so far. |
progress.loadCpus | integer | Optional | Current aggregate CPU load across running tasks. |
progress.loadMemory | integer | Optional | Current aggregate memory load across running tasks. |
progress.peakRunning | integer | Optional | Highest number of concurrently running tasks observed so far. |
progress.peakCpus | integer | Optional | Peak aggregate CPU load observed so far. |
progress.peakMemory | integer | Optional | Peak aggregate memory load observed so far. |
progress.processes | array | Optional | Array of per-process progress breakdowns. |
progress.processes[].index | integer | Optional | Stable order index for the process within the workflow summary. |
progress.processes[].name | string | Optional | Workflow process name. |
progress.processes[].pending | integer | Optional | Number of pending tasks for this process. |
progress.processes[].submitted | integer | Optional | Number of submitted tasks for this process. |
progress.processes[].running | integer | Optional | Number of running tasks for this process. |
progress.processes[].succeeded | integer | Optional | Number of successful tasks for this process. |
progress.processes[].cached | integer | Optional | Number of cached tasks for this process. |
progress.processes[].failed | integer | Optional | Number of failed tasks for this process. |
progress.processes[].aborted | integer | Optional | Number of aborted tasks for this process. |
progress.processes[].stored | integer | Optional | Number of stored tasks for this process. |
progress.processes[].ignored | integer | Optional | Number of ignored tasks for this process. |
progress.processes[].retries | integer | Optional | Number of retries for tasks in this process. |
progress.processes[].terminated | boolean | Optional | If |
progress.processes[].loadCpus | integer | Optional | Current aggregate CPU load for this process. |
progress.processes[].loadMemory | integer | Optional | Current aggregate memory load for this process. |
progress.processes[].peakRunning | integer | Optional | Peak number of concurrently running tasks for this process. |
progress.processes[].peakCpus | integer | Optional | Peak aggregate CPU load observed for this process. |
progress.processes[].peakMemory | integer | Optional | Peak aggregate memory load observed for this process. |
UpdateTraceProgress | Store workflow task execution metadata | ||
tasks | array | Optional | Array of task trace records reported since the previous progress update. |
tasks[].hash | string | Optional | Task hash reported by Nextflow. |
tasks[].name | string | Optional | Task name reported by Nextflow. |
tasks[].process | string | Optional | Workflow process name for the task. |
tasks[].tag | string | Optional | Task tag reported by Nextflow. |
tasks[].submit | string | Optional | Timestamp when the task was submitted. |
tasks[].start | string | Optional | Timestamp when the task started running. |
tasks[].complete | string | Optional | Timestamp when the task completed. |
tasks[].module | array | Optional | Array of module names associated with the task. |
tasks[].container | string | Optional | Container image used for the task. |
tasks[].attempt | integer | Optional | Task retry attempt number. |
tasks[].script | string | Optional | Executed task script content or path. |
tasks[].scratch | string | Optional | Scratch directory used by the task. |
tasks[].workdir | string | Optional | Task work directory path. |
tasks[].queue | string | Optional | Executor queue used for the task. |
tasks[].cpus | integer | Optional | Number of CPUs requested by the task. |
tasks[].memory | integer | Optional | Amount of memory requested by the task. |
tasks[].disk | integer | Optional | Amount of disk requested by the task. |
tasks[].time | integer | Optional | Time requested by the task. |
tasks[].env | string | Optional | Task execution environment variables payload. |
tasks[].executor | string | Optional | Nextflow executor used for the task. |
tasks[].machineType | string | Optional | Machine or instance type used to run the task. |
tasks[].cloudZone | string | Optional | Cloud zone used to run the task. |
tasks[].priceModel | string | Optional | |
tasks[].cost | number | Optional | Estimated task execution cost. |
tasks[].errorAction | string | Optional | Nextflow error strategy action applied to the task. |
tasks[].exitStatus | integer | Optional | Process exit status reported by the task runtime. |
tasks[].duration | integer | Optional | Total recorded task duration in milliseconds. |
tasks[].realtime | integer | Optional | Wall-clock task runtime in milliseconds. |
tasks[].nativeId | string | Optional | Native scheduler or executor job identifier. |
tasks[].pcpu | number | Optional | Observed CPU usage percentage for the task. |
tasks[].pmem | number | Optional | Observed memory usage percentage for the task. |
tasks[].rss | integer | Optional | Resident memory usage for the task. |
tasks[].vmem | integer | Optional | Virtual memory usage for the task. |
tasks[].peakRss | integer | Optional | Peak resident memory usage for the task. |
tasks[].peakVmem | integer | Optional | Peak virtual memory usage for the task. |
tasks[].rchar | integer | Optional | Number of characters read by the task. |
tasks[].wchar | integer | Optional | Number of characters written by the task. |
tasks[].syscr | integer | Optional | Number of read-like system calls performed by the task. |
tasks[].syscw | integer | Optional | Number of write-like system calls performed by the task. |
tasks[].readBytes | integer | Optional | Number of bytes read from storage by the task. |
tasks[].writeBytes | integer | Optional | Number of bytes written to storage by the task. |
tasks[].volCtxt | integer | Optional | Number of voluntary context switches for the task. |
tasks[].invCtxt | integer | Optional | Number of involuntary context switches for the task. |
tasks[].exit | integer | Optional | Task exit code recorded by Nextflow. |
tasks[].id | integer | Optional | Internal task numeric identifier. |
tasks[].taskId | integer | Required | Task numeric identifier reported by Nextflow. |
tasks[].status | string | Required | |
tasks[].dateCreated | string | Optional | Timestamp when the task record was created. |
tasks[].lastUpdated | string | Optional | Timestamp when the task record was last updated. |
progress | object | Optional | |
progress.pending | integer | Optional | Number of tasks currently pending execution. |
progress.submitted | integer | Optional | Number of tasks submitted to the executor or scheduler. |
progress.running | integer | Optional | Number of tasks currently running. |
progress.succeeded | integer | Optional | Number of tasks completed successfully. |
progress.cached | integer | Optional | Number of tasks satisfied from cache. |
progress.failed | integer | Optional | Number of tasks that failed. |
progress.aborted | integer | Optional | Number of tasks that were aborted. |
progress.stored | integer | Optional | Number of tasks whose results were stored without execution. |
progress.ignored | integer | Optional | Number of tasks ignored by the workflow logic. |
progress.retries | integer | Optional | Number of task retries attempted so far. |
progress.loadCpus | integer | Optional | Current aggregate CPU load across running tasks. |
progress.loadMemory | integer | Optional | Current aggregate memory load across running tasks. |
progress.peakRunning | integer | Optional | Highest number of concurrently running tasks observed so far. |
progress.peakCpus | integer | Optional | Peak aggregate CPU load observed so far. |
progress.peakMemory | integer | Optional | Peak aggregate memory load observed so far. |
progress.processes | array | Optional | Array of per-process progress breakdowns. |
progress.processes[].index | integer | Optional | Stable order index for the process within the workflow summary. |
progress.processes[].name | string | Optional | Workflow process name. |
progress.processes[].pending | integer | Optional | Number of pending tasks for this process. |
progress.processes[].submitted | integer | Optional | Number of submitted tasks for this process. |
progress.processes[].running | integer | Optional | Number of running tasks for this process. |
progress.processes[].succeeded | integer | Optional | Number of successful tasks for this process. |
progress.processes[].cached | integer | Optional | Number of cached tasks for this process. |
progress.processes[].failed | integer | Optional | Number of failed tasks for this process. |
progress.processes[].aborted | integer | Optional | Number of aborted tasks for this process. |
progress.processes[].stored | integer | Optional | Number of stored tasks for this process. |
progress.processes[].ignored | integer | Optional | Number of ignored tasks for this process. |
progress.processes[].retries | integer | Optional | Number of retries for tasks in this process. |
progress.processes[].terminated | boolean | Optional | If |
progress.processes[].loadCpus | integer | Optional | Current aggregate CPU load for this process. |
progress.processes[].loadMemory | integer | Optional | Current aggregate memory load for this process. |
progress.processes[].peakRunning | integer | Optional | Peak number of concurrently running tasks for this process. |
progress.processes[].peakCpus | integer | Optional | Peak aggregate CPU load observed for this process. |
progress.processes[].peakMemory | integer | Optional | Peak aggregate memory load observed for this process. |
containers | array | Optional | Array of container metadata records reported for the workflow tasks. |
containers[].requestId | string | Optional | Wave request identifier associated with this container resolution. |
containers[].sourceImage | string | Optional | Original container image requested by the workflow. |
containers[].targetImage | string | Required | Resolved container image actually used to run the task. |
containers[].buildId | string | Optional | Wave build identifier for the resolved container image. |
containers[].scanId | string | Optional | Wave security scan identifier for the resolved container image. |
containers[].mirrorId | string | Optional | Wave mirror identifier for the resolved container image. |
containers[].cached | boolean | Optional | If |
containers[].freeze | boolean | Optional | If |
containers[].requestTime | string | Optional | Timestamp when the container metadata was requested. |