2006-09-29 Sancho Lerena <estebans@artica.es>

* pandora_userguide.xml, pandora_chapter*: Many changes to use PNG
	graphics instead .GIF. Many format changes.

	* many *.gif - > *.png: .GIF files deleted and replaced by .PNG.
	


git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@204 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
slerena 2006-09-29 17:21:14 +00:00
parent a89bb06e43
commit 0916d9f488
61 changed files with 909 additions and 819 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 372 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 557 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 182 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 310 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 345 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 509 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 345 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 509 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 375 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 555 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 354 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 515 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 529 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 754 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 561 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 816 B

View File

@ -0,0 +1,8 @@
#!/bin/bash
for a in `ls *.gif`
do
nombre=`echo $a | cut -f 1 -d "." `
convert $nombre.gif $nombre.png
done

Binary file not shown.

Before

Width:  |  Height:  |  Size: 256 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 322 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 279 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 373 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 282 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 376 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 223 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 386 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 172 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 308 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 200 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 337 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 200 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 337 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 196 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 334 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 223 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 385 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 144 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 226 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 145 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 224 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 145 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 232 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 147 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 232 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 295 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 460 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 273 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 296 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 578 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 734 B

View File

@ -1,128 +1,134 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter id="chapter1">
<title>Introduction</title>
<sect1 id="sec1.1">
<title>What is Pandora?</title>
<title>Introduction</title>
<sect1 id="sec1.1">
<title>What is Pandora?</title>
<para>
Pandora is a monitoring tool that allows a system administrator
to visually analise the status and efficiency of Operating
Systems, Servers, Applications and Hardware Systems - such as
firewalls, proxies, databases, Web servers, tunnelling servers,
routers, switches, processes, services, remote access servers
and so on. All integrated into an open and distributed
architecture.
</para>
<para>
Pandora can be implemented over any operating system, with specific
agents for each platform. Pandora can also monitor any TCP/IP
hardware system, such as load balancers, routers, switches, printers
and so on.
</para>
<graphic fileref="images/esquema.png" valign="bottom" align="center"/>
<para>Pandora architecture is formed of four main components:</para>
<para>
<emphasis>- Web Console:</emphasis> Pandora's user
interface. The user controls and operates the system with
it. Several Web consoles can be implemented in a single system.
The Web console is written in PHP, and rests on a database and a
Web server. It is compatible with any platforms - GNU/Linux,
Solaris, Win2000, AIX, etc. However, the official supported
platform is GNU/Linux.
</para>
<para>
The console permits the user to control the status of the
agents, view statistical information, generate graphs and data
tables, keep a system incident control, as well as to generate
reports and change the alerts, agents, and user profile
settings.
</para>
<para>
<emphasis>- Core Server:</emphasis> Pandora Core server is the
receptor of the data packages and generates the alerts - it is
the brain of the system. Several servers can work alongside for
larger systems. It has been developed in Perl and works over
any platform, although, the official platform is GNU/Linux.
</para>
<para>
The core server accesses Pandora database, which is shared with
the Web server, and stores the processed data packages. The
server is executed under the name of "Demonio", and processes
the packages stored in its file system. The data is generated
by the system agents. Despite the server's low system resources
comsumption and simple installation and operation, the core
server is the most critical element of the system. The core
server receives and processes the produced data, and fires the
alerts and the events.
</para>
<para>
<emphasis>- Central Database:</emphasis> At the moment the
system only supports MySQL. The central database keeps all the
information Pandora needs to work - agent data, settings, user
information, incidents, system settings, etc. The system can use
a MySQL cluster to store the information, or a high
disponibility solution for larger sytems.
</para>
<para>
This database can work with any of the platform officially
supported by MySQL. Pandora can be implemented with MySQL
versions 3.0 and 4.0, although the latest is recommended.
</para>
<para>
<emphasis>- Pandora Agents:</emphasis> They collect all the
system's data. They are executed in each local system, although
they can also collect remote information by intalling monitoring
sytems for the agent in several different machines - called
satellite agents.
</para>
<para>Pandora is a monitoring tool that allows a system administrator
to visually analise the status and efficiency of Operating
Systems, Servers, Applications and Hardware Systems - such as
firewalls, proxies, databases, Web servers, tunnelling servers,
routers, switches, processes, services, remote access servers and
so on. All integrated into an open and distributed architecture.
</para>
<para>
Pandora can be implemented over any operating system, with specific
agents for each platform. Pandora can also monitor any TCP/IP
hardware system, such as load balancers, routers, switches, printers
and so on.
</para>
<graphic fileref="images/esquema.png" valign="bottom" align="center"/>
<para>Pandora architecture is formed of four main components:</para>
<para><emphasis>- Web Console:</emphasis>
Pandora's user interface. The user controls and operates the system
with it. Several Web consoles can be implemented in a single system.
The Web console is written in PHP, and rests on a database and
a Web server. It is compatible with any platforms - GNU/Linux,
Solaris, Win2000, AIX, etc. However, the official supported platform
is GNU/Linux.
</para>
<para>
The console permits the user to
control the status of the agents, view statistical information,
generate graphs and data tables, keep a system incident control,
as well as to generate reports and change the alerts, agents,
and user profile settings.
</para>
<para><emphasis>- Core Server:</emphasis>
The core server is the receptor of
the data packages and generates the alerts - it is the brain
of the system. Several servers can work alongside for larger systems.
It has been developed in Perl and works over any platform, although,
the official platform is GNU/Linux.
</para>
<para>
The core server accesses Pandora
database, which is shared with the Web server, and stores the
processed data packages. The server is executed under the name of
"Demonio", and processes the packages stored in its file system.
The data is generated by the system agents. Despite the server's
low system resources comsumption and simple installation and
operation, the core server is the most critical element of the system.
The core server receives and processes the produced data, and fires
the alerts and the events.
</para>
<para><emphasis>- Central Database:</emphasis>
At the moment the system only supports MySQL. The central database
keeps all the information Pandora needs to work - agent data,
settings, user information, incidents, system settings, etc. The
system can use a MySQL cluster to store the information, or a high
disponibility solution for larger sytems.
</para>
<para>This database can work with any of
the platform officially supported by MySQL. Pandora can be implemented
with MySQL versions 3.0 and 4.0, although the latest is recommended.
</para>
<para><emphasis>- Pandora Agents:</emphasis> They collect all the
system's data. They are executed in each local system, although
they can also collect remote information by intalling monitoring
sytems for the agent in several different machines
- called satellite agents.
</para>
<para>
They have been developed to work under a specific platform,
making use of the specific tools of the used language: VBSCript/Windows
Scripting for Microsoft platforms (Win2000, WinXP y Win2003) and
ShellScripting for Unix - which includes GNU/Linux, Solaris, AIX, HP-UX
and BSD, as well as the Nokia's IPSO. Pandora agents can be developed
in virtually any language, given its simple API and being open source.
</para>
</sect1>
<sect1 id="sec1.2">
<title>Pandora Administration</title>
<para>
The web console is the tool used to administrate
Pandora. It is written in PHP and doesn't need any
third party software to work, neither FLASH, JAVA,
nor ActiveX plug-ins. The Web console can be run
over any web browser supporting HTML and CSS (IE5+
or Mozilla 4+).
</para>
<graphic fileref="images/image001.png" valign="bottom" align="center"/>
<para>
Pandora administration is divided in the following
main elements:
</para>
<itemizedlist>
<listitem>
<para>Pandora users</para>
</listitem>
<listitem>
<para>Agents</para>
</listitem>
<listitem>
<para>Alerts</para>
</listitem>
<listitem>
<para>Incidents</para>
</listitem>
<listitem>
<para>Server configuration</para>
</listitem>
<listitem>
<para>Database maintenance</para>
</listitem>
</itemizedlist>
</sect1>
<para>
They have been developed to work under a specific platform,
making use of the specific tools of the used language:
VBSCript/Windows Scripting for Microsoft platforms (Win2000,
WinXP y Win2003) and ShellScripting for Unix - which includes
GNU/Linux, Solaris, AIX, HP-UX and BSD, as well as the Nokia's
IPSO. Pandora agents can be developed in virtually any language,
given its simple API and being open source.
</para>
</sect1>
<sect1 id="sec1.2">
<title>Pandora Administration</title>
<para>
The web console is the tool used to administrate
Pandora. It is written in PHP and doesn't need any
third party software to work, neither FLASH, JAVA,
nor ActiveX plug-ins. The Web console can be run
over any web browser supporting HTML and CSS (IE5+
or Mozilla 4+).
</para>
<graphic fileref="images/image001.png" valign="bottom" align="center"/>
<para>
Pandora administration is divided in the following
main elements:
</para>
<itemizedlist>
<listitem>
<para>Pandora users</para>
</listitem>
<listitem>
<para>Agents</para>
</listitem>
<listitem>
<para>Alerts</para>
</listitem>
<listitem>
<para>Incidents</para>
</listitem>
<listitem>
<para>Server configuration</para>
</listitem>
<listitem>
<para>Database maintenance</para>
</listitem>
</itemizedlist>
</sect1>
</chapter>

View File

@ -1,61 +1,50 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter id="chapter2">
<title>Users</title>
<para>
The definition of a user is based on the user's daily
activity. One or more profiles can be assigned to a single
user
activity. One or more profiles can be assigned to a single user
</para>
<para>
A profile is a list of actions a user can or cannot perform
on a given group, e.g. "view incidents", "database
management", etc
A profile is a list of actions a user can or cannot perform on a
given group, e.g. "view incidents", "database management", etc
</para>
<para>
Each user is given a number of groups of agents he/she has
permission to access, as well as the administrative profile
he/she will have in each group. Each user can belong to one
or more groups, with an assigned profile for each of
them.
permission to access, as well as the administrative profile he/she
will have in each group. Each user can belong to one or more
groups, with an assigned profile for each of them.
</para>
<para>
Agent belongs to a group and only one, sharing the group
with agents of similar characteristics. Groups also contain
incidents.
Agent belongs to a group and only one, sharing the group with
agents of similar characteristics. Groups also contain incidents.
</para>
<para>
Summarizing: User profiles in Pandora define which users can
access Pandora as well as what each user can do. Groups
define elements in common among various users. Each user
could be in one or more groups at any one time. Each group
has user profiles which are defined and attached to it. A
profile is a list of things a user can do, such as view
incidents, manage database or other.
access Pandora as well as what each user can do. Groups define
elements in common among various users. Each user could be in one
or more groups at any one time. Each group has user profiles which
are defined and attached to it. A profile is a list of things a
user can do, such as view incidents, manage database or other.
</para>
<sect1 id="sec2.1">
<title>Profile manager</title>
<para>
Pandora's profile manager is used to assign specific
profiles to each user. A hierarchy of users is so created,
structured by the user's profile within the company. With
this system different security levels can be implemented:
read-only users, agent group coordinators or system
administrators.
Pandora's profile manager is used to assign specific profiles to
each user. A hierarchy of users is so created, structured by the
user's profile within the company. With this system different
security levels can be implemented: read-only users, agent group
coordinators or system administrators.
</para>
<para>
A profile is created from the Profile Manager tool in the
Administration menu. There are five predefined
profiles:
Administration menu. There are five predefined profiles:
</para>
<itemizedlist>
@ -76,7 +65,7 @@
</listitem>
</itemizedlist>
<para>
To create a new profile click on "Manage Profiles"&gt;
To create a new profile click on "Manage Profiles" &gt;
"Create Profile" in the Administration Menu
</para>
<graphic fileref="images/image002.png" valign="bottom" align="center"/>
@ -94,8 +83,10 @@
<para>Manage incidents (IM)</para>
</listitem>
<listitem>
<para>View agents (AR). To view agents as well as the events
generated by them</para>
<para>
View agents (AR). To view agents as well as the events
generated by them
</para>
</listitem>
<listitem>
<para>Edit agents (AW). To modify then agent's modules</para>
@ -107,8 +98,10 @@
<para>Manage users (UM). To modify users and their roles</para>
</listitem>
<listitem>
<para>Manage DB (DM). To modify the configuration and data
of the database (Global)</para>
<para>
Manage DB (DM). To modify the configuration and data of the
database (Global)
</para>
</listitem>
<listitem>
<para>Manage alerts (LM). To define new alerts (Global)</para>
@ -149,7 +142,7 @@
<graphic fileref="images/image004.png" valign="bottom" align="center"/>
<para>
A user profile is deleted by clicking on the delete icon
<inlinegraphic fileref="images/cancel.gif"/> on the right
<inlinegraphic fileref="images/cancel.png"/> on the right
hand side of the profile.
</para>
</sect1>
@ -157,8 +150,8 @@
<title>Deleting a user</title>
<para>
A user is deleted by clicking on the delete icon <inlinegraphic
fileref="images/cancel.gif"/> on the right hand side
A user is deleted by clicking on the delete icon <inlinegraphic
fileref="images/cancel.png"/> on the right hand side
of the user. The list of users is accessed through the
"Manage Users" option in the Administration menu.
<graphic fileref="images/image005.png" valign="bottom" align="center"/>
@ -173,24 +166,25 @@
user usually reflects the user's activity.
</para>
<para>
Click on "View Users"&gt;"Statistics" in the Operation
Click on "View Users" &gt; "Statistics" in the Operation
menu to show this graph:
<graphic fileref="images/image006.png" valign="bottom" align="center"/> </para>
<graphic fileref="images/image006.png" valign="bottom" align="center"/>
</para>
</sect1>
<sect1 id="sec2.5">
<title>Messages to users</title>
<para>
To create a new message to other user, go to "Messages"
section in the Operation menu. You can also read the
received messages, but the sent messages are not stored.
</para>
<sect2 id="sec2.5.1">
<title>Messages to groups</title>
<para>
From "Messages"&gt;"Messages to groups" section in the
Operation menu you can send messages to groups of users.
The sent messages will not be stores.
</para>
</sect2>
</sect1>
</chapter>
<title>Messages to users</title>
<para>
To create a new message to other user, go to "Messages"
section in the Operation menu. You can also read the
received messages, but the sent messages are not stored.
</para>
<sect2 id="sec2.5.1">
<title>Messages to groups</title>
<para>
From "Messages" &gt; "Messages to groups" section in the
Operation menu you can send messages to groups of users. The
sent messages will not be stores.
</para>
</sect2>
</sect1>
</chapter>

View File

@ -1,267 +1,286 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter id="chapter4">
<title>Incident management</title>
<title>Incident management</title>
<para>
The system monitoring process needs to follow up the incidents
arising in the system besides receiving and processing the data to be
monitored in each time interval
</para>
<para>
Pandora uses a tool called Incident Manager for this task, where
each user can open an incident, where a description of what happened
in the network is shown. This can be completed with comments and files
when necessary.
</para>
<para>
This system is designed for group work. Different roles and
workflow systems permit to move incidents from one group to another.
The system allows different groups and different users to work on
the same incident, sharing information and files.
</para>
<para>
Clicking on "Manage Incidents", in the Operation menu, a list
showing all the incidents is displayed, ordered by the date-time they
were last updated. Filters can be applied to display only those
incidents the user is interested on.
</para>
<graphic fileref="images/image034.png" valign="bottom" align="center"/>
<para>
The system monitoring process needs to follow up the incidents
arising in the system besides receiving and processing the data to be
monitored in each time interval
</para>
<para>
Pandora uses a tool called Incident Manager for this task, where
each user can open an incident, where a description of what happened
in the network is shown. This can be completed with comments and files
when necessary.
</para>
<para>
This system is designed for group work. Different roles and
workflow systems permit to move incidents from one group to another.
The system allows different groups and different users to work on
the same incident, sharing information and files.
</para>
<para>
Clicking on "Manage Incidents", in the Operation menu, a list
showing all the incidents is displayed, ordered by the date-time they
were last updated. Filters can be applied to display only those
incidents the user is interested on.
</para>
<graphic fileref="images/image034.png" valign="bottom" align="center"/>
<para>
The filters that can be applied are:
</para>
<itemizedlist>
<listitem>
<para><emphasis>Incident status filter</emphasis>.
The user can display:</para>
<para>- All incidents</para>
<para>- Active incidents</para>
<para>- Closed incidents</para>
<para>- Rejected incidents</para>
<para>- Expired incidents</para>
</listitem>
<listitem>
<para>
<emphasis>Property filter</emphasis>.
The incidents are shown by:
</para>
<para>- All priorities</para>
<para>- Informative priority</para>
<para>- Low priority</para>
<para>- Medium priority</para>
<para>- High priority</para>
<para>- Very high priority</para>
<para>- Maintenance</para>
</listitem>
<listitem>
<para><emphasis>Group filter</emphasis>.
It can be selected to display just the
incidents of a given Pandora group.
</para>
</listitem>
</itemizedlist>
<para>
The incident list is displayed showing information in the following columns:
</para>
<para><emphasis>ID:</emphasis> ID of the incident.</para>
<para><emphasis>Status:</emphasis> The incident status is represented by the following
icons:</para>
<para><inlinegraphic fileref="images/dot_red.gif"/> Active incident</para>
<para><inlinegraphic fileref="images/dot_yellow.gif"/> Active incident
with comments</para>
<para><inlinegraphic fileref="images/dot_blue.gif"/> Rejected incident</para>
<para><inlinegraphic fileref="images/dot_green.gif"/> Closed incident</para>
<para><inlinegraphic fileref="images/dot_white.gif"/> Expired incident</para>
<para><emphasis>Incident name:</emphasis> Name given to the incident</para>
<para><emphasis>Priority:</emphasis> The incident assigned priority is represented
by the following icons:</para>
<para><inlinegraphic fileref="images/dot_red.gif"/>
<inlinegraphic fileref="images/dot_red.gif"/>
<inlinegraphic fileref="images/dot_red.gif"/>
Very high priority</para>
<para><inlinegraphic fileref="images/dot_yellow.gif"/>
<inlinegraphic fileref="images/dot_red.gif"/>
<inlinegraphic fileref="images/dot_red.gif"/>
High priority</para>
<para><inlinegraphic fileref="images/dot_yellow.gif"/>
<inlinegraphic fileref="images/dot_yellow.gif"/>
<inlinegraphic fileref="images/dot_red.gif"/>
Medium priority</para>
<para><inlinegraphic fileref="images/dot_green.gif"/>
<inlinegraphic fileref="images/dot_yellow.gif"/>
<inlinegraphic fileref="images/dot_yellow.gif"/>
Low priority</para>
<para><inlinegraphic fileref="images/dot_green.gif"/>
<inlinegraphic fileref="images/dot_green.gif"/>
<inlinegraphic fileref="images/dot_yellow.gif"/>
Informative priority</para>
<para><inlinegraphic fileref="images/dot_green.gif"/>
<inlinegraphic fileref="images/dot_green.gif"/>
<inlinegraphic fileref="images/dot_green.gif"/>
Maintenance priority</para>
<para><emphasis>Group:</emphasis> The name of the group the incident has been assigned
to. One incident can only belong to a single group.</para>
<para><emphasis>Updated at:</emphasis> This is the date/time the incident was updated
for the last time.</para>
<para><emphasis>Source:</emphasis> The source of the incident. The source is selected
from a list stored
in the data base. This list can only be modified by the database base
administrator.</para>
<para><emphasis>Owner:</emphasis> User to whom the incident has been assigned to.
It doesn't coinced
with the creator of the incident, as the incident may have been moved
from one user to another. The incident can be assigned to another user
by its owner, or by a user with management privileges over the group
the incidents belong to.</para>
<sect1 id="sec4.1">
<title>Adding an incident</title>
<para>The creation of incidents is performed by clicking on
"Manage Incidents" &gt; "New incident", in the Operation menu</para>
<graphic fileref="images/image035.png" valign="bottom" align="center"/>
<para>The "Create Incident" form will come up, containing the necessary
fields to define the incident. The process is completed by clicking
on the "Create" button.</para>
</sect1>
<sect1 id="sec4.2">
<title>Incident follow up</title>
<para>All the open incidents can be followed up. The tool is reached by
clicking on the "Manage Incidents" option, in the Operation menu.</para>
<para>The indicent is selected by clicking on its name in the
"Incident name" column.</para>
<para>The screen coming up shows us the configuration variables of
the incident, its comments and attached files.</para>
<para>The first part of the screen contains the Incident configuration.</para>
<graphic fileref="images/image036.png" valign="bottom" align="center"/>
<para>From this form the following values can be updated:</para>
<itemizedlist>
<listitem>
<para><emphasis>Incident name</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident owner</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident status</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident source</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Group the indicent will belong to</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Indicent priority</emphasis></para>
</listitem>
</itemizedlist>
<para>The indicent is updated by clicking on the "Update incident" button.</para>
<sect2 id="sec4.2.1">
<title>Adding comments to an incident</title>
<para> Comments about the incident can added clicking on "Add note".
This will open up a screen with a text box in it.
</para>
<graphic fileref="images/image037.png" valign="bottom" align="center"/>
<para>The comment is written in this box.
The Comment will appear in the "Notes attached to incident"
section after the button "Add" is pressed.
</para>
<graphic fileref="images/image038.png" valign="bottom" align="center"/>
<para>Only users with writting privilieges can add a comment,
and only the owners of the incident or of the notes can delete them.
</para>
</sect2>
<sect2 id="sec4.2.2">
<title>Attaching files to an incident</title>
<para>Sometimes it is necessary to link an incident with an image,
a configuration file, or any kind of file.
</para>
<para>The files are attached in the "Attach file" section.
Here the file can be searched for in the local machine and
attached when the "Upload" button is pressed.
</para>
<para>Only a user with writing privileges can attach a file,
and only the owner of the incident or of the file can delete it.
</para>
<graphic fileref="images/image039.png" valign="bottom" align="center"/>
<para>The incident follow up screen shows all the files attached
to the incident in the "Attached files" section of the screen.</para>
<graphic fileref="images/image040.png" valign="bottom" align="center"/>
</sect2>
</sect1>
<sect1 id="sec4.3">
<title>Searching for an incident</title>
<para>A specific incident can be found amongst the incidents created
in Pandora by either using a filter, as explained in the first
section of this chapter, or by making a query using the
"Manage Incidents"&gt;"Searh Incident" tool, in the Operation menu.</para>
<graphic fileref="images/image041.png" valign="bottom" align="center"/>
<para>Any text string included as a sub-string in the
incident can be searched for using this tool. This search engine looks for the
string in the Incident title as well as in the text contained by the incident.
The search engine will not search neither the Comments added to the agent nor
the attached files. The search can be performed in addition to group, priority
or status filters.</para>
</sect1>
<sect1 id="sec4.4">
<title>Statistics</title>
<para>The incident statisticts are shown in the "Manage Incidents"&gt;"Statistics"
option of the Operation menu. They can be of five different types:</para>
<itemizedlist>
<listitem>
<para><emphasis>Incident status</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident priority</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Users with the incident opened</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incidents by group</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident source</emphasis></para>
</listitem>
</itemizedlist>
<graphic fileref="images/image042.png" valign="bottom" align="center"/>
<graphic fileref="images/image043.png" valign="bottom" align="center"/>
<graphic fileref="images/image044.png" valign="bottom" align="center"/>
</sect1>
<para>
The filters that can be applied are:
</para>
<itemizedlist>
<listitem>
<para><emphasis>Incident status filter</emphasis>.
The user can display:</para>
<para>- All incidents</para>
<para>- Active incidents</para>
<para>- Closed incidents</para>
<para>- Rejected incidents</para>
<para>- Expired incidents</para>
</listitem>
<listitem>
<para>
<emphasis>Property filter</emphasis>.
The incidents are shown by:
</para>
<para>- All priorities</para>
<para>- Informative priority</para>
<para>- Low priority</para>
<para>- Medium priority</para>
<para>- High priority</para>
<para>- Very high priority</para>
<para>- Maintenance</para>
</listitem>
<listitem>
<para><emphasis>Group filter</emphasis>.
It can be selected to display just the
incidents of a given Pandora group.
</para>
</listitem>
</itemizedlist>
<para>
The incident list is displayed showing information in the following columns:
</para>
<para>
<emphasis>ID:</emphasis> ID of the incident.
</para>
<para>
<emphasis>Status:</emphasis> The incident status is represented by
the following icons:
</para>
<para><inlinegraphic fileref="images/dot_red.png"/> Active incident</para>
<para><inlinegraphic fileref="images/dot_yellow.png"/> Active incident
with comments</para>
<para><inlinegraphic fileref="images/dot_blue.png"/> Rejected incident</para>
<para><inlinegraphic fileref="images/dot_green.png"/> Closed incident</para>
<para><inlinegraphic fileref="images/dot_white.png"/> Expired incident</para>
<para><emphasis>Incident name:</emphasis> Name given to the incident</para>
<para>
<emphasis>Priority:</emphasis> The incident assigned priority is
represented by the following icons:
</para>
<para><inlinegraphic fileref="images/dot_red.png"/>
<inlinegraphic fileref="images/dot_red.png"/>
<inlinegraphic fileref="images/dot_red.png"/>
Very high priority</para>
<para><inlinegraphic fileref="images/dot_yellow.png"/>
<inlinegraphic fileref="images/dot_red.png"/>
<inlinegraphic fileref="images/dot_red.png"/>
High priority</para>
<para><inlinegraphic fileref="images/dot_yellow.png"/>
<inlinegraphic fileref="images/dot_yellow.png"/>
<inlinegraphic fileref="images/dot_red.png"/>
Medium priority</para>
<para><inlinegraphic fileref="images/dot_green.png"/>
<inlinegraphic fileref="images/dot_yellow.png"/>
<inlinegraphic fileref="images/dot_yellow.png"/>
Low priority</para>
<para><inlinegraphic fileref="images/dot_green.png"/>
<inlinegraphic fileref="images/dot_green.png"/>
<inlinegraphic fileref="images/dot_yellow.png"/>
Informative priority</para>
<para><inlinegraphic fileref="images/dot_green.png"/>
<inlinegraphic fileref="images/dot_green.png"/>
<inlinegraphic fileref="images/dot_green.png"/>
Maintenance priority</para>
<para>
<emphasis>Group:</emphasis> The name of the group the incident has
been assigned to. One incident can only belong to a single group.
</para>
<para>
<emphasis>Updated at:</emphasis> This is the date/time the
incident was updated for the last time.
</para>
<para>
<emphasis>Source:</emphasis> The source of the incident. The
source is selected from a list stored in the data base. This list
can only be modified by the database base administrator.
</para>
<para>
<emphasis>Owner:</emphasis> User to whom the incident has been
assigned to. It doesn't coinced with the creator of the incident,
as the incident may have been moved from one user to another. The
incident can be assigned to another user by its owner, or by a
user with management privileges over the group the incidents
belong to.
</para>
<sect1 id="sec4.1">
<title>Adding an incident</title>
<para>
The creation of incidents is performed by clicking on
"Manage Incidents" &gt; "New incident", in the Operation menu
</para>
<graphic fileref="images/image035.png" valign="bottom" align="center"/>
<para>
The "Create Incident" form will come up, containing the necessary
fields to define the incident. The process is completed by clicking
on the "Create" button.
</para>
</sect1>
<sect1 id="sec4.2">
<title>Incident follow up</title>
<para>
All the open incidents can be followed up. The tool is reached by
clicking on the "Manage Incidents" option, in the Operation menu.
</para>
<para>
The indicent is selected by clicking on its name in the
"Incident name" column.
</para>
<para>
The screen coming up shows us the configuration variables of
the incident, its comments and attached files.
</para>
<para>
The first part of the screen contains the Incident configuration
</para>
<graphic fileref="images/image036.png" valign="bottom" align="center"/>
<para>From this form the following values can be updated:</para>
<itemizedlist>
<listitem>
<para><emphasis>Incident name</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident owner</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident status</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident source</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Group the indicent will belong to</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Indicent priority</emphasis></para>
</listitem>
</itemizedlist>
<para>
The indicent is updated by clicking on the "Update incident" button.
</para>
<sect2 id="sec4.2.1">
<title>Adding comments to an incident</title>
<para> Comments about the incident can added clicking on "Add note".
This will open up a screen with a text box in it.
</para>
<graphic fileref="images/image037.png" valign="bottom" align="center"/>
<para>The comment is written in this box.
The Comment will appear in the "Notes attached to incident"
section after the button "Add" is pressed.
</para>
<graphic fileref="images/image038.png" valign="bottom" align="center"/>
<para>Only users with writting privilieges can add a comment,
and only the owners of the incident or of the notes can delete them.
</para>
</sect2>
<sect2 id="sec4.2.2">
<title>Attaching files to an incident</title>
<para>Sometimes it is necessary to link an incident with an image,
a configuration file, or any kind of file.
</para>
<para>
The files are attached in the "Attach file" section.
Here the file can be searched for in the local machine and
attached when the "Upload" button is pressed.
</para>
<para>
Only a user with writing privileges can attach a file,
and only the owner of the incident or of the file can delete it.
</para>
<graphic fileref="images/image039.png" valign="bottom" align="center"/>
<para>The incident follow up screen shows all the files attached
to the incident in the "Attached files" section of the screen.</para>
<graphic fileref="images/image040.png" valign="bottom" align="center"/>
</sect2>
</sect1>
<sect1 id="sec4.3">
<title>Searching for an incident</title>
<para>
A specific incident can be found amongst the incidents created
in Pandora by either using a filter, as explained in the first
section of this chapter, or by making a query using the "Manage
Incidents"&gt;"Searh Incident" tool, in the Operation menu.
</para>
<graphic fileref="images/image041.png" valign="bottom" align="center"/>
<para>
Any text string included as a sub-string in the incident can be
searched for using this tool. This search engine looks for the
string in the Incident title as well as in the text contained by
the incident. The search engine will not search neither the
Comments added to the agent nor the attached files. The search
can be performed in addition to group, priority or status
filters.
</para>
</sect1>
<sect1 id="sec4.4">
<title>Statistics</title>
<para>
The incident statisticts are shown in the "Manage
Incidents"&gt;"Statistics" option of the Operation menu. They
can be of five different types:
</para>
<itemizedlist>
<listitem>
<para><emphasis>Incident status</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident priority</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Users with the incident opened</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incidents by group</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Incident source</emphasis></para>
</listitem>
</itemizedlist>
<graphic fileref="images/image042.png" valign="bottom" align="center"/>
<graphic fileref="images/image043.png" valign="bottom" align="center"/>
<graphic fileref="images/image044.png" valign="bottom" align="center"/>
</sect1>
</chapter>

View File

@ -2,66 +2,107 @@
<chapter id="chapter5">
<title>Events</title>
<para>
An event in Pandora is any unusual change happend in an
agent.
</para>
<para>
An event is registered when an agent is down or starts up,
when a monitor fails or changes its status, or when an alarm
is sent.
</para>
<para>An event in Pandora is any unusual change happend in an agent.</para>
<para>
An event is usually preceded by an issue with the system
being monitored. A validation and deletion system has been
created to avoid leaving unanalised issues, so they can be
easily validated or deleted if the problem can be ignored or
it's been already solved.
</para>
<para>An event is registered when an agent is down or starts up, when a
monitor fails or changes its status, or when an alarm is sent.</para>
<para>An event is usually preceded by an issue with
the system being monitored. A validation and deletion system has been created
to avoid leaving unanalised issues, so they can be easily validated or deleted
if the problem can be ignored or it's been already solved.</para>
<para>The events appear ordered chronologically as they enter the system,
and can be viewed by clicking the "View Events" option in the Operation menu.
The newer events are placed at the top of the table.</para>
<para>
The events appear ordered chronologically as they enter the
system, and can be viewed by clicking the "View Events"
option in the Operation menu. The newer events are placed
at the top of the table.
</para>
<graphic fileref="images/image045.png" valign="bottom" align="center"/>
<para>The event information list shows the data in the following columns:</para>
<para>
The event information list shows the data in the following
columns:</para>
<para><emphasis>Status:</emphasis> The event status is represented by the icon below:</para>
<para><inlinegraphic fileref="images/dot_green.gif"/> The event has been validated</para>
<para><inlinegraphic fileref="images/dot_red.gif"/> The event hasn't been validated</para>
<para><emphasis>Event name:</emphasis> Name assigned to the event by Pandora.</para>
<para><emphasis>Agent name:</emphasis> Agent where the event happend.</para>
<para><emphasis>Group name:</emphasis> Group of the agent where the event has happened.</para>
<para><emphasis>User ID: </emphasis>User that validated the event.</para>
<para><emphasis>Timestamp:</emphasis> Date and time when the event was raised or validated
- if it has been validated.</para>
<para><emphasis>Action:</emphasis> Action that can be executed over the event.</para>
<para><inlinegraphic fileref="images/ok.gif"/>
<para>
<emphasis>Status:</emphasis> The event status is represented
by the icon below:</para>
<para>
<inlinegraphic fileref="images/dot_green.png"/> The event has
been validated</para>
<para>
<inlinegraphic fileref="images/dot_red.png"/> The event hasn't
been validated</para>
<para>
<emphasis>Event name:</emphasis> Name assigned to the event by
Pandora.</para>
<para>
<emphasis>Agent name:</emphasis> Agent where the event happend.</para>
<para>
<emphasis>Group name:</emphasis> Group of the agent where the
event has happened.</para>
<para>
<emphasis>User ID: </emphasis>User that validated the
event.</para>
<para>
<emphasis>Timestamp:</emphasis> Date and time when the event
was raised or validated - if it has been validated.
</para>
<para>
<emphasis>Action:</emphasis> Action that can be executed over
the event.
</para>
<para><inlinegraphic fileref="images/ok.png"/>
This icon will validate the event, disappearing the icon</para>
<para><inlinegraphic fileref="images/cancel.gif"/>
<para><inlinegraphic fileref="images/cancel.png"/>
This icon will delete the event</para>
<para>The events can be also validated or deleted in groups by selecting
the tick boxes on the last column of the event, and pressing "Validate" or
"Delete" at the bottom of the list.</para>
<para>
The events can be also validated or deleted in groups by
selecting the tick boxes on the last column of the event,
and pressing "Validate" or "Delete" at the bottom of the
list.
</para>
<sect1 id="sec5.1">
<title>Statistics</title>
<para>Three different kinds of graphical statistic representation can be
choosen from the "View Events"&gt;"Statistics" option in the Operation
menu:</para>
<itemizedlist>
<listitem>
<para>Total number of events divided by revised and not revised
<graphic fileref="images/image046.png" valign="bottom" align="center"/>
</para>
</listitem>
<listitem>
<para>Total events divided by the users who validated the events
<graphic fileref="images/image047.png" valign="bottom" align="center"/>
</para>
</listitem>
<listitem>
<para>Total events divided by the group the agent raising the event belongs to
<graphic fileref="images/image048.png" valign="bottom" align="center"/>
</para>
</listitem>
</itemizedlist>
<title>Statistics</title>
<para>
Three different kinds of graphical statistic
representation can be choosen from the "View
Events"&gt;"Statistics" option in the Operation menu:
</para>
<itemizedlist>
<listitem>
<para>
Total number of events divided by revised and not
revised
<graphic fileref="images/image046.png" valign="bottom" align="center"/>
</para>
</listitem>
<listitem>
<para>
Total events divided by the users who validated the
events
<graphic fileref="images/image047.png" valign="bottom" align="center"/>
</para>
</listitem>
<listitem>
<para>
Total events divided by the group the agent raising
the event belongs to
<graphic fileref="images/image048.png" valign="bottom" align="center"/>
</para>
</listitem>
</itemizedlist>
</sect1>
</chapter>

View File

@ -1,40 +1,63 @@
<?xml version="1.0" encoding="ISO-8859-15"?>
<chapter id="chapter6">
<title>System audit</title>
<para>The Pandora's system audit shows all the actions performed by each user, as well as the failed logins.</para>
<para>In the actual version of Pandora the system
audit includes actions that somehow try to by pass the security system:
attempts to delete an incident by an unauthorised user, attemps to change user
profiles by unauthoried users, etc. Its main function is, however, to trace the
user connections (login/logout).</para>
<para>The audit Logs can be found in the System Audit option of the Administration menu, ordered chronologicly.</para>
<para>Filters can be applied to the Logs displayed to show only those of interest for the user, selected by the action the Log produces.</para>
<para>The selectable actions are those actions stored in the Data Base at that time.</para>
<graphic fileref="images/image049.png" valign="bottom" align="center"/>
<para>The following fields display the Audit Logs information:</para>
<para><emphasis>User:</emphasis> User that triggerd the event (SYSTEM isspecial user of the system).</para>
<para><emphasis>Action:</emphasis> Action generated by the entry in the log.</para>
<para><emphasis>Date:</emphasis> Date of the entry in the log.</para>
<para><emphasis>Source IP:</emphasis> IP of the machine or the agent that provoked the entry.</para>
<para><emphasis>Comment:</emphasis> Comment describing the entry</para>
<sect1 id="sec6.1">
<title>Statistics</title>
<para>There isn't a special section to view system audit statistics. However, we could use a graph generated in the Users section to evaluate the actions of each user, as this graph would represent the total
number of entries in the audit log for each one: the more active the user is the higher the number of entries.</para>
<para>The graph will also show entries of invalid users, i.e., those entries generated by failed attemps to log in.</para>
<graphic fileref="images/image050.png" valign="bottom" align="center"/>
</sect1>
<title>System audit</title>
<para>
The Pandora's system audit shows all the actions performed by each
user, as well as the failed logins.
</para>
<para>
In the actual version of Pandora the system audit includes actions
that somehow try to by pass the security system: attempts to
delete an incident by an unauthorised user, attemps to change user
profiles by unauthoried users, etc. Its main function is, however,
to trace the user connections (login/logout).
</para>
<para>
The audit Logs can be found in the System Audit option of the
Administration menu, ordered chronologicly.
</para>
<para>
Filters can be applied to the Logs displayed to show only those of
interest for the user, selected by the action the Log produces.
</para>
<para>
The selectable actions are those actions stored in the Data Base
at that time.
</para>
<graphic fileref="images/image049.png" valign="bottom" align="center"/>
<para>The following fields display the Audit Logs information:</para>
<para><emphasis>User:</emphasis> User that triggerd the event (SYSTEM isspecial user of the system).</para>
<para><emphasis>Action:</emphasis> Action generated by the entry in the log.</para>
<para><emphasis>Date:</emphasis> Date of the entry in the log.</para>
<para><emphasis>Source IP:</emphasis> IP of the machine or the agent that provoked the entry.</para>
<para><emphasis>Comment:</emphasis> Comment describing the entry</para>
<sect1 id="sec6.1">
<title>Statistics</title>
<para>
There isn't a special section to view system audit
statistics. However, we could use a graph generated in the Users
section to evaluate the actions of each user, as this graph
would represent the total number of entries in the audit log for
each one: the more active the user is the higher the number of
entries.
</para>
<para>
The graph will also show entries of invalid users, i.e., those
entries generated by failed attemps to log in.
</para>
<graphic fileref="images/image050.png" valign="bottom" align="center"/>
</sect1>
</chapter>

View File

@ -1,16 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter id="chapter7">
<title>Pandora Servers</title>
<para>
From "Manage Servers" section, in the Administration menu you can see a
list of configured Pandora Servers and also can manage them.
</para>
<para>
From "Pandora Servers" in the Operation menu you can see a list
of the Pandora Servers.
</para>
<title>Pandora Servers</title>
<para>
From "Manage Servers" section, in the Administration menu you can see a
list of configured Pandora Servers and also can manage them.
</para>
<para>
From "Pandora Servers" in the Operation menu you can see a list
of the Pandora Servers.
</para>
</chapter>

View File

@ -1,224 +1,226 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter id="chapter8">
<title>Database Maintenance</title>
<title>Database Maintenance</title>
<para>
The core of Pandora's system is its Database. All the data
collected by the monitored machines is stored in this data base,
from the administrator's data, to the events, incidents and audit
data generated in the system at any time.
</para>
<para>
The core of Pandora's system is its Database. All the data
collected by the monitored machines is stored in this data base,
from the administrator's data, to the events, incidents and audit
data generated in the system at any time.
</para>
<para>
It is obvious that the efficiency and reliability of this
module is vital for the correct functioning of Pandora.
A regular data base maintainance is needed. To do so the data base
managers can use standard MySQL commands. Maintaining Pandora database
in good condition is critital for Pandora to work properly.
</para>
<para>As the database size will increase linearly, the data will be
compacted to reduce the amount of stored data without loosing important
information, specially the different graphs that are generated with
the processed data.
</para>
<para>
Going to "DB Maintenance" from the Administration menu we will
find the Database configuration defined in the "Pandora Setup" option
of the Administration menu to compact and delete data.
</para>
<graphic fileref="images/image054.png" valign="bottom" align="center"/>
<sect1 id="sec8.1">
<title>DB Information</title>
<para>The DB statistics are generated by Agent, on the
"DB Maintenance"&gt;"DB Information" in the Administration menu,
and are represented in two kinds of graphs:
</para>
<itemizedlist>
<listitem>
<para>Number of modules configured for each of the agents.</para>
</listitem>
<listitem>
<para>Number of packages sent by each agent.
A package is the group of data linked to the module
the agent sends in each interval of time.</para>
</listitem>
</itemizedlist>
<graphic fileref="images/image055.png" valign="bottom" align="center"/>
<graphic fileref="images/image056.png" valign="bottom" align="center"/>
<graphic fileref="images/image057.png" valign="bottom" align="center"/>
<para>These graphs can be also viewed from
"View Agents"&gt;"Statistics" in the Operation menu.</para>
</sect1>
<sect1 id="sec8.2">
<title>Manual purge of the Datadase</title>
<para>Pandora counts with powerful tools for the
Administrator to manually purge the majority of data stored in the Database.
This includes data generated by both the agents and the own server.</para>
</sect1>
<sect1 id="sec8.3">
<title>Agent's data purge</title>
<sect2 id="sec8.3.1">
<title>Debuging selected data from a module</title>
<para>
The option of purging selected data from a module is used
to eliminate those out of range entries, whatever the reason
- agent failure, out of range values, testing, DB errors, etc.
Eliminating erroneous, incorrect or unnecessary data makes
the graphical representation more acuarate and shows the data
without peaks or unreal scales.
</para>
<para>
From "DB Maintenance"&gt;"Database Debug" in the
Administration menu any of the out of range data received
from a agent's module can be deleted.
</para>
<graphic fileref="images/image058.png" valign="bottom" align="center"/>
<para>The purge settings are: agent, module, minimum and maximum
data range. Any parameter out of this minimum/maximum range
will be deleted.</para>
<para>
For example, in a module registering the number of processes,
if we are only interested in values between 0 and 100, any values
above that number will be usually produced by errors, noise
or abnormal circumstances. If we set to range between 0 and 100
all those values below and above - such as -1, 100 or 100000 -
will be permanently deleted from the database.
</para>
</sect2>
<sect2 id="sec8.3.2">
<title>Purging all the agent's data</title>
<para>
All the out of range data received by an agent can be deleted
from the "DB Maintainance"&gt;"Database Purge" option in the
Administration menu.
</para>
<para>
The data is deleted by the following parameters from
the "Delete data" screen:
</para>
<itemizedlist>
<listitem>
<para>Purge all data</para>
</listitem>
<listitem>
<para>Purge data over 90 days</para>
</listitem>
<listitem>
<para>Purge data over 30 days</para>
</listitem>
<listitem>
<para>Purge data over 14 days</para>
</listitem>
<listitem>
<para>Purge data over 7 days</para>
</listitem>
<listitem>
<para>Purge data over 3 days</para>
</listitem>
<listitem>
<para>Purge data over 1 day</para>
</listitem>
</itemizedlist>
<graphic fileref="images/image059.png" valign="bottom" align="center"/>
</sect2>
</sect1>
<sect1 id="sec8.4">
<title>Purging system data</title>
<sect2 id="sec8.4.1">
<title>Audit data purge</title>
<para>
All the audit data generated by the system can be deleted from
"DB Maintenance"&gt;"Database Audit", in the Administration menu
</para>
<para>
The data to be deleted is selected by setting the following
parameters in the "Delete Data" screen
</para>
<itemizedlist>
<listitem>
<para>Purge audit data over 90 days</para>
</listitem>
<listitem>
<para>Purge audit data over 30 days</para>
</listitem>
<listitem>
<para>Purge audit data over 14 days</para>
</listitem>
<listitem>
<para>Purge audit data over 7 days</para>
</listitem>
<listitem>
<para>Purge audit data over 3 days</para>
</listitem>
<listitem>
<para>Purge audit data over 1 day</para>
</listitem>
<listitem>
<para>Purge all audit data</para>
</listitem>
</itemizedlist>
<graphic fileref="images/image060.png" valign="bottom" align="center"/>
</sect2>
<sect2 id="sec8.4.2">
<title>Event data purge</title>
<para>
All the event data generated by the system can be deleted from
"DB Maintenance"&gt;"Database Event", in the Administration menu
</para>
<para>
The data to be deleted is selected by setting the following
parameters in the "Delete Data" screen
</para>
<itemizedlist>
<listitem>
<para>Purge event data over 90 days</para>
</listitem>
<listitem>
<para>Purge event data over 30 days</para>
</listitem>
<listitem>
<para>Purge event data over 14 days</para>
</listitem>
<listitem>
<para>Purge event data over 7 days</para>
</listitem>
<listitem>
<para>Purge event data over 3 days</para>
</listitem>
<listitem>
<para>Purge event data over 1 day</para>
</listitem>
<listitem>
<para>Purge all event data</para>
</listitem>
</itemizedlist>
<graphic fileref="images/image061.png" valign="bottom" align="center"/>
</sect2>
</sect1>
<para>
It is obvious that the efficiency and reliability of this
module is vital for the correct functioning of Pandora.
A regular data base maintainance is needed. To do so the data base
managers can use standard MySQL commands. Maintaining Pandora database
in good condition is critital for Pandora to work properly.
</para>
<para>
As the database size will increase linearly, the data will be
compacted to reduce the amount of stored data without loosing important
information, specially the different graphs that are generated with
the processed data.
</para>
<para>
Going to "DB Maintenance" from the Administration menu we will
find the Database configuration defined in the "Pandora Setup" option
of the Administration menu to compact and delete data.
</para>
<graphic fileref="images/image054.png" valign="bottom" align="center"/>
<sect1 id="sec8.1">
<title>DB Information</title>
<para>
The DB statistics are generated by Agent, on the
"DB Maintenance"&gt;"DB Information" in the Administration menu,
and are represented in two kinds of graphs:
</para>
<itemizedlist>
<listitem>
<para>Number of modules configured for each of the agents.</para>
</listitem>
<listitem>
<para>Number of packages sent by each agent.
A package is the group of data linked to the module
the agent sends in each interval of time.</para>
</listitem>
</itemizedlist>
<graphic fileref="images/image055.png" valign="bottom" align="center"/>
<graphic fileref="images/image056.png" valign="bottom" align="center"/>
<graphic fileref="images/image057.png" valign="bottom" align="center"/>
<para>These graphs can be also viewed from
"View Agents"&gt;"Statistics" in the Operation menu.</para>
</sect1>
<sect1 id="sec8.2">
<title>Manual purge of the Datadase</title>
<para>Pandora counts with powerful tools for the
Administrator to manually purge the majority of data stored in the Database.
This includes data generated by both the agents and the own server.</para>
</sect1>
<sect1 id="sec8.3">
<title>Agent's data purge</title>
<sect2 id="sec8.3.1">
<title>Debuging selected data from a module</title>
<para>
The option of purging selected data from a module is used
to eliminate those out of range entries, whatever the reason
- agent failure, out of range values, testing, DB errors, etc.
Eliminating erroneous, incorrect or unnecessary data makes
the graphical representation more acuarate and shows the data
without peaks or unreal scales.
</para>
<para>
From "DB Maintenance"&gt;"Database Debug" in the
Administration menu any of the out of range data received
from a agent's module can be deleted.
</para>
<graphic fileref="images/image058.png" valign="bottom" align="center"/>
<para>The purge settings are: agent, module, minimum and maximum
data range. Any parameter out of this minimum/maximum range
will be deleted.</para>
<para>
For example, in a module registering the number of processes,
if we are only interested in values between 0 and 100, any values
above that number will be usually produced by errors, noise
or abnormal circumstances. If we set to range between 0 and 100
all those values below and above - such as -1, 100 or 100000 -
will be permanently deleted from the database.
</para>
</sect2>
<sect2 id="sec8.3.2">
<title>Purging all the agent's data</title>
<para>
All the out of range data received by an agent can be deleted
from the "DB Maintainance"&gt;"Database Purge" option in the
Administration menu.
</para>
<para>
The data is deleted by the following parameters from
the "Delete data" screen:
</para>
<itemizedlist>
<listitem>
<para>Purge all data</para>
</listitem>
<listitem>
<para>Purge data over 90 days</para>
</listitem>
<listitem>
<para>Purge data over 30 days</para>
</listitem>
<listitem>
<para>Purge data over 14 days</para>
</listitem>
<listitem>
<para>Purge data over 7 days</para>
</listitem>
<listitem>
<para>Purge data over 3 days</para>
</listitem>
<listitem>
<para>Purge data over 1 day</para>
</listitem>
</itemizedlist>
<graphic fileref="images/image059.png" valign="bottom" align="center"/>
</sect2>
</sect1>
<sect1 id="sec8.4">
<title>Purging system data</title>
<sect2 id="sec8.4.1">
<title>Audit data purge</title>
<para>
All the audit data generated by the system can be deleted from
"DB Maintenance"&gt;"Database Audit", in the Administration menu
</para>
<para>
The data to be deleted is selected by setting the following
parameters in the "Delete Data" screen
</para>
<itemizedlist>
<listitem>
<para>Purge audit data over 90 days</para>
</listitem>
<listitem>
<para>Purge audit data over 30 days</para>
</listitem>
<listitem>
<para>Purge audit data over 14 days</para>
</listitem>
<listitem>
<para>Purge audit data over 7 days</para>
</listitem>
<listitem>
<para>Purge audit data over 3 days</para>
</listitem>
<listitem>
<para>Purge audit data over 1 day</para>
</listitem>
<listitem>
<para>Purge all audit data</para>
</listitem>
</itemizedlist>
<graphic fileref="images/image060.png" valign="bottom" align="center"/>
</sect2>
<sect2 id="sec8.4.2">
<title>Event data purge</title>
<para>
All the event data generated by the system can be deleted from
"DB Maintenance"&gt;"Database Event", in the Administration menu
</para>
<para>
The data to be deleted is selected by setting the following
parameters in the "Delete Data" screen
</para>
<itemizedlist>
<listitem>
<para>Purge event data over 90 days</para>
</listitem>
<listitem>
<para>Purge event data over 30 days</para>
</listitem>
<listitem>
<para>Purge event data over 14 days</para>
</listitem>
<listitem>
<para>Purge event data over 7 days</para>
</listitem>
<listitem>
<para>Purge event data over 3 days</para>
</listitem>
<listitem>
<para>Purge event data over 1 day</para>
</listitem>
<listitem>
<para>Purge all event data</para>
</listitem>
</itemizedlist>
<graphic fileref="images/image061.png" valign="bottom" align="center"/>
</sect2>
</sect1>
</chapter>

View File

@ -1,62 +1,63 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter id="chapter9">
<title>Pandora Configuration</title>
<para>All the configurable parameters in Pandora can be set in the
"Pandora Setup" section, in the Administration menu.</para>
<graphic fileref="images/image051.png" valign="bottom" align="center"/>
<para>These parameters are:</para>
<para><emphasis>Language:</emphasis> In following versions or revisions
of the actual Pandora version will support more languages.
At the moment version 1.2 supports English, Spanish, Bable, Italian,
French, Catalan and Portuguese of Brazil.
</para>
<para><emphasis>Page block size:</emphasis> Maximum size of the lists
in the event, incident and audit log sections.
</para>
<para><emphasis>Max. days before compact data:</emphasis> This parameter
controls data compacting. From the number of days in this parameter the
data starts getting compacted. For large amounts of data it is recommended
to set this parameter to a number between 14 and 28; for systems with
less data load or very powerful systems, a number
between 30 and 50 will be enough.
</para>
<para><emphasis>Max. days before purge:</emphasis>
This parameter controls how long the data is kept
before it is permanently deleted. The recommended value is 60.
For systems with little resources or large work load the recommended value
is between 40 and 50.
</para>
<para><emphasis>Graphic resolution (1 low, 5 high):</emphasis>
This value represents the precision of the
interpolation logarithm to generate the graphics.
</para>
<para><emphasis>Compact interpolation (Hours: 1 fine, 10 medium, 20 bad):</emphasis>
This is the grade of compression used to compact the Data Base,
being 1 the lowest compression rate and 20 the highest.
A value above 12 means a considerable data loss.
It's not recommended to use value above 6 if the data needs to be
represented graphically in large time intervals.
</para>
<sect1 id="sec9.1">
<title>Links</title>
<para>Links to different Internet or private network links can be
configured in Pandora. These could be search engines, applications or
company Intranets.</para>
<para>The links configured in Pandora can be edited through the
"Pandora Setup"&gt;"Links" option in the Administration menu.</para>
<graphic fileref="images/image052.png" valign="bottom" align="center"/>
<para>A new link is created by clicking on "Create".
The link can be then edited:</para>
<graphic fileref="images/image053.png" valign="bottom" align="center"/>
</sect1>
<title>Pandora Configuration</title>
<para>All the configurable parameters in Pandora can be set in the
"Pandora Setup" section, in the Administration menu.</para>
<graphic fileref="images/image051.png" valign="bottom" align="center"/>
<para>These parameters are:</para>
<para><emphasis>Language:</emphasis> In following versions or revisions
of the actual Pandora version will support more languages.
At the moment version 1.2 supports English, Spanish, Bable, Italian,
French, Catalan and Portuguese of Brazil.
</para>
<para><emphasis>Page block size:</emphasis> Maximum size of the lists
in the event, incident and audit log sections.
</para>
<para><emphasis>Max. days before compact data:</emphasis> This parameter
controls data compacting. From the number of days in this parameter the
data starts getting compacted. For large amounts of data it is recommended
to set this parameter to a number between 14 and 28; for systems with
less data load or very powerful systems, a number
between 30 and 50 will be enough.
</para>
<para><emphasis>Max. days before purge:</emphasis>
This parameter controls how long the data is kept
before it is permanently deleted. The recommended value is 60.
For systems with little resources or large work load the recommended value
is between 40 and 50.
</para>
<para><emphasis>Graphic resolution (1 low, 5 high):</emphasis>
This value represents the precision of the
interpolation logarithm to generate the graphics.
</para>
<para>
<emphasis>Compact interpolation (Hours: 1 fine, 10 medium, 20
bad):</emphasis> This is the grade of compression used to compact
the Data Base, being 1 the lowest compression rate and 20 the
highest. A value above 12 means a considerable data loss. It's
not recommended to use value above 6 if the data needs to be
represented graphically in large time intervals.
</para>
<sect1 id="sec9.1">
<title>Links</title>
<para>Links to different Internet or private network links can be
configured in Pandora. These could be search engines, applications or
company Intranets.</para>
<para>The links configured in Pandora can be edited through the
"Pandora Setup"&gt;"Links" option in the Administration menu.</para>
<graphic fileref="images/image052.png" valign="bottom" align="center"/>
<para>A new link is created by clicking on "Create".
The link can be then edited:</para>
<graphic fileref="images/image053.png" valign="bottom" align="center"/>
</sect1>
</chapter>

View File

@ -69,5 +69,4 @@
&include_pandora_chapter9;
&include_fdl;
&include_gpl;
</book>

View File

@ -1,5 +1,6 @@
<?xml version="1.0"?>
<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
<uri resource="pandora_chapter2.xml" typeId="DocBook"/>
<uri resource="pandora_install.xml" typeId="DocBook"/>
<uri resource="pandora_chapter1.xml" typeId="DocBook"/>
<uri resource="pandora_chapter2.xml" typeId="DocBook"/>