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

NAME

6       pmdanginx - nginx performance metrics domain agent (PMDA)
7

DESCRIPTION

9       pmdanginx  is  a  Performance Metrics Domain Agent (PMDA) which exports
10       performance metrics from nginx(8) - an HTTP and reverse proxy server, a
11       mail proxy server, and a generic TCP proxy server.
12

INSTALLATION

14       This  PMDA  requires  that  the  nginx stub_status module is active and
15       available at http://localhost/nginx_status.
16
17       In order to enable this module, the "server" section of the  nginx.conf
18       configuration file should contain the following.
19
20            location /nginx_status {
21                stub_status on;
22                access_log off;
23                allow 127.0.0.1;
24                allow ::1;
25                deny all;
26            }
27
28       Instrumentation availability can be verified using these commands (com‐
29       pile-time then run-time checks):
30
31           # nginx -V 2>&1 | grep -o with-http_stub_status_module
32           # curl http://localhost/nginx_status
33
34       Install the nginx PMDA by using the Install script as root:
35
36           # cd $PCP_PMDAS_DIR/nginx
37           # ./Install
38
39       To uninstall, the following must be done as root:
40
41           # cd $PCP_PMDAS_DIR/nginx
42           # ./Remove
43
44       pmdanginx is launched by pmcd(1) and should never be executed directly.
45       The  Install  and  Remove  scripts notify pmcd(1) when the agent is in‐
46       stalled or removed.
47

FILES

49       $PCP_PMDAS_DIR/nginx/nginx.conf
50           optional configuration file for pmdanginx
51
52       $PCP_PMDAS_DIR/nginx/Install
53           installation script for the pmdanginx agent
54
55       $PCP_PMDAS_DIR/nginx/Remove
56           undo installation script for the pmdanginx agent
57
58       $PCP_LOG_DIR/pmcd/nginx.log
59           default log file for error messages from pmdanginx
60

PCP ENVIRONMENT

62       Environment variables with the prefix PCP_ are used to parameterize the
63       file  and  directory  names used by PCP. On each installation, the file
64       /etc/pcp.conf contains the  local  values  for  these  variables.   The
65       $PCP_CONF  variable may be used to specify an alternative configuration
66       file, as described in pcp.conf(5).
67

SEE ALSO

69       PCPIntro(1), pmcd(1) and nginx(8).
70
71
72
73Performance Co-Pilot                  PCP                         PMDANGINX(1)
Impressum