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

NAME

6       pmdaapache - Apache2 web server performance metrics domain agent (PMDA)
7

SYNOPSIS

9       $PCP_PMDAS_DIR/apache/pmdaapache [-d domain] [-l logfile] [-U username]
10       [-S server] [-P port] [-L location]
11

DESCRIPTION

13       pmdaapache is a Performance Metrics Domain Agent (PMDA) which  extracts
14       performance metrics describing the state of an Apache web server.
15
16       The  apache PMDA exports metrics that measure the request rate, cumula‐
17       tive request sizes, uptime and various  connection  states  for  active
18       clients.
19
20       This information is obtained by performing a HTTP request to the server
21       status URL, which must be enabled in the httpd.conf configuration file.
22
23            ExtendedStatus on
24            <Location /server-status>
25            SetHandler server-status
26            Order deny,allow
27            Deny from all
28            Allow from localhost
29            </Location>
30
31       A brief description of the pmdaapache command line options follows:
32
33       -d   It is absolutely crucial that the performance metrics domain  num‐
34            ber  specified  here  is  unique  and consistent.  That is, domain
35            should be different for every PMDA on the one host, and  the  same
36            domain number should be used for the same PMDA on all hosts.
37
38       -l   Location of the log file.  By default, a log file named apache.log
39            is written in the current directory of pmcd(1) when pmdaapache  is
40            started, i.e.  $PCP_LOG_DIR/pmcd .  If the log file cannot be cre‐
41            ated or is not writable, output is written to the  standard  error
42            instead.
43
44       -S   Query  the  Apache status information from the named server rather
45            than the local host.
46
47       -P   Query the Apache status information from  the  given  port  rather
48            than the default (80).
49
50       -L   Specify  an  alternative  location  for  finding the server-status
51            page.
52
53       -U   User account under which to run the agent.   The  default  is  the
54            unprivileged  "pcp"  account  in  current  versions of PCP, but in
55            older versions the superuser account ("root") was used by default.
56

INSTALLATION

58       If you want access to the names, help text and values  for  the  apache
59       performance metrics, do the following as root:
60
61            # cd $PCP_PMDAS_DIR/apache
62            # ./Install
63
64       If you want to undo the installation, do the following as root:
65
66            # cd $PCP_PMDAS_DIR/apache
67            # ./Remove
68
69       pmdaapache  is  launched  by  pmcd(1)  and  should  never  be  executed
70       directly.  The Install and Remove scripts notify pmcd(1) when the agent
71       is installed or removed.
72

FILES

74       $PCP_PMCDCONF_PATH
75                 command line options used to launch pmdaapache
76       $PCP_PMDAS_DIR/apache/help
77                 default help text file for the apache metrics
78       $PCP_PMDAS_DIR/apache/Install
79                 installation script for the pmdaapache agent
80       $PCP_PMDAS_DIR/apache/Remove
81                 undo installation script for the pmdaapache agent
82       $PCP_LOG_DIR/pmcd/apache.log
83                 default  log  file  for  error messages and other information
84                 from pmdaapache
85

PCP ENVIRONMENT

87       Environment variables with the prefix PCP_ are used to parameterize the
88       file  and  directory names used by PCP.  On each installation, the file
89       /etc/pcp.conf contains the  local  values  for  these  variables.   The
90       $PCP_CONF  variable may be used to specify an alternative configuration
91       file, as described in pcp.conf(5).
92

SEE ALSO

94       PCPIntro(1), httpd(8), pmcd(1), pcp.conf(5) and pcp.env(5).
95
96
97
98Performance Co-Pilot                  PCP                        PMDAAPACHE(1)
Impressum