1PMDAMONGODB(1)              General Commands Manual             PMDAMONGODB(1)
2
3
4

NAME

6       pmdamongodb - MongoDB database metrics
7

DESCRIPTION

9       pmdamongodb  is a Performance Co-Pilot (PCP) Performance Metrics Domain
10       Agent (PMDA) which extracts live performance data from a  running  Mon‐
11       goDB database server.
12

CONFIGURATION

14       Firstly, pmdamongodb requires installation of the pymongo support pack‐
15       ages - a general purpose Python module for querying MongoDB.
16
17       Next, pmdamongodb reads an optional ini-style configuration file:
18
19              $PCP_PMDAS_DIR/mongodb/mongodb.conf
20
21       This file currently allows for two sections, one  for  configuring  the
22       MongoDB socket connection, the other for authentication.
23
24       [connection]
25
26       host (localhost)
27                      Connect to the MongoDB socket on the given hostname.
28
29       port (27017)   Connect to the MongoDB socket on the given port.
30
31       [authentication]
32
33       username (empty)
34                      Username to connect to the database.
35
36       password (empty)
37                      Password to connect to the database.
38

INSTALLATION

40       To install, the following must be done as root:
41
42           # cd $PCP_PMDAS_DIR/mongodb
43           # ./Install
44
45       To uninstall, the following must be done as root:
46
47           # cd $PCP_PMDAS_DIR/mongodb
48           # ./Remove
49
50       pmdamongodb  is  launched  by  pmcd(1) and should never be executed di‐
51       rectly.  The Install and Remove scripts notify pmcd(1) when  the  agent
52       is installed or removed.
53

FILES

55       $PCP_PMDAS_DIR/mongodb/mongodb.conf
56            configuration file for the pmdamongodb agent
57
58       $PCP_PMDAS_DIR/mongodb/Install
59            installation script for the pmdamongodb agent
60
61       $PCP_PMDAS_DIR/mongodb/Remove
62            undo installation script for the pmdamongodb agent
63
64       $PCP_LOG_DIR/pmcd/mongodb.log
65            default log file for messages from the pmdamongodb agent
66
67       Note    that    the   usual/default   value   for   $PCP_PMDAS_DIR   is
68       /var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is /var/log/pcp but
69       these settings are platform dependent.
70

PCP ENVIRONMENT

72       Environment variables with the prefix PCP_ are used to parameterize the
73       file and directory names used by PCP.  On each installation,  the  file
74       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
75       $PCP_CONF variable may be used to specify an alternative  configuration
76       file, as described in pcp.conf(5).
77

SEE ALSO

79       PCPIntro(1) and pmcd(1).
80
81
82
83Performance Co-Pilot                  PCP                       PMDAMONGODB(1)
Impressum