Web Interface Configuration
Youssef Benarab
The following parameters control the behavior of the PerformanceGuard web interface. They can be set either in the config_params database table or in the file performanceguard.xml (the default location of the file is \[PerformanceGuard installation folder\]\display\conf)
Service Settings
This parameter controls the PerformanceGuard Web Server service.
Port | |
|---|---|
Set in | performanceguard.xml |
Type | Number |
Default value | 80 |
Description | TCP/IP listener port for the PerformanceGuard Web Server service. Default is HTTP port 80. |
In performanceguard.xml | <Parameter name="port" override="false" value="80"/> |
Page Sizes
These parameters control the maximum number of rows to show on a page. If the actual number of rows exceeds the parameter value, navigation links are added to the page.
Protocol.Page.Size | |
|---|---|
Set in | config_params database table |
Type | Number |
Default value | 500 |
Description | Maximum number of ports to concurrently show on the port management page. |
Server.Page.Size | |
|---|---|
Set in | config_params database table |
Type | Number |
Default value | 500 |
Description | Maximum number of servers to concurrently show on the server management page. |
Report.Page.Size | |
|---|---|
Set in | config_params database table |
Type | Number |
Default value | 50 |
Description | Maximum number of reports to concurrently show on the report management page. |
Graph Parameters
These parameters control image format and refreshing intervals for generated graphs.
Refresh.interval | |
|---|---|
Set in | config_params database table |
Type | Seconds |
Default value | 120 |
Description | Time (sec) between automatic refreshing of the Time View, Server/Port and Server/Agent graphs. A value of 0 disables automatic refreshing. |
image.format | |
|---|---|
Set in | config_params database table |
Type | String. "image/jpeg" or "image/png" |
Default value | "image/jpeg" |
Description | Graph image format. PNG is smaller in size, but takes approximately 1-2 seconds longer to generate. JPEG is about three times the size of a PNG, and the quality of the image isn't as good as PNG |
moving.average | |
|---|---|
Set in | config_params database table |
Type | Number |
Default value | 10 |
Description | The number of samples to use when calculating moving averages in graphs. The value must be larger than 1. |
Client Activity
These parameters control which status color agents will have on the agent search and agent management pages.
ClientInactivityMinutesYellow | |
|---|---|
Set in | config_params database table |
Type | Minutes |
Default value | 30 |
Description | Minutes of inactivity before an agent's status color changes from green to yellow. |
ClientInactivityMinutesred | |
|---|---|
Set in | config_params database table |
Type | Minutes |
Default value | 1440 (that is 24 hours) |
Description | Minutes of inactivity before an agent's status color changes from yellow to red. |
Database Connection
These parameters control database connection.
jdbc.prefetch.size | |
|---|---|
Set in | performanceguard.xml |
Type | Integer |
Default value | 20 |
Description | JDBC row prefetch size, applies to all prepared statements |
In performanceguard.xml | <Parameter name="jdbc.prefetch.size" override="false" value="20"/> |
sql.folder | |
|---|---|
Set in | performanceguard.xml |
Type | Folder name |
Default value | local/ |
Description | The SQL statements used in the application are defined in various files in this folder. This value should only be changed by a CapaSystems consultant |
JdbcDriver | |
|---|---|
Set in | performanceguard.xml |
Type | JDBC driver class |
Default value | com.microsoft.sqlserver.jdbc.SQLServerDriver |
Description | JDBC driver for access to the PerformanceGuard database |
In performanceguard.xml | Parameter name="JdbcDriver" override="false" value="com.microsoft.sqlserver.jdbc.SQLServerDriver"/> |
JdbcConnectString | |
|---|---|
Set in | performanceguard.xml |
Type | String |
Default value | jdbc:sqlserver://localhost |
Description | Database connection string. |
In performanceguard.xml | Parameter name="JdbcConnectString" override="false" value="jdbc:sqlserver://localhost"/> |
User | |
|---|---|
Set in | performanceguard.xml |
Type | String |
Default value | pguard |
Description | PerformanceGuard backend server database user name. |
In performanceguard.xml | <Parameter name="User" override="false" value="pguard"/> |
Password | |
|---|---|
Set in | performanceguard.xml |
Type | String |
Default value | pguard |
Description | PerformanceGuard backend server database password. |
In performanceguard.xml | <Parameter name="Password" override="false" value="[encrypted password]"/> ]]> The password is stored in encrypted form in performanceguard.xml. |
Connection.pool.size | |
|---|---|
Set in | performanceguard.xml |
Type | Number of connections |
Default value | 15 |
Description | The number of simultaneous connections to the PerformanceGuard database. If an SQL error occurs on one of the connections in the pool, the application tries to re-establish the connection. |
In performanceguard.xml | <Parameter name="Connection.pool.size" override="false" value="15"/> |
Demo Mode
demo.mode | |
|---|---|
Set in | config_params database table |
Type | Integer |
Default value | 0 |
Description | Set demo.mode to 1 to activate demo mode. When demo mode is activated, the internal clock in the PerformanceGuard web interface will be stopped and reset to the time stamp of the last delivered sample. When in demo mode PerformanceGuard won't accept incoming data from agents, and it won't delete old data (the cleanup job is stopped). |
Access Logging
Access logging, that is logging of who accesses the PerformanceGuard system, is by default not enabled. When access logging has been enabled, you can view the access log in the folder [PerformanceGuard installation folder]\display\accesslogs.
accessLogEnabled | |
|---|---|
Set in | performanceguard.xml |
Type | True/false |
Default value | False |
Description | Determines whether access logging is enabled or not. |
In performanceguard.xml | <Parameter name="accessLogEnabled" override="false" value="False"/> |
accessLogRetainDays | |
|---|---|
Set in | performanceguard.xml |
Type | Number of days |
Default value | 7 |
Description | Determines how the log access log is kept for if access logging is enabled. The value 0 (zero) will keep the log forever. We don't recommend that you keep the log forever because it will take up more and more disk space. |
In performanceguard.xml | <Parameter name="accessLogRetainDays" override="false" value="7"/> |
Search this documentation
On this page
In this section