pmdaib(1) [centos man page]
PMDAIB(1) General Commands Manual PMDAIB(1) NAME
pmdaib - Infiniband performance metrics domain agent (PMDA) SYNOPSYS
$PCP_PMDAS_DIR/infiniband/pmdaib [-c configFile] [-D debug] [-d domain] [-l logfile] [-w] DESCRIPTION
pmdaib is a Performance Metrics Domain Agent (PMDA) which exports information and performance metrics about local Infiniband HCAs and local or remote Infiniband GUIDs. A brief description of the pmdaib command line options follows: -c Location of the config file. By default, the config file is named $PCP_PMDAS_DIR/infiniband/config. See CONFIG FILE for more infor- mation. -D A debug values, as specified by pmdbg (1) -d Specify an alternate performance metrics domain number. Almost never necessary. -l Location of the log file. By default, a log file named ib.log is written to $PCP_LOG_DIR/pmcd. If the log file cannot be created or is not writable, output is written to the standard error instead. -w Write out the default config file to $PCP_PMDAS_DIRS/infiniband and exit immediately. The written config file will contain the local HCA ports. It will not overwrite an existing file. This argument should only be used to create the template config file and should never appear in pmcd.conf. See CONFIG FILE for more information on the file format and on monitoring remote GUIDs. CONFIG FILE
By default, the PMDA will operate without using a config file. In this mode of operation the local HCA ports will be monitored. Note that if a new HCA is added to the machine that instance domain naming may change because it will always be based on the kernel's naming. In cases where this is not acceptable, or in the case where monitoring remote Infiniband ports is required, a config file must be created. A "template" file can be created by running the pmdaib daemon with the -w argument. This will create a config file with the local ports and GUIDs. If the config file is executable then it will be run and the output will be used as the config file. The config file is composed of line-based records. Blank lines and everything after the hash (#) character are ignored. Each line has 6 fields: [instName] [portGUID] [portNum] via [localPortName]:[localPortNum] The first field is used to give a static instance name to the Infiniband port that has a specific GUID. All of the other fields must be properly specified in order to monitor a particular port. For example, to monitor port 1 of the local HCA called 'mthca0' a possible config file line would be: myPort1 0xdeadbeef01234567 1 via mthca0:1 Remote ports can be easily monitored by specifying the GUID of the HCA or switch and specifying the remote port number. The localPort- Name:localPortNum tuple specifies which local HCA and port to use as the "first hop" in contacting the remote GUID. E.g., to monitor port 13 of a remote switch which is connected to the fabric on the first port of the second HCA: switch13 0xfeeffeefabcdabcd 13 via mthca1:1 LOCAL CONTEXT
The Infiniband pmda also supports accessing the metrics via PM_CONTEXT_LOCAL when using the PMAPI interface. In order to use the Infini- band pmda in this way, set the environment variable PMDA_LOCAL_IB prior to calling pmNewContext(3). SEE ALSO
pmcd(1), PMAPI(3), pmContextNew(3), ibnetdiscover(8). Performance Co-Pilot PCP PMDAIB(1)
Check Out this Related Man Page
PMDASAMPLE(1) General Commands Manual PMDASAMPLE(1) NAME
pmdasample - sample performance metrics domain agent (PMDA) SYNOPSIS
$PCP_PMDAS_DIR/pmdasample [-d domain] [-i port] [-l logfile] [-p] [-u socket] [-U username] DESCRIPTION
pmdasample is a sample Performance Metrics Domain Agent (PMDA) which exports a variety of synthetic performance metrics. This PMDA was developed as part of the quality assurance testing for the PCP product, but has other uses, most notably in the development of new PCP clients. The metrics exported by the sample PMDA cover the full range of data types, data semantics, value cardinality, instance domain stability and error conditions found in real PMDAs. A brief description of the pmdasample command line options follows: -d It is absolutely crucial that the performance metrics domain number specified here is unique and consistent. That is, domain should be different for every PMDA on the one host, and the same domain number should be used for the same PMDA on all hosts. -i Expect PMCD to connect to pmdasample on the specified TCP/IP port. port may be a port number or port name. -l Location of the log file. By default, a log file named sample.log is written in the current directory of pmcd(1) when pmdasample is started, i.e. $PCP_LOG_DIR/pmcd. If the log file cannot be created or is not writable, output is written to the standard error instead. -p Expect PMCD to create a pipe and the connection to pmdasample is via standard input and standard output. This is the default connec- tion mode. -u Expect PMCD to connect to pmdasample on the Unix domain socket named socket. -U User account under which to run the agent. The default is the unprivileged "pcp" account in current versions of PCP, but in older versions the superuser account ("root") was used by default. At most one of the options -i, -p and -u may be specified. INSTALLATION
If you want access to the names, help text and values for the sample performance metrics, do the following as root: # cd $PCP_PMDAS_DIR/sample # ./Install Note that the installation script also installs the DSO version of the sample PMDA, so there are in fact two PMDAs installed, and two sets of performance metrics, namely sample.* and sampledso.*. If you want to undo the installation (and remove both PMDAs), do the following as root: # cd $PCP_PMDAS_DIR/sample # ./Remove pmdasample is launched by pmcd(1) and should never be executed directly. The Install and Remove scripts notify pmcd(1) when the agent is installed or removed. FILES
$PCP_PMCDCONF_PATH command line options used to launch pmdasample $PCP_PMDAS_DIR/sample/help default help text file for the sample metrics $PCP_PMDAS_DIR/sample/Install installation script for the pmdasample agent $PCP_PMDAS_DIR/sample/Remove undo installation script for the pmdasample agent $PCP_LOG_DIR/pmcd/sample.log default log file for error messages and other information from pmdasample PCP ENVIRONMENT
Environment variables with the prefix PCP_ are used to parameterize the file and directory names used by PCP. On each installation, the file /etc/pcp.conf contains the local values for these variables. The $PCP_CONF variable may be used to specify an alternative configura- tion file, as described in pcp.conf(5). SEE ALSO
PCPIntro(1), pmcd(1), pmdasimple(1), pmdatrivial(1), pmdatxmon(1), pcp.conf(5) and pcp.env(5). Performance Co-Pilot PCP PMDASAMPLE(1)