Merge branch 'ent-5023-limpiar-toda-referencia-a-event-alert' into 'develop'

remove help_event_alert.php

See merge request artica/pandorafms!3057
This commit is contained in:
Daniel Rodriguez 2021-06-21 14:08:03 +00:00
commit 7937a988df
3 changed files with 6 additions and 131 deletions

View File

@ -89,4 +89,9 @@ godmode/update_manager/update_manager.offline.php
godmode/update_manager/update_manager.online.php
include/javascript/update_manager.js
enterprise/include/functions_update_manager.php
include/ajax/rolling_release.ajax.php
include/ajax/rolling_release.ajax.php
include/help/en/help_event_alert.php
include/help/es/help_event_alert.php
enterprise/godmode/alerts/alert_events.php
enterprise/godmode/alerts/alert_events_list.php
enterprise/godmode/alerts/alert_events_rules.php

View File

@ -1,66 +0,0 @@
<?php
/*
* @package Include/help/en
*/
?>
<h1>Event Alerts</h1>
It is possible to define alerts on events, that allows to work from a completely new approach much more flexible. This is an Enterprise feature.<br>
To create the new event alerts, click on the Create button in the Event alerts menu from the Administration menu. <br><br>
<br><br>
<?php html_print_image('images/help/event01.png', false, ['width' => '250px']); ?>
<br>
An event alert is composed by different rules, linked between them by logical operators (and, or, xor, nand, nor, nxor).
<br><br>
<?php html_print_image('images/help/event02.png', false, ['width' => '550px']); ?>
<br>
To could work easier with them, the configuration parameters of an event alert are identical to the module alert. Here could be find a detailed explanation of any of them. There are only two specific parameters of the event alerts:
<br><br>
<b>Rule evaluation mode:</b> There are two options Pass and Drop. Pass means that if a event fullfilled with a alert the alerts bellow are evaluated. Drop means that if a event fullfilled with a alert the alerts bellow stop to evaluated.
<br><br>
<b>Group by:</b> Allows to group the rules by agent, module, alert or group. For example, if a rule is configured to it fires when we receive two critical events, and it's grouped by agent, there should arrive two critical events from the same agent. It's possible to switch off.
<br><br>
Each rule is configured to fire with an specific kind of event. The alert will be fired when the logical equation defined by the rules and its operators is fulfilled
<br><br>
<?php html_print_image('images/help/event03.png', false, ['width' => '550px']); ?>
<br>
The configuration parameters of one rule that are possible are:
<br><br>
<b>Name:</b> Name of the rule.<br>
<b>User comment:</b> Free comment. <br>
<b>Event:</b> Regular expression that matches with the event text. <br>
<b>Window: </b>The events that have been generated out of the time window will be rejected<br>
<b>Count:</b> Number of events that have to match with the rule to it could be fired.<br>
<b>Agent: </b>Regular expression that matches with the name of the agent that generated the event. <br>
<b>Module:</b> Regular expression that matches with the name of the module that generated the event. <br>
<b>Module alerts:</b> Regular expression that matches with the name of the alert that generated the event. <br>
<b>Group: </b>Group the agent belongs to. <br>
<b>Criticity:</b> Event criticity. <br>
<b>Tag:</b> Tags associated to the event. <br>
<b>User:</b> User associated to the event. <br>
<b>Event type:</b> Kind of event. <br><br>
For example, we could configure a rule that matches with the events generated by any module that is named cpu_load of any agent of the Servers group that has associated the tag System when the module goes to critical status:
<br><br>
<?php html_print_image('images/help/event04.png', false, ['width' => '550px']); ?>
<br>
<p>Given the high number of events that the <?php echo get_product_name(); ?> database could store, the server works on an event window that is defined in the pandora_server.conf configuration file through the parameter event_window. The events that have been generated out of this time window won't be processed by the server, so it doesn't make sense to specify in a rule a time window higher to the one configured in the server </p>

View File

@ -1,64 +0,0 @@
<?php
/*
* @package Include/help/es
*/
?>
<h1>Alerta de evento</h1>
Desde la versión 4.0 de <?php echo get_product_name(); ?> se pueden definir alertas sobre los eventos, lo que permite trabajar desde una perspectiva completamente nueva y mucho más flexible. Esta es una característica Enterprise.<br><br>
Las Alertas de evento nuevas se crean pinchando en el botón Create en el menú Event alerts en el menú de Administración.
<br><br>
<?php html_print_image('images/help/event01.png', false, ['width' => '250px']); ?>
<br>
Una alerta de eventos está compuesta por distintas reglas, relacionadas entre por operadores lógicos (and, or, xor, nand, nor, nxor).
<br><br>
<?php html_print_image('images/help/event02.png', false, ['width' => '550px']); ?>
<br>
Para hacer más fácil trabajar con ellas, los parámetros de configuración de una alerta de eventos son idénticos a los de una alerta de módulo. Aquí se puede encontrar una explicación detallada de cada uno de ellos. Únicamente existen dos parámetros específicos de las alertas de eventos:
<br><br>
<b>Rule evaluation mode:</b> Hay dos opciones Pass y Drop. Pass significa que en caso de que un evento coincida con una alerta se sigan evaluando el resto de alertas. Drop significa que en caso de que un evento coincida con una alerta no se evaluen el resto de alertas.
<br><br>
<b>Group by:</b> Permite agrupar las reglas por agente, módulo, alerta o grupo. Por ejemplo, si se configura una regla para que salte cuando se reciban dos eventos críticos y se agrupa por agente, deberán llegar dos eventos críticos de un mismo agente. Se puede desactivar.
<br><br>
Cada regla se configura para saltar ante un determinado tipo de evento, cuando se cumple la ecuación lógica definida por las reglas y sus operadores, la alerta se dispara.
<br><br>
<?php html_print_image('images/help/event03.png', false, ['width' => '550px']); ?>
<br>
Los posibles parámetros de configuración de una regla son:
<br><br>
<b>Name:</b> Nombre de la regla.<br>
<b>User comment:</b> Comentario libre.<br>
<b>Event:</b> Expresión regular que casa con el texto del evento.<br>
<b>Window: </b>Los eventos que se hayan generado fuera de la ventana de tiempo serán descartados.<br>
<b>Count:</b> Número de eventos que tienen que casar con la regla para que ésta se dispare.<br>
<b>Agent: </b>Expresión regular que casa con el nombre del agente que generó el evento.<br>
<b>Module:</b> Expresión regular que casa con el nombre del módulo que generó el evento.<br>
<b>Module alerts:</b> Expresión regular que casa con el nombre de la alerta que generó el evento.<br>
<b>Group: </b>Grupo al que pertenece el Agente.<br>
<b>Criticity:</b> Criticidad del evento.<br>
<b>Tag:</b> Tags asociados al evento.<br>
<b>User:</b> Usuario asociado al evento.<br>
<b>Event type:</b> Tipo de evento. <br><br>
Por ejemplo, podríamos configurar una regla que case con los eventos generados por cualquier módulo que se llame cpu_load de cualquier agente del grupo Servers que lleve asociado el tag System cuando el módulo pasa al estado crítico:
<br><br>
<?php html_print_image('images/help/event04.png', false, ['width' => '550px']); ?>
<br>
<p>Dado el elevado número de eventos que puede llegar a albergar la base de datos de <?php echo get_product_name(); ?>, el servidor trabaja sobre una ventana de eventos que se define en el fichero de configuración pandora_server.conf mediante el parámetro event_window. Los eventos que se hayan generado fuera de esta ventana de tiempo no serán procesados por el servidor, de modo que no tiene sentido especificar en una regla una ventana de tiempo superior a la configurada en el servidor </p>