Difference between revisions of "Pandora: Metaconsole: Documentation en: Operation"

From Pandora FMS Wiki
Jump to: navigation, search
(Monitor Creation)
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
[[Pandora:Documentation_en#Part_6._Metaconsole|Go back to Pandora FMS documentation index]]
 
[[Pandora:Documentation_en#Part_6._Metaconsole|Go back to Pandora FMS documentation index]]
 +
  
 
= Operation =
 
= Operation =
  
This section will explain how to operate (create, edit, delete) data from the instances from the metaconsole. This operation is done from a single editor, we call it "Wizard" or monitoring assistant.
+
This section will explain how to operate (create, edit, delete) data from the instances from the metaconsole, as well as creating programmed tasks with the Cron Jobs Extensions.
 +
 
 +
This operation is carried out from the same Wizard.
  
 
== Assistant / Wizard==
 
== Assistant / Wizard==
  
Monitoring Wizard or Wizard is used to configure the agents and modules from the Metaconsole alerts, it's an exclusive component of the metaconsole, and it's not present in the regular console.
+
The monitoring Wizard is used to configure agents, modules and their alerts from the Metaconsole.
  
 
'''Issues to consider'''
 
'''Issues to consider'''
  
* The operation of modules will be implemented as components of both local network. This is not intended to create modules "from scratch"
+
* The operation of modules will be implemented as both local and network components. This is not intended to create modules "from scratch"
  
* You can create agents from scratch, with a simplified configuration, setting up the remaining fields by default.
+
* Agents that can be created from scratch, with a simplified configuration, setting up the remaining fields by default.
  
* Modules created in the agent (manually or outside the metaconsole wizard) cannot be edited in the Wizard.
+
* Modules created in the instance cannot be edited in the Wizard.
  
* Modules created in the Wizard will be indistinguishable from those created in the agent by other means. These modules can be edited and deleted from both the Wizard and from the agent setup directly.
+
* Modules created in the Wizard will not be distinguished from those created in the agent by other means. These modules can be edited and deleted from both the Wizard and from the instance setup directly.
  
'''Sample:'''
+
'''Example:'''
 
   
 
   
We have a metaconsole and two pandora instances, in which we have full access (read and administration rights)
+
There is a metaconsole and two pandora instances, where you have full access (read and administration permissions).
  
 
The instances have two agents with three modules each one:  
 
The instances have two agents with three modules each one:  
 
   
 
   
<center><br><br>
+
<center>
 
[[image:Wizard_example1.png|600px]]
 
[[image:Wizard_example1.png|600px]]
</center><br><br>
+
</center>
  
The first time we enter in the metaconsole wizard, you will see the agents, but not the modules:
+
The first time you enter the metaconsole wizard, you will see the agents, but not the modules:
 
   
 
   
<center><br><br>
+
<center>
 
[[image:Wizard_example2.png|500px]]
 
[[image:Wizard_example2.png|500px]]
</center><br><br>
+
</center>
 
   
 
   
We create from the metaconsole, a module to monitor the harddisk in each agent.
+
Create from the metaconsole a module to monitor the harddisk in each agent.
 
   
 
   
<center><br><br>
+
<center>
 
[[image:Wizard_example5.png|600px]]
 
[[image:Wizard_example5.png|600px]]
</center><br><br>
+
</center>
  
Now, from the wizard, we can see the module, and edit the created module:
+
Now, from the wizard, you can see and edit the created modules:
 
   
 
   
<center><br><br>
+
<center>
 
[[image:Wizard_example3.png|500px]]
 
[[image:Wizard_example3.png|500px]]
</center><br><br>
+
</center>
  
And from each Pandora FMS instance we can see the modules and edit them.
+
And from each Pandora FMS instance you may see the modules and edit them.
 
   
 
   
<center><br><br>
+
<center>
 
[[image:Wizard_example4.png|650px]]
 
[[image:Wizard_example4.png|650px]]
</center><br><br>
+
</center>
 
From the instances, is indistinguishable if a module has been created from the metaconsole or not.
 
  
{{Tip|A different case happen in the metaconsole three view, where you can see all modules, where you will see all modules that have access regardless of the actions of the Wizard. We can also view and delete (but not edit) the modules created from the Instance, when you edit an agent from the wizard.}}
+
{{Tip|A different case is that of the Metaconsole three view, where all modules you have access to can be seen, regardless of the actions of the Wizard. You may also view and delete (but not edit) the modules created from the Instance, when editing an agent from the Wizard.}}
  
 
=== Access ===
 
=== Access ===
Line 61: Line 62:
 
There are two ways to access the wizard:
 
There are two ways to access the wizard:
  
* Direct access to the Wizard from the main page of the metaconsole.
+
* Direct access to the Wizard from the main page of the Metaconsole.
  
 
<center><br><br>
 
<center><br><br>
[[image:Metaconsole_home.png|800px]]
+
[[image:Metaconsole_home_new.png]]
 
</center><br><br>
 
</center><br><br>
 +
  
 
* From the top menu, in the monitoring section.
 
* From the top menu, in the monitoring section.
 
   
 
   
<center><br><br>
+
<center><br><br>
[[image:Wizard_main.png|800px]]
+
[[image:Wizard_main_new.png]]
 
</center><br><br>
 
</center><br><br>
  
All users with wizard access will be able to access to module configuration and alerts. Agent configuration must be activated "per user", on demand.
+
 
 +
All users with wizard access will be able to access to monitor and alert configuration. Agent configuration must be activated "per user", on demand.
  
 
=== Action Flow ===
 
=== Action Flow ===
  
In the following graph is showed the complete flow of actions that are possible to do in the Metaconsole Wizard:
+
The following graph shows the complete flow of actions that are possible to be carried out in the Metaconsole Wizard:
  
<center><br><br>
+
<center>
 
[[image:Wizard_flow.png|800px]]
 
[[image:Wizard_flow.png|800px]]
</center><br><br>
+
</center>
  
 
=== Modules===
 
=== Modules===
  
In the module option we can create one module or edit one that is already created.
+
In the module option, you may create a module or edit one that is already created.
  
<center><br><br>
+
<center>
 
[[image:Wizard_modules.png|800px]]
 
[[image:Wizard_modules.png|800px]]
</center><br><br>
+
</center>
  
 
==== Creation ====
 
==== Creation ====
  
In the module creation '''the first step will be select one agent''' where to create it. It could be filtered by group or search by name between the available agents.
+
In module creation '''the first step will be selecting one agent''' where to create it. It could be filtered by group or searched by name between the available agents.
  
{{Tip|The agents available will be those of each Instance where our user has creation permissions (AW)
+
{{Tip|The available agents will be those of each Instance where the new user has creation permissions (AW).}}
}}
 
  
<center><br><br>
+
<center>
 
[[image:Wizard_modules_create1.png|800px]]
 
[[image:Wizard_modules_create1.png|800px]]
</center><br><br>
+
</center>
  
After selecting the agent, we should click in ''Create module''. Now we should select the type of module that we will create:
+
After selecting the agent, click on ''Create module''. Now select the type of module to create:
  
 
* Monitor
 
* Monitor
 
* Web Check
 
* Web Check
 
<center><br><br>
 
[[image:Wizard_modules_create2.png|800px]]
 
</center><br><br>
 
  
 
===== Monitor Creation  =====
 
===== Monitor Creation  =====
  
Monitor creation is done using the module templates/components.These components are classified by groups:
+
Monitor creation is done using module templates/components.These components are classified by groups:
  
The nature of the module (local or remote) will be transparent for the user, and in the selection combos, the components of both types will be mixed.
+
The nature of the module (local or remote) will be visible for the user, and in the selection combos, the components of both types will be mixed.
  
If we select the component, the description of it will be shown.
+
When selecting the component, its description will be shown.
  
 
<center><br><br>
 
<center><br><br>
[[image:Wizard_modules_create_monitors.png|800px]]
+
[[image:Wizard_modules_create_monitors_new.png]]
 
</center><br><br>
 
</center><br><br>
  
To configure the monitor we click on ''Create''.
 
  
The configuration of one monitor will be done in 4 steps:
+
To configure the monitor, click on ''Create''.
  
 +
The monitor configuration consists of in 4 steps:
  
* '''General Configuration:''' The monitor more general data (name,description,Ip,etc.)
+
 
 +
* '''General Configuration:''' Monitor general data (name,description,Ip,etc.).
  
 
<center><br><br>
 
<center><br><br>
[[image:Wizard_modules_create_monitors_general.png|800px]]
+
[[image:Wizard_modules_create_monitors_general_new.png]]
 
</center><br><br>
 
</center><br><br>
  
* '''Advanced Configuration:''' Monitor advanced data (Thresholds, interval, etc).
 
  
<center><br><br>
+
* '''Advanced Configuration:''' Monitor advanced data (thresholds, interval, etc).
 +
 
 +
<center>
 
[[image:Wizard_modules_create_monitors_advanced.png|800px]]
 
[[image:Wizard_modules_create_monitors_advanced.png|800px]]
</center><br><br>
+
</center>
  
* '''Alerts:''' An alert editor where to configure in the module alerts of the template alerts of whom we have permissions  
+
* '''Alerts:''' An alert editor where to configure in the module alert template alerts you have permissions for.
  
<center><br><br>
+
<center>
 
[[image:Wizard_modules_create_monitors_alerts.png|800px]]
 
[[image:Wizard_modules_create_monitors_alerts.png|800px]]
</center><br><br>
+
</center>
  
* '''Previsualization:'''' Data introduced in only one scree before finishing the process.
+
* '''Preview:'''' Data displayed in only one scree before finishing the process.
  
<center><br><br>
+
<center>
 
[[image:Wizard_modules_create_monitors_previous.png|800px]]
 
[[image:Wizard_modules_create_monitors_previous.png|800px]]
</center><br><br>
+
</center>
 +
 
 +
=====Creating web checks=====
  
{{Tip|Data to fill in depends on the component we use. Depending if it is a network or a local component and if it is basic or advanced .}}
+
For web check creation, the web check option must be enabled in “customize sections” from Metaconsole's Metasetup.
  
=====Creating Web Check=====
+
There are two different types of web checks:
  
The web checks can have two different kinds:
+
* '''Step by step:''' Web checks are configured with a wizard without the need to know its syntax.
  
* '''Step by step:'''The web checks are configured with an assistant without the need to know its syntax
+
* '''Advanced:''' Web checks are ''raw'' configured in a box text. It is only available for users with advanced permissions.
  
* '''Advanced:''' The web checks are configured ''in raw'' in a box text. It is only for users with advanced permissions.
+
{{Tip|If the user does not have advanced permissions, the advanced check option will not be available. It will lead you directly to configure a '''step by step''' check.}}
  
 
<center><br><br>
 
<center><br><br>
[[image:Wizard_modules_create_webchecks.png|800px]]
+
[[image:Wizard_modules_create_webchecks_new.png]]
 
</center><br><br>
 
</center><br><br>
  
{{Tip|If the user doesn't have advanced permissions,it won't have option to configure an advanced check. It will directly pass to configure a check '''Step by step'''.}}
 
 
Once you have selected the modality, we click on ''Create''.
 
  
 
The web check configuration will be done, same as with monitors in 4 steps:
 
The web check configuration will be done, same as with monitors in 4 steps:
  
* '''General Configuration:''' The monitor more general data (name, description, type.. and the check according to their modality)
+
* '''General Configuration:''' Monitor general data (name, description, type, etc. As well as the check according to its modality).
  
:* Modality Step by Step:
+
:* Step by Step Modality:
 
<center><br><br>
 
<center><br><br>
[[image:Wizard_modules_create_webchecks_stepbystep.png|800px]]
+
[[image:Wizard_modules_create_webchecks_stepbystep_new.png]]
 
</center><br><br>
 
</center><br><br>
  
 
:* Advanced Modality:
 
:* Advanced Modality:
 
<center><br><br>
 
<center><br><br>
[[image:Wizard_modules_create_webchecks_advanced.png|800px]]
+
[[image:Wizard_modules_create_webchecks_avanzado_new.png]]
 
</center><br><br>
 
</center><br><br>
  
: The kind of check can be:
 
:* Latency: In this check is obtained the total time that pass from the first petition until that the last one is checked. If there are several checks the average will be get.
 
  
:* Response: In this check is obtained a 1 (OK) or a 0 (failed) as result when checking all the transaction. If there are several attempts and some of them fails, then it is considered that the whole test fails also.
+
: This kind of check can be:
 +
:* Latency: This check obtains the total time that went by from the first petition until that the last one is checked. If there are several checks the average will be shown.
  
* '''Advanced Configuration:'''Monitor advanced data (Thresholds, interval, proxy configuration, etc)
+
:* Response: This check obtains 1 (OK) or 0 (failed) as result when checking the whole transaction. If there are several attempts and some of them fail, then it is considered that the whole test also fails.
  
 +
* '''Advanced Configuration:'''Monitor advanced data (thresholds, interval, proxy configuration, etc.).
 +
:* Modality Step by Step:
 +
<center><br><br>
 +
[[image:Wizard_modules_create_webchecks_advanced_conf.png]]
 +
</center><br><br>
 +
:* Advanced Modality:
 
<center><br><br>
 
<center><br><br>
[[image:Wizard_modules_create_webchecks_advanced_conf.png|800px]]
+
[[image:Wizard_modules_create_webchecksadvanced_advanced_conf.png]]
 
</center><br><br>
 
</center><br><br>
  
* '''Alerts:''' An alert editor where to configure in the module alerts of the alert templates on which we have permissions. Same as in the monitor creation.
 
  
* '''Previsualization'''' Data introduced on a single screen before finishing the process. Same as with the monitor creation.
+
* '''Alerts:''' An alert editor where to configure in the module alerts of the alert templates you have permissions on. Same as in monitor creation.
 +
 
 +
* '''Preview:'''' Data shown on a single screen before finishing the process. Same as with monitor creation.
  
 
===== Module Creation Flow =====
 
===== Module Creation Flow =====
  
<center><br><br>
+
<center>
 
[[image:Wizard_flow_create_module.png|800px]]
 
[[image:Wizard_flow_create_module.png|800px]]
</center><br><br>
+
</center>
  
 
==== Administration ====
 
==== Administration ====
  
The modules created from the Metaconsole Wizard will can be managed (edit and delete them).
+
The modules created from the Metaconsole Wizard can be managed (edited and deleted).
  
{{Warning|The modules created in the Instance will not be visible in the Wizard}}
+
{{Warning|The modules created in the Instance will not be visible in the Wizard.}}
  
The first step is to select the module that we want to manage. We can filter by group and search by agent to find it quickly.
+
The first step is to select the module to manage. You may filter by group and search by agent to find it quickly.
  
 
<center><br><br>
 
<center><br><br>
[[image:Wizard_modules_manage.png|800px]]
+
[[image:Wizard_modules_manage_new.png]]
 
</center><br><br>
 
</center><br><br>
  
Once it has been selected, we can do click on ''Delete'' to delete it or on ''Edit'' to edit it.
 
  
When editing it we will have access to a screen very similar to the creation one with the same 4 steps:
+
Once it has been selected, click on ''Delete'' to delete it or on ''Edit'' to edit it.
 +
 
 +
When editing you will have access to a screen very similar to the creation one with the same 4 steps:
  
* '''General Configuration:''' Edition of the monitor more general data.
+
* '''General Configuration:''' Monitor general data.
* '''Advanced Configuration:''' Edition of the monitor advanced data.
+
* '''Advanced Configuration:''' Monitor advanced data.
* '''Alerts:''' Monitor alert edition
+
* '''Alerts:''' Monitor alert edition.
 
* '''Preview:'''' The data modified in a single screen before finishing the process.
 
* '''Preview:'''' The data modified in a single screen before finishing the process.
  
{{Tip|The management of local and remote modules and web checks is transparent for the user.The fields to edit change but the editing/deleting process is the same}}
+
{{Tip|Local and remote module and web check management is visible for the user.The fields to edit change but the editing/deleting process is the same.}}
  
===== Module Administration Flow =====
+
===== Module administration flow =====
  
<center><br><br>
+
<center>
 
<a href="http://wiki.pandorafms.com/images/6/65/Wizard_modules.png">[[image:Wizard_flow_manage_module.png|700px]]</a>
 
<a href="http://wiki.pandorafms.com/images/6/65/Wizard_modules.png">[[image:Wizard_flow_manage_module.png|700px]]</a>
</center><br><br>
+
</center>
  
 
=== Alerts ===
 
=== Alerts ===
  
The alert editor is a direct link to the alert step in the module edition. This is done to make its access and management easier.  
+
The alert editor is a direct link to the alert step in module edition. This is done to make its access and management easier.  
  
In the alert options we could create an alert or edit one that is already created. Alerts could be only added ore created in modules to which we have access from the Wizard. Or, what is the same, those modules created from the Wizard and on which we have ACL permissions.
+
In the alert options you may create an alert or edit one that is already created. Alerts could be only added or created in modules to which you have access from the Wizard. Or those modules created from the Wizard and you have ACL permissions on.
  
<center><br><br>
+
<center>
[[image:Wizard_alerts.png|900px]]
+
[[image:Wizard_alerts.png|800px]]
</center><br><br>
+
</center>
  
 
==== Creation====
 
==== Creation====
  
In the alert creation we will select a module where we want create the alert.
+
In alert creation, select a module where you wish to create the alert.
  
<center><br><br>
+
<center>
[[image:Wizard_alerts_creation.png|900px]]
+
[[image:Wizard_alerts_creation.png|800px]]
</center><br><br>
+
</center>
  
After selecting the alert, we will click on ''Create alert''.
+
After selecting the alert, click on ''Create alert''.
  
The following screen will be the edition of the module associated to the alert in the alert edition step.
+
The following screen will be the edition of the module linked to the alert in the alert edition step.
  
 
+
<center>
<center><br><br>
+
[[image:Wizard_modules_create_monitors_alerts.png|800px]]
[[image:Wizard_modules_create_monitors_alerts.png|900px]]
+
</center>
</center><br><br>
 
  
 
===== Alert Creation Flow =====
 
===== Alert Creation Flow =====
  
<center><br><br>
+
<center>
 
[[image:Wizard_flow_create_alert.png|800px]]
 
[[image:Wizard_flow_create_alert.png|800px]]
</center><br><br>
+
</center>
  
 
==== Administration====
 
==== Administration====
Line 271: Line 276:
 
The alerts created from the Metaconsole Wizard can be managed (edited and deleted).
 
The alerts created from the Metaconsole Wizard can be managed (edited and deleted).
  
{{Warning|The alerts created in the Instance won't be visible in the Wizard}}
+
{{Warning|Alerts created in the Instance will not be visible in the Wizard.}}
  
The first step is to select the alert that we want manage. We can filter by group and search by agent to find it faster.
+
The first step is to select the alert to manage. Filter by group and search by agent to find it faster.
  
 
<center><br><br>
 
<center><br><br>
[[image:Wizard_alerts_management.png|900px]]
+
[[image:Wizard_alerts_management_new.png]]
 
</center><br><br>
 
</center><br><br>
  
Once it has been selected, we can click on ''Delete'' to delete it or on ''Edit'' to edit it.
 
  
If we click on ''Edit'' we will go, same as when we create an alert, to the edition of the associated module in the alert edition step.
+
Once selected, click on ''Delete'' to delete it or on ''Edit'' to edit it.
 +
 
 +
If you click on ''Edit'' you will be redirected, same as when creating an alert, to the edition of the associated module in the alert edition step.
  
<center><br><br>
 
[[image:Wizard_modules_create_monitors_alerts.png|900px]]
 
</center><br><br>
 
  
===== Alert Management Flow =====
+
===== Alert management flow =====
  
<center><br><br>
+
<center>
[[image:Wizard_flow_manage_alert.png|900px]]
+
[[image:Wizard_flow_manage_alert.png|800px]]
</center><br><br>
+
</center>
  
 
=== Agents===
 
=== Agents===
  
In the option of agents we can create an agent or edit an already created one.
+
In agent option you can create an agent or edit an already created one.
  
<center><br><br>
+
<center>
[[image:Wizard_agents.png|900px]]
+
[[image:Wizard_agents.png|800px]]
</center><br><br>
+
</center>
  
 
==== Creation ====
 
==== Creation ====
  
The creation of one agent is done in one of the configured Instances.
+
Agent creation is done in one of the configured Instances.
  
The administrator users can select in one of them create it. However, the standard users will have assigned one Instance where they will create the agents in a transparent way.
+
Administrator users can select in which one to create it. However, the standard users will have an Instance assigned where they will create the agents in a transparent way.
  
 
This assignment is done at [[Pandora:Metaconsole:Documentation_en:Administration#User_Management|User management]]
 
This assignment is done at [[Pandora:Metaconsole:Documentation_en:Administration#User_Management|User management]]
  
The agent configuration will be done in three steps:
+
Agent configuration will be done in three steps:
  
  
* '''General Configuration:'''  The monitor more general data (name, description, IP, etc). and in case of being administrator, also the Instance where it will be created.  
+
* '''General Configuration:'''  Monitor general data (name, description, IP, etc). And in case of being administrator, also the Instance where it will be created.  
  
<center><br><br>
+
<center>
[[image:Wizard_agents_general.png|900px]]
+
[[image:Wizard_agents_general.png|800px]]
</center><br><br>
+
</center>
  
* '''Modules:''' A module editor, where we select from a combo the network components that are available and we add them to the agent.
+
* '''Modules:''' A module editor, where to select from a combo the available network components and add them to the agent.
  
<center><br><br>
+
<center>
[[image:Wizard_agents_modules.png|900px]]
+
[[image:Wizard_agents_modules.png|800px]]
</center><br><br>
+
</center>
  
* '''Preview:''' Data introduced in a single screen before finishing the process.
+
* '''Preview:''' Data displayed in a single screen before finishing the process.
  
<center><br><br>
+
<center>
[[image:Wizard_agents_preview.png|900px]]
+
[[image:Wizard_agents_preview.png|800px]]
</center><br><br>
+
</center>
  
 
===== Agent Creation Workflow =====
 
===== Agent Creation Workflow =====
  
<center><br><br>
+
<center>
[[image:Wizard_flow_create_agent.png|900px]]
+
[[image:Wizard_flow_create_agent.png|800px]]
</center><br><br>
+
</center>
  
 
==== Administration ====
 
==== Administration ====
  
Those agents which user can modify its configuration (due ACL setup), can be administer (edit and delete).
+
Those agents the user has access to through ACL configuration can be managed (edited and deleted).
  
First step, is select the agent you want to administer. You can filter by group and/or search for a text substring, to find it easily.
+
The first step is selecting the agent to manage. Filter by group and/or search for a text substring, to find it easily.
  
<center><br><br>
+
<center>
[[image:Wizard_agents_manage.png|900px]]
+
[[image:Wizard_agents_manage.png|800px]]
</center><br><br>
+
</center>
  
Once you selected the agent, you can click on ''Delete'' to remove it, or in ''Edit'' to edit it. Edition screen is similar to the creation screen, with the same three steps:
+
Once the agent is selected, click on ''Delete'' to remove it, or on ''Edit'' to edit it. The edition screen is similar to the creation screen, with the same three steps:
  
* '''General configuration:''' Edit here the general information about the agent.
+
* '''General configuration:''' General information about the agent.
 
* '''Modules:''' Edit the agent modules
 
* '''Modules:''' Edit the agent modules
* '''Previsualization:'''' Just a preview to be sure everything it's ok.
+
* '''Previsualization:'''' Preview to make sure everything is ok.
  
{{Tip|Unlike management modules in an agent's edition will also see the modules that have been created with the Wizard}}
+
{{Tip|Unlike module management, agent edition also shows the modules that have not been created with the Wizard}}
  
 
===== Agent administration workflow =====
 
===== Agent administration workflow =====
  
 +
<center>
 +
[[image:Wizard_flow_manage_agent.png|800px]]
 +
</center>
 +
 +
== Cron Jobs ==
 +
To be able to acces this Metaconsole action, go to ''Extensions > Cron Jobs''.
 +
First, configure correctly the “crontab file” like this:
 
<center><br><br>
 
<center><br><br>
[[image:Wizard_flow_manage_agent.png|900px]]
+
[[image:Cron_tab_config.png]]
 
</center><br><br>
 
</center><br><br>
 +
Once done, perform the desired execution tasks. There is more information in the following [[Pandora:Documentation_en:Managing_and_Administration#Cron_Job|link]]
  
== Differences Depending on Access Level ==
+
== Differences depending on access level ==
  
The modules and alerts have configuration differences depending on the access level, based on how was created in the Wizard and templates and the user's access level that you set. Setting agents have fewer restrictions but also depends on the level of access.
+
The modules and alerts have configuration differences depending on the access level to the Wizard that the templates and components they were created with have and the access level of the user that configures them. Agent settings have fewer restrictions but also depends on the access level.
  
 
=== Monitors ===
 
=== Monitors ===
  
Configuration of a monitor will change depending of the access level on the component used: basic or advanced.
+
Monitor configuration will change depending of the access level on the component used: basic or advanced.
  
When the access level is "Advanced", you will have some additional fields:
+
When the access level is "Advanced", there will be some additional fields:
  
* The name (in the "basic" level, it takes the name of the component, in advaned, you can redefine it).
+
* The name (at the "basic" level, it takes the name of the component).
* Units.
+
* Monitor units.
* Macros (when are local modules or remote plugin modules). In the basic level, it will be crated with the default values.
+
* Macros (in local modules or remote plugin modules' cases). At the basic level, it will be crated with the default values.
  
 
=== WEB Checks  ===
 
=== WEB Checks  ===
  
When setting up a "webcheck", user with "advanced" user level, can choose between the "step by step" configuration or use the detailed, low level mode.
+
When setting up a "webcheck", user with "advanced" access can choose between the "step by step" or "advanced" configurations.
 
 
Users with "basic" level, only can use the "step by step" configuration mode.
 
  
WEB monitoring wizard (step by step configuration), uses a guided tour to setup up the different options, without showing the underlaying syntax. Advanced mode editor, allow user to write the full-sintax WEB monitoring module, which is more powerful and flexible, but also more complex.
+
Advanced checks are manually configured and write the ceck with their syntax in a text box. In addition, created module units can be defined.
  
 
=== Alerts ===
 
=== Alerts ===
  
In the alerts, the access level: ''Basic'' or ''advanced'' in the associated template, only affects to it's visibility: Alerts at "basic" level, can be seen by anybody which access to the wizard, and the "advanced" level, only by the users which have "advanced" level access.
+
In the alerts, the ''Basic'' or ''advanced'' levels of the associated template only affect its visibility. Basic level alerts can be seen by user that accesses the wizard, and the advanced level ones only by users whth advanced level access.
  
Is the component level which defines the "level" of the alerts in that module. A module can be associated with any of the alerts visible for the user.
+
It is the component level the one that defines the alert settings in their module. A module can be associated with any of the alerts visible for the user.
  
If it is a ''Basic'' component or a WEB Check ''styep-by-step'',the alerts will be created with a default action assigned, and cannot be changed.
+
If it is a basic component or a styep-by-step web check, the alerts will be created with a default action assigned, which cannot be changed.
  
If it is an ''Advanced'' component or a complex/advanced WEB Check, the default action can be changed.
+
If it is an advanced component or a complex/advanced WEB Check, when assigning an alert the default action will appear but any desired action can be assigned.
  
 
=== Agents ===
 
=== Agents ===
  
Agent management will give access to all agents accessible to the user, depending on it's ACL configuration. Doesn't depend on wizard access level of the user (advanced, basic), and neither if the modules were created with the wizard or from the node.
+
Agent management will '''give access to all agents accessible to the user, depending on its ACL configuration'''. Regardless of the user access level (advanced, basic), or whether the modules were created with the wizard or in the instance.
 +
 
 +
The only restriction about this, comes when adding modules in the edit/create view. This setup is done only by using only '''network''' components and with '''basic''' level. The reason for this behaviour is because this kind of modules do not have any configuration, and the ''advanced'' wizard level modules usually need extra configuration.
  
The only restriction about this, comes in the step to add modules in the edit/create view. This setup is done only by using network components and with "basic" level.
 
  
The reason for this behaviour is because this kind of modules doesn't have any configuration, and the ''advanced'' wizard level modules, should need extra configuration.
 
  
 
[[Pandora:Documentation_en#Part_6._Metaconsole|Go back to Pandora FMS documentation index]]
 
[[Pandora:Documentation_en#Part_6._Metaconsole|Go back to Pandora FMS documentation index]]
  
 
[[Category:Pandora FMS Metaconsole]]
 
[[Category:Pandora FMS Metaconsole]]

Latest revision as of 11:21, 27 October 2020

Go back to Pandora FMS documentation index


1 Operation

This section will explain how to operate (create, edit, delete) data from the instances from the metaconsole, as well as creating programmed tasks with the Cron Jobs Extensions.

This operation is carried out from the same Wizard.

1.1 Assistant / Wizard

The monitoring Wizard is used to configure agents, modules and their alerts from the Metaconsole.

Issues to consider

  • The operation of modules will be implemented as both local and network components. This is not intended to create modules "from scratch"
  • Agents that can be created from scratch, with a simplified configuration, setting up the remaining fields by default.
  • Modules created in the instance cannot be edited in the Wizard.
  • Modules created in the Wizard will not be distinguished from those created in the agent by other means. These modules can be edited and deleted from both the Wizard and from the instance setup directly.

Example:

There is a metaconsole and two pandora instances, where you have full access (read and administration permissions).

The instances have two agents with three modules each one:

Wizard example1.png

The first time you enter the metaconsole wizard, you will see the agents, but not the modules:

Wizard example2.png

Create from the metaconsole a module to monitor the harddisk in each agent.

Wizard example5.png

Now, from the wizard, you can see and edit the created modules:

Wizard example3.png

And from each Pandora FMS instance you may see the modules and edit them.

Wizard example4.png

Info.png

A different case is that of the Metaconsole three view, where all modules you have access to can be seen, regardless of the actions of the Wizard. You may also view and delete (but not edit) the modules created from the Instance, when editing an agent from the Wizard.

 


1.1.1 Access

There are two ways to access the wizard:

  • Direct access to the Wizard from the main page of the Metaconsole.


Metaconsole home new.png




  • From the top menu, in the monitoring section.


Wizard main new.png




All users with wizard access will be able to access to monitor and alert configuration. Agent configuration must be activated "per user", on demand.

1.1.2 Action Flow

The following graph shows the complete flow of actions that are possible to be carried out in the Metaconsole Wizard:

Wizard flow.png

1.1.3 Modules

In the module option, you may create a module or edit one that is already created.

Wizard modules.png

1.1.3.1 Creation

In module creation the first step will be selecting one agent where to create it. It could be filtered by group or searched by name between the available agents.

Info.png

The available agents will be those of each Instance where the new user has creation permissions (AW).

 


Wizard modules create1.png

After selecting the agent, click on Create module. Now select the type of module to create:

  • Monitor
  • Web Check
1.1.3.1.1 Monitor Creation

Monitor creation is done using module templates/components.These components are classified by groups:

The nature of the module (local or remote) will be visible for the user, and in the selection combos, the components of both types will be mixed.

When selecting the component, its description will be shown.



Wizard modules create monitors new.png




To configure the monitor, click on Create.

The monitor configuration consists of in 4 steps:


  • General Configuration: Monitor general data (name,description,Ip,etc.).


Wizard modules create monitors general new.png




  • Advanced Configuration: Monitor advanced data (thresholds, interval, etc).

Wizard modules create monitors advanced.png

  • Alerts: An alert editor where to configure in the module alert template alerts you have permissions for.

Wizard modules create monitors alerts.png

  • Preview:' Data displayed in only one scree before finishing the process.

Wizard modules create monitors previous.png

1.1.3.1.2 Creating web checks

For web check creation, the web check option must be enabled in “customize sections” from Metaconsole's Metasetup.

There are two different types of web checks:

  • Step by step: Web checks are configured with a wizard without the need to know its syntax.
  • Advanced: Web checks are raw configured in a box text. It is only available for users with advanced permissions.

Info.png

If the user does not have advanced permissions, the advanced check option will not be available. It will lead you directly to configure a step by step check.

 




Wizard modules create webchecks new.png




The web check configuration will be done, same as with monitors in 4 steps:

  • General Configuration: Monitor general data (name, description, type, etc. As well as the check according to its modality).
  • Step by Step Modality:


Wizard modules create webchecks stepbystep new.png



  • Advanced Modality:


Wizard modules create webchecks avanzado new.png




This kind of check can be:
  • Latency: This check obtains the total time that went by from the first petition until that the last one is checked. If there are several checks the average will be shown.
  • Response: This check obtains 1 (OK) or 0 (failed) as result when checking the whole transaction. If there are several attempts and some of them fail, then it is considered that the whole test also fails.
  • Advanced Configuration:Monitor advanced data (thresholds, interval, proxy configuration, etc.).
  • Modality Step by Step:


Wizard modules create webchecks advanced conf.png



  • Advanced Modality:


Wizard modules create webchecksadvanced advanced conf.png




  • Alerts: An alert editor where to configure in the module alerts of the alert templates you have permissions on. Same as in monitor creation.
  • Preview:' Data shown on a single screen before finishing the process. Same as with monitor creation.
1.1.3.1.3 Module Creation Flow

Wizard flow create module.png

1.1.3.2 Administration

The modules created from the Metaconsole Wizard can be managed (edited and deleted).

Template warning.png

The modules created in the Instance will not be visible in the Wizard.

 


The first step is to select the module to manage. You may filter by group and search by agent to find it quickly.



Wizard modules manage new.png




Once it has been selected, click on Delete to delete it or on Edit to edit it.

When editing you will have access to a screen very similar to the creation one with the same 4 steps:

  • General Configuration: Monitor general data.
  • Advanced Configuration: Monitor advanced data.
  • Alerts: Monitor alert edition.
  • Preview:' The data modified in a single screen before finishing the process.

Info.png

Local and remote module and web check management is visible for the user.The fields to edit change but the editing/deleting process is the same.

 


1.1.3.2.1 Module administration flow

<a href="http://wiki.pandorafms.com/images/6/65/Wizard_modules.png">Wizard flow manage module.png</a>

1.1.4 Alerts

The alert editor is a direct link to the alert step in module edition. This is done to make its access and management easier.

In the alert options you may create an alert or edit one that is already created. Alerts could be only added or created in modules to which you have access from the Wizard. Or those modules created from the Wizard and you have ACL permissions on.

Wizard alerts.png

1.1.4.1 Creation

In alert creation, select a module where you wish to create the alert.

Wizard alerts creation.png

After selecting the alert, click on Create alert.

The following screen will be the edition of the module linked to the alert in the alert edition step.

Wizard modules create monitors alerts.png

1.1.4.1.1 Alert Creation Flow

Wizard flow create alert.png

1.1.4.2 Administration

The alerts created from the Metaconsole Wizard can be managed (edited and deleted).

Template warning.png

Alerts created in the Instance will not be visible in the Wizard.

 


The first step is to select the alert to manage. Filter by group and search by agent to find it faster.



Wizard alerts management new.png




Once selected, click on Delete to delete it or on Edit to edit it.

If you click on Edit you will be redirected, same as when creating an alert, to the edition of the associated module in the alert edition step.


1.1.4.2.1 Alert management flow

Wizard flow manage alert.png

1.1.5 Agents

In agent option you can create an agent or edit an already created one.

Wizard agents.png

1.1.5.1 Creation

Agent creation is done in one of the configured Instances.

Administrator users can select in which one to create it. However, the standard users will have an Instance assigned where they will create the agents in a transparent way.

This assignment is done at User management

Agent configuration will be done in three steps:


  • General Configuration: Monitor general data (name, description, IP, etc). And in case of being administrator, also the Instance where it will be created.

Wizard agents general.png

  • Modules: A module editor, where to select from a combo the available network components and add them to the agent.

Wizard agents modules.png

  • Preview: Data displayed in a single screen before finishing the process.

Wizard agents preview.png

1.1.5.1.1 Agent Creation Workflow

Wizard flow create agent.png

1.1.5.2 Administration

Those agents the user has access to through ACL configuration can be managed (edited and deleted).

The first step is selecting the agent to manage. Filter by group and/or search for a text substring, to find it easily.

Wizard agents manage.png

Once the agent is selected, click on Delete to remove it, or on Edit to edit it. The edition screen is similar to the creation screen, with the same three steps:

  • General configuration: General information about the agent.
  • Modules: Edit the agent modules
  • Previsualization:' Preview to make sure everything is ok.

Info.png

Unlike module management, agent edition also shows the modules that have not been created with the Wizard

 


1.1.5.2.1 Agent administration workflow

Wizard flow manage agent.png

1.2 Cron Jobs

To be able to acces this Metaconsole action, go to Extensions > Cron Jobs. First, configure correctly the “crontab file” like this:



Cron tab config.png



Once done, perform the desired execution tasks. There is more information in the following link

1.3 Differences depending on access level

The modules and alerts have configuration differences depending on the access level to the Wizard that the templates and components they were created with have and the access level of the user that configures them. Agent settings have fewer restrictions but also depends on the access level.

1.3.1 Monitors

Monitor configuration will change depending of the access level on the component used: basic or advanced.

When the access level is "Advanced", there will be some additional fields:

  • The name (at the "basic" level, it takes the name of the component).
  • Monitor units.
  • Macros (in local modules or remote plugin modules' cases). At the basic level, it will be crated with the default values.

1.3.2 WEB Checks

When setting up a "webcheck", user with "advanced" access can choose between the "step by step" or "advanced" configurations.

Advanced checks are manually configured and write the ceck with their syntax in a text box. In addition, created module units can be defined.

1.3.3 Alerts

In the alerts, the Basic or advanced levels of the associated template only affect its visibility. Basic level alerts can be seen by user that accesses the wizard, and the advanced level ones only by users whth advanced level access.

It is the component level the one that defines the alert settings in their module. A module can be associated with any of the alerts visible for the user.

If it is a basic component or a styep-by-step web check, the alerts will be created with a default action assigned, which cannot be changed.

If it is an advanced component or a complex/advanced WEB Check, when assigning an alert the default action will appear but any desired action can be assigned.

1.3.4 Agents

Agent management will give access to all agents accessible to the user, depending on its ACL configuration. Regardless of the user access level (advanced, basic), or whether the modules were created with the wizard or in the instance.

The only restriction about this, comes when adding modules in the edit/create view. This setup is done only by using only network components and with basic level. The reason for this behaviour is because this kind of modules do not have any configuration, and the advanced wizard level modules usually need extra configuration.


Go back to Pandora FMS documentation index