commit 20b71acdf7f262ae8b47103f15f1bfe8019edb2b Author: Nathan Scott Date: Fri Jan 17 17:32:32 2014 +1100 Add man pages for all of the PMDAs currently missing one New man pages for the following PMDAs: apache, jbd2, lmsensors, logger, lustrecomm, mmv, mounts, proc, roomtemp, rpm, systemd, xfs and the kernel. diff --git a/man/man1/GNUmakefile b/man/man1/GNUmakefile index 18e3379..96da981 100644 --- a/man/man1/GNUmakefile +++ b/man/man1/GNUmakefile @@ -19,33 +19,68 @@ include $(TOPDIR)/src/include/builddefs MAN_SECTION = 1 -MAN_PAGES = chkhelp.1 dbpmda.1 mkaf.1 newhelp.1 pcp.1 pcpintro.1 \ - pmafm.1 pmcd.1 pmcd_wait.1 pmclient.1 pmdacisco.1 pmdamailq.1 \ - pmdasample.1 pmdasendmail.1 pmdasimple.1 pmdate.1 pmdatrace.1 \ - pmdatrivial.1 pmdatxmon.1 pmdbg.1 pmdumplog.1 pmerr.1 pmgenmap.1 \ - pmhostname.1 pmie.1 pmie_check.1 pminfo.1 pmlc.1 pmconfig.1 \ - pmlock.1 pmlogcheck.1 pmlogconf.1 pmlogextract.1 pmlogger.1 \ - pmlogger_check.1 pmnewlog.1 pmnsadd.1 pmnsdel.1 \ +MAN_PAGES = \ + chkhelp.1 dbpmda.1 mkaf.1 newhelp.1 pcp.1 pcpintro.1 pmafm.1 \ + pmcd.1 pmcd_wait.1 pmclient.1 pmconfig.1 pmdbg.1 pmdumplog.1 \ + pmerr.1 pmgenmap.1 pmhostname.1 pmie.1 pmie_check.1 pminfo.1 \ + pmlc.1 pmlock.1 pmlogcheck.1 pmlogconf.1 pmlogextract.1 \ + pmlogger.1 pmlogger_check.1 pmnewlog.1 pmnsadd.1 pmnsdel.1 \ pmnsmerge.1 pmpost.1 pmprobe.1 pmsocks.1 pmstat.1 pmstore.1 \ - pmtrace.1 pmval.1 pmdaweblog.1 pmlogsummary.1 pmdashping.1 \ - pmloglabel.1 genpmda.1 pmproxy.1 pmdasummary.1 pmlogreduce.1 \ + pmtrace.1 pmval.1 pmlogsummary.1 pmdate.1 \ + pmloglabel.1 genpmda.1 pmproxy.1 pmlogreduce.1 \ autofsd-probe.1 pmie2col.1 telnet-probe.1 pmsleep.1 pmsignal.1 \ pmieconf.1 pmiestatus.1 pmevent.1 pmcpp.1 pmlogrewrite.1 \ - pmdabash.1 pmatop.1 pmcollectl.1 pmwtf.1 collectl2pcp.1 \ - pmdagfs2.1 pmdagluster.1 pmmgr.1 pmfind.1 + pmatop.1 pmcollectl.1 pmwtf.1 collectl2pcp.1 pmmgr.1 pmfind.1 \ + \ + pmdaapache.1 pmdabash.1 pmdacisco.1 \ + pmdagfs2.1 pmdagluster.1 \ + pmdakernel.1 \ + pmdalogger.1 pmdamailq.1 pmdammv.1 pmdamounts.1 \ + pmdasample.1 pmdasendmail.1 pmdashping.1 pmdasimple.1 \ + pmdasummary.1 \ + pmdatrace.1 pmdatrivial.1 pmdatxmon.1 pmdaweblog.1 \ -# same guard as in src/pmwebapi/GNUmakefile -ifeq "$(HAVE_LIBMICROHTTPD)" "1" -MAN_PAGES += pmwebd.1 -endif +LINUX_PMDA_PAGES = \ + pmdalmsensors.1 pmdalustrecomm.1 pmdaproc.1 pmdaxfs.1 pmdajbd2.1 +ROOMTEMP_PMDA_PAGES = pmdaroomtemp.1 +SYSTEMD_PMDA_PAGES = pmdasystemd.1 +RPM_PMDA_PAGES = pmdarpm.1 +IB_PMDA_PAGES = pmdaib.1 +WEBD_PAGES = pmwebd.1 +ifeq "$(TARGET_OS)" "linux" +MAN_PAGES += $(LINUX_PMDA_PAGES) +else +LSRCFILES += $(LINUX_PMDA_PAGES) +endif +ifneq "$(findstring $(TARGET_OS),solaris linux)" "" +MAN_PAGES += $(ROOMTEMP_PMDA_PAGES) +else +LSRCFILES += $(ROOMTEMP_PMDA_PAGES) +endif +ifeq "$(HAVE_RPMLIB)" "1" +MAN_PAGES += $(RPM_PMDA_PAGES) +else +LSRCFILES += $(RPM_PMDA_PAGES) +endif +ifneq "$(PMDA_SYSTEMD)" "" +MAN_PAGES += $(SYSTEMD_PMDA_PAGES) +else +LSRCFILES += $(SYSTEMD_PMDA_PAGES) +endif ifneq "$(PMDA_INFINIBAND)" "" -MAN_PAGES += pmdaib.1 +MAN_PAGES += $(IB_PMDA_PAGES) +else +LSRCFILES += $(IB_PMDA_PAGES) +endif +ifeq "$(HAVE_LIBMICROHTTPD)" "1" +MAN_PAGES += $(WEBD_PAGES) +else +LSRCFILES += $(WEBD_PAGES) endif MAN_DEST = $(PCP_MAN_DIR)/man$(MAN_SECTION) LSRCFILES = $(MAN_PAGES) -LSRCFILES += pmtop.1 pmdahotproc.1 default :: default_pcp diff --git a/man/man1/pmdaapache.1 b/man/man1/pmdaapache.1 new file mode 100644 index 0000000..6b489d1 --- /dev/null +++ b/man/man1/pmdaapache.1 @@ -0,0 +1,176 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDAAPACHE 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdaapache\f1 \- Apache2 web server performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/apache/pmdaapache\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +[\f3\-S\f1 \f2server\f1] +[\f3\-P\f1 \f2port\f1] +[\f3\-L\f1 \f2location\f1] +.SH DESCRIPTION +.B pmdaapache +is a Performance Metrics Domain Agent (PMDA) which extracts +performance metrics describing the state of an Apache web server. +.PP +The +.B apache +PMDA exports metrics that measure the request rate, cumulative +request sizes, uptime and various connection states for active +clients. +.PP +This information is obtained by performing a HTTP request to the +server status URL, which must be enabled in the +.I httpd.conf +configuration file. +.P +.ft CW +.nf +.in +0.5i +ExtendedStatus on + +SetHandler server-status +Order deny,allow +Deny from all +Allow from localhost + +.in +.fi +.ft 1 +.PP +A brief description of the +.B pmdaapache +command line options follows: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I apache.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdaapache +is started, i.e. +.B $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-S +Query the Apache status information from the named +.I server +rather than the local host. +.TP +.B \-P +Query the Apache status information from the given +.I port +rather than the default (80). +.TP +.B \-L +Specify an alternative +.I location +for finding the server-status page. +.TP +.B \-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. +.SH INSTALLATION +If you want access to the names, help text and values for the apache +performance metrics, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/apache +# ./Install +.in +.fi +.ft 1 +.PP +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/apache +# ./Remove +.in +.fi +.ft 1 +.PP +.B pmdaapache +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdaapache +.TP 10 +.B $PCP_PMDAS_DIR/apache/help +default help text file for the apache metrics +.TP 10 +.B $PCP_PMDAS_DIR/apache/Install +installation script for the +.B pmdaapache +agent +.TP 10 +.B $PCP_PMDAS_DIR/apache/Remove +undo installation script for the +.B pmdaapache +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/apache.log +default log file for error messages and other information from +.B pmdaapache +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR httpd (8), +.BR pmcd (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdajbd2.1 b/man/man1/pmdajbd2.1 new file mode 100644 index 0000000..58e2129 --- /dev/null +++ b/man/man1/pmdajbd2.1 @@ -0,0 +1,161 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDAJBD2 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdajbd2\f1 \- journal block device (JBD) performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/jbd2/pmdajbd2\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-j\f1 \f2path\f1] +[\f3\-U\f1 \f2username\f1] +.SH DESCRIPTION +.B pmdajbd2 +is a Performance Metrics Domain Agent (PMDA) which extracts +performance metrics from the Journal Block Device subsystem +(version 2) in the Linux kernel. +These metrics are exported by the kernel in procfs files, +one file per block device. +The JBD2 subsystem is used by several filesystems including +ext3, ext4 and ocfs2. +.PP +The +.B jbd2 +PMDA exports metrics that measure detailed journal transaction +information, such as time spent waiting and locked, request +rates, blocks used and so on. +.PP +A brief description of the +.B pmdajbd2 +command line options follows (these are only relevant when +running the PMDA as a daemon, and not as a shared library): +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, when running as a daemon +a log file named +.I jbd2.log +is written in the current directory of +when +.B pmdajbd2 +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +When running in shared library mode, and diagnostic information will +be written into the +.B pmcd +log file, namely +.BR $PCP_LOG_DIR/pmcd/pmcd.log . +.TP +.B \-j +Allows an alternate path to the jbd2 statistics files to be specified. +The default path is +.IR /proc/fs/jbd2 . +.TP +.B \-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. +.SH INSTALLATION +This PMDA is installed by default and in the shared library +mode (rather than as a separate daemon to +.BR pmcd (1)). +Thus, the names, help text and values for the jbd2 performance metrics +should always be available. +.PP +If you do not use these metrics you can remove this PMDA, do the +following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/jbd2 +# ./Remove +.in +.fi +.ft 1 +.PP +If you want to enable the installation again, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/jbd2 +# ./Install +.in +.fi +.ft 1 +.PP +.B pmdajbd2 +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdajbd2 +.TP 10 +.B $PCP_PMDAS_DIR/jbd2/help +default help text file for the jbd2 metrics +.TP 10 +.B $PCP_PMDAS_DIR/jbd2/Install +installation script for the +.B pmdajbd2 +agent +.TP 10 +.B $PCP_PMDAS_DIR/jbd2/Remove +undo installation script for the +.B pmdajbd2 +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/jbd2.log +default log file for error messages and other information from +.B pmdajbd2 +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdakernel.1 b/man/man1/pmdakernel.1 new file mode 100644 index 0000000..b8d5203 --- /dev/null +++ b/man/man1/pmdakernel.1 @@ -0,0 +1,157 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH "KERNEL PMDAS" 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdaaix\f1, +\f3pmdadarwin\f1, +\f3pmdafreebsd\f1, +\f3pmdalinux\f1, +\f3pmdanetbsd\f1, +\f3pmdaproc\f1, +\f3pmdasolaris\f1, +\f3pmdawindows\f1, +\f3kernel PMDAs\f1 \- operating system kernel performance metrics domain agents +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/aix/pmdaaix\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.br +\f3$PCP_PMDAS_DIR/darwin/pmdadarwin\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.br +\f3$PCP_PMDAS_DIR/freebsd/pmdafreebsd\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.br +\f3$PCP_PMDAS_DIR/linux/pmdalinux\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.br +\f3$PCP_PMDAS_DIR/netbsd/pmdanetbsd\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.br +\f3$PCP_PMDAS_DIR/solaris/pmdasolaris\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.br +\f3$PCP_PMDAS_DIR/windows/pmdawindows\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.SH DESCRIPTION +Each supported platform has a kernel Performance Metrics Domain +Agent (PMDA) which extracts performance metrics from the kernel +of that platfrom. +A variety of platform-specific metrics are available, with an +equally varied set of access mechanisms - typically this involves +special system calls, or reading from files in kernel virtual +filesystems such as the Linux +.I sysfs +and +.I procfs +filesystems. +.PP +The platform kernel PMDA is one of the most critical components +of the PCP installation, and must be as efficient and reliable +as possible. +In all installations the default kernel PMDA will be installed +as a shared library and thus executes directly within the +.BR pmcd (1) +process. +This slightly reduces overheads associated with querying the +metadata and values associated with these metrics (no message +passing is required). +.PP +Unlike many other PMDAs, the kernel PMDA exports a number of +metric namespace subtrees, such as kernel, network, swap, mem, +ipc, filesys, nfs, disk and hinv (hardware inventory). +.PP +Despite usually running as shared libraries, most installations +also include a stand-alone executable for the kernel PMDA. +This is to aid profiling and debugging activities, with +.BR dbpmda (1) +for example. +In this case (but not for shared libraries), the following +command line options are available: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I [platform].log +is written in the current directory of +.BR pmcd (1) +when +.B pmda[platform] +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-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. +.SH INSTALLATION +Access to the names, help text and values for the kernel performance +metrics is available by default - unlike most other agents, no action +is required to enable them and they should not be removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMDAS_DIR/[platform]/help +default help text file for the the kernel metrics +.TP 10 +.B $PCP_LOG_DIR/pmcd/pmcd.log +default log file for error messages and other information from +the kernel PMDA. +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR dbpmda (1) +.BR pmcd (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdalmsensors.1 b/man/man1/pmdalmsensors.1 new file mode 100644 index 0000000..e266975 --- /dev/null +++ b/man/man1/pmdalmsensors.1 @@ -0,0 +1,138 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDALMSENSORS 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdalmsensors\f1 \- Linux hardware monitoring performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/lmsensors/pmdalmsensors\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.SH DESCRIPTION +.B pmdalmsensors +is a Performance Metrics Domain Agent (PMDA) which extracts +performance metrics describing the state of hardware using +the lm-sensors on compatible motherboards. +.PP +The +.B lmsensors +PMDA exports metrics that measure fan speeds, core temperatures +and voltage levels. +.PP +A brief description of the +.B pmdalmsensors +command line options follows: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I lmsensors.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdalmsensors +is started, i.e. +.B $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-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. +.SH INSTALLATION +If you want access to the names, help text and values for the lmsensors +performance metrics, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/lmsensors +# ./Install +.in +.fi +.ft 1 +.PP +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/lmsensors +# ./Remove +.in +.fi +.ft 1 +.PP +.B pmdalmsensors +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdalmsensors +.TP 10 +.B $PCP_PMDAS_DIR/lmsensors/help +default help text file for the lmsensors metrics +.TP 10 +.B $PCP_PMDAS_DIR/lmsensors/Install +installation script for the +.B pmdalmsensors +agent +.TP 10 +.B $PCP_PMDAS_DIR/lmsensors/Remove +undo installation script for the +.B pmdalmsensors +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/lmsensors.log +default log file for error messages and other information from +.B pmdalmsensors +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdalogger.1 b/man/man1/pmdalogger.1 new file mode 100644 index 0000000..846c535 --- /dev/null +++ b/man/man1/pmdalogger.1 @@ -0,0 +1,184 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDALOGGER 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdalogger\f1 \- log file performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/logger/pmdalogger\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-m\f1 \f2memory\f1] +[\f3\-s\f1 \f2interval\f1] +[\f3\-U\f1 \f2username\f1] +[\f2configfile\f1] +.SH DESCRIPTION +.B pmdalogger +is a configurable log file monitoring Performance Metrics Domain +Agent (PMDA). +It can be seen as analagous to the +.B \-f +option to +.BR tail (1) +and converts each new log line into a performance event. +It was the first PMDA to make extensive use of event metrics, which +can be consumed by client tools like +.BR pmevent (1). +.PP +The +.B logger +PMDA exports both event-style metrics reflecting timestamped event records +for text logged to a file (or set of files or output from a process), +as well as the more orthodox sample-style metrics such as event counts +and throughput size values. +.PP +The PMDA is configured via a +.I configfile +which contains one line for each source of events (file or process). +This file is setup by the Install script described in the later +section on ``INSTALLATION'' of the PMDA. +.PP +A brief description of the +.B pmdalogger +command line options follows: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I logger.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdalogger +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-m +Limit the physical memory used by the PMDA to buffer event records to +.I maxsize +bytes. +As log events arrive at the PMDA, they must be buffered until individual +client tools request the next batch since their previous batch of events. +The default maximum is 2 megabytes. +.TP +.B \-s +Sets the polling interval for detecting newly arrived log lines. +Mirrors the same option from the +.BR tail (1) +command. +.TP +.B \-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. +.SH INSTALLATION +If you want access to the names, help text and values for the logger +performance metrics, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/logger +# ./Install +.in +.fi +.ft 1 +.PP +This is an interactive installation process which prompts for each +log file path to be monitored (or command to be run), a metric +instance name to identify it, and whether access should be restricted +(refer to the +.B \-x +option to +.BR pmevent (1) +for further details). +.PP +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/logger +# ./Remove +.in +.fi +.ft 1 +.PP +.B pmdalogger +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdalogger +.TP 10 +.B $PCP_PMDAS_DIR/logger/logger.conf +default configuration file for the logger metrics +.TP 10 +.B $PCP_PMDAS_DIR/logger/help +default help text file for the logger metrics +.TP 10 +.B $PCP_PMDAS_DIR/logger/Install +installation script for the +.B pmdalogger +agent +.TP 10 +.B $PCP_PMDAS_DIR/logger/Remove +undo installation script for the +.B pmdalogger +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/logger.log +default log file for error messages and other information from +.B pmdalogger +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmevent (1), +.BR pmcd (1), +.BR tail (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdalustrecomm.1 b/man/man1/pmdalustrecomm.1 new file mode 100644 index 0000000..dd5fa85 --- /dev/null +++ b/man/man1/pmdalustrecomm.1 @@ -0,0 +1,141 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDALUSTERCOMM 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdalustrecomm\f1 \- Lustre filesystem comms performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/lustrecomm/pmdalustrecomm\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.SH DESCRIPTION +.B pmdalustrecomm +is a Performance Metrics Domain Agent (PMDA) which extracts +performance metrics from the Linux procfs filesystem about +the state of various aspects of the Lustre filesystem. +.PP +The +.B lustrecomm +PMDA exports metrics that focus on distributed communication +in the filesystem, including metrics related to timeouts, +network drops, send/recv information and route lengths. +However, it also covers the memory use of some of the Lustre +filesystem components. +.PP +A brief description of the +.B pmdalustrecomm +command line options follows: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I lustrecomm.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdalustrecomm +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-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. +.SH INSTALLATION +If you want access to the names, help text and values for the lustrecomm +performance metrics, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/lustrecomm +# ./Install +.in +.fi +.ft 1 +.PP +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/lustrecomm +# ./Remove +.in +.fi +.ft 1 +.PP +.B pmdalustrecomm +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdalustrecomm +.TP 10 +.B $PCP_PMDAS_DIR/lustrecomm/help +default help text file for the lustrecomm metrics +.TP 10 +.B $PCP_PMDAS_DIR/lustrecomm/Install +installation script for the +.B pmdalustrecomm +agent +.TP 10 +.B $PCP_PMDAS_DIR/lustrecomm/Remove +undo installation script for the +.B pmdalustrecomm +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/lustrecomm.log +default log file for error messages and other information from +.B pmdalustrecomm +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdammv.1 b/man/man1/pmdammv.1 new file mode 100644 index 0000000..859b151 --- /dev/null +++ b/man/man1/pmdammv.1 @@ -0,0 +1,177 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDAMMV 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdammv\f1 \- memory mapped values performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/mmv/pmdammv\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.SH DESCRIPTION +.B pmdammv +is a Performance Metrics Domain Agent (PMDA) which exports +application level performance metrics using memory mapped files. +It offers an extremely low overhead instrumentation facility +that is well-suited to long running, mission critical applications +where it is desirable to have performance metrics and availability +information permanently enabled. +.PP +The +.B mmv +PMDA exports instrumentation that has been added to an application +using the MMV APIs (refer to +.BR mmv_stats_init (3) +and +.BR mmv (5) +for further details). +These APIs can be called from several languages, including C, C++, +Perl, Python and Java (via the separate ``Parfait'' class library). +.PP +A brief description of the +.B pmdammv +command line options follows: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I mmv.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdammv +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-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. +.SH INSTALLATION +If you want access to the names, help text and values for the mmv +performance metrics, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/mmv +# ./Install +.in +.fi +.ft 1 +.PP +Note that the default mechanism for sharing memory mapped values +between instrumented applications and the +.B mmv +PMDA involves the creation of a world-writeable +.I $PCP_TMP_DIR/mmv +directory with the sticky-bit set (similar to +.I /tmp +and +.IR /var/tmp , +for example). +This suffices to allow any application, running under any user account, +to communicate with the PMDA (which runs under the "pcp" account by +default). +This may not be desirable for every environment, and one should consider +the security implications of any directory setup like this (similar +classes of issues exist as those that affect the system temporary file +directories). +.PP +The installation process will not overwrite any existing +.I $PCP_TMP_DIR/mmv +directory. +Thus it is possible to implement an alternate permissions strategy with +no world-writable directory for sharing files - any directory readable +by user or group "pcp" will suffice. +.PP +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/mmv +# ./Remove +.in +.fi +.ft 1 +.PP +.B pmdammv +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdammv +.TP 10 +.B $PCP_TMP_DIR/mmv +directory housing memory mapped value files +.TP 10 +.B $PCP_PMDAS_DIR/mmv/help +default help text file for the mmv metrics +.TP 10 +.B $PCP_PMDAS_DIR/mmv/Install +installation script for the +.B pmdammv +agent +.TP 10 +.B $PCP_PMDAS_DIR/mmv/Remove +undo installation script for the +.B pmdammv +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/mmv.log +default log file for error messages and other information from +.B pmdammv +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR mmv_stats_init (3), +.BR mmv (5), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdamounts.1 b/man/man1/pmdamounts.1 new file mode 100644 index 0000000..2de6f41 --- /dev/null +++ b/man/man1/pmdamounts.1 @@ -0,0 +1,147 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDAMOUNTS 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdamounts\f1 \- filesystem mounts performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/mounts/pmdamounts\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-U\f1 \f2username\f1] +.SH DESCRIPTION +.B pmdamounts +is a simple Performance Metrics Domain Agent (PMDA) which +monitors availability of a given set of filesystem mounts. +.PP +The +.B mounts +PMDA exports metrics that reflect whether the configured +filesystems are mounted ("up") or not. +The list of mount points to monitor is specified via the +.I $PCP_PMDAS_DIR/mounts/mounts.conf +file which simply contains one line for each mount point. +.PP +Note that the platform kernel PMDA exports a more extensive +set of filesystem metrics for every mounted filesystem \- +this PMDA is primarily intended for availability monitoring +using the +.I mounts.up +metric. +.PP +A brief description of the +.B pmdamounts +command line options follows: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I mounts.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdamounts +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-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. +.SH INSTALLATION +If you want access to the names, help text and values for the mounts +performance metrics, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/mounts +# ./Install +.in +.fi +.ft 1 +.PP +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/mounts +# ./Remove +.in +.fi +.ft 1 +.PP +.B pmdamounts +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdamounts +.TP 10 +.B $PCP_PMDAS_DIR/mounts/help +default help text file for the mounts metrics +.TP 10 +.B $PCP_PMDAS_DIR/mounts/Install +installation script for the +.B pmdamounts +agent +.TP 10 +.B $PCP_PMDAS_DIR/mounts/Remove +undo installation script for the +.B pmdamounts +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/mounts.log +default log file for error messages and other information from +.B pmdamounts +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdaproc.1 b/man/man1/pmdaproc.1 new file mode 100644 index 0000000..191f178 --- /dev/null +++ b/man/man1/pmdaproc.1 @@ -0,0 +1,185 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDAPROC 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdaproc\f1 \- process performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/proc/pmdaproc\f1 +[\f3\-AL\f1] +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-r\f1 \f2cgroup\f1] +[\f3\-U\f1 \f2username\f1] +.SH DESCRIPTION +.B pmdaproc +is a Performance Metrics Domain Agent (PMDA) which extracts +performance metrics describing the state of the individual +processes running on a Linux system. +.PP +The +.B proc +PMDA exports metrics that measure the memory, processor and +other resource use of each process, as well as summary information +collated across all of the running processes. +The PMDA uses credentials passed from the +.BR PMAPI (3) +monitoring tool identifying the user requesting the information, +to ensure that only values the user is allowed to access are +returned by the PMDA. +This involves the PMDA temporarily changing its effective user and +group identifiers for the duration of requests for instances and +values. +In other words, system calls to extract information are performed +as the user originating the request and not as a privileged user. +The mechanisms available for transfer of user credentials are +described further in the +.BR PCPIntro (1) +page. +.PP +A brief description of the +.B pmdaproc +command line options follows: +.TP 5 +.B \-A +Disables use of the credentials provided by +.B PMAPI +client tools, +and simply runs everything under the "root" account. +.TP +.B \-L +Changes the per-process instance domain used by most +.B procproc +metrics to include threads as well. +.TP +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I proc.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdaproc +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-r +Restrict the set of processes exported in the per-process instance domain +to only those processes that are contained by the specified +.IR cgroup +resource container. +This option provides an optional finer granularity to the monitoring, and +can also be used to reduce the resources consumed by +.I pmdaproc +during requests for instances and values. +.TP +.B \-U +User account under which to run the agent. +The default is the privileged "root" account, with +seteuid (2) +and +setegid (2) +switching for accessing most information. +.SH INSTALLATION +The +.B proc +PMDA is installed and available by default. +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/proc +# ./Remove +.in +.fi +.ft 1 +.PP +If you want to establish access to the names, help text and values for the proc +performance metrics once more, after removal, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/proc +# ./Install +.in +.fi +.ft 1 +.PP +.B pmdaproc +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdaproc +.TP 10 +.B $PCP_PMDAS_DIR/proc/help +default help text file for the proc metrics +.TP 10 +.B $PCP_PMDAS_DIR/proc/Install +installation script for the +.B pmdaproc +agent +.TP 10 +.B $PCP_PMDAS_DIR/proc/Remove +undo installation script for the +.B pmdaproc +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/proc.log +default log file for error messages and other information from +.B pmdaproc +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR seteuid (2), +.BR setegid (2), +.BR PMAPI (3), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdaroomtemp.1 b/man/man1/pmdaroomtemp.1 new file mode 100644 index 0000000..468c66e --- /dev/null +++ b/man/man1/pmdaroomtemp.1 @@ -0,0 +1,136 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDAROOMTEMP 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdaroomtemp\f1 \- room temperature performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/roomtemp/pmdaroomtemp\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +.SH DESCRIPTION +.B pmdaroomtemp +is a Performance Metrics Domain Agent (PMDA) which exports the +temperature from one or more sensors built using the DS2480 and +DS1280 chipsets and MicroLAN technology from Dallas Semiconductor +Corporation. +.PP +The +.B roomtemp +PMDA exports metrics that reflect the temperatures from one or +more of these devices, in both degrees Celcius and Fahrenheit. +Each metric has one instance for each temperature sensor device. +The external instance identifiers are the serial numbers (in hex) +of the DS1280 chips discovered when the MicroLAN was probed. +.PP +A brief description of the +.B pmdaroomtemp +command line options follows: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I roomtemp.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdaroomtemp +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.SH INSTALLATION +If you want access to the names, help text and values for the roomtemp +performance metrics, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/roomtemp +# ./Install +.in +.fi +.ft 1 +.PP +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/roomtemp +# ./Remove +.in +.fi +.ft 1 +.PP +.B pmdaroomtemp +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdaroomtemp +.TP 10 +.B $PCP_PMDAS_DIR/roomtemp/help +default help text file for the roomtemp metrics +.TP 10 +.B $PCP_PMDAS_DIR/roomtemp/Install +installation script for the +.B pmdaroomtemp +agent +.TP 10 +.B $PCP_PMDAS_DIR/roomtemp/Remove +undo installation script for the +.B pmdaroomtemp +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/roomtemp.log +default log file for error messages and other information from +.B pmdaroomtemp +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdarpm.1 b/man/man1/pmdarpm.1 new file mode 100644 index 0000000..48a02b5 --- /dev/null +++ b/man/man1/pmdarpm.1 @@ -0,0 +1,151 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDARPM 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdarpm\f1 \- RPM packages performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/rpm/pmdarpm\f1 +[\f3\-C\f1] +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-r\f1 \f2path\f1] +[\f3\-U\f1 \f2username\f1] +.SH DESCRIPTION +.B pmdarpm +is a Performance Metrics Domain Agent (PMDA) which extracts +performance metrics reflecting the state of the RPM package +database managed by +.BR rpm (1). +.PP +The +.B rpm +PMDA exports metrics that describe each package installed on a +system, as well as some cumulative totals. +When the RPM database changes the PMDA automatically detects this +and uses a background thread to asynchronously refresh its values. +.PP +A brief description of the +.B pmdarpm +command line options follows: +.TP 5 +.B \-C +Verify the package iteration code by scanning the RPM database +once, then exiting. +Only useful for problem diagnosis and testing. +.TP +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I rpm.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdarpm +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-r +Specify an alternate path to the RPM database (default is +.IR /var/lib/rpm/Packages ). +.TP +.B \-U +User account under which to run the agent. +The default is the unprivileged "pcp" account. +.SH INSTALLATION +If you want access to the names, help text and values for the rpm +performance metrics, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/rpm +# ./Install +.in +.fi +.ft 1 +.PP +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/rpm +# ./Remove +.in +.fi +.ft 1 +.PP +.B pmdarpm +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdarpm +.TP 10 +.B $PCP_PMDAS_DIR/rpm/help +default help text file for the rpm metrics +.TP 10 +.B $PCP_PMDAS_DIR/rpm/Install +installation script for the +.B pmdarpm +agent +.TP 10 +.B $PCP_PMDAS_DIR/rpm/Remove +undo installation script for the +.B pmdarpm +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/rpm.log +default log file for error messages and other information from +.B pmdarpm +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdasystemd.1 b/man/man1/pmdasystemd.1 new file mode 100644 index 0000000..b4fd3bd --- /dev/null +++ b/man/man1/pmdasystemd.1 @@ -0,0 +1,176 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" Copyright (c) 2000 Silicon Graphics, Inc. All Rights Reserved. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDASYSTEMD 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdasystemd\f1 \- systemd performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/systemd/pmdasystemd\f1 +[\f3\-f\f1] +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +[\f3\-m\f1 \f2memory\f1] +[\f3\-s\f1 \f2interval\f1] +[\f3\-U\f1 \f2username\f1] +.SH DESCRIPTION +.B pmdasystemd +is a systemd log file monitoring Performance Metrics Domain +Agent (PMDA). +It can be seen as analagous to the +.B \-f +option to +.BR journalctl (1) +and converts each new log line into a performance event, +suitable for consumption by +.BR PMAPI (3) +client tools like +.BR pmevent (1). +.PP +The +.B systemd +PMDA exports both event-style metrics reflecting timestamped event +records for messages logged to the system logs, as well as the more +orthodox sample-style metrics such as message counts and throughput +size values. +.PP +A brief description of the +.B pmdasystemd +command line options follows: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-f +Disables per-uid/gid record filtering. +By default the user and group credentials will be used to +filter log records returned to the client tool, preventing +information exposure to arbitrary users. +This option disables that, so use only with extreme caution. +.TP +.B \-l +Location of the log file. By default, a log file named +.I systemd.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdasystemd +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.TP +.B \-m +Limit the physical memory used by the PMDA to buffer event records to +.I maxsize +bytes. +As log events arrive at the PMDA, they must be buffered until individual +client tools request the next batch since their previous batch of events. +The default maximum is 2 megabytes. +.TP +.B \-s +Sets the polling interval for detecting newly arrived log lines. +Mirrors the same option from the +.BR tail (1) +command. +.TP +.B \-U +User account under which to run the agent. +The default is the "adm" user account. +.SH INSTALLATION +If you want access to the names, help text and values for the systemd +performance metrics, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/systemd +# ./Install +.in +.fi +.ft 1 +.PP +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/systemd +# ./Remove +.in +.fi +.ft 1 +.PP +.B pmdasystemd +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdasystemd +.TP 10 +.B $PCP_PMDAS_DIR/systemd/help +default help text file for the systemd metrics +.TP 10 +.B $PCP_PMDAS_DIR/systemd/Install +installation script for the +.B pmdasystemd +agent +.TP 10 +.B $PCP_PMDAS_DIR/systemd/Remove +undo installation script for the +.B pmdasystemd +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/systemd.log +default log file for error messages and other information from +.B pmdasystemd +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR pmevent (1), +.BR journalctl (1), +.BR tail (1), +.BR PMAPI (3), +.BR pcp.conf (5) +and +.BR pcp.env (5). diff --git a/man/man1/pmdaxfs.1 b/man/man1/pmdaxfs.1 new file mode 100644 index 0000000..23a3276 --- /dev/null +++ b/man/man1/pmdaxfs.1 @@ -0,0 +1,143 @@ +'\"macro stdmacro +.\" +.\" Copyright (c) 2014 Red Hat. +.\" +.\" This program is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License as published by the +.\" Free Software Foundation; either version 2 of the License, or (at your +.\" option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. +.\" +.TH PMDAXFS 1 "PCP" "Performance Co-Pilot" +.SH NAME +\f3pmdaxfs\f1 \- XFS filesystem performance metrics domain agent (PMDA) +.SH SYNOPSIS +\f3$PCP_PMDAS_DIR/xfs/pmdaxfs\f1 +[\f3\-d\f1 \f2domain\f1] +[\f3\-l\f1 \f2logfile\f1] +.SH DESCRIPTION +.B pmdaxfs +is a Performance Metrics Domain Agent (PMDA) which extracts +performance metrics describing the state of the XFS filesystem +from the Linux kernel. +.PP +The +.B xfs +PMDA exports metrics that measure information about metadata buffer +usage, the journal, btree operations, inode operations, extended +attributes, directories, quotas, read and write operation counts +and of course throughput. +.PP +The PMDA provides a facility to reset the values of all counters +to zero using +.BR pmstore (1) +with the xfs.control.reset metric. +.PP +A brief description of the +.B pmdaxfs +command line options follows: +.TP 5 +.B \-d +It is absolutely crucial that the performance metrics +.I domain +number specified here is unique and consistent. +That is, +.I domain +should be different for every PMDA on the one host, and the same +.I domain +number should be used for the same PMDA on all hosts. +.TP +.B \-l +Location of the log file. By default, a log file named +.I xfs.log +is written in the current directory of +.BR pmcd (1) +when +.B pmdaxfs +is started, i.e. +.BR $PCP_LOG_DIR/pmcd . +If the log file cannot +be created or is not writable, output is written to the standard error instead. +.SH INSTALLATION +The +.B xfs +PMDA is installed and available by default on Linux. +If you want to undo the installation, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/xfs +# ./Remove +.in +.fi +.ft 1 +.PP +If you want to establish access to the names, help text and values for the XFS +performance metrics once more, after removal, do the following as root: +.PP +.ft CW +.nf +.in +0.5i +# cd $PCP_PMDAS_DIR/xfs +# ./Install +.in +.fi +.ft 1 +.PP +.B pmdaxfs +is launched by +.BR pmcd (1) +and should never be executed directly. +The Install and Remove scripts notify +.BR pmcd (1) +when the agent is installed or removed. +.SH FILES +.PD 0 +.TP 10 +.B $PCP_PMCDCONF_PATH +command line options used to launch +.B pmdaxfs +.TP 10 +.B $PCP_PMDAS_DIR/xfs/help +default help text file for the xfs metrics +.TP 10 +.B $PCP_PMDAS_DIR/xfs/Install +installation script for the +.B pmdaxfs +agent +.TP 10 +.B $PCP_PMDAS_DIR/xfs/Remove +undo installation script for the +.B pmdaxfs +agent +.TP 10 +.B $PCP_LOG_DIR/pmcd/xfs.log +default log file for error messages and other information from +.B pmdaxfs +.PD +.SH "PCP ENVIRONMENT" +Environment variables with the prefix +.B PCP_ +are used to parameterize the file and directory names +used by PCP. +On each installation, the file +.I /etc/pcp.conf +contains the local values for these variables. +The +.B $PCP_CONF +variable may be used to specify an alternative +configuration file, +as described in +.BR pcp.conf (5). +.SH SEE ALSO +.BR PCPIntro (1), +.BR pmcd (1), +.BR pmstore (1), +.BR pcp.conf (5) +and +.BR pcp.env (5). commit e8593e28c773218a2521db3f201b371c78bcaff6 Author: Nathan Scott Date: Wed Jan 29 13:51:18 2014 +1100 Resolve build failure in man pages, overriding LSRCFILES incorrectly diff --git a/man/man1/GNUmakefile b/man/man1/GNUmakefile index 96da981..ae5857c 100644 --- a/man/man1/GNUmakefile +++ b/man/man1/GNUmakefile @@ -51,36 +51,36 @@ WEBD_PAGES = pmwebd.1 ifeq "$(TARGET_OS)" "linux" MAN_PAGES += $(LINUX_PMDA_PAGES) else -LSRCFILES += $(LINUX_PMDA_PAGES) +OTHER_PAGES += $(LINUX_PMDA_PAGES) endif ifneq "$(findstring $(TARGET_OS),solaris linux)" "" MAN_PAGES += $(ROOMTEMP_PMDA_PAGES) else -LSRCFILES += $(ROOMTEMP_PMDA_PAGES) +OTHER_PAGES += $(ROOMTEMP_PMDA_PAGES) endif ifeq "$(HAVE_RPMLIB)" "1" MAN_PAGES += $(RPM_PMDA_PAGES) else -LSRCFILES += $(RPM_PMDA_PAGES) +OTHER_PAGES += $(RPM_PMDA_PAGES) endif ifneq "$(PMDA_SYSTEMD)" "" MAN_PAGES += $(SYSTEMD_PMDA_PAGES) else -LSRCFILES += $(SYSTEMD_PMDA_PAGES) +OTHER_PAGES += $(SYSTEMD_PMDA_PAGES) endif ifneq "$(PMDA_INFINIBAND)" "" MAN_PAGES += $(IB_PMDA_PAGES) else -LSRCFILES += $(IB_PMDA_PAGES) +OTHER_PAGES += $(IB_PMDA_PAGES) endif ifeq "$(HAVE_LIBMICROHTTPD)" "1" MAN_PAGES += $(WEBD_PAGES) else -LSRCFILES += $(WEBD_PAGES) +OTHER_PAGES += $(WEBD_PAGES) endif MAN_DEST = $(PCP_MAN_DIR)/man$(MAN_SECTION) -LSRCFILES = $(MAN_PAGES) +LSRCFILES = $(MAN_PAGES) $(OTHER_PAGES) default :: default_pcp commit b3bdc8db5fd1b9ae4eae7339e936c8fa56a4879d Author: Nathan Scott Date: Mon Feb 10 13:56:31 2014 +1100 Fix errors on the recently added kernel PMDAs man page There is a separate pmdaproc man page, so listing that here gives warnings ("file listed twice") during packaging phase. Also, "kernel PMDA" is too generic a term to use in the NAME section as 'apropos kernel' then hits on this man page - fix that as well. diff --git a/man/man1/pmdakernel.1 b/man/man1/pmdakernel.1 index b8d5203..6d9b7bf 100644 --- a/man/man1/pmdakernel.1 +++ b/man/man1/pmdakernel.1 @@ -19,10 +19,8 @@ \f3pmdafreebsd\f1, \f3pmdalinux\f1, \f3pmdanetbsd\f1, -\f3pmdaproc\f1, \f3pmdasolaris\f1, -\f3pmdawindows\f1, -\f3kernel PMDAs\f1 \- operating system kernel performance metrics domain agents +\f3pmdawindows\f1 \- operating system kernel performance metrics domain agents .SH SYNOPSIS \f3$PCP_PMDAS_DIR/aix/pmdaaix\f1 [\f3\-d\f1 \f2domain\f1]