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

From Pandora FMS Wiki
Jump to: navigation, search
(Action Flow)
Line 80: Line 80:

Revision as of 13:22, 2 June 2016

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. This operation is done from a single editor, we call it "Wizard" or monitoring assistant.

1.1 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.

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"
  • You can create agents 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 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.


We have a metaconsole and two pandora instances, in which we have full access (read and administration rights)

The instances have two agents with three modules each one:

Wizard example1.png

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

Wizard example2.png

We create from the metaconsole, a module to monitor the harddisk in each agent.

Wizard example5.png

Now, from the wizard, we can see the module, and edit the created module:

Wizard example3.png

And from each Pandora FMS instance we can see the modules and edit them.

Wizard example4.png

From the instances, is indistinguishable if a module has been created from the metaconsole or not.


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.


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.png

  • From the top menu, in the monitoring section.

Wizard main.png

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

1.1.2 Action Flow

In the following graph is showed the complete flow of actions that are possible to do in the Metaconsole Wizard:

Wizard flow.png

1.1.3 Modules

In the module option we can create one module or edit one that is already created.

Wizard modules.png 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.


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


Wizard modules create1.png

After selecting the agent, we should click in Create module. Now we should select the type of module that we will create:

  • Monitor
  • Web Check

Wizard modules create2.png Monitor Creation

Monitor creation is done using the 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.

If we select the component, the description of it will be shown.

Wizard modules create monitors.png

To configure the monitor we click on Create.

The configuration of one monitor will be done in 4 steps:

  • General Configuration: The monitor more general data (name,description,Ip,etc.)

Wizard modules create monitors general.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 alerts of the template alerts of whom we have permissions

Wizard modules create monitors alerts.png

  • Previsualization:' Data introduced in only one scree before finishing the process.

Wizard modules create monitors previous.png


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 . Creating Web Check

The web checks can have two different kinds:

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

Wizard modules create webchecks.png


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:

  • General Configuration: The monitor more general data (name, description, type.. and the check according to their modality)
  • Modality Step by Step:

Wizard modules create webchecks stepbystep.png

  • Advanced Modality:

Wizard modules create webchecks advanced.png

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.
  • Advanced Configuration:Monitor advanced data (Thresholds, interval, proxy configuration, etc)

Wizard modules create webchecks advanced conf.png

  • 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. Module Creation Flow

Wizard flow create module.png Administration

The modules created from the Metaconsole Wizard will can be managed (edit and delete them).

Template warning.png

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.

Wizard modules manage.png

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:

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


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 Module Administration Flow

Wizard flow manage module.png

1.1.4 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.

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.

Wizard alerts.png Creation

In the alert creation we will select a module where we want create the alert.

Wizard alerts creation.png

After selecting the alert, we will click on Create alert.

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

Wizard modules create monitors alerts.png Alert Creation Flow

Wizard flow create alert.png Administration

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

Template warning.png

The alerts created in the Instance won't 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.

Wizard alerts management.png

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.

Wizard modules create monitors alerts.png Alert Management Flow

Wizard flow manage alert.png

1.1.5 Agents

In the option of agents we can create an agent or edit an already created one.

Wizard agents.png Creation

The creation of one agent 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.

This assignment is done at User management

The 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.

Wizard agents general.png

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

Wizard agents modules.png

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

Wizard agents preview.png Agent Creation Workflow

Wizard flow create agent.png Administration

Those agents which user can modify its configuration (due ACL setup), can be administer (edit and delete).

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.

Wizard agents manage.png

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:

  • General configuration: Edit here the general information about the agent.
  • Modules: Edit the agent modules
  • Previsualization:' Just a preview to be sure everything it's ok.


Unlike management modules in an agent's edition will also see the modules that have been created with the Wizard Agent administration workflow

Wizard flow manage agent.png

1.2 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.

1.2.1 Monitors

Configuration of a monitor 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:

  • The name (in the "basic" level, it takes the name of the component, in advaned, you can redefine it).
  • Units.
  • Macros (when are local modules or remote plugin modules). In the basic level, it will be crated with the default values.

1.2.2 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.

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.

1.2.3 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.

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.

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 an Advanced component or a complex/advanced WEB Check, the default action can be changed.

1.2.4 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.

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.

Go back to Pandora FMS documentation index