# webpingvis

## NAME



           **webpingvis** - visualize Web server response time
    


## SYNOPSIS



           **webpingvis**[**-CiVz**] [**-A** _align_] [**-a** _archive_] [**-h** _host_] [**-m** _max_] [**-n**
           _pmnsfile_] [**-O** _time_] [**-p** _port_] [**-S** _time_] [**-T** _time_] [**-t** _interval_]
           [**-x** _version_] [**-Z** _timezone_]
    


## DESCRIPTION



           **webpingvis** displays a summary of Web server response-time
           statistics collected from the Performance Co-Pilot (PCP)
           infrastructure.  The display is modulated by the values of
           performance metrics retrieved from the target _host_ (which is
           running pmcd(1) and the **pmdawebping**(1) Performance Metrics Domain
           Agent) or from the PCP archive log identified by _archive_.  The
           display is updated every _interval_ seconds (default 2 seconds).
    
           As in all pmview(1) scenes, when the mouse is moved over one of
           the bars, the current value and metric information for that bar
           will be shown in the text box near the top of the display.  The
           height of the bars is proportional to the performance metric
           values relative to the maximum, as controlled by size of the URLs
           being fetched by **pmdawebping**(1), and the **-m** option (see below).
    
           The bars in the **webpingvis** scene represent the following
           information:
    
           **Size**
               The green bars indicate the relative sizes of the results
               returned for each URL in the **pmdawebping** workload.
    
           **Response**
               For each URL in the **pmdawebping** workload, the components of
               the Web server response-time (connect, head and body) and the
               total response-time is displayed.
    
               To the right, the component and total times are summed over
               all URLs in the **pmdawebping** workload.
    
           **Errors**
               The four red error bars indicate the number of socket, HTTP,
               HTML or other errors that occurred in the last iteration of
               the **pmdawebping** workload.  Any of these errors will terminate
               the request for a URL.
    
           **webpingvis** uses pmview(1), and so the user interface follows that
           described for pmview(1), which in turn displays the scene within
           an Inventor examiner viewer.  For generic control of the viewer,
           see **ivview**(1).
    
           **webpingvis** passes most command line options to pmview(1).
           Therefore, the command line options **-A** , **-a** , **-C** , **-h** , **-n** , **-O** , **-p** ,
           **-S** , **-t** , **-T** , **-x** , **-Z** and **-z** , and the user interface are described in
           the pmview(1) man page.
    
           Options specific to **webpingvis** are:
    
           **-i** The URL names are not included as labels in the scene by
                  default.  The **-i** option forces them to be included.
    
           **-m** _max_ Change the normalization factor for the response-time bars.
                  The value for _max_ is in units of milliseconds, and should
                  be the expected maximum value for the total response-time
                  aggregated over all URLs in the **pmdawebping** workload.  The
                  default value is 1000 milliseconds.
    
           **-V** The derived configuration file for pmview(1) is written on
                  standard output.  This may be saved and used directly with
                  pmview(1) if the user wishes to customize the display, or
                  modify some of the normalization parameters.
    


## CAVEATS



           As **webpingvis** sorts the configured URLs by size, running
           **webpingvis** shortly after starting **pmdawebping**(1) may result in the
           URLs being sorted incorrectly as they may not have been fetched.
    
           The **~** character may not be parsed correctly by pmview(1).
           Therefore, if **pmdawebping**(1) is fetching any URLs containing **~**
           then **webpingvis** will not launch.
    


## FILES



           _$PCP_VAR_DIR/pmns/_ *
                  default PMNS specification files
           _$PCP_VAR_DIR/config/pmlogger/config.webpingvis_
                  pmlogger(1) configuration file that can be used to create a
                  PCP archive suitable for display with **webpingvis**
           _$PCP_VAR_DIR/config/pmchart/Web.Response_
                  A pmchart(1) configuration file for monitoring Web server
                  response time
    


## PCP ENVIRONMENT



           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**(4).
    


* * *