1PMDALUSTRE(1) General Commands Manual PMDALUSTRE(1)
2
6 pmdalustre - lustre filesystem statistics performance metrics domain
7 agent (PMDA)
8
10 pmdalustre is a Performance Metrics Domain Agent (PMDA) which reads and
11 exports metric values from the statistics interfaces of a Lustre
12 filesystem.
13 pmdalustre searches for statistics interfaces from several locations,
15 which vary depending on the version of Lustre installed locally.
16 Recent Lustre versions (v2.12 and later) export statistics from the
18 kernel debugfs pseudo filesystem, in the directories /sys/ker‐
19 nel/debug/lustre/llite and /sys/kernel/debug/lnet. If these interfaces
20 are not found during startup, pmdalustre will automatically check if
21 the statistics interfaces are available from the procfs pseudo filesys‐
22 tem below the /proc/fs/lustre/llite and /proc/sys/lnet directories.
23 These are the default locations of the statistics for Lustre versions
24 less than v2.12.
25 If neither of the above filesystem interfaces are detected, or if the
27 user wants to override the default locations, pmdalustre also supports
28 an optional configuration file named $PCP_PMDAS_DIR/lustre/lustre.conf.
29 Note that $PCP_PMDAS_DIR is set to /var/lib/pcp/pmdas on most Linux
30 based systems. The configuration file supports perl(1) variable
31 assignment syntax. An example configuration file suitable for Lustre
32 v2.12 and later is:
33 $LLITE_PATH="/sys/kernel/debug/lustre/llite/";
35 $LNET_PATH="/sys/kernel/debug/lustre/lnet/";
36 See comments in the shipped lustre.conf file for further details. By
38 default, this file is installed with everything commented (and so it
39 has no effect unless edited) because the built-in heuristics used by
40 pmdalustre should suffice.
41 Finally, overriding all of the above, the LUSTRE_LLITE_PATH and LUS‐
43 TRE_LNET_PATH environment variables may be set (and exported) to spec‐
44 ify the directory locations of the statistics interfaces to be used.
45 This mechanism using environment variabes is intended to be used for
46 development and testing purposes only.
47 The pmdalustre process runs as the root user because debugfs directo‐
49 ries are not normally readable by unprivileged users.
50
52 Install pmdalustre by using the Install script as the root user:
53 # cd $PCP_PMDAS_DIR/lustre
55 # ./Install
56 If you want to undo the installation, do the following as root:
58 # cd $PCP_PMDAS_DIR/lustre
60 # ./Remove
61 pmdalustre is launched by pmcd(1) and should never be executed
63 directly. The Install and Remove scripts notify pmcd(1) when the agent
64 is installed or removed.
65
67 $PCP_PMDAS_DIR/lustre/Install
68 installation script for the pmdalustre agent
69 $PCP_PMDAS_DIR/lustre/Remove
71 undo installation script for the pmdalustre agent
72 $PCP_LOG_DIR/pmcd/lustre.log
74 default log file for error messages from pmdalustre
75 $PCP_PMDAS_DIR/lustre/lustre.conf
77 Configuration file for over-riding default statistics directories
78 used by pmdalustre.
79
81 Environment variables with the prefix PCP_ are used to parameterize the
82 file and directory names used by PCP. On each installation, the file
83 /etc/pcp.conf contains the local values for these variables. The
84 $PCP_CONF variable may be used to specify an alternative configuration
85 file, as described in pcp.conf(5).
86
88 PCPIntro(1), perl(1), pmcd(1) and llstat(1).
89Performance Co-Pilot PCP PMDALUSTRE(1)