tyler.durden/pandorafms
1
0
Fork 0
mirror of https://github.com/pandorafms/pandorafms.git synced 2025-07-28 16:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

2006-09-13 Raul Mateos <raulofpandora@gmail.com>

Browse Source 
* New pandora_doc/en/images/ files
       * Updated pandora_doc/en/pandora_chapter 1 to 9.xml

git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@169 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
raulmateos 2006-09-13 15:48:45 +00:00
parent 0e67af2469
commit a2c12da531
31 changed files with 556 additions and 390 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pandora_doc/ChangeLog
View File

@ -1,8 +1,8 @@
2006-09-13 Raul Mateos <raulofpandora@gmail.com> 2006-09-13 Raul Mateos <raulofpandora@gmail.com>
* New /en/images/esquema.png file * New /en/images/ files
* Updated /en/pandora_chapter1.xml * Updated /en/pandora_chapter 1 to 9.xml
2006-09-12 Raul Mateos <raulofpandora@gmail.com> 2006-09-12 Raul Mateos <raulofpandora@gmail.com>

BIN
pandora_doc/en/images/b_blue.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 372 B

BIN
pandora_doc/en/images/b_down.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 182 B

BIN
pandora_doc/en/images/b_green.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 345 B

BIN
pandora_doc/en/images/b_red.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 345 B

BIN
pandora_doc/en/images/b_white.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 375 B

BIN
pandora_doc/en/images/b_yellow.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 354 B

BIN
pandora_doc/en/images/cancel.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 529 B

BIN
pandora_doc/en/images/config.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 561 B

BIN
pandora_doc/en/images/data_d.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 256 B

BIN
pandora_doc/en/images/data_m.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 279 B

BIN
pandora_doc/en/images/data_w.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 282 B

BIN
pandora_doc/en/images/dot_blue.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 223 B

BIN
pandora_doc/en/images/dot_down.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 172 B

BIN
pandora_doc/en/images/dot_green.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 200 B

BIN
pandora_doc/en/images/dot_red.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 200 B

BIN
pandora_doc/en/images/dot_white.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 196 B

BIN
pandora_doc/en/images/dot_yellow.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 223 B

BIN
pandora_doc/en/images/grafica_d.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 144 B

BIN
pandora_doc/en/images/grafica_h.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 145 B

BIN
pandora_doc/en/images/grafica_m.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 145 B

BIN
pandora_doc/en/images/grafica_w.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 147 B

7
pandora_doc/en/pandora_chapter1.xml
View File

@ -1,7 +1,8 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<chapter>
<chapter id="chapter1">
<title>Introduction</title> <title>Introduction</title>
<sect1> <sect1 id="1.1">
<title>What is Pandora?</title> <title>What is Pandora?</title>
<para>Pandora is a monitoring tool that allows a system administrator <para>Pandora is a monitoring tool that allows a system administrator
@ -87,7 +88,7 @@
in virtually any language, given its simple API and being open source. in virtually any language, given its simple API and being open source.
</para> </para>
</sect1> </sect1>
<sect1> <sect1 id="1.2">
<title>Pandora Administration</title> <title>Pandora Administration</title>
<para> <para>

55
pandora_doc/en/pandora_chapter2.xml
View File

@ -1,6 +1,7 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<chapter> <chapter id="chapter2">
<title>Users</title> <title>Users</title>
<para> <para>
@ -39,7 +40,7 @@
incidents, manage database or other. incidents, manage database or other.
</para> </para>
<sect1> <sect1 id="2.1">
<title>Profile manager</title> <title>Profile manager</title>
<para> <para>
@ -75,7 +76,7 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para> <para>
To create a new profile click on "Manage Profiles" -> To create a new profile click on "Manage Profiles"&gt;
"Create Profile" in the Administration Menu "Create Profile" in the Administration Menu
</para> </para>
<graphic fileref="images/image002.png" valign="bottom" align="center"/> <graphic fileref="images/image002.png" valign="bottom" align="center"/>
@ -118,7 +119,7 @@
</itemizedlist> </itemizedlist>
</sect1> </sect1>
<sect1> <sect1 id="2.2">
<title>Adding a user</title> <title>Adding a user</title>
<para> <para>
@ -147,23 +148,23 @@
</para> </para>
<graphic fileref="images/image004.png" valign="bottom" align="center"/> <graphic fileref="images/image004.png" valign="bottom" align="center"/>
<para> <para>
A user profile is deleted by clicking on the delete icon A user profile is deleted by clicking on the delete icon
<graphic fileref="../../images/cancel.gif"/> on the right <inlinegraphic fileref="images/cancel.gif"/> on the right
hand side of the profile. hand side of the profile.
</para> </para>
</sect1> </sect1>
<sect1> <sect1 id="2.3">
<title>Deleting a user</title> <title>Deleting a user</title>
<para> <para>
A user is deleted by clicking on the delete icon <graphic A user is deleted by clicking on the delete icon <inlinegraphic
fileref="../../images/cancel.gif"/> on the right hand side fileref="images/cancel.gif"/> on the right hand side
of the user. The list of users is accessed through the of the user. The list of users is accessed through the
"Manage Users" option in the Administration menu. "Manage Users" option in the Administration menu.
<graphic fileref="images/image005.png" valign="bottom" align="center"/> <graphic fileref="images/image005.png" valign="bottom" align="center"/>
</para> </para>
</sect1> </sect1>
<sect1> <sect1 id="2.4">
<title>Statistics</title> <title>Statistics</title>
<para> <para>
The user activity statistics show a graph with the The user activity statistics show a graph with the
@ -172,24 +173,24 @@
user usually reflects the user's activity. user usually reflects the user's activity.
</para> </para>
<para> <para>
Click on "View Users" -> "Statistics" in the Operation Click on "View Users"&gt;"Statistics" in the Operation
menu to show this graph: 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>
<sect1> <sect1 id="2.5">
<title>Messages to users</title> <title>Messages to users</title>
<para> <para>
To create a new message to other user, go to "Messages" To create a new message to other user, go to "Messages"
section in the Operation menu. You can also read the section in the Operation menu. You can also read the
received messages, but the sent messages are not stored. received messages, but the sent messages are not stored.
</para> </para>
<sect2> <sect2 id="2.5.1">
<title>Messages to groups</title> <title>Messages to groups</title>
<para> <para>
From "Messages" -> "Messages to groups" section in the From "Messages"&gt;"Messages to groups" section in the
Operation menu you can send messages to groups of users. Operation menu you can send messages to groups of users.
The sent messages will not be stores. The sent messages will not be stores.
</para> </para>
</sect2> </sect2>
</sect1> </sect1>
</chapter> </chapter>

589
pandora_doc/en/pandora_chapter3.xml
View File

@ -1,6 +1,7 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<chapter> <chapter id="chapter3">
<title>Agents</title> <title>Agents</title>
<para>The agents collect information. The public key <para>The agents collect information. The public key
@ -33,7 +34,7 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<sect1> <sect1 id="3.1">
<title>Group Manager</title> <title>Group Manager</title>
<para>Groups are added in "Manage Profiles" &gt; "Manage Groups", <para>Groups are added in "Manage Profiles" &gt; "Manage Groups",
@ -73,10 +74,10 @@
<para>A group is added by clicking "Create group" and assigning <para>A group is added by clicking "Create group" and assigning
a name to it.</para> a name to it.</para>
<para>A group is deleted by clicking the delete icon <para>A group is deleted by clicking the delete icon
<graphic fileref="../../images/cancel.gif"/> <inlinegraphic fileref="images/cancel.gif"/>
in the right hand side of each group.</para> in the right hand side of each group.</para>
</sect1> </sect1>
<sect1> <sect1 id="3.2">
<title>Adding an agent</title> <title>Adding an agent</title>
<para>Before an agent is added, the public key of the <para>Before an agent is added, the public key of the
@ -162,7 +163,7 @@
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<sect2> <sect2 id="3.2.1">
<title>Assigning modules</title> <title>Assigning modules</title>
<para>Pandora's agents use the operating system own commands to <para>Pandora's agents use the operating system own commands to
@ -247,12 +248,12 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Deleted by clicking <graphic fileref="../../images/cancel.gif"/> Deleted by clicking <inlinegraphic fileref="images/cancel.gif"/>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Edited by clicking <graphic fileref="../../images/config.gif"/> Edited by clicking <inlinegraphic fileref="images/config.gif"/>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -261,145 +262,198 @@
However, the type of data of the module can't be modified. However, the type of data of the module can't be modified.
</para> </para>
</sect2> </sect2>
<sect2> <sect2 id="3.2.2">
<title>Alerts</title> <title>Alerts</title>
<para> <para>
An alert is Pandora's reaction to an out of range module An alert is Pandora's reaction to an out of range module
value. The Alert can consist in sending and e-mail or SMS to value. The Alert can consist in sending and e-mail or SMS to
the administrator, sending a SNMP trap, write the incident the administrator, sending a SNMP trap, write the incident
into the system syslog or Pandora log file, etc. And basically into the system syslog or Pandora log file, etc. And basically
anything that can be triggered by a script configured in anything that can be triggered by a script configured in
Pandora's Operating System. Pandora's Operating System.
</para> </para>
<sect3> <sect3 id="3.2.2.1">
<title>Adding an Alert</title> <title>Adding an Alert</title>
<para> <para>
The existing Alerts are accessed by clicking on the "Manage The existing Alerts are accessed by clicking on the "Manage
Alerts" option, Administration menu. Alerts" option, Administration menu.
</para> </para>
<para>There are 6 default types of Alerts:</para> <para>There are 6 default types of Alerts:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<emphasis>eMail</emphasis>. Sends an e-mail from Pandora's Server <emphasis>eMail</emphasis>. Sends an e-mail from Pandora's Server
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Internal audit</emphasis>. Writes the incident <emphasis>Internal audit</emphasis>. Writes the incident
in Pandora's internal audit system in Pandora's internal audit system
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>LogFile</emphasis>. Writes the incident in the log file</para> <para><emphasis>LogFile</emphasis>. Writes the incident in the log file</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>SMS Text</emphasis>. Sends an SMS to a given mobile phone</para> <para><emphasis>SMS Text</emphasis>. Sends an SMS to a given mobile phone</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>SNMP Trap</emphasis>. Sends a SNMP Trap</para> <para><emphasis>SNMP Trap</emphasis>. Sends a SNMP Trap</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>Syslog</emphasis>. Sends an alert to the Syslog</para> <para><emphasis>Syslog</emphasis>. Sends an alert to the Syslog</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<graphic fileref="images/image011.png" valign="bottom" align="center"/> <graphic fileref="images/image011.png" valign="bottom" align="center"/>
<para>An Alert is deleted by clicking on the delete icon <graphic fileref="../../images/cancel.gif"/> placed on the right hand side of the Alert. A new customised Alert can be created clicking in "Create Alert".</para> <para>
An Alert is deleted by clicking on the delete icon
<inlinegraphic fileref="images/cancel.gif"/>
placed on the right hand side of the Alert.
A new customised Alert can be created clicking in "Create Alert".
</para>
<para>The values "_field1_", "_field2_" and "_field3_" in the customised Alerts are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode.</para> <para>The values "_field1_", "_field2_" and "_field3_"
in the customised Alerts are used to build the command
line that the machine where Pandora resides will execute
- if there were several servers, the one in Master mode.
</para>
<graphic fileref="images/image012.png" valign="bottom" align="center"/> <graphic fileref="images/image012.png" valign="bottom" align="center"/>
<para>When a new Alert is created the following field must be filled in:</para> <para>When a new Alert is created the following field must be filled in:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis>Alert name:</emphasis> The name of the Alert</para> <para><emphasis>Alert name:</emphasis> The name of the Alert</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>Command:</emphasis> Command the Alert will trigger</para> <para><emphasis>Command:</emphasis> Command the Alert will trigger</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>Description:</emphasis> Description of the Alert</para> <para><emphasis>Description:</emphasis> Description of the Alert</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>In 'Command' data field these variables are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode, replacing at runtime:</para> <para>
In 'Command' data field these variables are used to build
the command line that the machine where Pandora resides will execute
- if there were several servers, the one in Master mode,
replacing at runtime:
</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis>_field1_</emphasis>: Field #1, usually assigned as username, e-mail destination or single identification for this event</para> <para><emphasis>_field1_</emphasis>:
</listitem> Field #1, usually assigned as username,
<listitem> e-mail destination or single identification for this event
<para><emphasis>_field2_</emphasis>: Field #2, usually assigned as short description of events, as subject line in e-mail</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>><emphasis>_field3_</emphasis>: Field #3, a full text explanation for the event</para> <para><emphasis>_field2_</emphasis>:
</listitem> Field #2, usually assigned as short
<listitem> description of events, as subject line in e-mail
<para>><emphasis>_agent_</emphasis>: Agent name</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>_timestamp_</emphasis>: A standard representation of date and time. Replaced automatically when the event has been fired</para> <para><emphasis>_field3_</emphasis>:
</listitem> Field #3, a full text explanation
<listitem> for the event</para>
<para><emphasis>_data_</emphasis>: The data value that triggered the alert</para> </listitem>
</listitem> <listitem>
</itemizedlist> <para>><emphasis>_agent_</emphasis>: Agent name</para>
</sect3> </listitem>
<sect3> <listitem>
<title>Assigning Alerts</title> <para><emphasis>_timestamp_</emphasis>:
A standard representation of date and time.
Replaced automatically when the event has been fired
</para>
</listitem>
<listitem>
<para><emphasis>_data_</emphasis>: The data value that triggered the alert</para>
</listitem>
</itemizedlist>
</sect3>
<sect3 id="3.2.2.2">
<title>Assigning Alerts</title>
<para>The next step after an Agent has been added, its modules have been configurated and the alerts have been defined, it is time to assign those Alerts to the agent.</para> <para>
The next step after an Agent has been added, its
modules have been configurated and the alerts have been defined,
it is time to assign those Alerts to the agent.
</para>
<para>This is done by clicking on the Agent to be configured on the "Manage Agents" option, Administration menu. The Alert Assignation form is placed at the bottom of that page.</para> <para>
This is done by clicking on the Agent to be configured on the
"Manage Agents" option, Administration menu.
The Alert Assignation form is placed at the bottom of that page.
</para>
<graphic fileref="images/image013.png" valign="bottom" align="center"/> <graphic fileref="images/image013.png" valign="bottom" align="center"/>
<para>To assign an Alert the next fields must be filled in:</para> <para>To assign an Alert the next fields must be filled in:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis>Alert type:</emphasis> This can be selected from the list of alerts that have been previously generated.</para> <para><emphasis>Alert type:</emphasis>
</listitem> This can be selected from the list of alerts that have
<listitem> been previously generated.
<para><emphasis>Maximum Value:</emphasis> Defines the maximum value for a module. Any value above that threshold will trigger the Alert.</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>Minimum Value:</emphasis> Defines the minimum value for a module. Any value below that will trigger the Alert.</para> <para><emphasis>Maximum Value:</emphasis>
</listitem> Defines the maximum value for a module. Any value above that
<listitem> threshold will trigger the Alert.
<para><emphasis>Description:</emphasis> Describes the function of the Alert, and it is useful to identify the Alert amongst the others in the Alert General View.</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>Field #1 (Alias, name):</emphasis> Define the used value for the "_field1_" variable.</para> <para><emphasis>Minimum Value:</emphasis>
</listitem> Defines the minimum value for a module. Any value below that
<listitem> will trigger the Alert.
<para><emphasis>Field #2 (Single Line):</emphasis> Define the used value for the "_field2_" variable.</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>Field #3 (Full Text):</emphasis> Define the used value for the "_field3_" variable.</para> <para><emphasis>Description:</emphasis>
</listitem> Describes the function of the Alert, and it is useful to identify
<listitem> the Alert amongst the others in the Alert General View.
<para><emphasis>Time threshold:</emphasis> Minimum duration between the firing of two consecutive alerts, in seconds.</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>Max Alerts Fired:</emphasis> Maximun number of alerts that can be sent consecutively.</para> <para><emphasis>Field #1 (Alias, name):</emphasis>
</listitem> Define the used value for the "_field1_" variable.</para>
<listitem> </listitem>
<para><emphasis>Assigned module:</emphasis> Module to be motitorized by the alert.</para> <listitem>
</listitem> <para><emphasis>Field #2 (Single Line):</emphasis>
</itemizedlist> Define the used value for the "_field2_" variable.</para>
</listitem>
<listitem>
<para><emphasis>Field #3 (Full Text):</emphasis>
Define the used value for the "_field3_" variable.</para>
</listitem>
<listitem>
<para><emphasis>Time threshold:</emphasis>
Minimum duration between the firing of two consecutive alerts,
in seconds.
</para>
</listitem>
<listitem>
<para><emphasis>Max Alerts Fired:</emphasis>
Maximun number of alerts that can be sent consecutively.</para>
</listitem>
<listitem>
<para><emphasis>Assigned module:</emphasis>
Module to be motitorized by the alert.</para>
</listitem>
</itemizedlist>
<para>All the alerts of an agent can be seen through "Manage Agents" <para>All the alerts of an agent can be seen through "Manage Agents"
in the Adminitration menu and selecting the agent.</para> in the Adminitration menu and selecting the agent.</para>
</sect3> </sect3>
</sect2> </sect2>
<sect2> <sect2 id="3.2.3">
<title>Agent module and agent's alert management</title> <title>Agent module and agent's alert management</title>
<para>It might happen that the user finds that modules and alerts <para>It might happen that the user finds that modules and alerts
@ -436,7 +490,7 @@
deletion is performed, the data associated to them will also be deletion is performed, the data associated to them will also be
deleted.</para> deleted.</para>
</sect2> </sect2>
<sect2> <sect2 id="3.2.4">
<title>Agents group detail</title> <title>Agents group detail</title>
<para>Once you have configured your groups and agents, you can <para>Once you have configured your groups and agents, you can
@ -448,20 +502,20 @@
organized by status.</para> organized by status.</para>
<para>By pressing the icon <para>By pressing the icon
<graphic fileref="../../images/target.gif"/> <inlinegraphic fileref="images/target.gif"/>
at the right of any group image, you will update the info of at the right of any group image, you will update the info of
that group.</para> that group.</para>
</sect2> </sect2>
</sect1> </sect1>
<sect1> <sect1 id="3.3">
<title>Agent monitoring </title> <title>Agent monitoring</title>
<para>When the agents start the data transmission to the server, <para>When the agents start the data transmission to the server,
and it is added in the Web console, Pandora processes and inserts and it is added in the Web console, Pandora processes and inserts
the data in the Database. The data are consolidated and can be the data in the Database. The data are consolidated and can be
accessed from the Web console, either as row data or as graphs.</para> accessed from the Web console, either as row data or as graphs.</para>
<sect2> <sect2 id="3.3.1">
<title>Agent view</title> <title>Agent view</title>
<para>All the Agents can be accessed from the Operation menu. <para>All the Agents can be accessed from the Operation menu.
@ -488,176 +542,189 @@
<para><emphasis>Status:</emphasis> Shows the "general" status of the agent <para><emphasis>Status:</emphasis> Shows the "general" status of the agent
through the following icons:</para> through the following icons:</para>
<para> <para>
<graphic fileref="../../images/b_green.gif"/> <inlinegraphic fileref="images/b_green.gif"/>
All the monitors OK. It's the ideal status. All the monitors OK. It's the ideal status.
<graphic fileref="../../images/b_white.gif"/> </para>
No defined monitors. Sometimes nothing is monitored <para>
that could be right or wrong, and only numeric or <inlinegraphic fileref="images/b_white.gif"/>
text data is reported. No defined monitors. Sometimes nothing is monitored
<graphic fileref="../../images/b_red.gif"/> that could be right or wrong, and only numeric or
At least one of the monitors is failing. Usually we text data is reported.
want to avoid this, and keep our systems in a healthy </para>
green colour. <para>
<graphic fileref="../../images/b_blue.gif"/> The agent <inlinegraphic fileref="images/b_red.gif"/>
doesn't have any data. New agents with an empty data At least one of the monitors is failing. Usually we
package can have this status. want to avoid this, and keep our systems in a healthy
<graphic fileref="../../images/b_yellow.gif"/> Colour green colour.
shifting from green to red. This icon indicates </para>
that the agent has just changed its status, from <para>
'All OK' to 'we have a problem'. <inlinegraphic fileref="images/b_blue.gif"/> The agent
<graphic fileref="../../images/b_down.gif"/> When an agent doesn't have any data. New agents with an empty data
is down or there is no news from it for 2 times the Interval package can have this status.
value in seconds. Usually it is due to a communication issue </para>
or a crashed remote system.> <para>
</para> <inlinegraphic fileref="images/b_yellow.gif"/> Colour
shifting from green to red. This icon indicates
that the agent has just changed its status, from
'All OK' to 'we have a problem'.
</para>
<para>
<inlinegraphic fileref="images/b_down.gif"/> When an agent
is down or there is no news from it for 2 times the Interval
value in seconds. Usually it is due to a communication issue
or a crashed remote system.
</para>
<para><emphasis>Alerts:</emphasis> Shows if any alerts have been sent <para><emphasis>Alerts:</emphasis> Shows if any alerts have been sent
through the following icons:</para> through the following icons:
</para>
<para> <para>
<graphic fileref="../../images/dot_green.gif"/> <inlinegraphic fileref="images/dot_green.gif"/>
No alerts have been sent. No alerts have been sent.
<graphic fileref="../../images/dot_red.gif"/> </para>
<para>
<inlinegraphic fileref="images/dot_red.gif"/>
When at least one alert has been sent within When at least one alert has been sent within
the time threshold of the alert. the time threshold of the alert.
</para> </para>
<para><emphasis>Last contact:</emphasis> Shows the time and date of the <para><emphasis>Last contact:</emphasis> Shows the time and date of the
last data package sent by the agent, using a progress bar, last data package sent by the agent, using a progress bar,
according to value of the interval. If you see the image according to value of the interval. If you see the image
<graphic fileref="../../images/outof.gif"/>, <inlinegraphic fileref="images/outof.gif"/>,
the agent has not send data during the interval. the agent has not send data during the interval.
Passing the mouse over the image will show you the last contact Passing the mouse over the image will show you the last contact
in time and date format.</para> in time and date format.</para>
<para><emphasis>Note:</emphasis> The icon <para><emphasis>Note:</emphasis> The icon
<graphic fileref="../../images/setup.gif" width="15"/> <inlinegraphic fileref="images/setup.gif" width="15"/>
is only visible if you're and administrator and it's a link is only visible if you're and administrator and it's a link
to the "Manage Agents" &gt; "Update Agent" option in the to the "Manage Agents" &gt; "Update Agent" option in the
Administration menu. Administration menu.
</para> </para>
</sect2> </sect2>
<sect2> <sect2 id="3.3.2">
<title>Accessing the data of an agent</title> <title>Accessing the data of an agent</title>
<para>When an agent is accessed, by clicking on its name, all the <para>When an agent is accessed, by clicking on its name, all the
information related to that agent is displayed.</para> information related to that agent is displayed.</para>
<sect3> <sect3 id="3.3.2.1">
<title>Agent general info</title> <title>Agent general info</title>
<para>This shows the data introduced when the agent was created <para>This shows the data introduced when the agent was created
and the total number a data packages the agent has sent.</para> and the total number a data packages the agent has sent.</para>
<graphic fileref="images/image016.png" valign="bottom" align="center"/> <graphic fileref="images/image016.png" valign="bottom" align="center"/>
</sect3> </sect3>
<sect3> <sect3 id="3.3.2.2">
<title>Last data received</title> <title>Last data received</title>
<para>This is the description of all the agent modules <para>This is the description of all the agent modules
been monitored.</para> been monitored.</para>
<graphic fileref="images/image017.png" valign="bottom" align="center"/> <graphic fileref="images/image017.png" valign="bottom" align="center"/>
<para>In this list the module information is shown <para>In this list the module information is shown
in the following columns:</para> in the following columns:</para>
<para><emphasis>Module name:</emphasis> Name given to the module <para><emphasis>Module name:</emphasis> Name given to the module
in the agent's config file.</para> in the agent's config file.</para>
<para><emphasis>Module type:</emphasis> Type of module as described <para><emphasis>Module type:</emphasis> Type of module as described
in Asigning Modules section.</para> in Asigning Modules section.</para>
<para><emphasis>Description:</emphasis> Description given to the module <para><emphasis>Description:</emphasis> Description given to the module
in the agent's config file.</para> in the agent's config file.</para>
<para><emphasis>Data:</emphasis> Last data sent by the agent.</para> <para><emphasis>Data:</emphasis> Last data sent by the agent.</para>
<para><emphasis>Graph:</emphasis> Monthly(M), Weekly(W), Daily(D) <para><emphasis>Graph:</emphasis> Monthly(M), Weekly(W), Daily(D)
and Hourly(H) graphs are generated with and Hourly(H) graphs are generated with
the data sent by the agent against time.</para> the data sent by the agent against time.</para>
<para>On the left hand side of the graph the newst <para>On the left hand side of the graph the newst
data is represent, and on the right had side the oldest.</para> data is represent, and on the right had side the oldest.</para>
<para>The generated graphs are:</para> <para>The generated graphs are:</para>
<para> - <emphasis>Hourly graph</emphasis> <para> - <emphasis>Hourly graph</emphasis>
(<graphic fileref="../../images/grafica_h.gif"/>) (<inlinegraphic fileref="images/grafica_h.gif"/>)
covers a 60 minute interval</para> covers a 60 minute interval</para>
<graphic fileref="images/image018.png" valign="bottom" align="center"/> <graphic fileref="images/image018.png" valign="bottom" align="center"/>
<para> - <emphasis>Daily graph</emphasis> <para> - <emphasis>Daily graph</emphasis>
(<graphic fileref="../../images/grafica_d.gif"/>) (<inlinegraphic fileref="images/grafica_d.gif"/>)
covers a 24 hour interval</para> covers a 24 hour interval</para>
<graphic fileref="images/image019.png" valign="bottom" align="center"/> <graphic fileref="images/image019.png" valign="bottom" align="center"/>
<para> - <emphasis>Weekly graph</emphasis> <para> - <emphasis>Weekly graph</emphasis>
(<graphic fileref="../../images/grafica_w.gif"/>) (<inlinegraphic fileref="images/grafica_w.gif"/>)
covers a 7 day interval</para> covers a 7 day interval</para>
<graphic fileref="images/image020.png" valign="bottom" align="center"/> <graphic fileref="images/image020.png" valign="bottom" align="center"/>
<para> - <emphasis>Mothly graph</emphasis> <para> - <emphasis>Mothly graph</emphasis>
(<graphic fileref="../../images/grafica_m.gif"/>) (<inlinegraphic fileref="images/grafica_m.gif"/>)
covers a 30 day interval</para> covers a 30 day interval</para>
<graphic fileref="images/image021.png" valign="bottom" align="center"/> <graphic fileref="images/image021.png" valign="bottom" align="center"/>
<para><emphasis>Raw Data:</emphasis> This is the raw data sent by the agent</para> <para><emphasis>Raw Data:</emphasis> This is the raw data sent by the agent</para>
<para> - <graphic fileref="../../images/data_m.gif"/> Last month</para> <para> - <inlinegraphic fileref="images/data_m.gif"/> Last month</para>
<para> - <graphic fileref="../../images/data_w.gif"/> Last week</para> <para> - <inlinegraphic fileref="images/data_w.gif"/> Last week</para>
<para> - <graphic fileref="../../images/data_d.gif"/> Last day</para> <para> - <inlinegraphic fileref="images/data_d.gif"/> Last day</para>
</sect3> </sect3>
<sect3> <sect3 id="3.3.2.3">
<title>Complete list of monitors</title> <title>Complete list of monitors</title>
<para>This is the description of all the monitors defined by <para>This is the description of all the monitors defined by
the agent</para> the agent</para>
<graphic fileref="images/image022.png" valign="bottom" align="center"/> <graphic fileref="images/image022.png" valign="bottom" align="center"/>
<para>The list shows the information about the monitors in the <para>The list shows the information about the monitors in the
following columns:</para> following columns:</para>
<para><emphasis>Agent:</emphasis> Agent where the monitor is defined.</para> <para><emphasis>Agent:</emphasis> Agent where the monitor is defined.</para>
<para><emphasis>Type:</emphasis> Data type of the monitor. For a monitor this <para><emphasis>Type:</emphasis> Data type of the monitor. For a monitor this
value is always of the generic_proc type.</para> value is always of the generic_proc type.</para>
<para><emphasis>Module name:</emphasis> Name given to the module when it was <para><emphasis>Module name:</emphasis> Name given to the module when it was
created.</para> created.</para>
<para><emphasis>Description:</emphasis> Description given to the module <para><emphasis>Description:</emphasis> Description given to the module
in the agent's config file.</para> in the agent's config file.</para>
<para><emphasis>Status:</emphasis> The table shows the agent status through <para><emphasis>Status:</emphasis> The table shows the agent status through
the following icons:</para> the following icons:</para>
<para><graphic fileref="../../images/b_green.gif"/> <para><inlinegraphic fileref="images/b_green.gif"/>
The monitor is OK</para> The monitor is OK</para>
<para><graphic fileref="../../images/b_red.gif"/> <para><inlinegraphic fileref="images/b_red.gif"/>
The monitor is failing</para> The monitor is failing</para>
<para><emphasis>Last contact:</emphasis> Shows the time and date of <para><emphasis>Last contact:</emphasis> Shows the time and date of
the last data packaged received from the agent</para> the last data packaged received from the agent</para>
</sect3> </sect3>
<sect3> <sect3 id="3.3.2.4">
<title>Complete list of alerts</title> <title>Complete list of alerts</title>
<para>This is the description of all the alarms defined <para>This is the description of all the alarms defined
in the agent</para> in the agent</para>
<graphic fileref="images/image023.png" valign="bottom" align="center"/> <graphic fileref="images/image023.png" valign="bottom" align="center"/>
<para>The monitor information is shown in the list <para>The monitor information is shown in the list
divided in the following fields:</para> divided in the following fields:</para>
<para><emphasis>ID:</emphasis> Agent were the alert has been defined.</para> <para><emphasis>ID:</emphasis> Agent were the alert has been defined.</para>
<para><emphasis>Type:</emphasis> Type of alert.</para> <para><emphasis>Type:</emphasis> Type of alert.</para>
<para><emphasis>Description:</emphasis> Description given to the alert when <para><emphasis>Description:</emphasis> Description given to the alert when
it was created.</para> it was created.</para>
<para><emphasis>Last fired:</emphasis> The last time the alert was <para><emphasis>Last fired:</emphasis> The last time the alert was
executed.</para> executed.</para>
<para><emphasis>Times Fired:</emphasis> Number of times the alert was <para><emphasis>Times Fired:</emphasis> Number of times the alert was
launched.</para> launched.</para>
<para><emphasis>Status:</emphasis> Shows if the alert has been sent through <para><emphasis>Status:</emphasis> Shows if the alert has been sent through
the following icon:</para> the following icon:</para>
<para><graphic fileref="../../images/dot_green.gif"/> No alerts <para><inlinegraphic fileref="images/dot_green.gif"/> No alerts
have been sent</para> have been sent</para>
<para><graphic fileref="../../images/dot_red.gif"/> At least <para><inlinegraphic fileref="images/dot_red.gif"/> At least
one alert has been sent</para> one alert has been sent</para>
</sect3> </sect3>
</sect2> </sect2>
<sect2> <sect2 id="3.3.3">
<title>Group details</title> <title>Group details</title>
<para>The groups configured in Pandora can be <para>The groups configured in Pandora can be
@ -677,21 +744,21 @@
<para><emphasis>Status:</emphasis> The status is described through <para><emphasis>Status:</emphasis> The status is described through
the following icons:</para> the following icons:</para>
<para><graphic fileref="../../images/b_green.gif"/> <para><inlinegraphic fileref="images/b_green.gif"/>
All monitors are OK.</para> All monitors are OK.</para>
<para><graphic fileref="../../images/b_red.gif"/> <para><inlinegraphic fileref="images/b_red.gif"/>
At least one monitor has failed.</para> At least one monitor has failed.</para>
<para><graphic fileref="../../images/b_down.gif"/> <para><inlinegraphic fileref="images/b_down.gif"/>
At least one monitor is down and there is no contact At least one monitor is down and there is no contact
with it.</para> with it.</para>
<para><graphic fileref="../../images/b_white.gif"/> <para><inlinegraphic fileref="images/b_white.gif"/>
This Agent doesn't have any monitor defined.</para> This Agent doesn't have any monitor defined.</para>
<para><emphasis>OK:</emphasis> Number of monitors that are OK.</para> <para><emphasis>OK:</emphasis> Number of monitors that are OK.</para>
<para><emphasis>Failed:</emphasis> Number of failing monitors.</para> <para><emphasis>Failed:</emphasis> Number of failing monitors.</para>
<para><emphasis>Down:</emphasis> Number of down monitors.</para> <para><emphasis>Down:</emphasis> Number of down monitors.</para>
</sect2> </sect2>
<sect2> <sect2 id="3.3.4">
<title>Monitors view</title> <title>Monitors view</title>
<para>The description of all the monitors defined in the server <para>The description of all the monitors defined in the server
@ -704,7 +771,7 @@
in the individual view, but now they are shown all together. in the individual view, but now they are shown all together.
This allows a deeper analisys of each monitor.</para> This allows a deeper analisys of each monitor.</para>
</sect2> </sect2>
<sect2> <sect2 id="3.3.5">
<title>Alert details</title> <title>Alert details</title>
<para>The description of all the alerts defined in the server <para>The description of all the alerts defined in the server
@ -717,7 +784,7 @@
as in the individual view, but now they are shown all together. as in the individual view, but now they are shown all together.
This allows a deeper analisys of each alert.</para> This allows a deeper analisys of each alert.</para>
</sect2> </sect2>
<sect2> <sect2 id="3.3.6">
<title>Data Export</title> <title>Data Export</title>
<para>The Data Export tool can be found in the "View Agents"&gt;" <para>The Data Export tool can be found in the "View Agents"&gt;"
@ -745,7 +812,7 @@
<graphic fileref="images/image030.png" valign="bottom" align="center"/> <graphic fileref="images/image030.png" valign="bottom" align="center"/>
</sect2> </sect2>
<sect2> <sect2 id="3.3.7">
<title>Statistics</title> <title>Statistics</title>
<para>Two kinds of graphical statistics are displayed from the <para>Two kinds of graphical statistics are displayed from the
@ -767,10 +834,10 @@
<graphic fileref="images/image033.png" valign="bottom" align="center"/> <graphic fileref="images/image033.png" valign="bottom" align="center"/>
</sect2> </sect2>
</sect1> </sect1>
<sect1> <sect1 id="3.4">
<title>SNMP Console</title> <title>SNMP Console</title>
<para></para> <para></para>
<sect2> <sect2 id="3.4.1">
<title>SNMP Alerts</title> <title>SNMP Alerts</title>
<para></para> <para></para>
</sect2> </sect2>

100
pandora_doc/en/pandora_chapter4.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<chapter> <chapter id="chapter4">
<title>Incident management</title> <title>Incident management</title>
<para> <para>
@ -75,40 +75,41 @@
<para><emphasis>Status:</emphasis> The incident status is represented by the following <para><emphasis>Status:</emphasis> The incident status is represented by the following
icons:</para> icons:</para>
<para><graphic fileref="../../images/dot_red.gif"/> Active incident</para> <para><inlinegraphic fileref="images/dot_red.gif"/> Active incident</para>
<para><graphic fileref="../../images/dot_yellow.gif"/> Active incident <para><inlinegraphic fileref="images/dot_yellow.gif"/> Active incident
with comments</para> with comments</para>
<para><graphic fileref="../../images/dot_blue.gif"/> Rejected incident</para> <para><inlinegraphic fileref="images/dot_blue.gif"/> Rejected incident</para>
<para><graphic fileref="../../images/dot_green.gif"/> Closed incident</para> <para><inlinegraphic fileref="images/dot_green.gif"/> Closed incident</para>
<para><graphic fileref="../../images/dot_white.gif"/> Expired 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>Incident name:</emphasis> Name given to the incident</para>
<para><emphasis>Priority:</emphasis> The incident assigned priority is represented <para><emphasis>Priority:</emphasis> The incident assigned priority is represented
by the following icons:</para> by the following icons:</para>
<para><graphic fileref="../../images/dot_red.gif"/> <para><inlinegraphic fileref="images/dot_red.gif"/>
<graphic fileref="../../images/dot_red.gif"/> <inlinegraphic fileref="images/dot_red.gif"/>
<graphic fileref="../../images/dot_red.gif"/> <inlinegraphic fileref="images/dot_red.gif"/>
Very high priority</para> Very high priority</para>
<para><graphic fileref="../../images/dot_yellow.gif"/> <para><inlinegraphic fileref="images/dot_yellow.gif"/>
<graphic fileref="../../images/dot_red.gif"/> <inlinegraphic fileref="images/dot_red.gif"/>
<graphic fileref="../../images/dot_red.gif"/> <inlinegraphic fileref="images/dot_red.gif"/>
High priority</para> High priority</para>
<para><graphic fileref="../../images/dot_yellow.gif"/> <para><inlinegraphic fileref="images/dot_yellow.gif"/>
<graphic fileref="../../images/dot_yellow.gif"/> <inlinegraphic fileref="images/dot_yellow.gif"/>
<graphic fileref="../../images/dot_red.gif"/> <inlinegraphic fileref="images/dot_red.gif"/>
Medium priority</para> Medium priority</para>
<para><graphic fileref="../../images/dot_green.gif"/> <para><inlinegraphic fileref="images/dot_green.gif"/>
<graphic fileref="../../images/dot_yellow.gif"/> <inlinegraphic fileref="images/dot_yellow.gif"/>
<graphic fileref="../../images/dot_yellow.gif"/> <inlinegraphic fileref="images/dot_yellow.gif"/>
Low priority</para> Low priority</para>
<para><graphic fileref="../../images/dot_green.gif"/> <para><inlinegraphic fileref="images/dot_green.gif"/>
<graphic fileref="../../images/dot_green.gif"/> <inlinegraphic fileref="images/dot_green.gif"/>
<graphic fileref="../../images/dot_yellow.gif"/> <inlinegraphic fileref="images/dot_yellow.gif"/>
Informative priority</para> Informative priority</para>
<para><graphic fileref="../../images/dot_green.gif"/> <para><inlinegraphic fileref="images/dot_green.gif"/>
<graphic fileref="../../images/dot_green.gif"/> <inlinegraphic fileref="images/dot_green.gif"/>
<graphic fileref="../../images/dot_green.gif"/> Maintenance priority</para> <inlinegraphic fileref="images/dot_green.gif"/>
Maintenance priority</para>
<para><emphasis>Group:</emphasis> The name of the group the incident has been assigned <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> to. One incident can only belong to a single group.</para>
@ -124,7 +125,7 @@
from one user to another. The incident can be assigned to another user 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 by its owner, or by a user with management privileges over the group
the incidents belong to.</para> the incidents belong to.</para>
<sect1> <sect1 id="4.1">
<title>Adding an incident</title> <title>Adding an incident</title>
<para>The creation of incidents is performed by clicking on <para>The creation of incidents is performed by clicking on
@ -136,7 +137,7 @@
fields to define the incident. The process is completed by clicking fields to define the incident. The process is completed by clicking
on the "Create" button.</para> on the "Create" button.</para>
</sect1> </sect1>
<sect1> <sect1 id="4.2">
<title>Incident follow up</title> <title>Incident follow up</title>
<para>All the open incidents can be followed up. The tool is reached by <para>All the open incidents can be followed up. The tool is reached by
@ -174,41 +175,57 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>The indicent is updated by clicking on the "Update incident" button.</para> <para>The indicent is updated by clicking on the "Update incident" button.</para>
<sect2> <sect2 id="4.2.1">
<title>Adding comments to an incident</title> <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> <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"/> <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> <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"/> <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> <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>
<sect2> <sect2 id="4.2.2">
<title>Attaching files to an incident</title> <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>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>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> <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"/> <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> <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"/> <graphic fileref="images/image040.png" valign="bottom" align="center"/>
</sect2> </sect2>
</sect1> </sect1>
<sect1> <sect1 id="4.3">
<title>Searching for an incident</title> <title>Searching for an incident</title>
<para>A specific incident can be found amongst the <para>A specific incident can be found amongst the incidents created
incidents created in Pandora by either using a filter _ as explained in the in Pandora by either using a filter, as explained in the first
first section of this chapter - or by making a query using the "Manage Incidents"&gt;"Searh Incident" tool, in the Operation menu.</para> 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"/> <graphic fileref="images/image041.png" valign="bottom" align="center"/>
@ -219,10 +236,11 @@
the attached files. The search can be performed in addition to group, priority the attached files. The search can be performed in addition to group, priority
or status filters.</para> or status filters.</para>
</sect1> </sect1>
<sect1> <sect1 id="4.4">
<title>Statistics</title> <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> <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> <itemizedlist>
<listitem> <listitem>

14
pandora_doc/en/pandora_chapter5.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<chapter> <chapter id="chapter5">
<title>Events</title> <title>Events</title>
<para>An event in Pandora is any unusual change happend in an agent.</para> <para>An event in Pandora is any unusual change happend in an agent.</para>
@ -22,8 +22,8 @@
<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 bellow:</para> <para><emphasis>Status:</emphasis> The event status is represented by the icon bellow:</para>
<para><graphic fileref="../../images/dot_green.gif"/> The event has been validated</para> <para><inlinegraphic fileref="images/dot_green.gif"/> The event has been validated</para>
<para><graphic fileref="../../images/dot_red.gif"/> The event hasn't 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>Event name:</emphasis> Name assigned to the event by Pandora.</para>
<para><emphasis>Agent name:</emphasis> Agent where the event happend.</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>Group name:</emphasis> Group of the agent where the event has happened.</para>
@ -31,13 +31,15 @@
<para><emphasis>Timestamp:</emphasis> Date and time when the event was raised or validated <para><emphasis>Timestamp:</emphasis> Date and time when the event was raised or validated
- if it has been validated.</para> - if it has been validated.</para>
<para><emphasis>Action:</emphasis> Action that can be executed over the event.</para> <para><emphasis>Action:</emphasis> Action that can be executed over the event.</para>
<para><graphic fileref="../../images/ok.gif"/> This icon will validate the event, disappearing the icon</para> <para><inlinegraphic fileref="images/ok.gif"/>
<para><graphic fileref="../../images/cancel.gif"/> This icon will delete the event</para> This icon will validate the event, disappearing the icon</para>
<para><inlinegraphic fileref="images/cancel.gif"/>
This icon will delete the event</para>
<para>The events can be also validated or deleted in groups by selecting <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 the tick boxes on the last column of the event, and pressing "Validate" or
"Delete" at the bottom of the list.</para> "Delete" at the bottom of the list.</para>
<sect1> <sect1 id="5.1">
<title>Statistics</title> <title>Statistics</title>
<para>Three different kinds of graphical statistic representation can be <para>Three different kinds of graphical statistic representation can be

4
pandora_doc/en/pandora_chapter6.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-15"?> <?xml version="1.0" encoding="ISO-8859-15"?>
<chapter> <chapter id="chapter6">
<title>System audit</title> <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>The Pandora's system audit shows all the actions performed by each user, as well as the failed logins.</para>
@ -27,7 +27,7 @@
<para><emphasis>Source IP:</emphasis> IP of the machine or the agent that provoked the entry.</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> <para><emphasis>Comment:</emphasis> Comment describing the entry</para>
<sect1> <sect1 id="6.1">
<title>Statistics</title> <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 <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

2
pandora_doc/en/pandora_chapter7.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<chapter> <chapter id="chapter7">
<title>Pandora Servers</title> <title>Pandora Servers</title>
<para> <para>

118
pandora_doc/en/pandora_chapter8.xml
View File

@ -1,32 +1,52 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<chapter> <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 <para>
machines is stored in this data base, from the administrator's data, to the The core of Pandora's system is its Database. All the data
events, incidents and audit data generated in the system at any time.</para> 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 <para>
use standard MySQL commands. Maintaining Pandora database in good condition is critital for Pandora to work properly.</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 <para>As the database size will increase linearly, the data will be
the processed data.</para> 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> <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"/> <graphic fileref="images/image054.png" valign="bottom" align="center"/>
<sect1> <sect1 id="8.1">
<title>DB Information</title> <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> <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> <itemizedlist>
<listitem> <listitem>
<para>Number of modules configured for each of the agents.</para> <para>Number of modules configured for each of the agents.</para>
</listitem> </listitem>
<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> <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> </listitem>
</itemizedlist> </itemizedlist>
@ -37,35 +57,61 @@
<para>These graphs can be also viewed from <para>These graphs can be also viewed from
"View Agents"&gt;"Statistics" in the Operation menu.</para> "View Agents"&gt;"Statistics" in the Operation menu.</para>
</sect1> </sect1>
<sect1> <sect1 id="8.2">
<title>Manual purge of the Datadase</title> <title>Manual purge of the Datadase</title>
<para>Pandora counts with powerful tools for the <para>Pandora counts with powerful tools for the
Administrator to manually purge the majority of data stored in the Database. 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> This includes data generated by both the agents and the own server.</para>
</sect1> </sect1>
<sect1> <sect1 id="8.3">
<title>Agent's data purge</title> <title>Agent's data purge</title>
<sect2> <sect2 id="8.3.1">
<title>Debuging selected data from a module</title> <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>
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> <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"/> <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>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 <para>
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> 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>
<sect2> <sect2 id="8.3.2">
<title>Purging all the agent's data</title> <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>
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> <para>
The data is deleted by the following parameters from
the "Delete data" screen:
</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -94,14 +140,20 @@
<graphic fileref="images/image059.png" valign="bottom" align="center"/> <graphic fileref="images/image059.png" valign="bottom" align="center"/>
</sect2> </sect2>
</sect1> </sect1>
<sect1> <sect1 id="8.4">
<title>Purging system data</title> <title>Purging system data</title>
<sect2> <sect2 id="8.4.1">
<title>Audit data purge</title> <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>
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> <para>
The data to be deleted is selected by setting the following
parameters in the "Delete Data" screen
</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -129,12 +181,18 @@
<graphic fileref="images/image060.png" valign="bottom" align="center"/> <graphic fileref="images/image060.png" valign="bottom" align="center"/>
</sect2> </sect2>
<sect2> <sect2 id="8.4.2">
<title>Event data purge</title> <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>
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> <para>
The data to be deleted is selected by setting the following
parameters in the "Delete Data" screen
</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>

53
pandora_doc/en/pandora_chapter9.xml
View File

@ -1,29 +1,48 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<chapter> <chapter id="chapter9">
<title>Pandora Configuration</title> <title>Pandora Configuration</title>
<para>All the configurable parameters in Pandora can be set in the "Pandora Setup" section, in the Administration menu.</para> <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"/> <graphic fileref="images/image051.png" valign="bottom" align="center"/>
<para>These parameters are:</para> <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>Language:</emphasis> In following versions or revisions
<para><emphasis>Page block size:</emphasis> Maximum size of the lists in the event, incident and audit log sections.</para> of the actual Pandora version will support more languages.
<para><emphasis>Max. days before compact data:</emphasis> This parameter controls data compacting. From the At the moment version 1.2 supports English, Spanish, Bable, Italian,
number of days in this parameter the data starts getting compacted. For large French, Catalan and Portuguese of Brazil.
amounts of data it is recommended to set this parameter to a number between 14 </para>
and 28; for systems with less data load or very powerful systems, a number <para><emphasis>Page block size:</emphasis> Maximum size of the lists
between 30 and 50 will be enough.</para> in the event, incident and audit log sections.
<para><emphasis>Max. days before purge:</emphasis> This parameter controls how long the data is kept </para>
before it is permanently deleted. The recommended value is 60. For systems with <para><emphasis>Max. days before compact data:</emphasis> This parameter
little resources or large work load the recommended value is between 40 and 50.</para> controls data compacting. From the number of days in this parameter the
<para><emphasis>Graphic resolution (1 low, 5 high):</emphasis> This value represents the precision of the data starts getting compacted. For large amounts of data it is recommended
interpolation logarithm to generate the graphics.</para> to set this parameter to a number between 14 and 28; for systems with
<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 less data load or very powerful systems, a number
represented graphically in large time intervals.</para> between 30 and 50 will be enough.
<sect1> </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="9.1">
<title>Links</title> <title>Links</title>
<para>Links to different Internet or private network links can be <para>Links to different Internet or private network links can be