A technical walk-through of how the PerformanceGuard web interface works.
Anchorconcept358concept358Data API
The PerformanceGuard API is an application programming interface for access to collected data and administration of PerformanceGuard entities.

The API is based on REST (REpresentational State Transfer), and you access it through HTTP.

To try out the API, view examples, etc., log in to the PerformanceGuard display and type /swagger after the server name in the URL.

For more information, see API in the PerformanceGuard help system's table of contents.
For more information, see PerformanceGuard API.

Web Interface Configuration

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.

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.

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.

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.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8de92e72-9c32-419f-aaf9-18cc48cb2ef8"><ac:plain-text-body><![CDATA[

In performanceguard.xml

<Parameter name="Password" override="false" value="[encrypted password]"/>
]]></ac:plain-text-body></ac:structured-macro>
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

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, 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"/>

Anchorconcept360concept360Web Interface OEM Versions
It's possible to customize the product name, logo and company name in the PerformanceGuard web interface for OEM purposes.
This will also affect the product name and company name shown in reports.
The PerformanceGuard web interface also contains a copyright notice. It's not possible to change the name of the copyright holder.
Customizable items are available in a properties file that's by default called branding.properties. You find the file in the PerformanceGuard installation folder, under ...\display\localize.
The properties file may have a different name in your organization. The name of the properties file is controlled by the propertyFile parameter in the file ...\display\conf\performanceguard.xml. Note that the properties file must be placed in the ...\display\localize folder.
Anchorconcept361concept361Custom Data Extraction
As a PerformanceGuard administrator you may occasionally want to view custom performance data that's not covered by the data display options of the PerformanceGuard web interface.
When that's the case, you can get a CapaSystems consultant to help you extract the required custom data. After the consultant has extracted the data, you can view it in the PerformanceGuard web interface when you select ADMINISTRATION > Status > Uploaded Files.
Prerequisites
In order for extracted custom data to be available for viewing in the PerformanceGuard web interface, you or your CapaSystems consultant must define a home for the extracted data files. To do that, define a main folder with one of more subfolders, depending on the structure and nature of the extracted data.
To define the main folder, select ADMINISTRATION > Setup > Parameters. Then select the Display tab and scroll down to the Browse Upload Folders parameter.
Note that the folder structure, including at least one custom subfolder, must exist. That means that if you want to use the default path of C:\Program Files\PerformanceGuard\notification\uploadedFiles\Dump, you must create the Dump folder yourself, because that folder doesn't exist by default. You must also create at least one custom subfolder under the Dump folder, for example ...\Dump\CustomData.
If in doubt, ask your CapaSystems consultant to define the folder structure for you when he or she sets up the custom data extraction.