diff --git a/pandora_doc/en/pandora_chapter3.xml b/pandora_doc/en/pandora_chapter3.xml
index f7ce0f936f..eccccf521f 100644
--- a/pandora_doc/en/pandora_chapter3.xml
+++ b/pandora_doc/en/pandora_chapter3.xml
@@ -4,17 +4,36 @@
Agents
- The agents collect information. The public key
- of the machine to be monitored needs to be copied onto Pandora and the agent
- executed. Pandora's server starts now receiving and processing the data
- collected by the agent. The data collected from the agents are called "modules".
+
+ The agents collect information. They could be a "real" agent,
+ based on a software agent, or a network agent, a non-physical
+ agent, witout need of installing any software, that execute
+ network tasks in Pandora Network servers, and showing information
+ on console inside an Agent.
+
+
+ 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.
+
+
+ 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.
+
+
+ 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.
+
- The value of each module it 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.
-
- The user can:
+ With Pandora Console, user is capable to:
@@ -32,92 +51,107 @@
Configure Alerts
+
+
+ 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).
+
+
+
+
+ Export tabular data in CSV format.
+
+
Group Manager
- Groups are added in "Manage Profiles" > "Manage Groups",
- Administration menu.
+
+ Pandora groups are common to agents, incidents and
+ profiles. Groups are added in "Manage Profiles" > "Manage
+ Groups", Administration menu.
+
-
+
- There are nine default groups on this screen.
+ 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.
-
-
- Applications
-
-
- Comms
-
-
- Databases
-
-
- Firewall
-
-
- IDS
-
-
- Others
-
-
- Servers
-
-
- Workstations
-
-
-
- A group is added by clicking "Create group" and assigning
- a name to it.
- A group is deleted by clicking the delete icon
-
- in the right hand side of each group.
+
+ A group is added by clicking "Create group" and assigning a name
+ to it.
+
+
+ A group is deleted by clicking the delete icon
+
+ in the right hand side of each group.
+
Adding an agent
+
+ 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.
+
+
+ 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.
+
+
+ An agent is added in "Manage Agents" > "Create agent" in the
+ Administration menu.
+
- Before an agent is added, the public key of the
- 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.
+
- An agent is added in "Manage Agents" > "Create agent" in the Administration menu.
-
-
-
- To add a new agent the following parameters must be configured:
+
+ To add a new agent the following parameters must be
+ configured:
+
Agent Name: Name of the agent. This and
the "agent name" parameter in Pandora's agent.conf file
- must have the same value. If this
- variable is commented out in the code, the name used will be
- the name of the Host (to obtain this, execute the hostname
- command).
+ must have the same value. By default
+ agent takes hostname of the machine where it's running.
-
IP Address: 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.
- Group: Pandora's group the agent belongs.
+ Group: Pandora's group the agent
+ belongs. In this version of Pandora, an agent only can
+ belong to a group.
Interval: 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.
@@ -125,7 +159,7 @@
OS: The Operating System to be
monitored. The supported Operating Systems are: AIX, BeOS,
BSD, Cisco, HPUX, Linux, MacOS, Other, Solaris,
- Windows.
+ Windows.
@@ -141,15 +175,16 @@
- - Learning mode: All the modules sent by
- the agent are accepted. They are automatically defined by the
- system. It is recommended to activate the agents in this mode
- and change it once the user is familiar with the system.
+ Learning mode: All the modules sent
+ by the agent are accepted. If modules are not defined, they
+ are automatically defined by the system. It is recommended
+ to activate the agents in this mode and change it once the
+ user is familiar with the system.
- - Normal mode: The modules in this mode
+ Normal mode: The modules in this mode
must be configured manually. The self definition of the
modules is not allowed in this mode.
@@ -183,34 +218,98 @@
agent name is clicked. In the same screen there is a section to
assign modules.
-
-
- The following fields must be filled to create a
- module:
+
+
+ A Pandora module could be from different types:
+
+
+
+ generic_data, numeric data type.
+
+
- Module type: This is the type of data
- the module will process. There are five types of data:
+ generic_data_inc, incremental
+ numerical data type. It stores data resulting from
+ difference between last agent data and actual data.
-
-
- - generic_data>, Integer data type -
- generic_data_inc, Incremental integer
- data type - generic_data_proc, Boolean
- data type: 0 False, >0 True -
- generic_data_string, Alphanumeric data
- type (text string, max. 255 characters)
-
-
-
- Module name: The name of the module
+ generic_data_proc, 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.
+
+
+ generic_data_string, Alphanumeric data
+ type (text string, max. 255 characters).
+
+
+
+
+
+ generic_icmp get network latency in
+ miliseconds for remote system.
+
+
+
+
+
+ generic_icmp_proc, makes a "ping" to
+ remote system. Report 0 if system is not reachable or not
+ responding.
+
+
+
+
+
+ generic_tcp_proc, 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).
+
+
+
+
+
+ generic_tcp_data, generic_tcp_string,
+ generic_tcp_inc, gets numerical data, string
+ data or incremental data from TCP open port. If cannot
+ connect, no value returned.
+
+
+
+
+ generic_snmp types: 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.
+
+
+
+
+ generic_ucp_proc, makes a "udp" ping
+ to remote systems and reports "1" if a listing port is
+ responding and 0 if are not responding.
+
+
+
+
+ Pandora modules have some other fields that modify their behaviour:
+
+
Maximum: Upper threshold for the
@@ -233,27 +332,40 @@
-
+
+ Aditionally if you are defining a network module, you also
+ have more fields related to Network options:
+
+
+
+
+
+
+
+
All the modules to be monitored by an agent can be reviewed by
accessing the agent in the "Manage Agents" option,
Administration menu.
-
-
-
+
+
+
In this screen the modules can be:
- Deleted by clicking
+ Deleted by clicking
- Edited by clicking
+ Edited by clicking
@@ -263,339 +375,365 @@
- Alerts
-
-
- 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
- the administrator, sending a SNMP trap, write the incident
- into the system syslog or Pandora log file, etc. And basically
- anything that can be triggered by a script configured in
- Pandora's Operating System.
-
-
- Adding an Alert
-
-
- The existing Alerts are accessed by clicking on the "Manage
- Alerts" option, Administration menu.
-
- There are 6 default types of Alerts:
-
-
-
-
- eMail. Sends an e-mail from Pandora's Server
-
-
-
-
- Internal audit. Writes the incident
- in Pandora's internal audit system
-
-
-
- LogFile. Writes the incident in the log file
-
-
- SMS Text. Sends an SMS to a given mobile phone
-
-
- SNMP Trap. Sends a SNMP Trap
-
-
- Syslog. Sends an alert to the Syslog
-
-
-
-
-
-
- An Alert is deleted by clicking on the delete icon
-
- placed on the right hand side of the Alert.
- A new customised Alert can be created clicking in "Create Alert".
-
-
- 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.
-
-
-
-
- When a new Alert is created the following field must be filled in:
-
-
- Alert name: The name of the Alert
-
-
- Command: Command the Alert will trigger
-
-
- Description: Description of the Alert
-
-
-
-
- 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:
-
-
-
-
- _field1_:
- Field #1, usually assigned as username,
- e-mail destination or single identification for this event
-
-
-
- _field2_:
- Field #2, usually assigned as short
- description of events, as subject line in e-mail
-
-
-
- _field3_:
- Field #3, a full text explanation
- for the event
-
-
- >_agent_: Agent name
-
-
- _timestamp_:
- A standard representation of date and time.
- Replaced automatically when the event has been fired
-
-
-
- _data_: The data value that triggered the alert
-
-
-
-
- Assigning Alerts
-
-
- 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.
-
-
-
- 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.
-
-
-
-
- To assign an Alert the next fields must be filled in:
-
-
-
- Alert type:
- This can be selected from the list of alerts that have
- been previously generated.
-
-
-
- Maximum Value:
- Defines the maximum value for a module. Any value above that
- threshold will trigger the Alert.
-
-
-
- Minimum Value:
- Defines the minimum value for a module. Any value below that
- will trigger the Alert.
-
-
-
- Description:
- Describes the function of the Alert, and it is useful to identify
- the Alert amongst the others in the Alert General View.
-
-
-
- Field #1 (Alias, name):
- Define the used value for the "_field1_" variable.
-
-
- Field #2 (Single Line):
- Define the used value for the "_field2_" variable.
-
-
- Field #3 (Full Text):
- Define the used value for the "_field3_" variable.
-
-
- Time threshold:
- Minimum duration between the firing of two consecutive alerts,
- in seconds.
-
-
-
- Max Alerts Fired:
- Maximun number of alerts that can be sent consecutively.
-
-
- Assigned module:
- Module to be motitorized by the alert.
-
-
-
- All the alerts of an agent can be seen through "Manage Agents"
- in the Adminitration menu and selecting the agent.
-
+ Alerts
+
+
+ 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
+ the administrator, sending a SNMP trap, write the incident
+ into the system syslog or Pandora log file, etc. And basically
+ anything that can be triggered by a script configured in
+ Pandora's Operating System.
+
+
+ Adding an Alert
+
+
+ The existing Alerts are accessed by clicking on the "Manage
+ Alerts" option, Administration menu.
+
+ There are 6 default types of Alerts:
+
+
+
+
+ eMail. Sends an e-mail from Pandora's Server
+
+
+
+
+ Internal audit. Writes the incident
+ in Pandora's internal audit system
+
+
+
+ LogFile. Writes the incident in the log file
+
+
+ SMS Text. Sends an SMS to a given mobile phone
+
+
+ SNMP Trap. Sends a SNMP Trap
+
+
+ Syslog. Sends an alert to the Syslog
+
+
+
+
+
+
+ An Alert is deleted by clicking on the delete icon
+
+ placed on the right hand side of the Alert.
+ A new customised Alert can be created clicking in "Create Alert".
+
+
+ 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.
+
+
+
+
+ When a new Alert is created the following field must be filled in:
+
+
+ Alert name: The name of the Alert
+
+
+ Command: Command the Alert will trigger
+
+
+ Description: Description of the Alert
+
+
+
+
+ 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:
+
+
+
+
+ _field1_:
+ Field #1, usually assigned as username,
+ e-mail destination or single identification for this event
+
+
+
+ _field2_:
+ Field #2, usually assigned as short
+ description of events, as subject line in e-mail
+
+
+
+ _field3_:
+ Field #3, a full text explanation
+ for the event
+
+
+ >_agent_: Agent name
+
+
+ _timestamp_:
+ A standard representation of date and time.
+ Replaced automatically when the event has been fired
+
+
+
+ _data_: The data value that triggered the alert
+
+
+
+
+ Assigning Alerts
+
+
+ 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.
+
+
+
+ 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.
+
+
+
+
+ To assign an Alert the next fields must be filled in:
+
+
+
+ Alert type:
+ This can be selected from the list of alerts that have
+ been previously generated.
+
+
+
+ Maximum Value:
+ Defines the maximum value for a module. Any value above that
+ threshold will trigger the Alert.
+
+
+
+ Minimum Value:
+ Defines the minimum value for a module. Any value below that
+ will trigger the Alert.
+
+
+
+ Description:
+ Describes the function of the Alert, and it is useful to identify
+ the Alert amongst the others in the Alert General View.
+
+
+
+ Field #1 (Alias, name):
+ Define the used value for the "_field1_" variable.
+
+
+ Field #2 (Single Line):
+ Define the used value for the "_field2_" variable.
+
+
+ Field #3 (Full Text):
+ Define the used value for the "_field3_" variable.
+
+
+ Time threshold:
+ Minimum duration between the firing of two consecutive alerts,
+ in seconds.
+
+
+
+ Max Alerts Fired:
+ Maximun number of alerts that can be sent consecutively.
+
+
+ Assigned module:
+ Module to be motitorized by the alert.
+
+
+
+ All the alerts of an agent can be seen through "Manage Agents"
+ in the Adminitration menu and selecting the agent.
+
Agent module and agent's alert management
-
+
It might happen that the user finds that modules and alerts
configured for an agent would be repeated in a new agent.
-
+
In order to simplify the administrator's job Pandora offers
the option of copying modules and alerts defined in an agent to be
assigned to another.
-
+
The screen is accessed through "Manage Agents" >
"Manage Config.", in the Administration menu:
-
-
-
- The Source Agent menu permits the selection of the agent
- where the needed modules and/or alerts reside. The "Get Info"
- button shows the modules for that agent in the Modules list box.
+
+
+
+
+ Source Agent menu permits the selection of the agent where the
+ needed modules and/or alerts reside. The "Get Info" button
+ shows the modules for that agent in the Modules list box.
- The copy process is performed to copy
- the module and/or alert configuration from the selected source
- agents to the selected destination agents. Several agents can be
- selected, pressing CTRL and the mouse right button 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.
+
+ Copy process is performed to copy the
+ module and/or alert configuration from the selected source
+ agents to the selected destination agents. Several agents can
+ be selected, pressing CTRL and the mouse right button
+ 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.
- The delete process is performed to delete the
- configuration of the destination agents, in the multiple selection
- list box. Several agents can be selected at a time, and the tick
- boxes at the top of the form indicate whether it is the modules
- or the alerts configuration what is to be deleted. The
- application will prompt to confirm the deletion, as once
- deletion is performed, the data associated to them will also be
- deleted.
+
+ Deletion process is performed to delete
+ the configuration of the destination agents, in the multiple
+ selection list box. Several agents can be selected at a time,
+ and the tick boxes at the top of the form indicate whether it
+ is the modules or the alerts configuration what is to be
+ deleted. The application will prompt to confirm the deletion,
+ as once deletion is performed, the data associated to them
+ will also be deleted.
+
Agents group detail
+
+
+ Once you have configured your groups and agents, you can see
+ the status of the groups of agents through "View Agents", in
+ the Operation Menu.
+
+
+
+ If you pass the mouse over any group image, you'll see the
+ number of agents of that group as well the number of monitors,
+ organized by status.
+
- Once you have configured your groups and agents, you can
- see the status of the groups of agents through "View Agents",
- in the Operation Menu.
-
- If you pass the mouse over any group image, you'll see
- the number of agents of that group as well the number of monitors,
- organized by status.
-
- By pressing the icon
-
- at the right of any group image, you will update the info of
- that group.
+
+ By pressing the icon
+
+ at the right of any group image, you will update the info of
+ that group.
+
Agent monitoring
-
- 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
- accessed from the Web console, either as row data or as graphs.
+
+
+ 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
+ accessed from the Web console, either as row data or as
+ graphs.
Agent view
- 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.
+
+ 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.
-
+
- The list of agents shows all the relevant the information
- in the following columns:
+
+ The list of agents shows all the relevant the information
+ in the following columns:
+
Agent: Shows the agent's name.
SO: Displays an icon that represents the
Operating System.
Interval: Shows the time interval (seconds)
in which the agent sends data to the server.
- Group: This is the group the agent belongs to.
- Modules: 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.
- Status: Shows the "general" status of the agent
- through the following icons:
-
- All the monitors OK. It's the ideal status.
-
-
-
- No defined monitors. Sometimes nothing is monitored
- that could be right or wrong, and only numeric or
- text data is reported.
-
-
-
- At least one of the monitors is failing. Usually we
- want to avoid this, and keep our systems in a healthy
- green colour.
-
-
- The agent
- doesn't have any data. New agents with an empty data
- package can have this status.
-
-
- 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'.
-
-
- 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.
-
+ Group: This is the group the agent belongs to.
+
+
+ Modules: 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.
+
+
+ Status: Shows the "general" status of the agent
+ through the following icons:
+
+
+
+ All the monitors OK. It's the ideal status.
+
+
+
+ No defined monitors. Sometimes nothing is monitored
+ that could be right or wrong, and only numeric or
+ text data is reported.
+
+
+
+ At least one of the monitors is failing. Usually we
+ want to avoid this, and keep our systems in a healthy
+ green colour.
+
+
+ The agent
+ doesn't have any data. New agents with an empty data
+ package can have this status.
+
+
+ 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'.
+
+
+ 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.
+
Alerts: Shows if any alerts have been sent
through the following icons:
-
+
-
+
No alerts have been sent.
-
-
-
+
+
+
When at least one alert has been sent within
the time threshold of the alert.
Last contact: Shows the time and date of the
last data package sent by the agent, using a progress bar,
according to value of the interval. If you see the image
- ,
+ ,
the agent has not send data during the interval.
Passing the mouse over the image will show you the last contact
in time and date format.
Note: The icon
-
+
is only visible if you're and administrator and it's a link
to the "Manage Agents" > "Update Agent" option in the
Administration menu.
@@ -603,137 +741,158 @@
Accessing the data of an agent
-
+
When an agent is accessed, by clicking on its name, all the
information related to that agent is displayed.
- Agent general info
-
- This shows the data introduced when the agent was created
- and the total number a data packages the agent has sent.
-
-
+ Agent general info
+
+ This shows the data introduced when the agent was created
+ and the total number a data packages the agent has sent.
+
+
- Last data received
-
- This is the description of all the agent modules
- been monitored.
-
-
-
- In this list the module information is shown
- in the following columns:
-
- Module name: Name given to the module
- in the agent's config file.
- Module type: Type of module as described
- in Asigning Modules section.
- Description: Description given to the module
- in the agent's config file.
- Data: Last data sent by the agent.
- Graph: Monthly(M), Weekly(W), Daily(D)
- and Hourly(H) graphs are generated with
- the data sent by the agent against time.
-
- On the left hand side of the graph the newst
- data is represent, and on the right had side the oldest.
-
- The generated graphs are:
- - Hourly graph
- ()
- covers a 60 minute interval
-
-
- - Daily graph
- ()
- covers a 24 hour interval
-
-
- - Weekly graph
- ()
- covers a 7 day interval
-
-
- - Mothly graph
- ()
- covers a 30 day interval
-
-
- Raw Data: This is the raw data sent by the agent
-
- - Last month
- - Last week
- - Last day
+ Last data received
+
+ This is the description of all the agent modules
+ been monitored.
+
+
+
+ In this list the module information is shown
+ in the following columns:
+
+ Module name: Name given to the module
+ in the agent's config file.
+ Module type: Type of module as described
+ in Asigning Modules section.
+ Description: Description given to the module
+ in the agent's config file.
+ Data: Last data sent by the agent.
+ Graph: Monthly(M), Weekly(W), Daily(D)
+ and Hourly(H) graphs are generated with
+ the data sent by the agent against time.
+
+ On the left hand side of the graph the newst
+ data is represent, and on the right had side the oldest.
+
+ The generated graphs are:
+ - Hourly graph
+ ()
+ covers a 60 minute interval
+
+
+ - Daily graph
+ ()
+ covers a 24 hour interval
+
+
+ - Weekly graph
+ ()
+ covers a 7 day interval
+
+
+ - Mothly graph
+ ()
+ covers a 30 day interval
+
+
+ Raw Data: This is the raw data sent by the agent
+
+ - Last month
+ - Last week
+ - Last day
- Complete list of monitors
-
- This is the description of all the monitors defined by
- the agent
-
-
-
- The list shows the information about the monitors in the
- following columns:
-
- Agent: Agent where the monitor is defined.
- Type: Data type of the monitor. For a monitor this
- value is always of the generic_proc type.
- Module name: Name given to the module when it was
- created.
- Description: Description given to the module
- in the agent's config file.
- Status: The table shows the agent status through
- the following icons:
-
-
- The monitor is OK
-
- The monitor is failing
-
- Last contact: Shows the time and date of
- the last data packaged received from the agent
-
+ Complete list of monitors
+
+ This is the description of all the monitors defined by
+ the agent
+
+
+
+ The list shows the information about the monitors in the
+ following columns:
+
+ Agent: Agent where the monitor is defined.
+ Type: Data type of the monitor. For a monitor this
+ value is always of the generic_proc type.
+ Module name: Name given to the module when it was
+ created.
+ Description: Description given to the module
+ in the agent's config file.
+ Status: The table shows the agent status through
+ the following icons:
+
+
+ The monitor is OK
+
+ The monitor is failing
+
+ Last contact: Shows the time and date of
+ the last data packaged received from the agent
+
- Complete list of alerts
-
- This is the description of all the alarms defined
- in the agent
-
-
-
- The monitor information is shown in the list
- divided in the following fields:
-
- ID: Agent were the alert has been defined.
- Type: Type of alert.
- Description: Description given to the alert when
- it was created.
- Last fired: The last time the alert was
- executed.
- Times Fired: Number of times the alert was
- launched.
- Status: Shows if the alert has been sent through
- the following icon:
-
- No alerts
- have been sent
- At least
- one alert has been sent
+ Complete list of alerts
+
+
+ This is the description of all the alarms defined in the
+ agent
+
+
+
+
+
+ The monitor information is shown in the list divided in the
+ following fields:
+
+
+ ID: Agent were the alert has been defined.
+
+
+ Type: Type of alert.
+
+
+ Description: Description given to the
+ alert when it was created.
+
+
+ Last fired: The last time the alert was
+ executed.
+
+
+ Times Fired: Number of times the alert
+ was launched.
+
+
+ Status: Shows if the alert has been
+ sent through the following icon:
+
+
+
+ No alerts have been sent
+
+
+ At
+ least one alert has been sent
+
Group details
+
+ The groups configured in Pandora can be accessed through "View
+ Agents">"Group detail" in the Operation menu. The group
+ details can be reviewed quickly thanks to a system of coloured
+ bulbs.
+
- The groups configured in Pandora can be
- accessed through "View Agents">"Group detail" in the
- Operation menu. The group details can be reviewed quickly thanks
- to a system of coloured bulbs.
-
-
-
+
+
The groups are displayed ordered by the following columns:
Groups: Name of the group
@@ -743,58 +902,67 @@
in the group.
Status: The status is described through
the following icons:
-
-
+
+
All monitors are OK.
-
+
At least one monitor has failed.
-
+
At least one monitor is down and there is no contact
with it.
-
+
This Agent doesn't have any monitor defined.
-
+
OK: Number of monitors that are OK.
Failed: Number of failing monitors.
Down: Number of down monitors.
Monitors view
-
- The description of all the monitors defined in the server
- can be viewed from the "View Agents" > "Monitor detail"
- option in the Operation menu.
-
-
-
- In this list all the monitors appear in a similar way as
- in the individual view, but now they are shown all together.
- This allows a deeper analisys of each monitor.
+
+ The description of all the monitors defined in the server can
+ be viewed from the "View Agents" > "Monitor detail" option
+ in the Operation menu.
+
+
+
+ In this list all the monitors appear in a similar way as in
+ the individual view, but now they are shown all together.
+ This allows a deeper analisys of each monitor.
+
Alert details
+
+ The description of all the alerts defined in the server can be
+ viewed from the "View Agents" > "Alert Details" option in
+ Operation menu.
+
+
- The description of all the alerts defined in the server
- can be viewed from the "View Agents" > "Alert Details"
- option in Operation menu.
-
-
-
- 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.
+
+ 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.
+
Data Export
- The Data Export tool can be found in the "View Agents" >
- "Export data" option in the Operation Menu.
+
+ The Data Export tool can be found in the "View Agents" >
+ "Export data" option in the Operation Menu.
+
- Three parameters need to be configured for exporting data:
- the agent where data resides, the modules to be exported
- and the date interval of the data to be exported:
+
+ Three parameters need to be configured for exporting data: the
+ agent where data resides, the modules to be exported and the
+ date interval of the data to be exported:
+
-
+
The fields in the results of Exporting data are:
@@ -803,14 +971,14 @@
Timestamp: Date and time of the the package
was sent by the agent.
-
+
Selecting the CSV format for the output, a text
file with extension .csv is be created. The data
is qualified by single quotes
and the fields separated by commas:
-
+
Statistics
@@ -829,17 +997,24 @@
sends after each time interval
-
-
-
+
+
+
SNMP Console
-
+
+ THIS SECTION NEEDS TO BE WRITEN
+
SNMP Alerts
-
+
+ THIS SECTION NEEDS TO BE WRITEN
+
diff --git a/pandora_doc/en/pandora_userguide.pdf b/pandora_doc/en/pandora_userguide.pdf
new file mode 100644
index 0000000000..ec820e8834
--- /dev/null
+++ b/pandora_doc/en/pandora_userguide.pdf
@@ -0,0 +1,17208 @@
+%PDF-1.4
+1 0 obj
+<< /S /GoTo /D (1.0) >>
+endobj
+4 0 obj
+(Pandora v1.2)
+endobj
+5 0 obj
+<< /S /GoTo /D (2.0) >>
+endobj
+8 0 obj
+(Table of Contents)
+endobj
+9 0 obj
+<< /S /GoTo /D (3.0) >>
+endobj
+12 0 obj
+(Chapter 1. Introduction to Pandora)
+endobj
+13 0 obj
+<< /S /GoTo /D (3.1.1) >>
+endobj
+16 0 obj
+(1.1. Pandora. The Free monitoring system)
+endobj
+17 0 obj
+<< /S /GoTo /D (3.2.1) >>
+endobj
+20 0 obj
+(1.2. Introducing Pandora.)
+endobj
+21 0 obj
+<< /S /GoTo /D (3.3.1) >>
+endobj
+24 0 obj
+(1.3. What kind of systems/ services can be monitored?)
+endobj
+25 0 obj
+<< /S /GoTo /D (3.3.1.2) >>
+endobj
+28 0 obj
+(1.3.1. Global architecture)
+endobj
+29 0 obj
+<< /S /GoTo /D (3.4.1) >>
+endobj
+32 0 obj
+(1.4. Information gathering with Pandora agents)
+endobj
+33 0 obj
+<< /S /GoTo /D (3.4.2.2) >>
+endobj
+36 0 obj
+(1.4.1. XML Data files)
+endobj
+37 0 obj
+<< /S /GoTo /D (3.4.3.2) >>
+endobj
+40 0 obj
+(1.4.2. Pandora servers)
+endobj
+41 0 obj
+<< /S /GoTo /D (3.4.4.2) >>
+endobj
+44 0 obj
+(1.4.3. Pandora console)
+endobj
+45 0 obj
+<< /S /GoTo /D (3.4.5.2) >>
+endobj
+48 0 obj
+(1.4.4. Pandora database)
+endobj
+49 0 obj
+<< /S /GoTo /D (3.4.5.1.3) >>
+endobj
+52 0 obj
+(1.4.4.1. Compacting data)
+endobj
+53 0 obj
+<< /S /GoTo /D (3.5.1) >>
+endobj
+56 0 obj
+(1.5. Pandora 1.2 new features)
+endobj
+57 0 obj
+<< /S /GoTo /D (3.6.1) >>
+endobj
+60 0 obj
+(1.6. About Pandora)
+endobj
+61 0 obj
+<< /S /GoTo /D (4.0) >>
+endobj
+64 0 obj
+(Chapter 2. Users)
+endobj
+65 0 obj
+<< /S /GoTo /D (4.7.1) >>
+endobj
+68 0 obj
+(2.1. Profile manager)
+endobj
+69 0 obj
+<< /S /GoTo /D (4.8.1) >>
+endobj
+72 0 obj
+(2.2. Adding a user)
+endobj
+73 0 obj
+<< /S /GoTo /D (4.9.1) >>
+endobj
+76 0 obj
+(2.3. Deleting a user)
+endobj
+77 0 obj
+<< /S /GoTo /D (4.10.1) >>
+endobj
+80 0 obj
+(2.4. Statistics)
+endobj
+81 0 obj
+<< /S /GoTo /D (4.11.1) >>
+endobj
+84 0 obj
+(2.5. Messages to users)
+endobj
+85 0 obj
+<< /S /GoTo /D (4.11.6.2) >>
+endobj
+88 0 obj
+(2.5.1. Messages to groups)
+endobj
+89 0 obj
+<< /S /GoTo /D (5.0) >>
+endobj
+92 0 obj
+(Chapter 3. Agents)
+endobj
+93 0 obj
+<< /S /GoTo /D (5.12.1) >>
+endobj
+96 0 obj
+(3.1. Group Manager)
+endobj
+97 0 obj
+<< /S /GoTo /D (5.13.1) >>
+endobj
+100 0 obj
+(3.2. Adding an agent)
+endobj
+101 0 obj
+<< /S /GoTo /D (5.13.7.2) >>
+endobj
+104 0 obj
+(3.2.1. Assigning modules)
+endobj
+105 0 obj
+<< /S /GoTo /D (5.13.8.2) >>
+endobj
+108 0 obj
+(3.2.2. Alerts)
+endobj
+109 0 obj
+<< /S /GoTo /D (5.13.8.2.3) >>
+endobj
+112 0 obj
+(3.2.2.1. Adding an Alert)
+endobj
+113 0 obj
+<< /S /GoTo /D (5.13.8.3.3) >>
+endobj
+116 0 obj
+(3.2.2.2. Assigning Alerts)
+endobj
+117 0 obj
+<< /S /GoTo /D (5.13.9.2) >>
+endobj
+120 0 obj
+(3.2.3. Agent module and agent's alert management)
+endobj
+121 0 obj
+<< /S /GoTo /D (5.13.10.2) >>
+endobj
+124 0 obj
+(3.2.4. Agents group detail)
+endobj
+125 0 obj
+<< /S /GoTo /D (5.14.1) >>
+endobj
+128 0 obj
+(3.3. Agent monitoring)
+endobj
+129 0 obj
+<< /S /GoTo /D (5.14.11.2) >>
+endobj
+132 0 obj
+(3.3.1. Agent view)
+endobj
+133 0 obj
+<< /S /GoTo /D (5.14.12.2) >>
+endobj
+136 0 obj
+(3.3.2. Accessing the data of an agent)
+endobj
+137 0 obj
+<< /S /GoTo /D (5.14.12.4.3) >>
+endobj
+140 0 obj
+(3.3.2.1. Agent general info)
+endobj
+141 0 obj
+<< /S /GoTo /D (5.14.12.5.3) >>
+endobj
+144 0 obj
+(3.3.2.2. Last data received)
+endobj
+145 0 obj
+<< /S /GoTo /D (5.14.12.6.3) >>
+endobj
+148 0 obj
+(3.3.2.3. Complete list of monitors)
+endobj
+149 0 obj
+<< /S /GoTo /D (5.14.12.7.3) >>
+endobj
+152 0 obj
+(3.3.2.4. Complete list of alerts)
+endobj
+153 0 obj
+<< /S /GoTo /D (5.14.13.2) >>
+endobj
+156 0 obj
+(3.3.3. Group details)
+endobj
+157 0 obj
+<< /S /GoTo /D (5.14.14.2) >>
+endobj
+160 0 obj
+(3.3.4. Monitors view)
+endobj
+161 0 obj
+<< /S /GoTo /D (5.14.15.2) >>
+endobj
+164 0 obj
+(3.3.5. Alert details)
+endobj
+165 0 obj
+<< /S /GoTo /D (5.14.16.2) >>
+endobj
+168 0 obj
+(3.3.6. Data Export)
+endobj
+169 0 obj
+<< /S /GoTo /D (5.14.17.2) >>
+endobj
+172 0 obj
+(3.3.7. Statistics)
+endobj
+173 0 obj
+<< /S /GoTo /D (5.15.1) >>
+endobj
+176 0 obj
+(3.4. SNMP Console)
+endobj
+177 0 obj
+<< /S /GoTo /D (5.15.18.2) >>
+endobj
+180 0 obj
+(3.4.1. SNMP Alerts)
+endobj
+181 0 obj
+<< /S /GoTo /D (6.0) >>
+endobj
+184 0 obj
+(Chapter 4. Incident management)
+endobj
+185 0 obj
+<< /S /GoTo /D (6.16.1) >>
+endobj
+188 0 obj
+(4.1. Adding an incident)
+endobj
+189 0 obj
+<< /S /GoTo /D (6.17.1) >>
+endobj
+192 0 obj
+(4.2. Incident follow up)
+endobj
+193 0 obj
+<< /S /GoTo /D (6.17.19.2) >>
+endobj
+196 0 obj
+(4.2.1. Adding comments to an incident)
+endobj
+197 0 obj
+<< /S /GoTo /D (6.17.20.2) >>
+endobj
+200 0 obj
+(4.2.2. Attaching files to an incident)
+endobj
+201 0 obj
+<< /S /GoTo /D (6.18.1) >>
+endobj
+204 0 obj
+(4.3. Searching for an incident)
+endobj
+205 0 obj
+<< /S /GoTo /D (6.19.1) >>
+endobj
+208 0 obj
+(4.4. Statistics)
+endobj
+209 0 obj
+<< /S /GoTo /D (7.0) >>
+endobj
+212 0 obj
+(Chapter 5. Events)
+endobj
+213 0 obj
+<< /S /GoTo /D (7.20.1) >>
+endobj
+216 0 obj
+(5.1. Statistics)
+endobj
+217 0 obj
+<< /S /GoTo /D (8.0) >>
+endobj
+220 0 obj
+(Chapter 6. System audit)
+endobj
+221 0 obj
+<< /S /GoTo /D (8.21.1) >>
+endobj
+224 0 obj
+(6.1. Statistics)
+endobj
+225 0 obj
+<< /S /GoTo /D (9.0) >>
+endobj
+228 0 obj
+(Chapter 7. Pandora Servers)
+endobj
+229 0 obj
+<< /S /GoTo /D (10.0) >>
+endobj
+232 0 obj
+(Chapter 8. Database Maintenance)
+endobj
+233 0 obj
+<< /S /GoTo /D (10.22.1) >>
+endobj
+236 0 obj
+(8.1. DB Information)
+endobj
+237 0 obj
+<< /S /GoTo /D (10.23.1) >>
+endobj
+240 0 obj
+(8.2. Manual purge of the Datadase)
+endobj
+241 0 obj
+<< /S /GoTo /D (10.24.1) >>
+endobj
+244 0 obj
+(8.3. Agent's data purge)
+endobj
+245 0 obj
+<< /S /GoTo /D (10.24.21.2) >>
+endobj
+248 0 obj
+(8.3.1. Debuging selected data from a module)
+endobj
+249 0 obj
+<< /S /GoTo /D (10.24.22.2) >>
+endobj
+252 0 obj
+(8.3.2. Purging all the agent's data)
+endobj
+253 0 obj
+<< /S /GoTo /D (10.25.1) >>
+endobj
+256 0 obj
+(8.4. Purging system data)
+endobj
+257 0 obj
+<< /S /GoTo /D (10.25.23.2) >>
+endobj
+260 0 obj
+(8.4.1. Audit data purge)
+endobj
+261 0 obj
+<< /S /GoTo /D (10.25.24.2) >>
+endobj
+264 0 obj
+(8.4.2. Event data purge)
+endobj
+265 0 obj
+<< /S /GoTo /D (11.0) >>
+endobj
+268 0 obj
+(Chapter 9. Pandora Configuration)
+endobj
+269 0 obj
+<< /S /GoTo /D (11.26.1) >>
+endobj
+272 0 obj
+(9.1. Links)
+endobj
+273 0 obj
+<< /S /GoTo /D (12.0) >>
+endobj
+276 0 obj
+(Appendix A. GNU Free Documentation License)
+endobj
+277 0 obj
+<< /S /GoTo /D (12.27.1) >>
+endobj
+280 0 obj
+(A.1. 0. PREAMBLE)
+endobj
+281 0 obj
+<< /S /GoTo /D (12.28.1) >>
+endobj
+284 0 obj
+(A.2. 1. APPLICABILITY AND DEFINITIONS)
+endobj
+285 0 obj
+<< /S /GoTo /D (12.29.1) >>
+endobj
+288 0 obj
+(A.3. 2. VERBATIM COPYING)
+endobj
+289 0 obj
+<< /S /GoTo /D (12.30.1) >>
+endobj
+292 0 obj
+(A.4. 3. COPYING IN QUANTITY)
+endobj
+293 0 obj
+<< /S /GoTo /D (12.31.1) >>
+endobj
+296 0 obj
+(A.5. 4. MODIFICATIONS)
+endobj
+297 0 obj
+<< /S /GoTo /D (12.32.1) >>
+endobj
+300 0 obj
+(A.6. 5. COMBINING DOCUMENTS)
+endobj
+301 0 obj
+<< /S /GoTo /D (12.33.1) >>
+endobj
+304 0 obj
+(A.7. 6. COLLECTIONS OF DOCUMENTS)
+endobj
+305 0 obj
+<< /S /GoTo /D (12.34.1) >>
+endobj
+308 0 obj
+(A.8. 7. AGGREGATION WITH INDEPENDENT WORKS)
+endobj
+309 0 obj
+<< /S /GoTo /D (12.35.1) >>
+endobj
+312 0 obj
+(A.9. 8. TRANSLATION)
+endobj
+313 0 obj
+<< /S /GoTo /D (12.36.1) >>
+endobj
+316 0 obj
+(A.10. 9. TERMINATION)
+endobj
+317 0 obj
+<< /S /GoTo /D (12.37.1) >>
+endobj
+320 0 obj
+(A.11. 10. FUTURE REVISIONS OF THIS LICENSE)
+endobj
+321 0 obj
+<< /S /GoTo /D (12.38.1) >>
+endobj
+324 0 obj
+(A.12. Addendum)
+endobj
+325 0 obj
+<< /S /GoTo /D (13.0) >>
+endobj
+328 0 obj
+(Appendix B. GNU General Public License)
+endobj
+329 0 obj
+<< /S /GoTo /D (13.39.1) >>
+endobj
+332 0 obj
+(B.1. Preamble)
+endobj
+333 0 obj
+<< /S /GoTo /D (13.40.1) >>
+endobj
+336 0 obj
+(B.2. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION)
+endobj
+337 0 obj
+<< /S /GoTo /D (13.40.25.2) >>
+endobj
+340 0 obj
+(B.2.1. Section 0)
+endobj
+341 0 obj
+<< /S /GoTo /D (13.40.26.2) >>
+endobj
+344 0 obj
+(B.2.2. Section 1)
+endobj
+345 0 obj
+<< /S /GoTo /D (13.40.27.2) >>
+endobj
+348 0 obj
+(B.2.3. Section 2)
+endobj
+349 0 obj
+<< /S /GoTo /D (13.40.28.2) >>
+endobj
+352 0 obj
+(B.2.4. Section 3)
+endobj
+353 0 obj
+<< /S /GoTo /D (13.40.29.2) >>
+endobj
+356 0 obj
+(B.2.5. Section 4)
+endobj
+357 0 obj
+<< /S /GoTo /D (13.40.30.2) >>
+endobj
+360 0 obj
+(B.2.6. Section 5)
+endobj
+361 0 obj
+<< /S /GoTo /D (13.40.31.2) >>
+endobj
+364 0 obj
+(B.2.7. Section 6)
+endobj
+365 0 obj
+<< /S /GoTo /D (13.40.32.2) >>
+endobj
+368 0 obj
+(B.2.8. Section 7)
+endobj
+369 0 obj
+<< /S /GoTo /D (13.40.33.2) >>
+endobj
+372 0 obj
+(B.2.9. Section 8)
+endobj
+373 0 obj
+<< /S /GoTo /D (13.40.34.2) >>
+endobj
+376 0 obj
+(B.2.10. Section 9)
+endobj
+377 0 obj
+<< /S /GoTo /D (13.40.35.2) >>
+endobj
+380 0 obj
+(B.2.11. Section 10)
+endobj
+381 0 obj
+<< /S /GoTo /D (13.40.36.2) >>
+endobj
+384 0 obj
+(B.2.12. NO WARRANTY Section 11)
+endobj
+385 0 obj
+<< /S /GoTo /D (13.40.37.2) >>
+endobj
+388 0 obj
+(B.2.13. Section 12)
+endobj
+389 0 obj
+<< /S /GoTo /D (13.41.1) >>
+endobj
+392 0 obj
+(B.3. How to Apply These Terms to Your New Programs)
+endobj
+393 0 obj
+<< /S /GoTo /D [394 0 R /Fit ] >>
+endobj
+397 0 obj <<
+/Length 189
+/Filter /FlateDecode
+>>
+stream
+xڍP;BAZ¾Vlg,F+5Zx~yCA`<Ѣ'iP4l`$TQ2?^MȠX$5Pw bF3C.;n=]UH0)>-(-)]b
:em/;'5^0> endobj
+395 0 obj <<
+/Type /XObject
+/Subtype /Image
+/Width 350
+/Height 203
+/BitsPerComponent 8
+/Length 15222
+/ColorSpace /DeviceRGB
+/Filter /DCTDecode
+>>
+stream
+ JFIF G G Exif MM * C !"$"$ C ^" P !1AQa"2q7#6BRVstubr3CU%5F 1 !1Q2A"Baq#R3 ? tQE QE QE QE QE QE W-(@QvɾE
+))k.Gx@8NCy<\** #jIa|wQ
7a\V?=n}WԇE/Rr$ݿh:BinJH}*kP utOe4
+ȿQEyES ~+>Ҹm)'EzւEPEPEPEPEPE
+ڞb"]JIo