Configuration Options

This page contains the option combinations for the sampler, store, transport and authentication configuration files. Each sampler has it's own table(s) containing the list of options associated to that sampler as well as the combinations for these options. Each combination is a case that we plan to test within a testing infrastructure.

Notes

• For every table without a specified "Fail", "Pass", or "Xfail" column, please input a F/P/XF for each test case result, respectively.
• All bolded text in the tables should be tested as expected failures (e.g. Xfail)

Samplers

app_sampler

Options	Pass	Fail	Xfail	Description Error
stream=<STREAM_NAME>
metrics=<METRICS>
cfg_file=<PATH>
stream=<STREAM_NAME>; metrics=<METRICS>
stream=<STREAM_NAME>; cfg_file=<PATH>
metrics=<METRICS>; cfg_file=<PATH>
stream=<STREAM_NAME>; metrics=<METRICS>; cfg_file=<PATH>
Default values for all (not set)

appinfo

aries_mmr

Options	Pass	Fail	Xfail	Description Error
aries_rtr_id=<rtrid>
Default (not set)

array_example

clock

• This samlper uses the sampler_base base class configuration attributes. Please see the table for ldms_sampler_base and ldms_sampler_base.man for information about the base class configuration attributes.

cray_power_sampler

• TODO no manpage

cray_system_sampler

cray_gemini_r_sampler

Options <namespace>	hsn_metrics_type=0; off_<namespace>=0	hsn_metrics_type=1; off_<namespace>=0	hsn_metrics_type=2; off_<namespace>=0	hsn_metrics_type=0; off_<namespace>=1	hsn_metrics_type=1; off_<namespace>=1	hsn_metrics_type=2; off_<namespace>=1
hsn
vmstat
loadavg
current_freemem
kgnilnd
procnetdev
lustre (if built with --enable-lustre
nvidia (if built with --enable-cray_nvidia)

• Where <namespace> is the namespace options listed in the first column

cray_aries_r_sampler

Options <namespace>	hsn_metrics_type=0; off_<namespace>=0	hsn_metrics_type=1; off_<namespace>=0	hsn_metrics_type=2; off_<namespace>=0	hsn_metrics_type=0; off_<namespace>=1	hsn_metrics_type=1; off_<namespace>=1	hsn_metrics_type=2; off_<namespace>=1
hsn
vmstat
loadavg
current_freemem
kgnilnd
procnetdev
lustre (if built with --enable-lustre
nvidia (if built with --enable-cray_nvidia)
energy

• Where <namespace> is the namespace options listed in the first column

dstat

Options <bool>	io=0	stat=0	statm=0	mmalloc=0	fd=0	io=1	stat=1	statm=1	mmalloc=1	fd=1
io					n/a					n/a
stat					n/a					n/a
statm					n/a					n/a
mmalloc					n/a					n/a
fd
io; stat
io; statm
io; mmalloc
io; fd
stat; statm
stat; mmalloc
stat; fd
statm; mmalloc
statm; fd
mmalloc; fd
io; stat; statm
io; stat; mmalloc
io; stat; fd
io; statm; mmalloc
io; statm; fd
io; mmalloc; fd
stat; statm; mmalloc
stat; statm; fd
statm; mmalloc; fd
io; stat; statm; mmalloc; fd

• Where the different combinations of options (io, stat, statm, malloc, and fd) are listed in the first column for each row. Since they are all boolean values, the rest of the columns contains the options of 0 (f, F, n, N) and 1 (t, T, y, Y)

edac

Options	max_mc=2	max_csrow=4	Description Error
max_csrow=<max_csrow>
max_mc=<max_mc>

filesingle

Options [timing]	timing=0	timing=2	timing=5	timing=10	Description Error
conf=<metric_definitions> [timing]
Default ([timing] not set)

generic_sampler

Options	Pass	Fail	Xfail	Description Error
path=<path>
mx=M1:T1
mx=M1:T1, M2:T2
path; mx=M1:T1
path; mx=M2:T2
Default (no options set in config file)

grp_test (i.e. setgroup)

setgroup_add	setgroup_mod=<interval, offset>	setgroup_rm	set_group_ins	producer=<PRODUCER>	interval=10000000	interval=15000000	interval=20000000 usec	Default
producer
interval
offset=1000000
producer; interval
producer; offset=1000000
interval; offset=100000
producer; interval; offset=1000000
setgroup_mod=<interval, offset>
setgroup_rm
set_group_ins

• Where each option ending in ";" is set in the configuration file.

hello_sampler

• There are no options for this sampler other than the base class configuration attributes. Please see the table for ldms_sampler_base and ldms_sampler_base.man for information about the base class configuration attributes.

ibm_occ

• TODO no manpage

ibnet

Options	port-number=<num>	millis=<millisecond timeout>	timing=<bool>	node-name-map=<nmap>	metric-conf=port_query_time	metric-conf=port_query_offset	metric-conf=ib_query_time	metric-conf=port_data_process_time	Default
port-number=<num>
millis=<millisecond timeout>
timing=<bool>
node-name-map=<nnmap>
metric-conf=<metricfile>
port-number; millis
port-number; timing
port-number; node-name-map
port-number; metric-conf
millis; timing
millis, node-name-map
millis, metric-conf
timing; nod-name-map
timing; metric-conf
node-name-map; metric-conf
port-number; millis; timing
port-number; millis; node-name-map
port-number; millis; metric-conf
millis; timing; node-name-map
millis; timing; metric-conf
timing; node-name-map; metric-conf
port-number; timing; node-name-map; metric-conf

• Where each option ending in ";" is set in the configuration file.

kgnilnd

• There are no options specific to this sampler plugin. This plugin uses the sampler_base base class. Please see the table for ldms_sampler_base and ldms_sampler_base.man for information about the base class configuration attributes.

job_info

• There are no options (or man page) specific to this sampler. Please see the table for ldms_sampler_base and ldms_sampler_base.man for information about the base class configuration attributes.

lnet_stats

• There are no options specific to this sampler plugin. This plugin uses the sampler_base base class. Please see the table for ldms_sampler_base and ldms_sampler_base.man for information about the base class configuration attributes.

loadavg

Options metrics=<mlist>	force_integer	Default (no force_integer)	Description Error
load1min
load5min
load15min
runnable
scheduling_entities
newest_pid
load1min, load5min
load1min, load15min
load1min, runnable
load1min, newest_pid
load1min, newest_pid
load5min, load15min
load5min, runnable
load5min, scheduling_entities
load5min, newest_pid
load15min, runnable
load15min, scheduling_entities
load15min, newest_pid
runnable, scheduling_entities
runnable, newest_pid
scheduling_entities, newest_pid
load1min, load5min, load15min
load1min, load5min, runnable
load1min, load5min, scheduling_entities
load1min, load5min, newest_pid
load5min, load15min, runnable
load5min, load15min, scheduling_entities
load5min, load15min, newest_pid
load15min, runnable, scheduling_entities
load15min, runnable, newest_pid
runnable, scheduling_entities, newest_pid
load1min, load5min, load15min, runnable
load1min, load5min, load15min, scheduling_entities
load1min, load5min, load15min, newest_pid
load5min, load15min, runnable, scheduling_entities
load5min, load15min, runnable, newest_pid
load15min, runnable, scheduling_entities, newest_pid
load1min, load5min, load15min, runnable, scheduling_entities
load1min, load5min, load15min, runnable, newest_pid
load5min, load15min, runnable, scheduling_entities, newest_pid
load1min, load5min, load15min, runnable, scheduling_entities, newest_pid
Default (all enabled)

• Where each combination in the "Option" column is a list set to <mlist>. Please see select the link associated with the sampler name for more information.

lustre2_client

Options	Pass	Fail	Xfail	Error Description
osc_path =<oscpath>
mdc_path =<mdcpath>
llite_path =<llitepath>
osc_path =<oscpath>; mdc_path=<mdcpath>
osc_path =<oscpath>; llite_path =<llitepath>
mdc_path =<mdcpath>; llite_path =<llitepath>
osc_path =<oscpath>; mdc_path=<mdcpath>; llite_path =<llitepath>
Default (no path is set in config file)

llnl-lustre-*

• TODO

meminfo

• There are no options specific to this sampler plugin. This plugin uses the sampler_base base class. Please see the table for ldms_sampler_base and ldms_sampler_base.man for information about the base class configuration attributes.

msr_interlagos

Options	L3_CACHE_MISSES	DCT_RD_TOT	RW_DRAM_EXT	RW_DRAM_INT	TOT_CYC	TOT_INS	L1_DCM	RETIRED_FLOPS	VEC_INS	TLB_DM	maxcore	Default
initialize
add (metricname=<name>)
add; add - (x2)
finalize
halt (metricname=<name>)
continue (metricname=<name>)
reassign (oldmetricname=<oldname> newmetricname=<newname>)
rewrite (metricname=<name>)
halt; continue; reassign
halt; continue; rewrite
halt; continue; reassign; rewrite
reassign; rewrite
ls

• Where the first row from columns 1-10 are the <metricname> options and <maxcore> needs to be >= the actual number of cores. Please see select the link associated with the sampler name for more information.

opa2

Options	Pass	Fail	Xfail	Description Error
ports=
ports= (2x port numbers)
ports= (3x port numbers)
Default (not set in config file)

• Where <portlist> is a comma separated list of ca_name.portnum. Default is '*'.

papi_sampler

Options	Pass	Fail	Xfail	Description Error
stream=STREAM
stream(default) ; job_expiry=30sec
stream(default); job_expiry=90sec
stream(default); job_expiry=120sec
stream=STREAM; job_expiry=30sec
stream=STREAM; job_expiry=90sec
stream=STREAM; job_expiry=120sec
stream(default); job_expiry(default)

perfevent

Below are 6 tables each with their own option combinations depending on the id=<int> configuration. To better understand these option tables, it is highly encouraged to read through the sampler manpage

Options action=add; id=0	type=0	type=1	type=2	type=3	type=4	type=5	type=6	type=7	type=8	type=9	action=init	action=ls	action=del metricname=
action=init
action=ls
action=del metricname=
pid=0 and cpu=-1
pid=0 and cpu>= 0
pid>0 and cpu>=0
pid=-1 and cpu>=0
pid=-1 and cpu=-1

Options action=add; id=1	type=0	type=1	type=2	type=3	type=4	type=5	type=6	type=7	type=8	action=init	action=ls	action=del metricname=
action=init
action=ls
action=del metricname=
pid=0 and cpu=-1
pid=0 and cpu>= 0
pid>0 and cpu>=0
pid=-1 and cpu>=0
pid=-1 and cpu=-1

Options action=add; id=2	action=init	action=ls	action=del metricname=
action=init
action=ls
action=del metricname=
pid=0 and cpu=-1
pid=0 and cpu>= 0
pid>0 and cpu>=0
pid=-1 and cpu>=0
pid=-1 and cpu=-1

Options action=add; id=3	action=init	action=ls	action=del metricname=	pid=0 and cpu=-1	pid=0 and cpu>= 0	pid>0 and cpu>=0	pid=-1 and cpu>=0	pid=-1 and cpu=-1	Description Error
(0)|(0<<8)|(0<<16)
(1)|(0<<1)|(0<<16)
(2)|(0<<1)|(0<<16)
(3)|(0<<1)|(0<<16)
(4)|(0<<1)|(0<<16)
(5)|(0<<1)|(0<<16)
(6)|(0<<1)|(0<<16)
(0)|(1<<1)|(0<<16)
(0)|(2<<1)|(0<<16)
(0)|(1<<1)|(1<<16)
(0)|(2<<1)|(1<<16)
(1)|(1<<1)|(0<<16)
(1)|(2<<1)|(0<<16)
(1)|(1<<1)|(1<<16)
(1)|(2<<1)|(1<<16)
(2)|(1<<1)|(0<<16)
(2)|(2<<1)|(0<<16)
(2)|(1<<1)|(1<<16)
(2)|(2<<1)|(1<<16)
(3)|(1<<1)|(0<<16)
(3)|(2<<1)|(0<<16)
(3)|(1<<1)|(1<<16)
(3)|(2<<1)|(1<<16)
(4)|(1<<1)|(0<<16)
(4)|(2<<1)|(0<<16)
(4)|(1<<1)|(1<<16)
(4)|(2<<1)|(1<<16)
(5)|(1<<1)|(0<<16)
(5)|(2<<1)|(0<<16)
(5)|(1<<1)|(1<<16)
(5)|(2<<1)|(1<<16)
(6)|(1<<1)|(0<<16)
(6)|(2<<1)|(0<<16)
(6)|(1<<1)|(1<<16)
(6)|(2<<1)|(1<<16)
action=init
action=ls
action=del metricname=<string>

Options action=add; id=4 add "raw" id value	action=init	action=ls	action=del metricname=
action=init
action=ls
action=del metricname=
pid=0 and cpu=-1
pid=0 and cpu>= 0
pid>0 and cpu>=0
pid=-1 and cpu>=0
pid=-1 and cpu=-1

Options action=add; id=5	action=init	action=ls	action=del metricname=
action=init
action=ls
action=del metricname=
pid=0 and cpu=-1
pid=0 and cpu>= 0
pid>0 and cpu>=0
pid=-1 and cpu>=0
pid=-1 and cpu=-1

procdiskstats

Options	Fail	Pass	Xfail	Description Error
devices=<devices>
devices=default

procinterrupts

• There are no options specific to this sampler plugin. This plugin uses the sampler_base base class. Please see the table for ldms_sampler_base and ldms_sampler_base.man for information about the base class configuration attributes.

procnfs

• There are no options specific to this sampler plugin. This plugin uses the sampler_base base class. Please see the table for ldms_sampler_base and ldms_sampler_base.man for information about the base class configuration attributes.

procstat

Options	Fail	Pass	Xfail	Description Error
maxcpu=
maxcpu=2
maxcpu=8
maxcpu=32
maxcpu(default/not set)

sampler_atasmart

Options	Pass	Fail	Xfail	Description Error
disks=/dev/sda
disks=/dev/sda1

shm

Options	Fail	Pass	Xfail	Description Error
shm_index=<name>
shm_boxmax=<int>
shm_array_max=<int>
shm_metric_max=<int>
shm_set_timeout=<int>
shm_index; shm_boxmax
shm_index; shm_array_max
shm_index; shm_metric_max
shm_index; shm_set_timeout
shm_bowmax; shm_array_max
shm_bowmax; shm_metric_max
shm_bowmax; shm_set_timeout
shm_array_max; shm_metric_max
shm_array_max; shm_set_timeout
shm_metric_max; shm_set_timeout
shm_index; shm_boxmax; shm_array_max
shm_index; shm_boxmax; shm_metric_max
shm_index; shm_boxmax; shm_set_timeout
shm_bowmax; shm_array_max; shm_metric_max
shm_bowmax; shm_array_max; shm_set_timeout
shm_array_max; shm_metric_max; shm_set_timeout
shm_index; shm_boxmax; shm_array_max; shm_metric_max
shm_index; shm_boxmax; shm_array_max; shm_set_timeout
shm_bowmax; shm_array_max; shm_metric_max; shm_set_timeout
shm_index; shm_boxmax; shm_array_max; shm_metric_max; shm_set_timeout

slurm_sampler

Options	STREAM=NAME	MAX_JOBS=1:5:20	MAX_TASKS=1:10:30	Description Error
stream= STREAM
job_count= MAX_JOBS
task_count= MAX_TASKS
stream, job_count
stream, task_count
job_count, task_count
stream, job_count, task_count
Default (no option is set)

• Where, if it is a pass/fail/xfail the result would be: P:F:XF for each row in columns 2-3.

switchx

• TODO no manpage

switchx_eth

• TODO no manpage

sysclassib

Options	Pass	Fail	Xfail	Error Description
metrics_type=0
ports= CARD1.PORT1
ports= CARD2.PORT2
metrics_type=0; ports= CARD1.PORT1
metrics_type=0; ports= CARD2.PORT2
metrics_type=1; ports= CARD1.PORT1
metrics_type=1; ports= CARD2.PORT2
metrics_type(default); ports(default)

syspapi

Options	cfg_file=PATH	events=PAPI_TOT_INS	events=PAPI_TOT_CYC	Description Error
cumulative=0; auto_pause=0
cumulative=0; auto_pause=1
cumulative=1; auto_pause=0
cumulative=1; auto_pause=1
cumulative=0; auto_pause=0; cfg_file=PATH; events	n/a
cumulative=0; auto_pause=1; cfg_file=PATH; events	n/a
cumulative=1; auto_pause=0; cfg_file=PATH; events	n/a
cumulative=1; auto_pause=1; cfg_file=PATH; events	n/a

tx2mon

Options	array=1	auto-schema=1	extra=1	array=0	auto=schema=0	extra=0	Description Error
array		n/a	n/a		n/a	n/a
auto-schema	n/a		n/a	n/a		n/a
extra	n/a	n/a		n/a	n/a
array; auto-schema			n/a			n/a
array; extra		n/a			n/a
auto-schema; extra	n/a			n/a
array; auto-schema; extra
default

variable

Options	Pass	Fail	Xfail	Description Error
instance=vm1_1/variable
schema=string1
instance=vm1_1/variable; schema=string1

vmstat

• There are no options specific to this sampler plugin. This plugin uses the sampler_base base class. Please see the table for ldms_sampler_base and ldms_sampler_base.man for information about the base class configuration attributes.

ldms_sampler_base

ldms_sampler_base

Use the following two tables (Sampler and ldms_sampler_base Options) to generate the correct test case option combinations for each sampler and check if they Fail/Pass/Xfail.

Sampler	Pass	Fail	Xfail	Description Error
app_sampler
appinfo
aries_mmr
array_example
clock
cray_power_sampler
cray_system_sampler
dstat
filesingle
generic_sampler
grp_test
hello_sampler
ibm_occ
ibnet
job_info
kgnilnd
jobid
edac
lnet_stats
loadavg
lustre2_client
llnl-lustre-*
meminfo
msr_interlagos
opa2
papi_sampler
perfevent
procdiskstats
procinterrupts
procnetdev
procnfs
procstat
sampler_atasmart
shm
slurm_sampler
switchx
switchx_eth
synthetic
sysclassib
syspapi
test_sampler
tx2mon
variable
vmstat
sampler	job_end=<name>

Use the following table as a guide to create the correct test cases and identify any test failures.

ldms_sampler_base Options	Pass	Fail	Xfail	Description Error
schema=<schema>
component_id=<compid>
job_set=<name>
job_id=<name>
app_id=<name>
job_start=<name>
job_end=<name>
schema; component_id
schema; job_set
schema; job_id
schema; app_id
schema; job_start
schema; job_end
component_id; job_set
component_id; job_id
component_id; app_id
component_id; job_start
component_id; job_end
job_set; job_id
job_set; app_id
job_set; job_start
job_set; job_end
job_id; app_id
job_id; job_start
job_id; job_end
app_id; job_start
app_id; job_end
job_start; job_end
schema; component_id; job_set
schema; component_id; job_id
schema; component_id; app_id
schema; component_id; job_start
schema; component_id; job_end
component_id; job_set; job_id
component_id; job_set; app_id
component_id; job_set; job_start
component_id; job_set; job_end
job_set; job_id; app_id
job_set; job_id; job_start
job_set; job_id; job_end
job_id; app_id; job_start
job_id; app_id; job_end
app_id; job_start; job_end
schema; component_id; job_set; job_id
schema; component_id; job_set; app_id
schema; component_id; job_set; job_start
schema; component_id; job_set; job_end
component_id; job_set; job_id; app_id
component_id; job_set; job_id; job_start
component_id; job_set; job_id; job_end
job_set; job_id; app_id; job_start
job_set; job_id; app_id; job_end
job_id; app_id; job_start; job_end
schema; component_id; job_set; job_id; app_id
schema; component_id; job_set; job_id; job_start
schema; component_id; job_set; job_id; job_end
component_id; job_set; job_id; app_id; job_start
component_id; job_set; job_id; app_id; job_end
job_set; job_id; app_id; job_start; job_end
schema; component_id; job_set; job_id; app_id; job_start
schema; component_id; job_set; job_id; app_id; job_end
component_id; job_set; job_id; app_id; job_start; job_end
schema; component_id; job_set; job_id; app_id; job_start; job_end

Stores

store_csv

Options	Combinations of 1	Combinations of 2	Combinations of 3	Combinations of 4	Combinations of 5	Combinations of 6	Combinations of 7	Combinations of 8	Combinations of 9	Combinations of 10	Combinations of 11	Combinations of 12
altheader=0
altheader=!0
typeheader=0
typeheader=1
typeheader=2
ietfcsv=0
ietfscv=1
buffer=0
buffer=1
buffer=N
buffertype=2
buffertype=4
rolltype=1
rolltype=2
rolltype=3
rolltype=4
rolltype=5
rollover=0
rollover=2
userdata=0
userdata=!0
create_perm=0
create_perm=0600
create_uid=<numeric-uid>
create_gid=<numeric-gid>
rename_template=<metapath>
Default (no values set)

Options for rename_template	Pass	Fail	Xfail	Description Error
rename_uid; rename_gid
rename_perm
rename_uid; rename_gid; rename_perm

store_flatfile

Options	Pass	Fail	Xfail	Error Description
schema=meminfo
schema=vmstat
schema=dstat
schema=meminfo; metric=Active
schema=vmstat; metric=nr_free_pages
schema=dstat; metric=read_bytes

store_function_csv

Options	Combinations of 1	Combinations of 2	Combinations of 3	Combinations of 4	Combinations of 5	Combinations of 6
altheader=0
altheader=!0
ageusec=
buffer=0
buffer=1
buffer=N
buffertype=3
buffertype=4
rolltype=1
rolltype=2
rolltype=3
rolltype=4
rollover=0
rollover=2

store_sos

Options	Pass	Fail	Xfail	Error Description
schema=meminfo
schema=vmstat
schema=dstat
schema=meminfo; metric=Active
schema=vmstat; metric=nr_free_pages
schema=vmstat; metric=Active
schema=dstat; metric=read_bytes

Transports

sock

fabric

rdma

ugini

Authentications

• Usage: Include -a <authentication-name> [options] at the end of the ldmsd command.

munge

Options	Pass	Fail	Xfail	Description Error
-A socket=<PATH>
Default PATH (-A socket not set)

naive

Options	Pass	Fail	Xfail	Description Error
-A uid=<UID>
-A gid=<GID>
-A uid=<UID>; -A gid=<GID>
Default (no options are set)

none

Options	Pass	Fail	Xfail	Description Error
-a none
Default (auth_non is not set)

• NOTE: running "ldmsd -x sock:1024 -a none" is equivalent to simply running "ldmsd -x sock:1024"

ovis

Options	secretword=ovisauthone	secretword=ldmstest	secretword=ldms (this should be Xfail)	Description Error
-A conf=<PATH>
export LDMS_AUTH_FILE=<PATH>
$HOME/.ldmsauth.conf (e.g. /etc/password/..)
$SYSCONFIGDIR/ldmsauth.conf (e.g. /etc/ldmsauth.conf)