Skip to content

Commit 34bdffd

Browse files
docs: Update reports page (#6645) [ci fast]
Co-authored-by: Ben Sherman <bentshermann@gmail.com>
1 parent 88fa9cb commit 34bdffd

File tree

8 files changed

+291
-274
lines changed

8 files changed

+291
-274
lines changed
-134 KB
Loading
-199 KB
Loading

docs/_static/report-tasks-min.png

-242 KB
Loading

docs/_static/timeline-min.png

11.5 KB
Loading

docs/reference/cli.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1020,7 +1020,9 @@ The `log` command is used to query the execution metadata associated with pipeli
10201020
: Show log entries for runs executed *but* the specified one.
10211021

10221022
`-f, -fields`
1023-
: Comma-separated list of fields to include in the printed log. Use the `-l` option to see the list of available fields.
1023+
: Comma-separated list of fields to include in the printed log.
1024+
: The same fields as the `trace.fields` option can be specified here, as well as `stdout` and `stderr`. The trace fields `%cpu` and `%mem` must be specified as `pcpu` and `pmem`, respectively.
1025+
: Use the `-l` option to see the complete list of available fields.
10241026

10251027
`-F, -filter`
10261028
: Filter log entries by a custom expression, e.g. `process =~ /hello.*/ && status == 'COMPLETED'`.

docs/reference/config.md

Lines changed: 161 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,7 @@ The following settings are available:
556556

557557
## `dag`
558558

559-
The `dag` scope controls the workflow diagram generated by Nextflow.
559+
The `dag` scope controls the generation of the {ref}`workflow-diagram`.
560560

561561
The following settings are available:
562562

@@ -578,6 +578,32 @@ The following settings are available:
578578
`dag.file`
579579
: Graph file name (default: `'dag-<timestamp>.html'`).
580580

581+
: The output format is inferred from the file extension. The following formats are supported:
582+
583+
`dot`
584+
: Graphviz [DOT](http://www.graphviz.org/content/dot-language) file.
585+
586+
`gexf`
587+
: Graph Exchange XML Format ([GEXF](https://gexf.net/)).
588+
589+
`html`
590+
: HTML file with Mermaid diagram.
591+
592+
`mmd`
593+
: Mermaid diagram.
594+
595+
`pdf`
596+
: *Requires [Graphviz](http://www.graphviz.org).*
597+
: Graphviz PDF file.
598+
599+
`png`
600+
: *Requires [Graphviz](http://www.graphviz.org)*
601+
: Graphviz PNG file.
602+
603+
`svg`
604+
: *Requires [Graphviz](http://www.graphviz.org)*
605+
: Graphviz SVG file.
606+
581607
`dag.overwrite`
582608
: When `true` overwrites any existing DAG file with the same name (default: `false`).
583609

@@ -1334,7 +1360,7 @@ The following settings are available:
13341360

13351361
## `report`
13361362

1337-
The `report` scope allows you to configure the workflow {ref}`execution-report`.
1363+
The `report` scope controls the generation of the {ref}`execution-report`.
13381364

13391365
The following settings are available:
13401366

@@ -1474,12 +1500,12 @@ The following settings are available:
14741500

14751501
## `timeline`
14761502

1477-
The `timeline` scope controls the execution timeline report generated by Nextflow.
1503+
The `timeline` scope controls the generation of the {ref}`timeline-report`.
14781504

14791505
The following settings are available:
14801506

14811507
`timeline.enabled`
1482-
: Create the timeline report on workflow completion file (default: `false`).
1508+
: Create the execution timeline on workflow completion (default: `false`).
14831509

14841510
`timeline.file`
14851511
: Timeline file name (default: `'timeline-<timestamp>.html'`).
@@ -1516,15 +1542,143 @@ The following settings are available:
15161542

15171543
## `trace`
15181544

1519-
The `trace` scope controls the layout of the execution trace file generated by Nextflow.
1545+
The `trace` scope controls the generation of the {ref}`trace-report`.
15201546

15211547
The following settings are available:
15221548

15231549
`trace.enabled`
1524-
: Create the execution trace file on workflow completion (default: `false`).
1550+
: Create the trace file on workflow completion (default: `false`).
15251551

15261552
`trace.fields`
1527-
: Comma-separated list of {ref}`trace fields <trace-fields>` to include in the report.
1553+
: Comma-separated list of fields to include in the trace file.
1554+
1555+
: Available fields:
1556+
1557+
`task_id`
1558+
: Task ID.
1559+
1560+
`hash`
1561+
: Task hash code.
1562+
1563+
`native_id`
1564+
: Task ID given by the underlying execution system e.g. POSIX process PID when executed locally, job ID when executed by a grid engine, etc.
1565+
1566+
`process`
1567+
: Nextflow process name.
1568+
1569+
`tag`
1570+
: User provided identifier associated with this task.
1571+
1572+
`name`
1573+
: Task name.
1574+
1575+
`status`
1576+
: Task status. Options: `NEW`, `SUBMITTED`, `RUNNING`, `COMPLETED`, `FAILED`, and `ABORTED`.
1577+
1578+
`exit`
1579+
: POSIX process exit status.
1580+
1581+
`module`
1582+
: Environment module used to run the task.
1583+
1584+
`container`
1585+
: Docker image name used to execute the task.
1586+
1587+
`cpus`
1588+
: The CPUs number request for the task execution.
1589+
1590+
`time`
1591+
: The time request for the task execution
1592+
1593+
`disk`
1594+
: The disk space request for the task execution.
1595+
1596+
`memory`
1597+
: The memory request for the task execution.
1598+
1599+
`attempt`
1600+
: Attempt at which the task completed.
1601+
1602+
`submit`
1603+
: Timestamp when the task has been submitted.
1604+
1605+
`start`
1606+
: Timestamp when the task execution has started.
1607+
1608+
`complete`
1609+
: Timestamp when task execution has completed.
1610+
1611+
`duration`
1612+
: Time elapsed to complete since the submission.
1613+
1614+
`realtime`
1615+
: Task execution time i.e. delta between completion and start timestamp.
1616+
1617+
`queue`
1618+
: The queue that the executor attempted to run the process on.
1619+
1620+
`%cpu`
1621+
: Percentage of CPU used by the process.
1622+
1623+
`%mem`
1624+
: Percentage of memory used by the process.
1625+
1626+
`rss`
1627+
: Real memory (resident set) size of the process. Equivalent to `ps -o rss` .
1628+
1629+
`vmem`
1630+
: Virtual memory size of the process. Equivalent to `ps -o vsize` .
1631+
1632+
`peak_rss`
1633+
: Peak of real memory. Data is read from field `VmHWM` in `/proc/$pid/status` file.
1634+
1635+
`peak_vmem`
1636+
: Peak of virtual memory. Data is read from field `VmPeak` in `/proc/$pid/status` file.
1637+
1638+
`rchar`
1639+
: Number of bytes the process read, using any read-like system call from files, pipes, tty, etc. Data is read from `/proc/$pid/io`.
1640+
1641+
`wchar`
1642+
: Number of bytes the process wrote, using any write-like system call. Data is read from `/proc/$pid/io`.
1643+
1644+
`syscr`
1645+
: Number of read-like system call invocations that the process performed. Data is read from `/proc/$pid/io`.
1646+
1647+
`syscw`
1648+
: Number of write-like system call invocations that the process performed. Data is read from `/proc/$pid/io`.
1649+
1650+
`read_bytes`
1651+
: Number of bytes the process directly read from disk. Data is read from `/proc/$pid/io`.
1652+
1653+
`write_bytes`
1654+
: Number of bytes the process originally dirtied in the page-cache (assuming they will go to disk later). Data is read from `/proc/$pid/io`.
1655+
1656+
`vol_ctxt`
1657+
: Number of voluntary context switches. Data is read from field `voluntary_ctxt_switches` in `/proc/$pid/status` file.
1658+
1659+
`inv_ctxt`
1660+
: Number of involuntary context switches. Data is read from field `nonvoluntary_ctxt_switches` in `/proc/$pid/status` file.
1661+
1662+
`env`
1663+
: The variables defined in task execution environment.
1664+
1665+
`workdir`
1666+
: The directory path where the task was executed.
1667+
1668+
`script`
1669+
: The task command script.
1670+
1671+
`scratch`
1672+
: The value of the process `scratch` directive.
1673+
1674+
`error_action`
1675+
: The action applied on error for task failure.
1676+
1677+
`hostname`
1678+
: The host on which the task was executed. Supported only for the Kubernetes executor yet. Activate with `k8s.fetchNodeName = true` in the Nextflow config file.
1679+
1680+
`cpu_model`
1681+
: The name of the CPU model used to execute the task. This data is read from`/proc/cpuinfo`.
15281682

15291683
`trace.file`
15301684
: Trace file name (default: `'trace-<timestamp>.txt'`).

0 commit comments

Comments
 (0)