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

2006-10-11 Sancho Lerena <slerena@artica.es>

Browse Source 
* en/pandora_userguide.xml: Changed chapter1 link by Introduction
	chapter from Pandora Install guide.

	* en/pandora_userguide.pdf: Added provisional PDF output.

	* en/pandora_chapter3.xml: Updated chapter3, not finished!.
	


git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@228 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
slerena 2006-10-11 13:56:53 +00:00
parent 103639ff45
commit c99fa4bb1d
3 changed files with 17920 additions and 532 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

615
pandora_doc/en/pandora_chapter3.xml
View File

@ -4,17 +4,36 @@
<title>Agents</title> <title>Agents</title>
<para>The agents collect information. The public key <para>
of the machine to be monitored needs to be copied onto Pandora and the agent The agents collect information. They could be a "real" agent,
executed. Pandora's server starts now receiving and processing the data based on a software agent, or a network agent, a non-physical
collected by the agent. The data collected from the agents are called "modules".</para> agent, witout need of installing any software, that execute
network tasks in Pandora Network servers, and showing information
on console inside an Agent.
</para>
<para>
For agents who need to install software onto remote systems,
public key of the machine to be monitored needs to be copied onto
Pandora Data server to be able to collect data, as it's specified
in detail in Pandora Install documentation.
</para>
<para>
Data collected from the agents are stored in small pieces of
information called "modules". Each module store only a kind of
data. Value of each module is the value of one monitored
variable. The agent must be activated in Pandora's server and a
group assigned to the agent. The data starts then been
consolidated in the database and can be accessed.
</para>
<para>
A network agent NEEDs to be assigned to a Network Server to
execute network tasks. If you cannot see any Network Servers it's
because you has not executed any Network Servers. Please configure
and run a Network Server before trying to assign a network module
to an Agent.
</para>
<para>The value of each module it is the value of one <para>With Pandora Console, user is capable to:</para>
monitored variable. The agent must be activated in Pandora's server and a group
assigned to the agent. The data starts then been consolidated in the database
and can be accessed.</para>
<para>The user can:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -32,92 +51,107 @@
<listitem> <listitem>
<para>Configure Alerts</para> <para>Configure Alerts</para>
</listitem> </listitem>
<listitem>
<para>
Configure modules. Define max and minumun valid values for
each module, set a comprehensive description or even change
module name (remember that module name must be the same in
console and in software agent configuration).
</para>
</listitem>
<listitem>
<para>
Export tabular data in CSV format.
</para>
</listitem>
</itemizedlist> </itemizedlist>
<sect1 id="sec3.1"> <sect1 id="sec3.1">
<title>Group Manager</title> <title>Group Manager</title>
<para>Groups are added in "Manage Profiles" &gt; "Manage Groups", <para>
Administration menu.</para> Pandora groups are common to agents, incidents and
profiles. Groups are added in "Manage Profiles" &gt; "Manage
Groups", Administration menu.
</para>
<graphic fileref="images/image007.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image007.png" valign="bottom" align="center"/>
<para>There are nine default groups on this screen.</para> <para>There are several default groups defined in Pandora. You also can create your own (please use given icons or edit and add your own icons). You can also modify default ones.</para>
<itemizedlist> <para>
<listitem> A group is added by clicking "Create group" and assigning a name
<para><emphasis>Applications</emphasis></para> to it.
</listitem> </para>
<listitem> <para>
<para><emphasis>Comms</emphasis></para> A group is deleted by clicking the delete icon
</listitem> <inlinegraphic scale='70' fileref="images/cancel.png"/>
<listitem> in the right hand side of each group.
<para><emphasis>Databases</emphasis></para> </para>
</listitem>
<listitem>
<para><emphasis>Firewall</emphasis></para>
</listitem>
<listitem>
<para><emphasis>IDS</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Others</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Servers</emphasis></para>
</listitem>
<listitem>
<para><emphasis>Workstations</emphasis></para>
</listitem>
</itemizedlist>
<para>A group is added by clicking "Create group" and assigning
a name to it.</para>
<para>A group is deleted by clicking the delete icon
<inlinegraphic fileref="images/cancel.png"/>
in the right hand side of each group.</para>
</sect1> </sect1>
<sect1 id="sec3.2"> <sect1 id="sec3.2">
<title>Adding an agent</title> <title>Adding an agent</title>
<para>
You can define new agents. Once defined in Pandora console, its
ready to receive data from a Software agent (old agents, based
on software installed in a remote machine), or from Network
Agents (assined to a Network Server who run network tasks to
monitorize remote systems). You also mix both types of module in
the same agent.
</para>
<para>
Please remember that a network agent NEEDs to be assigned to a
Network Server to execute network tasks. If you cannot see any
Network Servers it's because you has not executed any Network
Servers. Please configure and run a Network Server before trying
to assign a network module to an Agent.
</para>
<para>
An agent is added in "Manage Agents" &gt; "Create agent" in the
Administration menu.
</para>
<para>Before an agent is added, the public key of the <graphic scale='70' fileref="images/image008.png" valign="bottom" align="center"/>
machine to be monitored needs to be copied. The agent is then executed, and
added through the web console. The data starts now being consolidated in the
Database and can be accessed.</para>
<para>An agent is added in "Manage Agents" &gt; "Create agent" in the Administration menu.</para> <para>
To add a new agent the following parameters must be
<graphic fileref="images/image008.png" valign="bottom" align="center"/> configured:
</para>
<para>To add a new agent the following parameters must be configured:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<emphasis>Agent Name:</emphasis> Name of the agent. This and <emphasis>Agent Name:</emphasis> Name of the agent. This and
the "agent name" parameter in Pandora's agent.conf file the "agent name" parameter in Pandora's agent.conf file
<emphasis>must have the same value</emphasis>. If this <emphasis>must have the same value</emphasis>. By default
variable is commented out in the code, the name used will be agent takes hostname of the machine where it's running.
the name of the Host (to obtain this, execute the hostname
command).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>IP Address:</emphasis> IP address of an agent. An <emphasis>IP Address:</emphasis> IP address of an agent. An
agent can share its IP address with other agents. agent can share its IP address with other agents. Its only
for informational purposes. In network agents its useful,
because use this IP address for all new network module
definition by default.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Group:</emphasis> Pandora's group the agent belongs. <emphasis>Group:</emphasis> Pandora's group the agent
belongs. In this version of Pandora, an agent only can
belong to a group.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Interval:</emphasis> Execution interval of an <emphasis>Interval:</emphasis> Execution interval of an
agent. It is the time elapsed between two executions. agent. It is the time elapsed in seconds, between two
executions. An agent could have a defined interval, but
could have modules with different (bigger or smaller)
intervals. An agent its considered "down" (not responding)
when Pandora servers (any of them) has no contact with agent
in Interval x 2 seconds.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -141,15 +175,16 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
- <emphasis>Learning mode:</emphasis> All the modules sent by <emphasis>Learning mode:</emphasis> All the modules sent
the agent are accepted. They are automatically defined by the by the agent are accepted. If modules are not defined, they
system. It is recommended to activate the agents in this mode are automatically defined by the system. It is recommended
and change it once the user is familiar with the system. to activate the agents in this mode and change it once the
user is familiar with the system.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
- <emphasis>Normal mode:</emphasis> The modules in this mode <emphasis>Normal mode:</emphasis> The modules in this mode
must be configured manually. The self definition of the must be configured manually. The self definition of the
modules is not allowed in this mode. modules is not allowed in this mode.
</para> </para>
@ -183,34 +218,98 @@
agent name is clicked. In the same screen there is a section to agent name is clicked. In the same screen there is a section to
assign modules.</para> assign modules.</para>
<graphic fileref="images/image009.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image009.png" valign="bottom" align="center"/>
<para>The following fields must be filled to create a
module:</para>
<para>
A Pandora module could be from different types:
</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<emphasis>Module type:</emphasis> This is the type of data <emphasis>generic_data</emphasis>, numeric data type.
the module will process. There are five types of data: </para>
</listitem>
<listitem>
<para>
<emphasis>generic_data_inc</emphasis>, incremental
numerical data type. It stores data resulting from
difference between last agent data and actual data.
</para>
</listitem>
<listitem>
<para>
<emphasis>generic_data_proc</emphasis>, Boolean data type:
0 means False or "bad values", and 1 means True or "good"
value. Generic Proc types are also called "monitors"
because could say if something is "ok" or is "wrong". Are
displayed in agent view as little lamps. Red if 0, Green
is 1.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
- <emphasis>generic_data></emphasis>, Integer data type -
<emphasis>generic_data_inc</emphasis>, Incremental integer
data type - <emphasis>generic_data_proc</emphasis>, Boolean
data type: 0 False, &gt;0 True -
<emphasis>generic_data_string</emphasis>, Alphanumeric data <emphasis>generic_data_string</emphasis>, Alphanumeric data
type (text string, max. 255 characters) type (text string, max. 255 characters).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Module name:</emphasis> The name of the module <emphasis>generic_icmp</emphasis> get network latency in
miliseconds for remote system.
</para> </para>
</listitem> </listitem>
<listitem>
<para>
<emphasis>generic_icmp_proc</emphasis>, makes a "ping" to
remote system. Report 0 if system is not reachable or not
responding.
</para>
</listitem>
<listitem>
<para>
<emphasis>generic_tcp_proc</emphasis>, makes a "tcp" ping
to remote systems and reports "1" if a listing port is
responding. Optionally, you may pass parameters in "TCP
SEND" (you can use the macro ^M to send carriage returns)
and wait to receive string defined in "TCP RECEIVE". If
Pandora Network Server received TCP RECEIVE string, it
returns 1 (ok), else return 0 (wrong).
</para>
</listitem>
<listitem>
<para>
<emphasis>generic_tcp_data, generic_tcp_string,
generic_tcp_inc</emphasis>, gets numerical data, string
data or incremental data from TCP open port. If cannot
connect, no value returned.
</para>
</listitem>
<listitem>
<para>
<emphasis>generic_snmp types:</emphasis> they obtain
informacion using SNMP interface. If you enter SNMP
community, and IP address, you can walk SNMP MIB from
target using SNMP v1 protocol, and all MIB variables will
be listed to allow you choose one. You also can enter MIB
using numerical OID or human - comprenhensive format.
</para>
</listitem>
<listitem>
<para>
<emphasis>generic_ucp_proc</emphasis>, makes a "udp" ping
to remote systems and reports "1" if a listing port is
responding and 0 if are not responding.
</para>
</listitem>
</itemizedlist>
<para>
Pandora modules have some other fields that modify their behaviour:
</para>
<itemizedlist>
<listitem> <listitem>
<para> <para>
<emphasis>Maximum:</emphasis> Upper threshold for the <emphasis>Maximum:</emphasis> Upper threshold for the
@ -233,6 +332,16 @@
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>
Aditionally if you are defining a network module, you also
have more fields related to Network options:
</para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
<para> <para>
All the modules to be monitored by an agent can be reviewed by All the modules to be monitored by an agent can be reviewed by
@ -240,7 +349,8 @@
Administration menu. Administration menu.
</para> </para>
<graphic fileref="images/image010.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image010.png" valign="bottom"
align="center"/>
<para> <para>
In this screen the modules can be: In this screen the modules can be:
@ -248,12 +358,14 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Deleted by clicking <inlinegraphic fileref="images/cancel.png"/> Deleted by clicking <inlinegraphic scale='70'
fileref="images/cancel.png"/>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Edited by clicking <inlinegraphic fileref="images/config.png"/> Edited by clicking <inlinegraphic scale='70'
fileref="images/config.png"/>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -308,11 +420,11 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<graphic fileref="images/image011.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image011.png" valign="bottom" align="center"/>
<para> <para>
An Alert is deleted by clicking on the delete icon An Alert is deleted by clicking on the delete icon
<inlinegraphic fileref="images/cancel.png"/> <inlinegraphic scale='70' fileref="images/cancel.png"/>
placed on the right hand side of the Alert. placed on the right hand side of the Alert.
A new customised Alert can be created clicking in "Create Alert". A new customised Alert can be created clicking in "Create Alert".
</para> </para>
@ -323,7 +435,8 @@
- if there were several servers, the one in Master mode. - if there were several servers, the one in Master mode.
</para> </para>
<graphic fileref="images/image012.png" valign="bottom" align="center"/> <graphic scale='70' 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>
@ -392,7 +505,7 @@
The Alert Assignation form is placed at the bottom of that page. The Alert Assignation form is placed at the bottom of that page.
</para> </para>
<graphic fileref="images/image013.png" valign="bottom" align="center"/> <graphic scale='70' 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>
@ -466,110 +579,135 @@
<para>The screen is accessed through "Manage Agents" &gt; <para>The screen is accessed through "Manage Agents" &gt;
"Manage Config.", in the Administration menu:</para> "Manage Config.", in the Administration menu:</para>
<graphic fileref="images/image014.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image014.png" valign="bottom"
align="center"/>
<para>The Source Agent menu permits the selection of the agent <para>
where the needed modules and/or alerts reside. The "Get Info" Source Agent menu permits the selection of the agent where the
button shows the modules for that agent in the Modules list box. needed modules and/or alerts reside. The "Get Info" button
shows the modules for that agent in the Modules list box.
</para> </para>
<para><emphasis>The copy process</emphasis> is performed to copy <para>
the module and/or alert configuration from the selected source <emphasis>Copy process</emphasis> is performed to copy the
agents to the selected destination agents. Several agents can be module and/or alert configuration from the selected source
selected, pressing CTRL and the mouse right button simultaneously. agents to the selected destination agents. Several agents can
The two tick boxes at the top of the form will be used to specify be selected, pressing CTRL and the mouse right button
if the configuration to copy is from modules and/or from alerts. simultaneously. The two tick boxes at the top of the form
will be used to specify if the configuration to copy is from
modules and/or from alerts.
</para> </para>
<para><emphasis>The delete process</emphasis> is performed to delete the <para>
configuration of the destination agents, in the multiple selection <emphasis>Deletion process</emphasis> is performed to delete
list box. Several agents can be selected at a time, and the tick the configuration of the destination agents, in the multiple
boxes at the top of the form indicate whether it is the modules selection list box. Several agents can be selected at a time,
or the alerts configuration what is to be deleted. The and the tick boxes at the top of the form indicate whether it
application will prompt to confirm the deletion, as once is the modules or the alerts configuration what is to be
deletion is performed, the data associated to them will also be deleted. The application will prompt to confirm the deletion,
deleted.</para> as once deletion is performed, the data associated to them
will also be deleted.
</para>
</sect2> </sect2>
<sect2 id="sec3.2.4"> <sect2 id="sec3.2.4">
<title>Agents group detail</title> <title>Agents group detail</title>
<para>Once you have configured your groups and agents, you can <para>
see the status of the groups of agents through "View Agents", Once you have configured your groups and agents, you can see
in the Operation Menu.</para> the status of the groups of agents through "View Agents", in
the Operation Menu.
</para>
<para>If you pass the mouse over any group image, you'll see <para>
the number of agents of that group as well the number of monitors, If you pass the mouse over any group image, you'll see the
organized by status.</para> number of agents of that group as well the number of monitors,
organized by status.
</para>
<para>By pressing the icon <para>
<inlinegraphic fileref="images/target.png"/> By pressing the icon
<inlinegraphic scale='70' fileref="images/target.png"/>
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 id="sec3.3"> <sect1 id="sec3.3">
<title>Agent monitoring</title> <title>Agent monitoring</title>
<para>When the agents start the data transmission to the server, <para>
and it is added in the Web console, Pandora processes and inserts When the agents start the data transmission to the server, 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 id="sec3.3.1"> <sect2 id="sec3.3.1">
<title>Agent view</title> <title>Agent view</title>
<para>All the Agents can be accessed from the Operation menu. <para>
From here the status of the agents can be quickly reviewed thanks All the Agents can be accessed from the Operation menu. From
here the status of the agents can be quickly reviewed thanks
to a simple system of bulbs and coloured circles.</para> to a simple system of bulbs and coloured circles.</para>
<graphic fileref="images/image015.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image015.png" valign="bottom"
align="center"/>
<para>The list of agents shows all the relevant the information <para>
in the following columns:</para> The list of agents shows all the relevant the information
in the following columns:
</para>
<para><emphasis>Agent:</emphasis> Shows the agent's name.</para> <para><emphasis>Agent:</emphasis> Shows the agent's name.</para>
<para><emphasis>SO:</emphasis> Displays an icon that represents the <para><emphasis>SO:</emphasis> Displays an icon that represents the
Operating System.</para> Operating System.</para>
<para><emphasis>Interval:</emphasis> Shows the time interval (seconds) <para><emphasis>Interval:</emphasis> Shows the time interval (seconds)
in which the agent sends data to the server.</para> in which the agent sends data to the server.</para>
<para><emphasis>Group:</emphasis> This is the group the agent belongs to.</para>
<para><emphasis>Modules:</emphasis> Under normal circumstances this field
shows the values representing the number of modules and
the number of monitors, both in black. If the status of a monitor
changes to "incorrect", one additional number is shown: the number
of modules, the number of monitors and the number of monitors with
"incorrect" status, all in black save the last one.</para>
<para><emphasis>Status:</emphasis> Shows the "general" status of the agent
through the following icons:</para>
<para> <para>
<inlinegraphic fileref="images/b_green.png"/> <emphasis>Group:</emphasis> This is the group the agent belongs to.
</para>
<para>
<emphasis>Modules:</emphasis> Under normal circumstances this
field shows the values representing the number of modules and
the number of monitors, both in black. If the status of a
monitor changes to "incorrect", one additional number is
shown: the number of modules, the number of monitors and the
number of monitors with "incorrect" status, all in black save
the last one.
</para>
<para>
<emphasis>Status:</emphasis> Shows the "general" status of the agent
through the following icons:
</para>
<para>
<inlinegraphic scale='70' fileref="images/b_green.png"/>
All the monitors OK. It's the ideal status. All the monitors OK. It's the ideal status.
</para> </para>
<para> <para>
<inlinegraphic fileref="images/b_white.png"/> <inlinegraphic scale='70' fileref="images/b_white.png"/>
No defined monitors. Sometimes nothing is monitored No defined monitors. Sometimes nothing is monitored
that could be right or wrong, and only numeric or that could be right or wrong, and only numeric or
text data is reported. text data is reported.
</para> </para>
<para> <para>
<inlinegraphic fileref="images/b_red.png"/> <inlinegraphic scale='70' fileref="images/b_red.png"/>
At least one of the monitors is failing. Usually we At least one of the monitors is failing. Usually we
want to avoid this, and keep our systems in a healthy want to avoid this, and keep our systems in a healthy
green colour. green colour.
</para> </para>
<para> <para>
<inlinegraphic fileref="images/b_blue.png"/> The agent <inlinegraphic scale='70' fileref="images/b_blue.png"/> The agent
doesn't have any data. New agents with an empty data doesn't have any data. New agents with an empty data
package can have this status. package can have this status.
</para> </para>
<para> <para>
<inlinegraphic fileref="images/b_yellow.png"/> Colour <inlinegraphic scale='70' fileref="images/b_yellow.png"/> Colour
shifting from green to red. This icon indicates shifting from green to red. This icon indicates
that the agent has just changed its status, from that the agent has just changed its status, from
'All OK' to 'we have a problem'. 'All OK' to 'we have a problem'.
</para> </para>
<para> <para>
<inlinegraphic fileref="images/b_down.png"/> When an agent <inlinegraphic scale='70' fileref="images/b_down.png"/> When an agent
is down or there is no news from it for 2 times the Interval 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 value in seconds. Usually it is due to a communication issue
or a crashed remote system. or a crashed remote system.
@ -578,24 +716,24 @@
through the following icons: through the following icons:
</para> </para>
<para> <para>
<inlinegraphic fileref="images/dot_green.png"/> <inlinegraphic scale='70' fileref="images/dot_green.png"/>
No alerts have been sent. No alerts have been sent.
</para> </para>
<para> <para>
<inlinegraphic fileref="images/dot_red.png"/> <inlinegraphic scale='70' fileref="images/dot_red.png"/>
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
<inlinegraphic fileref="images/outof.png"/>, <inlinegraphic scale='70' fileref="images/outof.png"/>,
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
<inlinegraphic fileref="images/setup.png" width="15"/> <inlinegraphic scale='70' fileref="images/setup.png" 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.
@ -612,7 +750,7 @@
<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 scale='70' fileref="images/image016.png" valign="bottom" align="center"/>
</sect3> </sect3>
<sect3 id="sec3.3.2.2"> <sect3 id="sec3.3.2.2">
<title>Last data received</title> <title>Last data received</title>
@ -620,7 +758,7 @@
<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 scale='70' 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>
@ -641,30 +779,30 @@
<para>The generated graphs are:</para> <para>The generated graphs are:</para>
<para> - <emphasis>Hourly graph</emphasis> <para> - <emphasis>Hourly graph</emphasis>
(<inlinegraphic fileref="images/grafica_h.png"/>) (<inlinegraphic scale='70' fileref="images/grafica_h.png"/>)
covers a 60 minute interval</para> covers a 60 minute interval</para>
<graphic fileref="images/image018.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image018.png" valign="bottom" align="center"/>
<para> - <emphasis>Daily graph</emphasis> <para> - <emphasis>Daily graph</emphasis>
(<inlinegraphic fileref="images/grafica_d.png"/>) (<inlinegraphic scale='70' fileref="images/grafica_d.png"/>)
covers a 24 hour interval</para> covers a 24 hour interval</para>
<graphic fileref="images/image019.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image019.png" valign="bottom" align="center"/>
<para> - <emphasis>Weekly graph</emphasis> <para> - <emphasis>Weekly graph</emphasis>
(<inlinegraphic fileref="images/grafica_w.png"/>) (<inlinegraphic scale='70' fileref="images/grafica_w.png"/>)
covers a 7 day interval</para> covers a 7 day interval</para>
<graphic fileref="images/image020.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image020.png" valign="bottom" align="center"/>
<para> - <emphasis>Mothly graph</emphasis> <para> - <emphasis>Mothly graph</emphasis>
(<inlinegraphic fileref="images/grafica_m.png"/>) (<inlinegraphic scale='70' fileref="images/grafica_m.png"/>)
covers a 30 day interval</para> covers a 30 day interval</para>
<graphic fileref="images/image021.png" valign="bottom" align="center"/> <graphic scale='70' 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> - <inlinegraphic fileref="images/data_m.png"/> Last month</para> <para> - <inlinegraphic scale='70' fileref="images/data_m.png"/> Last month</para>
<para> - <inlinegraphic fileref="images/data_w.png"/> Last week</para> <para> - <inlinegraphic scale='70' fileref="images/data_w.png"/> Last week</para>
<para> - <inlinegraphic fileref="images/data_d.png"/> Last day</para> <para> - <inlinegraphic scale='70' fileref="images/data_d.png"/> Last day</para>
</sect3> </sect3>
<sect3 id="sec3.3.2.3"> <sect3 id="sec3.3.2.3">
<title>Complete list of monitors</title> <title>Complete list of monitors</title>
@ -672,7 +810,7 @@
<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 scale='70' 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>
@ -687,9 +825,9 @@
<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><inlinegraphic fileref="images/b_green.png"/> <para><inlinegraphic scale='70' fileref="images/b_green.png"/>
The monitor is OK</para> The monitor is OK</para>
<para><inlinegraphic fileref="images/b_red.png"/> <para><inlinegraphic scale='70' fileref="images/b_red.png"/>
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
@ -699,40 +837,61 @@
<sect3 id="sec3.3.2.4"> <sect3 id="sec3.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>
in the agent</para> This is the description of all the alarms defined in the
agent
</para>
<graphic fileref="images/image023.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image023.png"
valign="bottom" align="center"/>
<para>The monitor information is shown in the list <para>
divided in the following fields:</para> The monitor information is shown in the list divided in the
following fields:
<para><emphasis>ID:</emphasis> Agent were the alert has been defined.</para> </para>
<para><emphasis>Type:</emphasis> Type of alert.</para> <para>
<para><emphasis>Description:</emphasis> Description given to the alert when <emphasis>ID:</emphasis> Agent were the alert has been defined.
it was created.</para> </para>
<para><emphasis>Last fired:</emphasis> The last time the alert was <para>
executed.</para> <emphasis>Type:</emphasis> Type of alert.
<para><emphasis>Times Fired:</emphasis> Number of times the alert was </para>
launched.</para> <para>
<para><emphasis>Status:</emphasis> Shows if the alert has been sent through <emphasis>Description:</emphasis> Description given to the
the following icon:</para> alert when it was created.
</para>
<para><inlinegraphic fileref="images/dot_green.png"/> No alerts <para>
have been sent</para> <emphasis>Last fired:</emphasis> The last time the alert was
<para><inlinegraphic fileref="images/dot_red.png"/> At least executed.
one alert has been sent</para> </para>
<para>
<emphasis>Times Fired:</emphasis> Number of times the alert
was launched.
</para>
<para>
<emphasis>Status:</emphasis> Shows if the alert has been
sent through the following icon:
</para>
<para>
<inlinegraphic scale='70' fileref="images/dot_green.png"/>
No alerts have been sent
</para>
<para>
<inlinegraphic scale='70' fileref="images/dot_red.png"/> At
least one alert has been sent
</para>
</sect3> </sect3>
</sect2> </sect2>
<sect2 id="sec3.3.3"> <sect2 id="sec3.3.3">
<title>Group details</title> <title>Group details</title>
<para>
The groups configured in Pandora can be accessed through "View
Agents"&gt;"Group detail" in the Operation menu. The group
details can be reviewed quickly thanks to a system of coloured
bulbs.
</para>
<para>The groups configured in Pandora can be <graphic scale='70' fileref="images/image025.png"
accessed through "View Agents"&gt;"Group detail" in the valign="bottom" align="center"/>
Operation menu. The group details can be reviewed quickly thanks
to a system of coloured bulbs.</para>
<graphic fileref="images/image025.png" valign="bottom" align="center"/>
<para>The groups are displayed ordered by the following columns:</para> <para>The groups are displayed ordered by the following columns:</para>
@ -744,14 +903,14 @@
<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><inlinegraphic fileref="images/b_green.png"/> <para><inlinegraphic scale='70' fileref="images/b_green.png"/>
All monitors are OK.</para> All monitors are OK.</para>
<para><inlinegraphic fileref="images/b_red.png"/> <para><inlinegraphic scale='70' fileref="images/b_red.png"/>
At least one monitor has failed.</para> At least one monitor has failed.</para>
<para><inlinegraphic fileref="images/b_down.png"/> <para><inlinegraphic scale='70' fileref="images/b_down.png"/>
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><inlinegraphic fileref="images/b_white.png"/> <para><inlinegraphic scale='70' fileref="images/b_white.png"/>
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>
@ -760,41 +919,50 @@
</sect2> </sect2>
<sect2 id="sec3.3.4"> <sect2 id="sec3.3.4">
<title>Monitors view</title> <title>Monitors view</title>
<para>
<para>The description of all the monitors defined in the server The description of all the monitors defined in the server can
can be viewed from the "View Agents" &gt; "Monitor detail" be viewed from the "View Agents" &gt; "Monitor detail" option
option in the Operation menu.</para> in the Operation menu.
</para>
<graphic fileref="images/image026.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image026.png"
valign="bottom" align="center"/>
<para>In this list all the monitors appear in a similar way as <para>
in the individual view, but now they are shown all together. In this list all the monitors appear in a similar way as in
This allows a deeper analisys of each monitor.</para> the individual view, but now they are shown all together.
This allows a deeper analisys of each monitor.
</para>
</sect2> </sect2>
<sect2 id="sec3.3.5"> <sect2 id="sec3.3.5">
<title>Alert details</title> <title>Alert details</title>
<para>
The description of all the alerts defined in the server can be
viewed from the "View Agents" &gt; "Alert Details" option in
Operation menu.
</para>
<graphic scale='70' fileref="images/image027.png"
valign="bottom" align="center"/>
<para>The description of all the alerts defined in the server <para>
can be viewed from the "View Agents" &gt; "Alert Details" In this list all the alerts appear in a similar way as in the
option in Operation menu.</para> individual view, but now they are shown all together. This
allows a deeper analisys of each alert.
<graphic fileref="images/image027.png" valign="bottom" align="center"/> </para>
<para>In this list all the alerts appear in a similar way
as in the individual view, but now they are shown all together.
This allows a deeper analisys of each alert.</para>
</sect2> </sect2>
<sect2 id="sec3.3.6"> <sect2 id="sec3.3.6">
<title>Data Export</title> <title>Data Export</title>
<para>The Data Export tool can be found in the "View Agents" &gt; <para>
"Export data" option in the Operation Menu.</para> The Data Export tool can be found in the "View Agents" &gt;
"Export data" option in the Operation Menu.
</para>
<para>Three parameters need to be configured for exporting data: <para>
the agent where data resides, the modules to be exported Three parameters need to be configured for exporting data: the
and the date interval of the data to be exported:</para> agent where data resides, the modules to be exported and the
date interval of the data to be exported:
</para>
<graphic fileref="images/image028.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image028.png" valign="bottom" align="center"/>
<para>The fields in the results of Exporting data are:</para> <para>The fields in the results of Exporting data are:</para>
@ -803,14 +971,14 @@
<para><emphasis>Timestamp:</emphasis> Date and time of the the package <para><emphasis>Timestamp:</emphasis> Date and time of the the package
was sent by the agent.</para> was sent by the agent.</para>
<graphic fileref="images/image029.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image029.png" valign="bottom" align="center"/>
<para>Selecting the CSV format for the output, a text <para>Selecting the CSV format for the output, a text
file with extension <emphasis>.csv</emphasis> is be created. The data file with extension <emphasis>.csv</emphasis> is be created. The data
is qualified by single quotes is qualified by single quotes
and the fields separated by commas:</para> and the fields separated by commas:</para>
<graphic fileref="images/image030.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image030.png" valign="bottom" align="center"/>
</sect2> </sect2>
<sect2 id="sec3.3.7"> <sect2 id="sec3.3.7">
<title>Statistics</title> <title>Statistics</title>
@ -829,17 +997,24 @@
sends after each time interval</para> sends after each time interval</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<graphic fileref="images/image031.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image031.png"
<graphic fileref="images/image032.png" valign="bottom" align="center"/> valign="bottom" align="center"/>
<graphic fileref="images/image033.png" valign="bottom" align="center"/> <graphic scale='70' fileref="images/image032.png"
valign="bottom" align="center"/>
<graphic scale='70' fileref="images/image033.png"
valign="bottom" align="center"/>
</sect2> </sect2>
</sect1> </sect1>
<sect1 id="sec3.4"> <sect1 id="sec3.4">
<title>SNMP Console</title> <title>SNMP Console</title>
<para></para> <para>
THIS SECTION NEEDS TO BE WRITEN
</para>
<sect2 id="sec3.4.1"> <sect2 id="sec3.4.1">
<title>SNMP Alerts</title> <title>SNMP Alerts</title>
<para></para> <para>
THIS SECTION NEEDS TO BE WRITEN
</para>
</sect2> </sect2>
</sect1> </sect1>
</chapter> </chapter>

17208
pandora_doc/en/pandora_userguide.pdf Normal file
View File

File diff suppressed because one or more lines are too long

7
pandora_doc/en/pandora_userguide.xml
View File

@ -3,7 +3,7 @@
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY pandora_version "v1.2"> <!ENTITY pandora_version "v1.2">
<!ENTITY pandora "<emphasis>Pandora</emphasis>"> <!ENTITY pandora "<emphasis>Pandora</emphasis>">
<!ENTITY include_pandora_chapter1 SYSTEM "pandora_chapter1.xml"> <!ENTITY include_pandora_chapter1 SYSTEM "pandora_introduction.xml">
<!ENTITY include_pandora_chapter2 SYSTEM "pandora_chapter2.xml"> <!ENTITY include_pandora_chapter2 SYSTEM "pandora_chapter2.xml">
<!ENTITY include_pandora_chapter3 SYSTEM "pandora_chapter3.xml"> <!ENTITY include_pandora_chapter3 SYSTEM "pandora_chapter3.xml">
<!ENTITY include_pandora_chapter4 SYSTEM "pandora_chapter4.xml"> <!ENTITY include_pandora_chapter4 SYSTEM "pandora_chapter4.xml">
@ -45,6 +45,11 @@
</para> </para>
</legalnotice> </legalnotice>
<revhistory> <revhistory>
<revision>
<revnumber>1.1</revnumber>
<date>10 October 2006</date>
<revremark>Submitted.</revremark>
</revision>
<revision> <revision>
<revnumber>1.0</revnumber> <revnumber>1.0</revnumber>
<date>11 Sept 2006</date> <date>11 Sept 2006</date>