Plugin_shm_sampler

Date:

5 March 2018

This is a sampler plug-in module within the the LDMS that can read from a dynamic number of shm files.

Within ldmsd_controller or a configuration file:

load name=shm_sampler

config name=shm_sampler [ <attr>=<value> ]

is a sampler plug-in module within the the LDMS. This sampler can read from a dynamic number of shm files. These files are tracked by a central index file in shared memory. The main usage of this sampler is to stream application performance data.

Configuration options:

producer=<name> instance=<name> [shm_index=<name>][shm_boxmax=<int>][shm_array_max=<int>][shm_metric_max=<int>] [shm_set_timeout=<int>][component_id=<int>] [schema=<name>] [job_set=<name> job_id=<name> app_id=<name> job_start=<name> job_end=<name>]

A unique name for the host providing the data

A unique name for the metric set

A unique name for the shared memory index file

Maximum number of entries in the shared memory index file

Maximum number of elements in array metrics

Maximum number of metrics

No read/write timeout in seconds

A unique number for the component being monitored, Defaults to zero.

The name of the metric set schema, Defaults to the sampler name

The instance name of the set containing the job data, default is ‘job_info’

The name of the metric containing the Job Id, default is ‘job_id’

The name of the metric containing the Application Id, default is ‘app_id’

The name of the metric containing the Job start time, default is ‘job_start’

The name of the metric containing the Job end time, default is ‘job_end’

None known.

Within ldmsd_controller or a configuration file:

load name=shm_sampler
config name=shm_sampler producer=samplerd instance=samplerd/shm_sampler shm_index=/ldms_shm_mpi_index shm_boxmax=4 component_id=23
start name=shm_sampler interval=1000000 offset=0

ldmsd(8), ldms_quickstart(7), ldmsd_controller(8)