diff --git a/pandora_console/include/help/en/help_alert_command.php b/pandora_console/include/help/en/help_alert_command.php index ce60378f6c..b464b427bb 100644 --- a/pandora_console/include/help/en/help_alert_command.php +++ b/pandora_console/include/help/en/help_alert_command.php @@ -6,4 +6,4 @@

Alert commands

-

Pandora FMS's reaction to a value stating "out of range" can be diverse: it can be recorder on the syslog, an email or SMS alert can be sent, or the execution of any script found on the Pandora FMS device and that can be properly processed.

+

's reaction to a value stating "out of range" can be diverse: it can be recorder on the syslog, an email or SMS alert can be sent, or the execution of any script found on the device and that can be properly processed.

diff --git a/pandora_console/include/help/en/help_alert_config.php b/pandora_console/include/help/en/help_alert_config.php index 79c5f47255..b8d02b6282 100644 --- a/pandora_console/include/help/en/help_alert_config.php +++ b/pandora_console/include/help/en/help_alert_config.php @@ -8,7 +8,7 @@ Name: Name assigned to the action.
Group: Group the action belongs to.
- Command: In this field the command that will be used in case the alert is triggered can be defined. Users can choose from the different commands that are defined on Pandora. Depending on the command chosen a variable group of fields will be shown (specific to each command)
+ Command: In this field the command that will be used in case the alert is triggered can be defined. Users can choose from the different commands that are defined on . Depending on the command chosen a variable group of fields will be shown (specific to each command)
Threshold: The action’s execution threshold.
Command Preview: In this field, which can’t be edited, the command that will be run on the system will appear automatically.
Field X: In these fields:

@@ -48,7 +48,7 @@ Apart from the defined module macros, the following macros are also available:
  • _data_: Module data that caused the alert to fire.
  • _email_tag_: Emails associated to the module’s tags.
  • _event_cfX_: (Only event alerts) Key of the event custom field that fired the alert. For example, if there is a custom field whose key is IPAM, its value can be obtained using the _event_cfIPAM_ macro.
    • -
  • _event_description_: (Only event alerts) The textual description of the Pandora FMS event.
    • +
  • _event_description_: (Only event alerts) The textual description of the event.
  • _event_extra_id_ : (Only event alerts) Extra id.
  • _event_id_: (Only event alerts) ID of the event that triggered the alert.
  • _event_text_severity_: (Only event alerts) Event text severity (Maintenance, Informational, Normal Minor, Warning, Major, Critical).
    • @@ -71,7 +71,7 @@ Apart from the defined module macros, the following macros are also available:
  • _groupcustomid_: Group custom ID.
  • _groupother_: Other information about the group. Configured when the group is created.
  • _homeurl_ : It is a link of the public URL this must be configured in the general options of the setup.
    • -
  • _id_agent_: Agent’s ID, useful for building a direct URL that redirects to a Pandora FMS console webpage.
    • +
  • _id_agent_: Agent’s ID, useful for building a direct URL that redirects to a console webpage.
  • _id_alert_: Alert’s numeric ID (unique), used to correlate the alert with third party software.
  • _id_group_ : Agent group ID.
  • _id_module_: Module ID.
    • diff --git a/pandora_console/include/help/en/help_alert_macros.php b/pandora_console/include/help/en/help_alert_macros.php index cda2daf380..d2afc89053 100644 --- a/pandora_console/include/help/en/help_alert_macros.php +++ b/pandora_console/include/help/en/help_alert_macros.php @@ -33,7 +33,7 @@ Besides the defined module macros, the following macros are available:
  • _data_: Module data that caused the alert to fire.
  • _email_tag_: Emails associated to the module’s tags.
  • _event_cfX_: (Only event alerts) Key of the event custom field that fired the alert. For example, if there is a custom field whose key is IPAM, its value can be obtained using the _event_cfIPAM_ macro.
    • -
  • _event_description_: (Only event alerts) The textual description of the Pandora FMS event.
    • +
  • _event_description_: (Only event alerts) The textual description of the event.
  • _event_extra_id_: (Only event alerts) Extra id.
  • _event_id_: (Only event alerts) ID of the event that triggered the alert.
  • _event_text_severity_: (Only event alerts) Event text severity (Maintenance, Informational, Normal Minor, Warning, Major, Critical).
    • @@ -56,7 +56,7 @@ Besides the defined module macros, the following macros are available:
  • _groupcustomid_: Group custom ID.
  • _groupother_: Other information about the group. Configured when the group is created.
  • _homeurl_ : It is a link of the public URL this must be configured in the general options of the setup.
    • -
  • _id_agent_: Agent’s ID, useful for building a direct URL that redirects to a Pandora FMS console webpage.
    • +
  • _id_agent_: Agent’s ID, useful for building a direct URL that redirects to a console webpage.
  • _id_alert_: Alert’s numeric ID (unique), used to correlate the alert with third party software.
  • _id_group_ : Agent group ID.
  • _id_module_: Module ID.
    • diff --git a/pandora_console/include/help/en/help_alert_recovery.php b/pandora_console/include/help/en/help_alert_recovery.php index 4dae2c624a..3bf4747308 100644 --- a/pandora_console/include/help/en/help_alert_recovery.php +++ b/pandora_console/include/help/en/help_alert_recovery.php @@ -5,4 +5,4 @@ ?>

    Alert recovery

    -It defines whether Pandora FMS launches another alert when the alert’s condition is recovered. It has the same “field1”, but adds "[RECOVER]" to “field2” and “field3”. It is disabled by default. +It defines whether launches another alert when the alert’s condition is recovered. It has the same “field1”, but adds "[RECOVER]" to “field2” and “field3”. It is disabled by default. diff --git a/pandora_console/include/help/en/help_alert_type.php b/pandora_console/include/help/en/help_alert_type.php index 2832ab62e6..93325ecb6c 100644 --- a/pandora_console/include/help/en/help_alert_type.php +++ b/pandora_console/include/help/en/help_alert_type.php @@ -7,9 +7,9 @@ There are some preset alerts, on which it’s very likely you will have to make adjustments, 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. These alerts are predefined and cannot be deleted, however the user can define new ones that can use custom commands, and add them using Alert management. diff --git a/pandora_console/include/help/en/help_alerts.php b/pandora_console/include/help/en/help_alerts.php index 34f9d31ce0..85a4c9fcd8 100644 --- a/pandora_console/include/help/en/help_alerts.php +++ b/pandora_console/include/help/en/help_alerts.php @@ -14,7 +14,7 @@
  • Alert type: This can be selected from the previously generated alert list.
  • Max. Value: Defines the maximum value for a module. Any value above that threshold will trigger the alert.
    • -
  • Min. Value: Defines the minimum value for a module. Any value below that will trigger the alert. The ”max." & "min." couple are key values when defining an alert, since they define the range for normal values. Outside that range Pandora FMS will trigger the alert.
    • +
  • Min. Value: Defines the minimum value for a module. Any value below that will trigger the alert. The ”max." & "min." couple are key values when defining an alert, since they define the range for normal values. Outside that range will trigger the alert.
  • Alert text: In the case of string modules you can define a regular expression or a substring to match the contents of a data module in order to trigger the alert.
  • Time from / Time to: This defines a “valid” timespan to trigger alert.
  • Description: Describes the function of the alert, and it is useful to identify the alert among the others in the general view of alerts.
    • diff --git a/pandora_console/include/help/en/help_alerts_config.php b/pandora_console/include/help/en/help_alerts_config.php index 0348588629..7f772f1c39 100644 --- a/pandora_console/include/help/en/help_alerts_config.php +++ b/pandora_console/include/help/en/help_alerts_config.php @@ -3,22 +3,22 @@ * @package Include/help/es */ ?> -

    Pandora FMS’ Quick Guide to Alert Configuration

    +

    's Quick Guide to Alert Configuration


    Introduction to the Current Alert System

    People usually complain about the complexity of defining alerts on -Pandora FMS. Before, until version 2.0, alerts were easier to +. Before, until version 2.0, alerts were easier to configure. For each alert the condition and what it did when the action was not completed was defined for each case. It was a more "intuitive" thing (but it also had fields such as the "threshold" alert that caused many headaches to more than one person!). It was very simple, but, was it worth it ?

    -One of our “star” users (we mention this because he had A LOT of agents installed, and also knew the inner workings of Pandora FMS quite well) mentioned that creating an alert for 2000 modules was tremendously complicated, especially when it was necessary to modify something for all of them. Due to this, and other issues, we decided to modify the alert system so that it could be modular, so that the alert’s definition and its triggering condition (template) could be separated from the action that has to be executed when the alert is triggered (alert action) and from the command that is run within the action (Alert command). The combination of an alert template with a module triggers the alert itself.

    +One of our “star” users (we mention this because he had A LOT of agents installed, and also knew the inner workings of quite well) mentioned that creating an alert for 2000 modules was tremendously complicated, especially when it was necessary to modify something for all of them. Due to this, and other issues, we decided to modify the alert system so that it could be modular, so that the alert’s definition and its triggering condition (template) could be separated from the action that has to be executed when the alert is triggered (alert action) and from the command that is run within the action (Alert command). The combination of an alert template with a module triggers the alert itself.

    This way, if I have 1000 devices with a module named “Host Alive” and all of them have a related alert template named “Host Down” that when triggered executes an action named “Warn the Operator”, and I wish to change the minimum number of alerts that must be fired before the Operator is warned, I only have to change the definition on the template instead of going one by one over the 1000 alerts to modify that specific condition.

    -Many users only manage a few dozen devices, but there are many users with hundreds—even thousands—of systems monitored with Pandora FMS, and we have to try and make it so that with Pandora FMS all types of environments can be managed.
    +Many users only manage a few dozen devices, but there are many users with hundreds—even thousands—of systems monitored with , and we have to try and make it so that with all types of environments can be managed.



    @@ -118,9 +118,9 @@ html_print_image("images/help/alert07.png", false, array('width' => '550px')); ?>
    -We’ve now made it so that the system can discriminate when something is right (OK status, marked in GREEN) and when something is wrong (CRITICAL status, marked in RED). Now what we have to do is make the system send us an email when the module reaches that status. For this we’ll use Pandora FMS’ alert system.
    +We’ve now made it so that the system can discriminate when something is right (OK status, marked in GREEN) and when something is wrong (CRITICAL status, marked in RED). Now what we have to do is make the system send us an email when the module reaches that status. For this we’ll use 's alert system.

    -For this we need to make sure there is a command available that can do what we need it to (in this case, send an email). This example is easy because there is a predefined command on Pandora FMS that is meant to automate email sending, meaning this is already done.
    +For this we need to make sure there is a command available that can do what we need it to (in this case, send an email). This example is easy because there is a predefined command on that is meant to automate email sending, meaning this is already done.

    Configuring the Alert

    @@ -133,7 +133,7 @@ html_print_image("images/help/alert08.png", false, array('width' => '550px')); ?>
    -This action uses the “send email” command, and is really simple, since only one field from the form needs to be filled out (Field1) leaving the other two empty. This is one of the most confusing parts of the alert system on Pandora FMS: what are field1, field2 and field3?
    +This action uses the “send email” command, and is really simple, since only one field from the form needs to be filled out (Field1) leaving the other two empty. This is one of the most confusing parts of the alert system on : what are field1, field2 and field3?

    These fields are the ones used to “pass” the information on from the alert template to the command, and at the same time from that command to the next. This way both the template and the command can provide different information to the command. In this case, the command only establishes field1 and leaves field2 and field3 to be filled by the template, like what is shown next.

    @@ -163,19 +163,19 @@ The most critical parameters here are the following:

    Time threshold: Set to one day by default. If a module is constantly down during, for example, one day and and we have set a value of 5 minutes here, it means that alerts would be sent every 5 minutes. If we leave it at one day (24hrs.), it’ll only send the alert once, when it goes down. If the module recovers, and drops again, it’ll send another alert, but if it remains down from the second drop, it won’t send more alerts until 24hrs have gone by.

    -Min. Number of alerts: The minimum number of times that a condition will have to be met (in this case, that the module is in CRITICAL status) before Pandora FMS runs the actions linked to the alert template. It’s a way to avoid false positives “flooding” you with alerts, or so that an erratic behaviour doesn’t lead to multiply alerts going off. If we place a ‘1’ here it means that until this doesn’t happen at least once, it won’t be taken into account. If i set a value of ‘0’ the first time the module returns an error, the alert will go off.
    +Min. Number of alerts: The minimum number of times that a condition will have to be met (in this case, that the module is in CRITICAL status) before runs the actions linked to the alert template. It’s a way to avoid false positives “flooding” you with alerts, or so that an erratic behaviour doesn’t lead to multiply alerts going off. If we place a ‘1’ here it means that until this doesn’t happen at least once, it won’t be taken into account. If i set a value of ‘0’ the first time the module returns an error, the alert will go off.

    Max. Number of alerts: A value of 1 means that it’ll only execute the action once. If we have ’10’ set here, it’ll run the action 10 times. This is a way to limit the number of times an alert can go off.

    Again, we can see the fields “field1, field2, field3”. Now we can see that field1 is blank, which is precisely the one we’ve defined when configuring the action. Field2 and Field3 are used for the “send mail” action to define the subject and the message’s body, whilst Field1 is used to define the recipient(s) of said message (addresses must be separated by commas). Therefore the template, combined with the use of some macros, is defining the subject and alert message in a way that, in our case, we would receive a message like the following (supposing the agent where the module is placed is named “Farscape”):

    To: sancho.lerena@notexist.ocm
    -Subject: [PANDORA] Farscape cpu_sys is in CRITICAL status with a value +Subject: [MONITORING] Farscape cpu_sys is in CRITICAL status with a value of 20
    Message body:

    -This is an automated alert generated by Pandora FMS
    -Please contact your Pandora FMS operator for more information. *DO NOT* reply to +This is an automated alert generated by
    +Please contact your operator for more information. *DO NOT* reply to this email.

    Given that the default action is the one we have defined previously, all @@ -229,7 +229,7 @@ Alerts in standby are useful because they can be viewed without interfering with
    Using Alert Commands other than the “send email” command

    -The email, as a command is internal to Pandora FMS and can’t be configured, this means Field1, Field2 and Field3 are fields that are preset to be used as the recipient, subject and body for the email alert. But, what happens when we want to execute a different, more customised alert?
    +The email, as a command is internal to and can’t be configured, this means Field1, Field2 and Field3 are fields that are preset to be used as the recipient, subject and body for the email alert. But, what happens when we want to execute a different, more customised alert?

    We’ll define a new, totally customised command. Imagine that we want to generate a log file with each alert we find. The format for that log file has to be something like:

    @@ -262,9 +262,9 @@ We can see that the alert was fired at 18:17:10 because of the " farscape" agent, in the "cpu_sys" module, with a data value of "23.00" and with the description that we chose when we defined the action.

    -Since the command’s execution, the field order and other affairs can make it so we don’t really understand how it’s executed at the end of the command, the easiest thing to do is to activate the Pandora server debug traces (verbose 10) in the configuration file for the Pandora server ‘/etc/pandora/pandora_server.conf’, and then reset the server +Since the command’s execution, the field order and other affairs can make it so we don’t really understand how it’s executed at the end of the command, the easiest thing to do is to activate the server debug traces (verbose 10) in the configuration file for the server ‘/etc/pandora/pandora_server.conf’, and then reset the server (/etc/init.d/pandora_server restart). After, we take a look at the file /var/log/pandora/pandora_server.log and look for the exact line with the -alert command execution that we've defined, to see how the Pandora FMS +alert command execution that we've defined, to see how the server is launching and executing the command.

    diff --git a/pandora_console/include/help/en/help_cascade_protection.php b/pandora_console/include/help/en/help_cascade_protection.php index e534776177..913b4bd7d4 100644 --- a/pandora_console/include/help/en/help_cascade_protection.php +++ b/pandora_console/include/help/en/help_cascade_protection.php @@ -8,7 +8,7 @@

    -This option should be assigned to avoid an “alert storm” that can come in because a group of agents are unreachable. This type of behaviour occurs when an intermediary device, like for example a router, is down and all devices behind it, therefore, cannot be reached. Probably these devices aren’t down and chances indicate that they’re working with another router in HA mode. But, if nothing is done, it’s likely for Pandora FMS to think that they’re down since they can’t be tested using a Remote ICMP Proc test (a Ping check). +This option should be assigned to avoid an “alert storm” that can come in because a group of agents are unreachable. This type of behaviour occurs when an intermediary device, like for example a router, is down and all devices behind it, therefore, cannot be reached. Probably these devices aren’t down and chances indicate that they’re working with another router in HA mode. But, if nothing is done, it’s likely for to think that they’re down since they can’t be tested using a Remote ICMP Proc test (a Ping check).

    When you enable cascade protection for an agent, this means that if any of its parents has a CRITICAL alert fired, then the agent’s alerts WILL NOT BE fired. If the agent's parent has a module in CRITICAL or several alerts with less criticality than CRITICAL, alerts from the agent will be fired as normal if needed. Cascade protection checks parent alerts with CRITICAL priority, including the correlated alerts assigned to the parent.

    @@ -23,7 +23,7 @@ If you want to use an advanced cascade protection system, just use correlation a

    -This option should be assigned to avoid an “alert storm” that can come in because a group of agents are unreachable. This type of behaviour occurs when an intermediary device, like for example a router, is down and all devices behind it, therefore, cannot be reached. Probably these devices aren’t down and chances indicate that they’re working with another router in HA mode. But, if nothing is done, it’s likely for Pandora FMS to think that they’re down since they can’t be tested using a Remote ICMP Proc test (a Ping check). +This option should be assigned to avoid an “alert storm” that can come in because a group of agents are unreachable. This type of behaviour occurs when an intermediary device, like for example a router, is down and all devices behind it, therefore, cannot be reached. Probably these devices aren’t down and chances indicate that they’re working with another router in HA mode. But, if nothing is done, it’s likely for to think that they’re down since they can’t be tested using a Remote ICMP Proc test (a Ping check).

    When you enable cascade protection for an module, this means that if this parent agent module has a CRITICAL alert fired, then agent alerts WILL NOT BE fired.

    diff --git a/pandora_console/include/help/en/help_categories.php b/pandora_console/include/help/en/help_categories.php index 57de2bbda0..ee0bf3e83d 100644 --- a/pandora_console/include/help/en/help_categories.php +++ b/pandora_console/include/help/en/help_categories.php @@ -3,6 +3,6 @@ * @package Include/help/en */ ?> -

    Categories in Pandora FMS

    +

    Categories in

    On the system some categories can be created and configured to later be assigned to any module desired.
    The only user that has the permits to create and configure these categories is the administrator and they can be used to apply a “fee” to modules depending on the category the are sorted into. diff --git a/pandora_console/include/help/en/help_configure_gis_map.php b/pandora_console/include/help/en/help_configure_gis_map.php index 3aeefe5e1d..87ec1222fb 100644 --- a/pandora_console/include/help/en/help_configure_gis_map.php +++ b/pandora_console/include/help/en/help_configure_gis_map.php @@ -10,14 +10,14 @@ This page is the place to configure a GIS Map.

    Map Name

    -Each map has a desciptive name used to recognice the map within Pandora FMS. +Each map has a desciptive name used to recognice the map within .

    Select Connections

    The first step is to select the main connection used in this GIS Map. At least one connection must be selected to configure the GIS Map, but it's possible to add more by pressing the "Add")); ?> (Add) icon.

    -When the firs connection is set, Pandora FMS asks if you want to use the default values of the connection for the map, to avoid to write again all the information. Also if the default connection for the map is changed (using the radio button), Pandora FMS will ask again if you want to use the values of the new default connection. +When the firs connection is set, asks if you want to use the default values of the connection for the map, to avoid to write again all the information. Also if the default connection for the map is changed (using the radio button), will ask again if you want to use the values of the new default connection.

    Map Paramteres

    diff --git a/pandora_console/include/help/en/help_context_module_unknow.php b/pandora_console/include/help/en/help_context_module_unknow.php index 891306a655..aa2fda8b4f 100644 --- a/pandora_console/include/help/en/help_context_module_unknow.php +++ b/pandora_console/include/help/en/help_context_module_unknow.php @@ -3,7 +3,7 @@ * @package Include/help/en */ ?> -

    Unknown modules in Pandora

    +

    Unknown modules in

    You may have unknown modules for many reasons. Unknown module is a special status for a module/monitor which means “I dont have recent data for this monitor and I should have data”. A monitor goes to unknown status when doesnt receive nothing in at least its interval (for example, 300 seconds) multiplied by two, in this case, if you doesn't receive nothing in ten minutes, monitor goes to unknown.

    @@ -11,10 +11,10 @@ You may have unknown modules for many reasons. Unknown module is a special statu These are a few cases where you can get unknown modules: