2013-03-22 Mario Pulido <mario.pulido@artica.es>
* godmode/alerts/configure_alert_template.php,
include/help/en/help_conf_alert_template.php,
include/help/en/help_manage_alert_list.php,
include/help/es/help_conf_alert_template.php,
include/help/es/help_manage_alert_list.php,
images/help/alert1.png,images/help/alert2.png: Added helps in alerts.
git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@7880 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
mariopulido87
parent
925b3f9308
commit
1198e56dcd
|
|
@ -1,3 +1,12 @@
|
|||
2013-03-22 Mario Pulido <mario.pulido@artica.es>
|
||||
|
||||
* godmode/alerts/configure_alert_template.php,
|
||||
include/help/en/help_conf_alert_template.php,
|
||||
include/help/en/help_manage_alert_list.php,
|
||||
include/help/es/help_conf_alert_template.php,
|
||||
include/help/es/help_manage_alert_list.php,
|
||||
images/help/alert1.png,images/help/alert2.png: Added helps in alerts.
|
||||
|
||||
2013-03-22 Ramon Novoa <rnovoa@artica.es>
|
||||
|
||||
* operation/gis_maps/ajax.php,
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ if ($a_template !== false) {
|
|||
}
|
||||
else {
|
||||
|
||||
ui_print_page_header (__('Alerts').' » '.__('Configure alert template'), "", false, "", true);
|
||||
ui_print_page_header (__('Alerts').' » '.__('Configure alert template'), "", false, "conf_alert_template", true);
|
||||
|
||||
}
|
||||
}
|
||||
|
|
@ -93,7 +93,7 @@ if ($a_template !== false) {
|
|||
}
|
||||
else {
|
||||
|
||||
ui_print_page_header (__('Alerts').' » '.__('Configure alert template'), "", false, "", true);
|
||||
ui_print_page_header (__('Alerts').' » '.__('Configure alert template'), "", false, "conf_alert_template", true);
|
||||
|
||||
}
|
||||
}
|
||||
|
|
@ -115,7 +115,7 @@ else {
|
|||
}
|
||||
else {
|
||||
|
||||
ui_print_page_header (__('Alerts').' » '.__('Configure alert template'), "", false, "", true);
|
||||
ui_print_page_header (__('Alerts').' » '.__('Configure alert template'), "", false, "conf_alert_template", true);
|
||||
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.9 KiB |
|
|
@ -0,0 +1,118 @@
|
|||
<?php
|
||||
/**
|
||||
* @package Include/help/en
|
||||
*/
|
||||
?>
|
||||
|
||||
<h1> Creating an Alert Template</h1>
|
||||
|
||||
The first step to create an alert template are Conditions.
|
||||
<br><br>
|
||||
Here are detailed the fields to fill in Conditions:
|
||||
<br><br>
|
||||
<ul type=”disc”>
|
||||
<li> <b>Name:</b> The name of the template.<br></li><br>
|
||||
<li> <b>Description:</b> Describes the template function and is useful to identify the template from others in the alert general view. <br></li><br>
|
||||
<li> <b>Priority:</b> Field that gives information about the alert. It is useful to search alerts. You can choose between the following priorities: <br><br></li><br>
|
||||
* Maintenance<br>
|
||||
* Informational<br>
|
||||
* Normal<br>
|
||||
* Minor<br>
|
||||
* Warning<br>
|
||||
* Major<br>
|
||||
* Critical<br>
|
||||
* Warning/Critical<br>
|
||||
* Not normal<br><br>
|
||||
|
||||
<li> <b>Condition Type:</b> Field where the kind of condition that will be applied on the alert is defined.The required combos will be added according to the chosen kind.There are the following fields: <br></li></ul>
|
||||
<li> <i>Regular Expression:</i> The regular expression is used. The alert will be fired when the module value perform a fixed condition expresed using a regular expression, this is the condition used to fire on string/text data. The other conditions are for status or numerical data.<br>
|
||||
By choosing the regular condition it appears the possibility to select the Trigger box when matches the value. In case of select, the alert will be fired when the value matches, and in case of not selecting it, the alert will be fired when the value does not match. </li><br>
|
||||
<li> <i>Max and Min:</i> limit value from which the service is in warning state.<br>
|
||||
By choosing the regular condition the possibility to select the Trigger box when matches the value will appear.In case of selecting it, the alert will be fired when the value is out of the range selected between the maximum an the minimum.In case of not selecting it, the alert will be launched when the value would be between the range selected betweeb the maximum and the minimum. </li><br>
|
||||
<li> <i>Max:</i> A maximum and a minimum value are used. <br></li><br>
|
||||
<li> <i>Min:</i> A minimum value is used. The alert will be fired when the module value would be lower than the minimum value selected. </li><br>
|
||||
<li> <i>Equal to:</i> The value Equal to is used. The alert will be fired when the module value would be the same as the selected one. It is used ONLY for numerical values (for example 0 or 0.124). </li><br>
|
||||
<li> <i>Not Equal to:</i> Similar to previous but adding a logical NOT. </li><br>
|
||||
<li> <i>Warning Status:</i> The module state is used.The alert will be fired when this state would be Warning. </li><br>
|
||||
<li> <i>Critical Status:</i> The module state is used.The alert will be fired when this state would be Critical. </li><br>
|
||||
<li> <i>Unknown Status:</i> The alert would fire when the module is in unknown status </li><br>
|
||||
<li> <i>On Change</i> The alert would fire when the module value changes </li><br>
|
||||
<li> <i>Always</i> The alert always fire </li><br>
|
||||
<br><br>
|
||||
|
||||
Once the fields have been filled, press on the "Next" button and this way you will have access to the following screen.
|
||||
|
||||
<?php html_print_image ("images/help/alert1.png", false, array('width' => '550px')); ?>
|
||||
<br><br>
|
||||
Next we are going to detail the fields to fill in:
|
||||
<br><br>
|
||||
|
||||
<b>Days of Week</b><br><br>
|
||||
|
||||
Days when the alert could be fired.<br><br>
|
||||
|
||||
<b>Use special days list</b><br><br>
|
||||
|
||||
Enable/disable use of special days (holidays and special working days) list.<br><br>
|
||||
|
||||
<b>Time From</b><br><br>
|
||||
|
||||
Time from which the action of the alert will be executed.<br>
|
||||
<br>
|
||||
<b>Time To</b><br><br>
|
||||
|
||||
Time until the action of the alert will be executed.<br><br>
|
||||
|
||||
<b>Time Threshold</b><br><br>
|
||||
|
||||
Defines the time interval in which it is guaranteed that an alert is not going to be fired more times than the number fixed in Maximum number of alerts. If the defined interval is exceeded, an alert will not recover if it comes to an specific value, except if the alert Recover value would be activated. In this case it is recovered inmediatelly after receiving an specific value,regardless the threshold.<br><br>
|
||||
|
||||
<b>Min number of alerts</b><br><br>
|
||||
|
||||
Minimum number of times that the data has to be out of range (always counting from the number defined in FlipFlop parameter of the module) to start firing an alert. Default is 0, which means that the alert will be fired when the first value satisfies the condition. It works as a filter, necessary to eliminate false positives.<br><br>
|
||||
|
||||
<b>Max number of alerts</b><br><br>
|
||||
|
||||
Maximum number of alerts that could be sent consecutively in the same time interval (Time Threshold). <br><br>
|
||||
|
||||
<b>Advanced fields management</b><br><br>
|
||||
|
||||
Defines the value for the "_fieldX_" variable. Here could be used the list of macros that is described in the fields help.<br><br>
|
||||
|
||||
<b>Default Action</b><br><br>
|
||||
|
||||
In this combo is defined the action by default that the template is going to have. This is the action that will be automatically created when the template would be assigned to the module. You can put none or one, but you can not put several actions by default.
|
||||
|
||||
<?php html_print_image ("images/help/alert2.png", false, array('width' => '550px')); ?>
|
||||
|
||||
Next are the fields that you should fill in:<br><br>
|
||||
|
||||
<b>Alert Recovery</b><br><br>
|
||||
|
||||
Combo where you can define if the alert recovery is enabled or not.In case that the alert recovery is enabled, when the module would have again values out of the alert range, the alert that matches with the Field 1 defined in the alert and with the Field 2 and 3 that are defined next, will be executed.<br><br>
|
||||
|
||||
<b>Field 2</b><br><br>
|
||||
|
||||
Defines the value for the "_field2_" variable in the alert recovery.<br><br>
|
||||
|
||||
<b>Field 3</b><br><br>
|
||||
|
||||
Defines the value for the "_field3_" variable in the alert recovery.<br>
|
||||
|
||||
Once the fields have been filled in, press on the "Finish" button.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -14,8 +14,9 @@ When a new alert is created the following fields must be filled in:
|
|||
</p>
|
||||
|
||||
<ul>
|
||||
<li>Agent name: The name of the agent associated with the alert.</li>
|
||||
<li>Module: Alert get module value and test if it is "out of range". In afirmative case it will raise an event (seding e-mail, etc.).</li>
|
||||
<li>Template: Alerts width all parameters defined. They are used to do the administrator management easier.</li>
|
||||
<li>Action: Allows to choose between all the alerts that have been configured. The selected action will be added to the action that is defined in the template.</li>
|
||||
<li><b>Agent name:</b> The name of the agent associated with the alert.</li>
|
||||
<li><b>Module:</b> Alert get module value and test if it is "out of range". In afirmative case it will raise an event (seding e-mail, etc.).</li>
|
||||
<li><b>Template:</b> Alerts width all parameters defined. They are used to do the administrator management easier.</li>
|
||||
<li><b>Action:</b> Allows to choose between all the alerts that have been configured. The selected action will be added to the action that is defined in the template.</li>
|
||||
<li><b>Threshold:</b> Defines the time interval in which it is guaranteed that an alert is not going to be fired more times than the number fixed in Maximum number of alerts.
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,120 @@
|
|||
<?php
|
||||
/**
|
||||
* @package Include/help/en
|
||||
*/
|
||||
?>
|
||||
|
||||
<h1> Creación de una Plantilla de Alertas</h1>
|
||||
|
||||
El primer paso para crear una plantilla de alertas son las condiciones.
|
||||
<br><br>
|
||||
A continuación se detallan los campos que hay que rellenar:
|
||||
<br><br>
|
||||
<ul type=”disc”>
|
||||
<li> <b>Name:</b> El nombre del template. <br></li><br>
|
||||
<li> <b>Description:</b> Describe la función de la plantilla, y resulta útil para identificar la plantilla entre otras en la vista general de alertas. <br></li><br>
|
||||
<li> <b>Priority:</b> Campo informativo acerca de la alerta. Sirve para filtrar a la hora de buscar alertas. Se puede elegir entre las siguientes prioridades: <br><br></li><br>
|
||||
* Maintenance<br>
|
||||
* Informational<br>
|
||||
* Normal<br>
|
||||
* Minor<br>
|
||||
* Warning<br>
|
||||
* Major<br>
|
||||
* Critical<br>
|
||||
* Warning/Critical<br>
|
||||
* Not normal<br><br>
|
||||
|
||||
<li> <b>Condition Type:</b> Campo donde se define el tipo de condición que se aplicará a la alerta. Se añadirán los combos necesarios según el tipo elegido, existen los siguientes tipos: <br></li></ul>
|
||||
<li> <i>Regular Expression:</i> Se usa una expresión regular. La alerta saltara cuando el valor del módulo cumpla una condición establecida. <br>
|
||||
Al elegir la condición regular aparece la posibilidad de marcar la casilla Trigger when matches the value. En caso de marcar, la la alerta se lanzará cuando coincida el valor y, en caso de no marcarla, la alerta se lanzará cuando no coincida el valor. </li><br>
|
||||
<li> <i>Max and Min:</i> Se usa un valor máximo y otro mínimo. <br>
|
||||
Al alegir la condición regular aparece la posibilidad de marcar la casilla Trigger when matches the value. En caso de marcarla, la alerta se lanzará cuando el valor este fuera del rango marcado entre el máximo y el mínimo y, en caso de no marcarla, la alerta se lanzará cuando el valor este dentro del rango marcado entre el máximo y el mínimo. </li><br>
|
||||
<li> <i>Max:</i> Se usa un valor máximo. La alerta saltara cuando el valor del módulo sea mayor que el valor máximo marcado. <br></li><br>
|
||||
<li> <i>Min:</i> Se usa un valor mínimo. La alerta saltara cuando el valor del módulo sea menor que el valor mínimo marcado. </li><br>
|
||||
<li> <i>Equal to:</i> Usado para disparar la alerta cuando se proporciona un valor de debe ser igual al dato recibido. Esta condición, igual que las de max/min se usa sólo para valores numéricos, p.e: 234 o 124.35. </li><br>
|
||||
<li> <i>Not Equal to:</i> Igual que el anterior pero negando la condición (operador lógico NOT). </li><br>
|
||||
<li> <i>Warning Status:</i> Se usa el estado del módulo. La alerta saltará cuando dicho estado sea Warning. </li><br>
|
||||
<li> <i>Critical Status:</i> Se usa el estado del módulo. La alerta saltará cuando dicho estado sea Critical. </li><br>
|
||||
<li> <i>Unknown Status:</i> La alerta saltará cuando el modulo esté en estado desconocido </li><br>
|
||||
<li> <i>On Change</i> La alerta saltará cuando el modulo cambie de valor </li><br>
|
||||
<li> <i>Always</i> La alerta se disparará siempre </li><br>
|
||||
<br><br>
|
||||
|
||||
Una vez se han rellenado los campos se pincha en el botón “Next” y se accede a la siguiente pantalla .
|
||||
|
||||
<?php html_print_image ("images/help/alert1.png", false, array('width' => '550px')); ?>
|
||||
<br><br>
|
||||
A continuación se detallan los campos que hay que rellenar:
|
||||
<br><br>
|
||||
|
||||
<b>Days of Week</b><br><br>
|
||||
|
||||
Establece los días en los que la alerta podrá dispararse. <br><br>
|
||||
|
||||
<b>Use special days list</b><br><br>
|
||||
|
||||
Habilitar/deshabilitar el uso de la lista de días especiales (festivos y días laborables especiales). <br><br>
|
||||
|
||||
<b>Time From</b><br><br>
|
||||
|
||||
Hora a partir de la cual se ejecuta la acción de la alerta. <br>
|
||||
<br>
|
||||
<b>Time To</b><br><br>
|
||||
|
||||
Hora hasta la que se ejecuta la acción de la alerta. <br><br>
|
||||
|
||||
<b>Time Threshold</b><br><br>
|
||||
|
||||
Define el intervalo de tiempo en el cual se garantiza que una alerta no se va a disparar más veces del número establecido en Numero máximo de alertas. Pasado el intervalo definido, una alerta se recupera si llega un valor correcto, salvo que esté activado el valor Recuperación de alerta, en cuyo caso se recupera inmediatamente después de recibir un valor correcto independientemente del umbral. <br><br>
|
||||
|
||||
<b>Min number of alerts</b><br><br>
|
||||
|
||||
Número mínimo de veces que tiene que llegar un valor fuera de rango (contando siempre a partir del número definido en el parámetro FlipFlop del módulo) para empezar a disparar una alerta. El valor por defecto es 0, lo que significa que la alerta se disparará cuando llegue el primer valor que cumpla la condición. Funciona como un filtro, necesario para eliminar falsos positivos. <br><br>
|
||||
|
||||
<b>Max number of alerts</b><br><br>
|
||||
|
||||
Máximo número de alertas que se pueden enviar consecutivamente en el mismo intervalo de tiempo (Time Threshold).<br><br>
|
||||
|
||||
<b>Advanced fields management</b><br><br>
|
||||
|
||||
Define el valor para la variable "_fieldX_". Aqui se pueden utilizar una serie de macros que se describen en la ayuda de las macros.<br><br>
|
||||
|
||||
<b>Default Action</b><br><br>
|
||||
|
||||
En este combo se define la acción por defecto que va a tener el template. Esta es la accion que se creará automáticamente cuando asigne la plantilla al módulo. Puede no poner ninguna o poner una, pero no se pueden poner varias acciones por defecto.<br><br>
|
||||
|
||||
Una vez se han rellenado los campos se pincha en el botón “Next” y se accede a la siguiente pantalla . <br><br>
|
||||
|
||||
<?php html_print_image ("images/help/alert2.png", false, array('width' => '550px')); ?>
|
||||
|
||||
A continuación se detallan los campos que hay que rellenar: <br><br>
|
||||
|
||||
<b>Alert Recovery</b><br><br>
|
||||
|
||||
Combo donde se puede definir si esta habilitado o no la recuperación de alertas. En el caso de que esté habilitada la recuperación de alertas, cuando el módulo vuelve a tener valores fuera del rango de alerta, se ejecutará la acción correspondiente con el campo Field 1 que se ha definido en la alerta y los campos Field 2 y Field 3 que se definen a continuación. <br><br>
|
||||
|
||||
<b>Field 2</b><br><br>
|
||||
|
||||
Define el valor para la variable "_field2_". en la recuperación de la alerta. <br><br>
|
||||
|
||||
<b>Field 3</b><br><br>
|
||||
|
||||
Define el valor para la variable "_field3_". en la recuperación de la alerta.<br>
|
||||
|
||||
Una vez se han rellenado los campos se pincha en el botón “Finish”.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -14,8 +14,10 @@ Cuando una alerta es creada los siguiente campos deben de rellenarse:
|
|||
</p>
|
||||
|
||||
<ul>
|
||||
<li>Agent name: El nombre del agente asociado a la alarma.</li>
|
||||
<li>Module: La alerta recogerá el valor del módulo y comprobará si está "fuera de rango". En caso afirmativo creará un evento (sending, e-mail, etc.).</li>
|
||||
<li>Template: Alertas con todos los parámetros predefinidos. Son usadas para hacer más sencilla la gestión de las alertas porel administrador.</li>
|
||||
<li>Action: Permite elegir entre todas las alertas que están configuradas. La acción seleccionada será añadida a la acción definida por el template.</li>
|
||||
<li><b>Agent name:</b> El nombre del agente asociado a la alarma.</li>
|
||||
<li><b>Module:</b> La alerta recogerá el valor del módulo y comprobará si está "fuera de rango". En caso afirmativo creará un evento (sending, e-mail, etc.).</li>
|
||||
<li><b>Template:</b> Alertas con todos los parámetros predefinidos. Son usadas para hacer más sencilla la gestión de las alertas porel administrador.</li>
|
||||
<li><b>Action:</b> Permite elegir entre todas las alertas que están configuradas. La acción seleccionada será añadida a la acción definida por el template.</li>
|
||||
<li><b>Threshold:</b> Define el intervalo de tiempo en el que se garantiza que una alerta no va a ser disparada más veces que el número fijado en el número máximo de alertas.
|
||||
|
||||
</ul>
|
||||
|
|
|
|||
Loading…
Reference in New Issue