A quick man page for zbxpcp with installation, testing and some
troubleshooting tips. Under section 3 as there are e.g. libxml(3)
and zlib(3).
Note that I tried to make the page understandable also for people
who've never heard about PCP before so it should explain few
wording and somewhat verbose approach.
---
man/man3/zbxpcp.3 | 129 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 129 insertions(+)
create mode 100644 man/man3/zbxpcp.3
diff --git a/man/man3/zbxpcp.3 b/man/man3/zbxpcp.3
new file mode 100644
index 0000000..22637b5
--- /dev/null
+++ b/man/man3/zbxpcp.3
@@ -0,0 +1,129 @@
+'\"! tbl | mmdoc
+'\"macro stdmacro
+.\"
+.\" Copyright (C) 2015 Marko Myllynen <myllynen@xxxxxxxxxx>
+.\"
+.\" 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 ZBXPCP 3 "PCP" "Performance Co-Pilot"
+
+.SH NAME
+\f3zbxpcp\f1 \- Zabbix Agent Loadable PCP Module
+
+.SH DESCRIPTION
+The
+.B zbxpcp
+loadable module extends Zabbix agent by making Performance Co-Pilot
+(PCP) metrics available to it. With
+.B zbxpcp
+module configured in
+.I zabbix_agentd.conf
+all the PCP metrics are available from the Zabbix agent like any other
+agent items. As a loadable module (DSO)
+.B zbxpcp
+does not rely on any external programs but directly uses the PCP APIs to
+fetch PCP metrics when requested.
+
+A typical PCP installation on Linux offers over 1000 metrics by default
+and is in turn extensible with its own plugins, or PMDAs (``Performance
+Metrics Domain Agents''). In addition to a very complete
+.I proc
+based statistics, readily available PCP PMDAs provide support for such
+system and application level components as Apache, CIFS, 389 Directory
+Server, GFS2, Gluster, InfiniBand, KVM, MySQL, NFS, Postfix, PostgreSQL,
+Samba, and Sendmail, among others. In addition to Linux, PCP also runs
+on Mac OS X, BSD, Solaris, and Windows.
+
+For PCP introduction, see
+.BR PCPIntro (5).
+To investigate the available PCP metrics, use for example
+.BR pminfo (1).
+The
+.I PCP Quick Reference Guide
+is available at its home page http://pcp.io\:/.
+
+For general information about Zabbix data collection and loadable
+modules, see
+https://www.zabbix.com/documentation/3.0/manual/config/items. For Zabbix
+introduction and downloads, see http://www.zabbix.com/.
+
+.B zbxpcp
+is compatible with the Zabbix module API version
+.IR 1 .
+
+.SH CONFIGURATION
+First make sure PCP is installed and configured properly, see the above
+references for instructions and use for example
+.BR pminfo (3)
+to make sure the PCP metrics can be fetched. To enable the
+.B zbxpcp
+loadable module in a Zabbix agent, the following lines must be added to
+the Zabbix agent configuration file
+.I zabbix_agentd.conf
+(make sure to use the correct
+.IR LoadModulePath ):
+
+.RS +4
+.ft CW
+.nf
+LoadModulePath=/usr/lib64/zabbix/agent/
+LoadModule=zbxpcp.so
+.fi
+.ft P
+.RE
+
+After restarting the Zabbix agent all the PCP metrics will be available
+with the ``\c
+.BR pcp. ''
+prefix like all the other agent items. This can be verified with the
+commands:
+
+.RS +4
+.ft CW
+.nf
+$ pminfo -t
+$ zabbix_agentd -p
+$ pminfo -f kernel.all.sysfork
+$ zabbix_get -s 127.0.0.1 -p 10050 -k pcp.kernel.all.sysfork
+.fi
+.ft P
+.RE
+
+Then to collect PCP metrics from Zabbix agents, the Zabbix server side
+configuration is as usual (see Zabbix documentation if needed).
+
+The PCP
+.B pmcd
+service must always be running when starting up a
+.B zbxpcp
+enabled Zabbix agent, otherwise the module will fail to load and the PCP
+metrics will not become available. Special care must be taken to make
+sure this happens also when rebooting the system. A
+.B pmcd
+restart needs to be followed by a Zabbix agent restart.
+
+.SH FILES
+.PD 0
+.TP 10
+.BI /etc/zabbix/zabbix_agentd.conf
+Typical Zabbix agent configuration file location.
+.TP 10
+.BI /usr/lib(64)/zabbix/modules/zbxpcp.so
+Zabbix agent loadable PCP module.
+.PD
+
+.SH SEE ALSO
+.BR PCPIntro (1),
+.BR pminfo (1),
+.BR pmrep (1),
+.BR zabbix_get (1),
+.BR zabbix_agentd (8).
Thanks,
--
Marko Myllynen
|