PureAgent Web Interface

PureAgent Logo
PureTest 3.5
April 2008
http://www.minq.se
support@minq.se

Documentation Index

Web Interface Overview

Once PureAgent is started it will start a Web server which will listen on port 6411 as default. To access the User Interface, direct your browser to the listening port on the machine where the agent is running. Assuming that you are running on your local machine, you can use the URL:

    http://localhost:6411

When you start up PureAgent for the first time, you must use the user name admin and password pureagent to log in:

login

You should change the password using the Server Admin page as soon as possible to restrict access.

It is recommended that you look at the license information page when you start up PureAgent for the first time. If any of the license constraints have been violated, PureAgent will default to a demonstration mode with limited capabilities. The license information can be found under the Server Admin menu selection. Please refer to the troubleshooting section if you encounter any problems during startup.

The User Interface has a menu at the top where you can access the different parts:

menu

Activities
Use this to show an overview of the activities that have been installed in the agent. Each activity is shown with its name and current status. Clicking on the name will bring up detailed information for that activity.
Alarm Recipients
This brings up the form where alarm recipients can be specified.
Alarms
Shows a back-log of recent alarms.
Server Admin
Administration page for the agent itself. Use this to initiate a controlled shutdown of PureAgent. The license information can also be viewed to make sure that no license constraints have been violated.
Logout
This logs you out.
Help
Agent documentation.
About
Additional information about PureAgent and related products.

Activities

What is an Activity?

An activity in PureAgent is the same as a scenario in the Pure Performance suite, with a unique name, an execution schedule and a specified alarm level.

In order to design scenarios suitable for PureAgent, you can use the PureTest tool which includes utilities such as the HTTP Recorder for rapid scenario development. Please refer to the PureTest documentation for details regarding creating a scenario.

Simple activities defined by a single URL can be installed directly in PureAgent without the use of the PureTest tool to define a scenario.

Creating an Activity

There are two ways of creating a new Activity in PureAgent:

Create and Upload a Scenario file

For example, creating an Activity representing a search in www.google.com ca be done by using HttpRecorder utility in the PureTest tool to record a scenario. The scenario is saved to a file C:/google.plc and can look something like:

example scenario

Once you have created the activity you can upload it as an activity in PureAgent. This is done by pressing the Create button on the Activities page to bring up the Activity Installation form which is shown in the following figure:

upload scenario

The Activity Name that you specify must be unique within this instance of PureAgent. The name will also be used as the identifier when reporting alarms and presenting result information for this activity.

The Scenario File must be the path to a valid PureLoad scenario file in your local file system.

Activity defined by a single URL

As a simple alternative to upload a scenario file the create scenario form contains a part where a scenario defined by a single URL may be created:

example using url

The Activity Name that you specify must be unique within this instance of PureAgent. The name will also be used as the identifier when reporting alarms and presenting result information for this activity.

The URL must be a valid url to a page to access.

Activity Settings

After an activity has been created, you will be directed to the Activity Settings page where you can specify time interval and alarm levels for the activity. The Activity Settings page can be seen in the following figure:

activity settings

The schedule Interval is the time in seconds between activity executions. If the interval is set to less than the actual execution time of an activity, it will be executed again and again at the fastest possible rate. The default value is 300 seconds (five minutes).

Maximum time is the alarm level. If the activity execution time exceeds this level it will be considered to have violated the alarm level and an alarm may be generated depending on how many violations that are allowed (see below). A negative alarm level (<0) is used to indicate that the execution times should not be compared to any level, which is also the default value.

Grace Count specifies the number of consecutive times the alarm level is allowed to be violated before an alarm is generated. For example, if the grace count is set to 2 and the alarm level was violated during the last execution, violating the level again next time will cause an alarm to be generated whereas a successful execution below the level would clear the grace counter. This mechanism can prevent unwanted alarms if you have a monitored system that is expected and allowed to have temporary peaks.

Persistent Count is then umber of consecutive times an alarm is sent before the activity is considered to be in a state of persistent failure. When this state has been reached there will be no more alarms sent until the activity detects successful behavior again. The same count is used to determine that the failure has ceased. Example: Persistent Count is set to 2. The activity generates an alarm two times in a row. The second alarm that is sent will then inform that there is a persistent failure. The activity will now keep on running, but the failures are not reported as alarms. When the activity has been successful two times in a row, an alarm will be sent that informs that the failure has ceased.

Alarm Recipients shows a list of defined recipients. Select the recipients that should receive alarms from this activity. Managing alarm recipients is described in the Alarms chapter.

Activity List

Once you have set the properties after creation of an activity you are redirected to a page showing a list of installed activities. This page can be seen as the main page of PureAgent:

activity list

The list consist of the following columns:

Activity
The name of the activity. E.g. 'My Web'. Following the link 'My Web' will show the Activity Report for the activity.
Status
The current status of the activity. See below for possible values.
Alarm Recipients
Indicates if there exists alarm recipients for the activity.
Last 24 Hours
24 hour statistics for the Activity where fail is number of failures, Min is minimum execution time and Max is maximum execution time during last 24 hours.

The different status columns:

Started
Indicates if this activity is started or not
Alarm
If not empty, this column indicates that the last execution result in an alarm. The symbols used are:
yellow - last execution resulted in a alarm (non persistent), and
red - last execution resulted in a alarm (persistent).
Last
Last execution result. The symbols used are:
green - last execution succeed, and
red - lLast execution failed.

Activity Report

To view the Activity Report for an activity, select the activity in the ativity list. The Activity Report allows you to change settings for the activity as well as see various reports for the activity.

activity report

The various views are:

Activity Toolbar
Alows you to change settings for the activity, start/stop the activity and remove the activity. Removing the activity is only possible when an activity is stopped.
Basic Settings
The settings for the activity. May be changed by selecting the settings icon. Also includes links to scenario definition, last execution results and XML definition of the scenario.
Alarm Settings
The alarm settings for the activity. Can be changed by selecting the settings icon.
Latest 24 hours
Shows graphs and statistics over execution the last 24 hours.

Starting and stopping Activity

An activity is started by pressing the Start button on the View Report page. The scheduler in PureAgent will execute the PureTest scenario in the activity periodically according to the activity settings.

An activity stopped by pressing the Stop button on the View Report page.

Result History

As activities are executed PureAgent will store the results persistently. The result history page can be reached in three ways:

  1. by selecting the activity in the Activity List and selecting the History Action to be performed
  2. by selecting Browse History link in the activity report page
  3. by licking in the graph showed in the activity report page

The following figure shows the viewing of history for two activities simultaneously:

history

Interval start/end

The Interval end fields represents the end date and time of the displayed graphs and statistics. The left pair of input fields represents the start date end time of the interval.

Changing these values and pressing the refresh icon will update the page to show the graphs and statistics for the selected interval.

Zoom Selection

The combination of zoom and zoom selection controls the zooming that is performed when clicking in image graph.

x
Zooming is performed x-wise. For example clicking in the image graph at a x point representing the time of 14:00 will result in the page being updated with:

y
Zooming is performed y-wise. For example clicking in the image graph at a y point representing the value of 1.5 seconds will result in the page being updated with:

Note: Displayed graphs are always shown using a fixed number of displayed points. This means that a single point in a graph represents a calculated average for all the measurements performed during the interval of the point and the previous point. This also implies that the ok counter in the activity statistics part may show a higher value than the visible number of points in the graph for the activity.

Zooming in the graph will eventually make the graph show a single point for every performed measurement.

Statistics during viewed interval

This part displays different statistics for the chosen activities. All values is shown for the displayed interval.

Ok
Number of successful executions of the activity.
Failed
Number failed executions of the activity.
Timed out
Number execution with a execution time exceeding max time of the activity.
Average Time
Average execution time.
Max Execution Time
Maximal execution time
Min Execution Time
Minimal execution time.

Note: Counter may not correspond to the shown number of points in the graphs. See the Note in the previous section about zoom and zoom selection.

Last Execution Result

Aside from storing results persistently when running activities PureAgent will keep information about the last execution details available for viewing. The is information is in a more detailed format and contains timing information for all tasks and task sequences included in the activity.

To see the last execution result, select the link in the Activity Report page:

execution result

The figure above shows metrics about the last successful execution of the activity named 'Google Search'. In case of the last execution was a failure some additional metrics is shown.

The first part (Execution Result) describes the status of the last execution. In this case the execution was successful. For successful executions and for some failure cases the page also shows statistics for individual Tasks included in the activity.

Note that if several Tasks are given the same name under the same level the average time indeed indicates an average. If the Task is a single Task the average time is actually the exact execution time for the Task.

Alarm Recipients

In order to receive alarms when failures are detected in a monitored system, one or more Alarm Recipients must be created as described in this section.

Alarm Recipients

The Alarm Recipients page shows an overview of the defined recipients as shown in the figure below:

alarm recipients

Clicking on a name will bring up a configuration form where the details can be changed. Press the Remove button to remove a recipient that is no longer needed.

Creating an Alarm Recipient

An Alarm Recipient is created by pressing the create button on the Alarm Recipients page. This brings up the following form:

creating alarm recipient

Here you specify the name, e-mail and phone of the new alarm recipient. You may also select which activities that this recipient should receive alarms for. If no activities have been installed it will simply say 'N/A'.

Email and Phone must be filled in if they are required by the alarm Type. Alarms sent as emails requires an email address. The possible selections for type depends on which alarm modules that have been installed. The mail-alarm module is included in all purchased licenses, but it must be configured properly before it becomes available.

Alarms

When the execution of an activity fails, or the execution time of the activity exceeds the maximum time setting for the activity, an alarm is generated.

Alarm backlog

Alarms that are generated are stored in a back-log that can be viewed by pressing the Alarms menu selection. The alarm back log shows alarms generated since the PureAgent was started. The number of entries in the backlog is limited.

The alarm are also logged in a file located at <install_home>/log/alarm.log

An example alarm back-log is shown below:

alarms

The table shows the time when the alarm occurred, which activity it originated from and the alarm message. The messages are shown in different colors depending on the type of alarm: yellow for execution time exceeding the alarm level, orange for failures, red for failures considered persistent and green when failures cease to be persistent.

Forwarding Alarms

Alarms may be forwarded using different modules. One such module is the mail alarm module which sends alarms using standard Internet mail.

Enabling forwarding of alarms is done by setting up Alarm recipients (see Creating an Alarm Recipient).

Alarm modules

PureAgent will report alarms to the set of installed alarm modules. See Agent Configuration for details.

Server Admin

Server Admin allows you to view license information, change password and shutdown the agent:

server admin

Agent Shutdown

Shutting down PureAgent should be done in a controlled way in order to ensure the integrity of the persistent storage. A controlled shutdown is done by selecting Shutdown PureAgent under the Server Admin menu selection. This will prompt you again to make sure that you do indeed want to shutdown. After bringing down PureAgent, the web server will exit and you must use the launcher as described above to bring PureAgent up again.

In the case of an uncontrolled shutdown due to power failure or other reasons, there should in most cases be no problem.





Copyright © 2008 Minq Software AB. All rights reserved.