From 9a2cd1a360d1f740c57987ccd885655a4435f98c Mon Sep 17 00:00:00 2001 From: "Christopher J. Morrone" Date: Wed, 26 Jul 2023 13:26:56 -0700 Subject: [PATCH] Improve Plugin_jobid.man --- ldms/man/Plugin_jobid.man | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/ldms/man/Plugin_jobid.man b/ldms/man/Plugin_jobid.man index 7b1ec9e96..1dc64eff4 100644 --- a/ldms/man/Plugin_jobid.man +++ b/ldms/man/Plugin_jobid.man @@ -61,6 +61,29 @@ The sampler offset for the jobid plugin should be slightly less than all other p Other samplers use the jobid plugin as the jobid data source. If the jobid sampler is not loaded, these samplers will report 0 jobid values. +.SH FILE FORMAT + +The file consists of key-value pairs, one per line, separated by an equals-sign. The recognized keys are: + +.TP +JOBID +.BR +An unsigned integer (up to 64-bit) identifying the job. The number zero is reserved to mean that no job is currently running. +.TP +UID +.BR +An unsigned integer (up to 64-bit) representing the User ID associated with the job. +.TP +APPID +.BR +An unsigned integer (up to 64-bit) representing the an application ID for the job. +.TP +USER +.BR +A string representing the username associated with the job. + +Only the JOBID field is required. The other fields are optional, and will default to zero. + .SH EXAMPLES .PP .nf @@ -90,8 +113,6 @@ echo UID=$SLURM_UID >> /var/run/ldms.jobinfo echo USER=$SLURM_JOB_USER >> /var/run/ldms.jobinfo .fi -These slurm files might be found in /etc/nodestate/bin/. - .SH SEE ALSO ldms(7), ldmsd(8), ldmsd_controller(8)