Document source of vol_ctxt and inv_ctxt trace metrics (#4333)

Signed-off-by: Ben Sherman <bentshermann@gmail.com>
nextflow-io · Sep 21, 2023 · 6525b0a · 6525b0a
1 parent 4e3e9ac
commit 6525b0a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/tracing.md b/docs/tracing.md
@@ -282,10 +282,10 @@ The following table shows the fields that can be included in the execution repor
 : Number of bytes the process originally dirtied in the page-cache (assuming they will go to disk later). This data is read from file `/proc/$pid/io`.
 
 `vol_ctxt`
-: Number of voluntary context switches.
+: Number of voluntary context switches. This data is read from field `voluntary_ctxt_switches` in `/proc/$pid/status` file.
 
 `inv_ctxt`
-: Number of involuntary context switches.
+: Number of involuntary context switches. This data is read from field `nonvoluntary_ctxt_switches` in `/proc/$pid/status` file.
 
 `env`
 : The variables defined in task execution environment.

diff --git a/modules/nextflow/src/main/groovy/nextflow/trace/TraceRecord.groovy b/modules/nextflow/src/main/groovy/nextflow/trace/TraceRecord.groovy
@@ -98,8 +98,8 @@ class TraceRecord implements Serializable {
             time:       'time',
             env:        'str',
             error_action:'str',
-            vol_ctxt: 'num',
-            inv_ctxt: 'num',
+            vol_ctxt: 'num',        // -- /proc/$pid/status field 'voluntary_ctxt_switches'
+            inv_ctxt: 'num',        // -- /proc/$pid/status field 'nonvoluntary_ctxt_switches'
             hostname: 'str',
             cpu_model:  'str'
     ]