2008-07-01 Jorge Gonzalez <jorge.gonzalez@artica.es>

* include/help/en/help_plugin_parameters.php,
        include/help/en/help_alert_recovery.php,
        include/help/en/help_prediction_source_module.php,
        include/help/en/help_snmpwalk.php,
        include/help/en/help_alert_type.php,
        include/help/en/help_network_component.php: Added new help pages.

        * include/help/en/help_map_builder.php,
        include/help/en/help_postprocess.php,
        include/help/en/help_recontask.php, include/help/en/help_alerts.php,
        include/help/en/help_manage_alerts.php: modified HTML tag.

        * godmode/agentes/module_manager_editor_network.php,
        godmode/agentes/module_manager_editor_plugin.php,
        godmode/agentes/module_manager_editor_prediction.php,
        godmode/agentes/alert_manager_editor.php,
        godmode/agentes/module_manager_editor_data.php,
        godmode/agentes/modificar_agente.php,
        godmode/agentes/agent_manager.php, godmode/alerts/configure_alert.php:
        Added/modified help support.



git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@912 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
jorgonzalez 2008-07-01 11:26:17 +00:00
parent 155c4f4bf9
commit ca2703ef6c
20 changed files with 116 additions and 33 deletions

View File

@ -1,3 +1,26 @@
2008-07-01 Jorge Gonzalez <jorge.gonzalez@artica.es>
* include/help/en/help_plugin_parameters.php,
include/help/en/help_alert_recovery.php,
include/help/en/help_prediction_source_module.php,
include/help/en/help_snmpwalk.php,
include/help/en/help_alert_type.php,
include/help/en/help_network_component.php: Added new help pages.
* include/help/en/help_map_builder.php,
include/help/en/help_postprocess.php,
include/help/en/help_recontask.php, include/help/en/help_alerts.php,
include/help/en/help_manage_alerts.php: modified HTML tag.
* godmode/agentes/module_manager_editor_network.php,
godmode/agentes/module_manager_editor_plugin.php,
godmode/agentes/module_manager_editor_prediction.php,
godmode/agentes/alert_manager_editor.php,
godmode/agentes/module_manager_editor_data.php,
godmode/agentes/modificar_agente.php,
godmode/agentes/agent_manager.php, godmode/alerts/configure_alert.php:
Added/modified help support.
2008-06-30 Jorge Gonzalez <jorge.gonzalez@artica.es>
* include/help/en/help_recontask.php: Added help page for Recon tasks.

View File

@ -67,13 +67,13 @@ if (isset ($id_agente) && $id_agente != "") {
echo "
<a href='index.php?sec=estado&
sec2=operation/agentes/ver_agente&id_agente=".$id_agente."'>
<img src='images/lupa.png' border='0' align='middle' alt=''></a>";
<img src='images/lupa.png' border='0' align='middle' title='".lang_string("agent_detail")."'></a>";
}
// Remote configuration available
if (file_exists ($config["remote_config"] . "/" . $agent_md5 . ".md5")) {
echo "
<a href='index.php?sec=gagente&sec2=godmode/agentes/configurar_agente&tab=main&id_agente=".$id_agente."&disk_conf=" . $agent_md5 . "'>
<img src='images/application_edit.png' border='0' align='middle' alt=''></a>";
<img src='images/application_edit.png' border='0' align='middle' title='".lang_string("Edit remote config")."'></a>";
}
echo '<tr><td class="datos2">';

View File

@ -4,6 +4,7 @@
// ========================================
// Copyright (c) 2008 Artica Soluciones Tecnológicas, http://www.artica.es
// Copyright (c) 2008 Sancho Lerena <slerena@gmail.com>
// Copyright (c) 2008 Jorge González <jorge.gonzalez@artica.es>
// Please see http://pandora.sourceforge.net for full contribution list
@ -20,7 +21,7 @@
$add_component = get_parameter ("add_component",0);
echo "<h3>".$lang_label["alert_asociation_form"];
pandora_help("alerts");
pandora_help ("alerts");
echo "</h3>";
echo '<form name="agente" method="post" action="index.php?sec=gagente&sec2=godmode/agentes/configurar_agente&tab=alert&id_agente='.$id_agente.'">';
@ -79,8 +80,9 @@ if (! isset($alert_priority)) {
print_select (get_priorities (), "alert_priority", $alert_priority, '', '', '');
// Alert type
echo '<tr><td class="datos">';
echo $lang_label["alert_type"];
echo '<tr><td class="datos">'. lang_string ("alert_type");
pandora_help ("alert_type");
echo '</td>';
echo '<td class="datos"><select name="tipo_alerta">';
if (isset($tipo_alerta)){
echo "<option value='".$tipo_alerta."'>".dame_nombre_alerta($tipo_alerta)."</option>";
@ -260,8 +262,9 @@ echo '<td class="datos2">';
echo '<input type="text" name="campo_2_rec" size="20" value="'.$alerta_campo2_rec.'">';
// Alert recovery disable / enable
echo "<td class='datos2'>";
echo lang_string ("Alert recovery");
echo '<td class="datos2">'. lang_string ("Alert recovery");
pandora_help ("alert_recovery");
echo '</td>';
echo "<td class='datos2'>";
echo '<select name="alert_recovery">';
if ((isset($alert_recovery)) AND ($alert_recovery == "1")) {

View File

@ -220,7 +220,7 @@ if (mysql_num_rows($result)){
// Has remote configuration ?
$agent_md5 = md5($row["nombre"], FALSE);
if (file_exists($config["remote_config"] . "/" . $agent_md5 . ".md5")){
echo "<img src='images/application_edit.png' border='0' align='middle' alt=''>";
echo "<img src='images/application_edit.png' border='0' align='middle' title='".lang_string("Edit remote config")."'>";
}
echo "</td>";

View File

@ -103,7 +103,7 @@ echo '</tr><tr>';
echo '<td class="datos2">'.lang_string ("module_type");
pandora_help("module_type");
echo '</td>';
echo '<td class="datos2">';
echo '<td class="datos2" colspan="3">';
if ($update_module_id != NULL){
echo "<span class='redi'>Not available in edition mode</span>";

View File

@ -98,6 +98,7 @@ echo "<input type='hidden' name='form_id_modulo' value='2'>";
// Network component usage
echo "<tr><td class='datos3'>";
echo lang_string ("using_network_component");
pandora_help ("network_component");
echo "</td><td class='datos3' colspan=2>";
if ($update_module_id != NULL){
@ -143,7 +144,7 @@ echo '</tr>';
// module type / max timeout
echo '</tr><tr>';
echo '<td class="datos2">'.lang_string ("module_type");
pandora_help("module_type");
pandora_help ("module_type");
echo '</td>';
echo '<td class="datos2">';
@ -185,7 +186,9 @@ echo '</select>';
// Snmp walk
echo '<tr>';
echo '<td class="datos2">'.lang_string ("snmp_walk")."</td>";
echo '<td class="datos2">'.lang_string ("snmp_walk");
pandora_help ("snmpwalk");
echo '</td>';
echo '<td class="datos2" colspan=2>';
echo '<select name="form_combo_snmp_oid">';
// FILL OID Combobox
@ -205,7 +208,7 @@ echo '<input type="submit" class="sub next" name="oid" value="SNMP Walk">';
// Snmp Oid / community
echo '<tr>';
echo '<td class="datos">'.lang_string ("snmp_oid");
pandora_help("snmpoid");
pandora_help ("snmpoid");
echo '</td>';
echo '<td class="datos"><input type="text" name="form_snmp_oid" size="25" value="'.$form_snmp_oid.'"></td>';
echo '<td class="datos">'.lang_string ("snmp_community")."</td>";
@ -223,7 +226,7 @@ echo '</tr>';
// Post process / Export server
echo '<tr>';
echo '<td class="datos">'.lang_string ("post_process");
pandora_help("postprocess");
pandora_help ("postprocess");
echo '</td>';
echo '<td class="datos"><input type="text" name="form_post_process" size="5" value="'.$form_post_process.'"></td>';
echo '<td class="datos">'.lang_string ("export_server")."</td>";

View File

@ -121,7 +121,9 @@ echo '</select>';
echo '</tr>';
echo '</tr><tr>';
echo '<td class="datos2">'.lang_string ("Plugin parameters")."</td>";
echo '<td class="datos2">'.lang_string ("Plugin parameters");
pandora_help ("plugin_parameters");
echo '</td>';
echo '<td class="datos2"><input type="text" name="form_plugin_parameter" size="30" value="'.$form_plugin_parameter.'"></td>';
echo '<td class="datos2">'.lang_string ("Port")."</td>";
@ -138,7 +140,7 @@ echo '</tr>';
// module type / max timeout
echo '</tr><tr>';
echo '<td class="datos2">'.lang_string ("module_type");
pandora_help("module_type");
pandora_help ("module_type");
echo '</td>';
echo '<td class="datos2">';
@ -186,7 +188,7 @@ echo '</tr>';
// Post process / Export server
echo '<tr>';
echo '<td class="datos">'.lang_string ("post_process");
pandora_help("postprocess");
pandora_help ("postprocess");
echo '</td>';
echo '<td class="datos"><input type="text" name="form_post_process" size="5" value="'.$form_post_process.'"></td>';
echo '<td class="datos">'.lang_string ("export_server")."</td>";

View File

@ -102,8 +102,10 @@ echo '</tr>';
echo '<tr>';
echo '<td class="datos">'.lang_string ("source_module")."</td>";
echo '<td class="datos" colspan=3>';
echo '<td class="datos">'.lang_string ("source_module");
pandora_help ("prediction_source_module");
echo '</td>';
echo '<td class="datos" colspan="3">';
echo '<select name="form_id_prediction_module">';
$sql1='SELECT id_agente_modulo, tagente_modulo.nombre, tagente.id_agente, tagente.id_grupo, tagente.nombre FROM tagente_modulo, tagente WHERE id_tipo_modulo NOT IN (100,24,19,20,21,22,23,17,10,2) AND tagente.id_agente = tagente_modulo.id_agente ORDER BY tagente.nombre';
$result=mysql_query($sql1);
@ -116,9 +118,7 @@ echo "</tr>";
// module type
echo '</tr><tr>';
echo '<td class="datos2">'.lang_string ("module_type");
pandora_help("module_type");
echo '</td>';
echo '<td class="datos2">'. lang_string ("module_type") .'</td>';
echo '<td class="datos2">';
if ($update_module_id != NULL){
echo "<span class='redi'>Not available in edition mode</span>";

View File

@ -59,7 +59,7 @@ echo "<h2>".$lang_label["alert_config"]." &gt; ";
if (isset($_GET["id_alerta"])){
echo $lang_label["mod_alert"];
}
pandora_help("manage_alerts");
pandora_help ("manage_alerts");
echo "</h2>";
?>
<form name="alerta" method="post" action="index.php?sec=galertas&sec2=godmode/alerts/modify_alert&id_alerta=<?php echo $id_alerta ?>">

View File

@ -0,0 +1,3 @@
<h1>Alert recovery</h1>
It defines whether Pandora FMS launches another alert when the alert condition is recovered. It has the same field1, but adds "[RECOVER]" to field2 and field3. It is disabled by default.

View File

@ -0,0 +1,11 @@
<h1>Alert type</h1>
There are some predefined alerts, in which is very likely you will have to adjust, in case your system does not provide the internal commands needed to execute those alerts. The development team has tested these alerts with Red Hat Enterprise Linux (RHEL), CentOS, Debian and Ubuntu Server.
<ul>
<li><b>Compound only</b>: This alert will not be executed individually. This will just be part of a combined alert, and is needed to trigger the combined alert depending on its status and other compound alerts, if exist.</li>
<li><b>eMail</b>: Sends an e-mail from Pandora FMS Server. It uses your local sendmail. If you installed other kind of local mailer or do not have one, you should install and configure sendmail or any equivalent (and check the syntax) to be able to use this service. Pandora FMS rely on system tools to execute almost every alert, it will be necessary to check that those commands work properly on your system.</li>
<li><b>Internal audit</b>: This is the only "internal" alert, it writes the incident in Pandora FMS internal audit system. This is stored in Pandora FMS Database and can be reviewed with Pandora FMS audit viewer from the Web console.</li>
<li><b>Pandora FMS Alertlog</b>: Saves information about the alert inside a text file (.log). Use this type of alert to generate log files using the format you need. To do so, you will need to modify the command so that it will use the format and file you want. Note that Pandora FMS does not handle file rotation, and that Pandora FMS Server process that executes the alert will need acess to the log file to write on it.</li>
<li><b>Pandora FMS Event</b>: This alert create an special event into Pandora FMS event manager.</li>
</ul>
This alerts are predefined and cannot be deleted, however the user can define new ones that use custom commands and add with the Alert management.

View File

@ -3,9 +3,9 @@
Assigning Alerts to modules
Adding new alert to a module
Adding new alert to a module
<br></br>
<br /><br />
The next step after adding an agent, having configured its modules, and defined the alerts, is assigning those alerts to the agent. This step is necessary to establish alert conditions in those desired cases. This is done by clicking on the agent to be configured in the "Manage agents" option, from Administration menu, or using the edition mode and selecting the tab "Alerts", from the agent view.
<br></br>
<br /><br />
The next fields must be filled to assign an alert:
<ul>
<li>Alert type: This can be selected from the alert list previously generated.</li>
@ -23,9 +23,9 @@ The next fields must be filled to assign an alert:
<li>Assigned module: Module to be monitored by the alert.</li>
</ul>
All the alerts of an agent can be seen using the "Alerts" tab. Let's see an example:
<br><br>
<br /><br />
"I want to fire an alert when XXX goes down, and please, dont't disturb me again at least for one hour. After that time, if it is still down, fire another alert and wait another hour".
<br><br>
<br /><br />
You need to setup:
<ul>
<li>Time threshold 3600 (1 hour).</li>

View File

@ -1,9 +1,9 @@
<h1>Alerts</h1>
Alerts in Pandora FMS react to an "out of range" module value. The alert can consist of sending an e-mail or an SMS to the administrator, sending a SNMP trap, write the incident into the system log or into Pandora FMS log file, etc. Basically, an alert can be anything that can be triggered by a script configured in the Operating System where Pandora FMS Servers run.
<br><br>
<br /><br />
The values "_field1_", "_field2_" and "_field3_" of the customized alerts are used to build the command line that will be executed.
<br><br>
<br /><br />
When a new alert is created the following fields must be filled in:
<ul>

View File

@ -8,7 +8,7 @@ To create a map, you must first fill the form providing:
<li>A size (width/height)</li>
</ul>
One you have filled it, click on "Update" so the map will be loaded.
<br><br>
<br /><br />
To add items to the map, go to the form below the background image, and fill it, providing, for each element:
<ul>
<li>A label and a color for it</li>
@ -21,6 +21,6 @@ To add items to the map, go to the form below the background image, and fill it,
<li>A linked map, in case you want to link the item with another map</li>
</ul>
To edit the properties of an already created item, just drag the item to the form "MAP ELEMENT EDITOR" and drop it there, the form will load the element's properties.
<br><br>
<br /><br />
To delete an element of the map, just drag and drop it into the recycle bin icon. Then click on "Delete".

View File

@ -0,0 +1,9 @@
<h1>Network Component</h1>
The Network Component combo box allows you to select a template from a list of more than a hundred and automatically fill some fields with the typical values.
<br /><br />
To do so, select the template you want, click on "Get data" and wait few seconds until the information is filled. Depending on the template, some fields will be filled in and some others will not, for example:
<ul>
<li>TCP port would be filled for "Check FTP Server" but not SNMP OID</li>
<li>TCP port would not be filled for "Catalyst CPU Usage (5min)" but SNMP OID will.</li>
</ul>

View File

@ -0,0 +1,12 @@
<h1>Plugin parameters</h1>
This field reffers to all parameters that can be passed to a plugin and are not defined in the form, unlike Port, Password, Max. timeout...
<br /><br />
These parameters could be:
<ul>
<li>An URL</li>
<li>A path</li>
<li>A file</li>
<li>Etc.</li>
</ul>
This field is optional and depends, completely, on the plugin.

View File

@ -1,4 +1,5 @@
<h1>Post process</h1>
Post process is a numeric value that is used after get data to numerical post process in a multipliear operation. For example a data with a value of 1000 with a Post Process value of 1024 will result in a definitive data of 1024000 value. This is useful to normalize data, convert between units, etc. This also can be used to divide, using a multiplier below 1 value, like, for example, 0.001 that will divide current value by 1000.
<br><br>
<br /><br />
An empty value, or 0, will disable the usage of post process (default).

View File

@ -0,0 +1,11 @@
<h1>Source type</h1>
Right now prediction just supports two types of modules. A numeric data predition, based on a time margin (defined as an interval in the new prediction module), or a detection of a deviation of the typical behaviour between a time margin, defined as 1/2 of the defined interval. The longer the time margin is, the bigger error the prediction has, and more possible values must be considered. These two modules are implemented as <i>generic_data</i> and <i>generic_proc</i>, respectively.
<h2>Prediction module creation</h2>
<b>The prediction needs data from, at least, a week to work properly</b>. Prediction is done calculating average values of the module on a given interval, at four times: t1, t2, t3, t4. Being t1 a week ago value, t2 two weeks ago value, t3 three weeks ago value, and t4 four weeks ago value.
<h2>Anomaly module creation</h2>
To calculate anomalies, the typical deviation is also computed for those samples with values different from 0, and then the real value is compared with the predicted value +/- the typical deviation.

View File

@ -1,7 +1,7 @@
<h1>Recon Task</h1>
To create a Recon Task, you must fill this form. Please fill all the fields, paying special attention to <b>"Recon Server"</b> and <b>"Network Server"</b>, remember you must choose one for each, so the task will be assinged to the required servers and it will run.
<br><br>
<br /><br />
"Network" refers to the network segment, and are defined using <b>CIDR</b> format. For example 192.168.1.0/24 refers to <i>all C class on 192.168.1.0</i>, wich includes all the addresses in the scope: 192.168.1.0 - 192.168.1.255.
<br><br>
<br /><br />
"Network profile" are predefined profiles for the reconnaissance task. It will add such modules defined in the profile to the newly discovered machines in the network.

View File

@ -0,0 +1,5 @@
<h1>SNMP walk</h1>
Pandora FMS has also a simple SNMP browser that allows to walk the MIB of a remote device by a SNMP Walk.
<br /><br />
Walking ("SNMP Walk") over a device will make all MIB variables available, so you can choose one. You can also enter a MIB using numerical OID or human understandable format, if you have the correct MIB installed in your Pandora FMS Network Server.