1ZBXPCP(3)                  Library Functions Manual                  ZBXPCP(3)
2
3
4

NAME

6       zbxpcp - Zabbix Agent Loadable PCP Module
7

DESCRIPTION

9       The  zbxpcp  loadable module extends Zabbix agent by making Performance
10       Co-Pilot (PCP) metrics available to it.  With the zbxpcp module config‐
11       ured  in  zabbix_agentd.conf all the PCP metrics are available from the
12       Zabbix agent like any other agent items.  As a  loadable  module  (DSO)
13       zbxpcp does not rely on any external programs but directly uses the PCP
14       APIs to fetch PCP metrics when requested.
15
16       A typical Linux PCP installation offers over 1,000 metrics  by  default
17       and is in turn extensible with its own plugins, or PMDAs (``Performance
18       Metrics Domain Agents'').  In addition to  very  complete  /proc  based
19       statistics, readily available PCP PMDAs provide support for such system
20       and application level components as 389 Directory Server, Apache,  con‐
21       tainers,  HAProxy, GFS2, Gluster, libvirt, MySQL, NFS, Oracle, Postfix,
22       PostgreSQL, Samba, and Sendmail, among others.  PCP also runs  on  many
23       platforms,  including  Linux,  Mac  OS X, FreeBSD, NetBSD, Solaris, and
24       Windows.
25
26       For PCP introduction, see PCPIntro(1).  To  investigate  the  available
27       PCP  metrics, use for example pminfo(1).  The PCP Quick Reference Guide
28       is available at the PCP home page https://pcp.io/.
29
30       For general information about Zabbix data collection and loadable  mod‐
31       ules, see https://www.zabbix.com/documentation/3.0/manual/config/items.
32       For Zabbix introduction and downloads, see https://www.zabbix.com/.
33
34       zbxpcp is compatible with the Zabbix module API version 1.
35

CONFIGURATION

37       First make sure PCP is installed and configured properly, see the above
38       references  for instructions and use for example pminfo(1) to make sure
39       the PCP metrics can be fetched.  To enable the zbxpcp  loadable  module
40       in  a  Zabbix  agent,  the  following lines must be added to the Zabbix
41       agent configuration file zabbix_agentd.conf (make sure to use the  cor‐
42       rect LoadModulePath):
43
44           LoadModulePath=/usr/lib64/zabbix/agent/
45           LoadModule=zbxpcp.so
46
47       After restarting the Zabbix agent all the PCP metrics will be available
48       with the ``pcp.''  prefix like all the other agent items.  This can  be
49       verified with the commands:
50
51           $ pminfo -t
52           $ zabbix_agentd -p
53           $ pminfo -f kernel.all.sysfork
54           $ zabbix_get -s 127.0.0.1 -p 10050 -k pcp.kernel.all.sysfork
55
56       Then  to collect PCP metrics from Zabbix agents, the Zabbix server side
57       configuration is as usual (see Zabbix documentation if needed).
58
59       The PCP pmcd service must always be running when starting up  a  zbxpcp
60       enabled  Zabbix  agent,  otherwise the module will fail to load and the
61       PCP metrics will not become available.  Special care must be  taken  to
62       make sure this happens also when rebooting the system.
63

FILES

65       /etc/zabbix/zabbix_agentd.conf
66              Typical Zabbix agent configuration file location.
67
68       /etc/zabbix/zbxpcp-derived-metrics.conf
69              Optional PCP derived metrics configuration file for zbxpcp.  See
70              pmLoadDerivedConfig(3) for more info on derived metrics.
71
72       $PCP_LIB_DIR/zabbix/agent/zbxpcp.so
73              Zabbix agent loadable PCP module.
74

SEE ALSO

76       PCPIntro(1), pminfo(1), pmrep(1), zabbix_get(1), pmLoadDerivedConfig(3)
77       and zabbix_agentd(8).
78
79
80
81Performance Co-Pilot                  PCP                            ZBXPCP(3)
Impressum