NAME | DESCRIPTION | INSTALLATION | FILES | PCP ENVIRONMENT | SEE ALSO | COLOPHON

PMDANGINX(1)               General Commands Manual              PMDANGINX(1)

NAME         top

       pmdanginx - nginx performance metrics domain agent (PMDA)

DESCRIPTION         top

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

INSTALLATION         top

       This PMDA requires that the nginx stub_status module is active and
       available at http://localhost/nginx_status

       In order to enable this module, the "server" section of the
       nginx.conf configuration file should contain the following.

            location /nginx_status {
                stub_status on;
                access_log off;
                allow 127.0.0.1;
                allow ::1;
                deny all;
            }

       Instrumentation availability can be verified using these commands
       (compile-time then run-time checks):

             # nginx -V 2>&1 | grep -o with-http_stub_status_module
             # curl http://localhost/nginx_status

       Install the nginx PMDA by using the Install script as root:

             # cd $PCP_PMDAS_DIR/nginx
             # ./Install

       To uninstall, do the following as root:

             # cd $PCP_PMDAS_DIR/nginx
             # ./Remove

       pmdanginx is launched by pmcd(1) and should never be executed
       directly. The Install and Remove scripts notify pmcd(1) when the
       agent is installed or removed.

FILES         top

       $PCP_PMDAS_DIR/nginx/nginx.conf
           optional configuration file for pmdanginx

       $PCP_PMDAS_DIR/nginx/Install
           installation script for the pmdanginx agent

       $PCP_PMDAS_DIR/nginx/Remove
           undo installation script for the pmdanginx agent

       $PCP_LOG_DIR/pmcd/nginx.log
           default log file for error messages from pmdanginx

PCP ENVIRONMENT         top

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

SEE ALSO         top

       pmcd(1) and nginx(8).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at ⟨http://www.pcp.io/⟩.
       If you have a bug report for this manual page, send it to
       pcp@oss.sgi.com.  This page was obtained from the project's upstream
       Git repository ⟨git://git.pcp.io/pcp⟩ on 2017-04-25.  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page, or
       you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail
       to man-pages@man7.org

Performance Co-Pilot                 PCP                        PMDANGINX(1)