lustre_client

Man page for the LDMS lustre_client plugin

Date:: 1 May 2019
Manual section:: 7
Manual group:: LDMS sampler

SYNOPSIS

Within ldmsd_controller or a configuration file:

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

DESCRIPTION

With LDMS (Lightweight Distributed Metric Service), plugins for the ldmsd (ldms daemon) are configured via ldmsd_controller or a configuration file. The lustre_client plugin provide a metric set for each of the lustre client mounts found on a node. The schema is named “lustre_client”. The data for the metric sets is generally found in /proc/fs/lustre/llite/*/stats.

This plugin currently employs zero configuration. The producer name is set to the hostname by default, and the metric set instance names are derived from the llite instance name. Any user-supplied configuration values not documented here will be ignored.

This plugin should work with at least Lustre versions 2.8, 2.10, 2.12 and 2.15. The debugfs filesystem must be mounted for lustre data access, which is also usually restricted to the root user.

CONFIGURATION ATTRIBUTE SYNTAX

config

name=<plugin_name> [job_set=<metric set name>] [producer=<name>] [component_id=<u64>]

configuration line

name=<plugin_name>: This MUST be lustre_client.
job_set=<job metric set name>: The name of the metric set that contains the job id information (default=job_id)
producer=<alternate host name>: The default used for producer (if not provided) is the result of gethostname(). The set instance names will be $producer/$llite_name.
component_id=<uint64_t>: Optional (defaults to 0) number of the host where the sampler is running. All sets on a host will have the same value.
perm=<octal number>: Set the access permissions for the metric sets. (default 440).
extra215=1: Enable lustre 2.15 new metrics; this appends a small number, unique to the choice of extras, to the default schema name.
extratimes=1: Enable start and elapsed time metrics (rounded to seconds). This appends a small number, unique to the choice of extras, to the default schema name.
test_path=<LLITE_DIR>: This debugging option instructs the plugin to read data from a directory containing a static snapshot of an llite directory instead of from debugfs files.

NOTES

Improperly spelled option names are not trapped as configuration errors.

EXAMPLES