Difference between revisions of "Pandora: QuickGuides EN: General Quick Guide"

From Pandora FMS Wiki
Jump to: navigation, search
(Assign an alert to a module)
(Enterprise license activation: Video tutorial PFMS. Artifice for web links to work near subtitles. Spelling.)
 
(171 intermediate revisions by 15 users not shown)
Line 1: Line 1:
= Introduction to this guide =
+
= Introduction =
  
The purpose of this guide is to quickly introduce Pandora FMS to someone not familiar with Pandora FMS, but who has a medium/high knowledge of systems and networks. We don't pretend to make a path along all the features of Pandora FMS, but remark the most important of them, so that a user that read the complete guide could make basic administration and operation tasks in record time. It's good to consider that the Pandora FMS official training lasts 40 hours, and the official documentation has more than 1200 pages, so this is just a small bridge to make easier the approach to Pandora FMS.
+
The purpose of this guide is to quickly introduce Pandora FMS to someone unfamiliar with Pandora FMS, but who has medium to high knowledge of systems and networks. The purpose is not delving into all Pandora FMS features, but rather discussing the most important ones. That way, a user that reads the complete Quick Guide should be able to perform basic administration and operation tasks quickly. Considering that Pandora FMS official training takes 40 hours, and the official documentation has more than 1200 pages, this is meant to be just a small bridge to a larger documentation package for Pandora FMS, so that the first contact is not too complicated.
  
 
= Installation =
 
= Installation =
  
We'd use the Pandora FMS CD Appliance because it's the quickest and easiest method for intermediate users. There are several alternative ways to install Pandora FMS, but this is the one we recommend. For further information, please read [[Pandora:Documentation_en:Installing|Pandora FMS Installation]] chapter.  
+
We recommend using the Pandora FMS Appliance CD because it is the quickest and easiest method for intermediate users. For further information about alternative installin methods, read the [[Pandora:Documentation_en:Installing|Pandora FMS Installation chapter]] .  
  
The installation CD is based on Linux CentOS 6.5, and contains pre-installed all the things required to make Pandora FMS work. You should have a machine with a minimum hardware requirements to make Pandora FMS run properly. You must have a minimum of 2GB of RAM and 20GB of disk.
+
The installation CD is based on Linux CentOS 7, and contains all the required elements and dependencies to make Pandora FMS work. You should have a machine with the minimum hardware requirements to make Pandora FMS run properly, including a minimum of 4GB of RAM and 20GB of disk-space.  
  
 
+
{{Tip|The more systems you want to monitor, the more resources (CPU, memory, disk speed) you will have to assign to the Pandora FMS server.}}
{{Tip|The more systems you want to monitor the more resources (CPU, memory, Disk speed) you'll have to assign to the Pandora FMS server.}}
 
  
 
== Installing the Appliance CD ==
 
== Installing the Appliance CD ==
  
Download the CD image from the Download section of our website and record the ISO image in a DVD, or run the system from that file if you are using a virtualized system (XenServer, VMware, VirtualBox, etc). There are CD images of 32 and 64 bit.
+
Download the CD image from the Download section of our website and burn the ISO image onto a DVD, or run the system from that file if you are using a virtualized system (XenServer, VMware, VirtualBox, etc). There are CD images for both 32 and 64-bit installations.
  
The following screen will be displayed at the beginning of the boot. If  Nos aparece esta pantalla al inicio del arranque. If you don't press any key it will automatically load the Live CD, instead of that, press any key and select "Installation" option.  
+
The following screen will be displayed at the beginning of the boot process. If you do not press any key, the process will automatically load the Live CD, or you can press any key and select the "Install Pandora FMS" option.  
  
<br>
 
<br>
 
 
<center>
 
<center>
[[image:centos1.png|400px]]
+
[[image:install_1.png|400px]]
 
</center>
 
</center>
  
 +
The graphic installer will lead you step by step through the whole installation process. This installer is a standard installation process used by CentOS, and is available in different languages. It is a quite easy process, just pay special attention when entering the superuser password (root), and when asked about the hard drive partitioning:
 +
 +
<center>
 +
[[image:install_2.png|500px]]]
 
<br>
 
<br>
 +
Select the language
 +
</center>
 
<br>
 
<br>
 +
 
<center>
 
<center>
[[image:centos2.png|400px]]
+
[[image:install_3.png|500px]]
 
</center>
 
</center>
 +
 +
Select and configure all the necessary options to install, “Date & Time”, “Keyboard” and “Installation Destination”.
 +
Remember to activate the network interface, or else you will need to activate it manually after installation.
 +
 +
<center>
 +
[[image:install_4.png|500px]]
 +
[[image:install_5.png|500px]]
 
<br>
 
<br>
 +
Activate the network interface and optionally change the hostname.
 +
</center>
 
<br>
 
<br>
  
The graphic installer will lead you step by step during the whole installing process. This installer is a standard installing process used by CentOS, and it's available in different languages. It's a very easy process and you'll just have to pay special attention when introducing the superuser password (root), and when you'll be asked about the partitioning:
+
When clicking the installation destination button, the partition process will start.
  
 +
<center>
 +
[[image:install_6.png|500px]]
 
<br>
 
<br>
 +
Select the disk where the installation will be performed and click on "done".
 +
[[image:install_7.png|500px]]
 
<br>
 
<br>
 +
</center>
 +
Select the partitioning, unless you have advanced knowledge use the option "Click here to create them automatically".
 
<center>
 
<center>
[[image:Guiarapida_password.png]]
 
<br><br>
 
We choose "root" user password (superuser)
 
</center>
 
 
 
<br>
 
<br>
 +
[[image:install_8.png|500px]]
 +
<br>
 +
Verify the created partitions and click on "done".
 +
<br>
 +
[[image:install_9.png|500px]]
 +
<br>
 +
Accept changes.
 +
<br>
 +
[[image:install_10.png|500px]]
 +
<br>
 +
Click on "Begin Installation".
 +
<br>
 +
[[image:install_11.png|500px]]
 
<br>
 
<br>
<center>
+
Here you can assign the root password and optionally create a user.
[[image:Guiarapida_disco.png]]
+
 
<br><br>
 
We choose the partitioning. Unless you know what it does, use the "Use all space".
 
 
</center>
 
</center>
<br>
+
 
 +
Now just wait until the process is finished and the system restarts automatically.
  
 
== First steps ==
 
== First steps ==
  
Once installed, the system should boot and after a few seconds show the desktop that has to be similar to the following:  
+
Once installed, the system should boot, and after a few seconds, it will show a Terminal where to log in:
  
<br>
 
<br>
 
 
<center>
 
<center>
[[image:guiarapida_escritorio.png|500px]]
+
[[image:F_step_1.png|500px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
The first step should be to know the IP that the system has assigned to us to allow us to connect to the server from outside. For that, we will open a terminal in the Applications menu Applications -> System Tools -> Terminal. In this terminal we will write the command:
+
The first step would be getting the system IP address to be able to connect to the server from outside. To retrieve it, execute the command:
  
 
  ifconfig  
 
  ifconfig  
  
<br>
 
<br>
 
 
<center>
 
<center>
[[image:guiarapida_ifconfig.png|400px]]
+
[[image:F_step_2.png|500px]]
 +
</center>
 +
 
 +
Here is an example. In this particular case, the system's IP address is 192.168.70.158
 +
 
 +
If the system has booted and taken an IP from our network via DHCP it will be shown on the list. If you wish to set a static IP for this system, do it by using the '''nmtui''' command, which shows a graphic interface to do so.
 +
 
 +
<center>
 +
[[image:F_step_3.png|400px]]
 +
</center>
 +
 
 +
Once you know the IP address of the Pandora FMS system, you can access it from outside the virtual machine, which is always more convenient. You can do it via SSH or HTTP. Remember that you already set the root password (superuser) during the configuration in the installation process.
 +
 
 +
Open a browser and enter the IP address that you got from your server:
 +
 
 +
<nowiki>http://x.x.x.x/pandora_console</nowiki>
 +
 
 +
In the previous example it would be <nowiki>http://192.168.70.158/pandora_console</nowiki>, but you must retrieve your system's IP correctly to be able to continue. If everything is correct, you will see the Pandora FMS console welcome screen, which looks similar to this one:
 +
 
 +
<center>
 +
[[image:F_step_4.png|400px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
You can see this example. In this particular case, the system IP is 192.168.70.121
+
{{Tip|Use the default credentials: user ''admin'' and password ''pandora''}}
  
If the system has booted and and taken an IP from our network it will be shown in the list. If we want to set a fixed IP to this system, we could do it through the CentOS Network Configuration Interface. Click on the right button over the network icon and "Edit connections". The purpose of this guide is not detail the configuration of the base system but allow the minimum work configuration.  
+
Once you reach this point, you have a complete installation of Pandora FMS ready to start using it.
  
Once you know the IP address of Pandora FMS system, you can access to it from outside the virtual machine, which is always more comfortable. You can do it via SSH or via HTTP. Remember that you set the root password (superuser) in the configuration.  
+
== Enterprise license activation ==
 +
{{Warning|This section is for Enterprise users only. You can safely skip it if you are using the Open Source version.}}
  
Open a browser and write the following address with the IP that you got from your server:
+
{{tip|It is very important to not boot the pandora_server daemon with the Enterprise version installed, without not having enable the console Enterprise version, since there will be failures.}}
  
http://x.x.x.x/pandora_console
+
{{warning|This process is not necessary if we have a '''Metaconsole''' license as this type of license automatically activates each associated node.}}
  
In the last example it would be http://192.168.70.121/pandora_console, but you must get the IP of your system correctly to continue. If everything is correct you must access the welcome screen of Pandora FMS console, similar to the next:  
+
Once you access your Pandora FMS through the browser, you will be asked to enter a valid license:
  
<br>
 
<br>
 
 
<center>
 
<center>
[[image:guiarapida_login.png|400px]]
+
[[image:Enterprise_1.png|400px]]
 
</center>
 
</center>
 +
 +
Click on '''Request new license''' and proceed to the next step. In this step you need to fill out the contact information and the '''Auth key''' that the [mailto:[email protected] sales department] has forwarded, if it is an Enterprise version.
 +
 +
<center>
 +
Proceed to the next step by clicking on '''Online validation'''
 +
[[image:Enterprise_2.png|400px]]
 
<br>
 
<br>
<br>
+
</center>
 +
 
 +
Once done, the license will pop out to validate it.
 +
 
 +
Once you are done with all the steps, your console is ready to use. More information can be found in the video tutorial [https://www.youtube.com/watch?v=SNQULvPVmYM «How to renew Pandora FMS License»].<br><br><br>
 +
 
 +
== Enterprise server start ==
 +
{{Warning|This section is for Enterprise users only. You can safely skip it if you are using the Open Source version.}}
 +
 
 +
After activating your license, the Enterprise server should start. In your Pandora FMS server, open a terminal selecting ''Applications'' > ''System Tools'' > ''Terminal'', and then type in:
  
{{Tip|Use the credentials by default: user ''admin'' and password ''pandora''}}
+
sudo /etc/init.d/pandora_server start
  
Once arrived to this point, you have a complete installation of Pandora FMS ready to use.
+
To verify that everything works, access your Pandora FMS through the browser and go to '''Manage servers'''. You should see something like this:
  
= Detecting problems in your network =
+
<center>
 +
[[image:Pandora servers.PNG]]
 +
</center>
  
To start with Pandora FMS, the best option is detect and try to monitor the devices that are around. No matter if they are PCs with Windows, Linux servers or routers/switches because we are doing a very basic monitoring (check if they answer to a ping). After that and once they are detected we could improve the monitoring.  
+
= Detecting systems in your network =
 +
 
 +
To start using Pandora FMS, detect and monitor the devices that are on your local network. It does not matter whether they are PCs with Windows, Macintosh, Linux servers or routers/switches because this is just a very basic monitoring task (checking if they answer to a ping). Once they are detected, you may improve the monitoring.  
 
   
 
   
  
 
== Create a Recon Task ==
 
== Create a Recon Task ==
  
Let's follow the next steps. In the side menu go to "Manage Servers" -> "Manage Recon Task" as shown in the image below, and click on Create Recon Task button.  
+
Follow the next steps. From the side menu, go to ''Discovery'' > ''Discovery'' as shown in the image below, and click on "Host&Devices" and "NetScan".  
  
 
<center>
 
<center>
 
<br><br>
 
<br><br>
[[File:Guiarapida recon1.png]]
+
[[File:Guiarapida recon1.png|400px]]
 +
<br><br>
 +
<br><br>
 +
[[File:Guiarapida recon1_2.png]]
 +
<br><br>
 +
<br><br>
 +
[[File:Guiarapida recon1_3.png]]
 
<br><br>
 
<br><br>
 
</center>
 
</center>
  
Create the task as in the image:
+
Create the task as follows: modify the network range that is to be explored. In this screenshot the range is 192.168.70.0/24 which means that all the hosts in the 192.168.70.xx network will be explored. Use the appropriate IP address range here to define your network. Selecting the group "Applications", which is used to cointain de discovered devices. From now on, the services managed or monitored by Pandora FMS are called "agents".
  
 
<center>
 
<center>
 
<br><br>
 
<br><br>
[[File:Guiarapida recon2.png|690px]]
+
[[File:Guiarapida recon2.png|800px]]
 
<br><br>
 
<br><br>
 
</center>
 
</center>
  
You will have to modify only the network range to explore. In this screenshot is 192.168.70.0/24 which means that all the hosts of the 192.168.70.xx network will be explored. Use here the appropriate mask to define your network.
+
The network template "Basic monitoring" has been selected, which only covers latency and network availability checks. You may select other type of checks such as SNMP or WMI, to be carrioed out during the recon task.
  
"Basic monitoring" network template which covers uniquely the latency and network availability checks has been selected. Group "Network" that will be used to contain the detected devices has been selected. From know and on we will call "agents" (in a generic way) to the devices managed or monitored by Pandora FMS.  
+
<center>
 +
<br><br>
 +
[[File:Guiarapida recon2_1.png|800px]]
 +
<br><br>
 +
</center>
  
Once created it will show us the entry, and we must click on the lens icon to see the task details, as shown in the screenshot below:
+
Once created, it will show the entry, and click on the magnifying glass icon to see the task details, as shown in the screenshot below:
  
 
<center>
 
<center>
 
<br><br>
 
<br><br>
[[File:Guiarapida viewrecon.png|720px]]
+
[[File:Guiarapida viewrecon.png|800px]]
 
<br><br>
 
<br><br>
 
</center>
 
</center>
  
By clicking on the lens icon, it will show the current status os the task, which should be the task execution. In this screenshot you could see how advanced is the progress bar, and in that moment the system is searching systems in the network to add the monitoring.   
+
By clicking on the magnifying glass icon, you will be shown the current task status, which in this case is completed. In this screenshot you can see the progress bar is not there, and the system has already found the network devices to add to the monitoring.   
  
 
<center>
 
<center>
 
<br><br>
 
<br><br>
[[File:Guiarapida_reconexec.png|720px]]
+
[[File:Guiarapida_reconexec.png|800px]]
 
<br><br>
 
<br><br>
 
</center>
 
</center>
  
== Review the detected systems ==
 
  
At this point, is recommended to wait till all the network has been detected. Click on Refresh tab [[File:refreshtab.png]]. When you are finished, go to Agent Detail view to see all the systems detected. Menu "Monitoring" -> "Agent detail", as in the image:
+
== Reviewing detected systems ==
 +
 
 +
At this point, we recommend you to wait until the network has been fully detected. When finished, access the agent detail view to see all detected systems. Menu Click on the Refresh tab [[File:refreshtab.png]]. When you're finished, go to Agent Detail view to see all the detected systems. Menu ''Monitoring'' > ''Views'' > ''Agent detail'', as seen in the image:
  
 
<center>
 
<center>
 
<br><br>
 
<br><br>
[[File:Guiarapida_monitoringagentdetail.png|720px]]
+
[[File:Guiarapida_monitoringagentdetail.png|800px]]
 
<br><br>
 
<br><br>
 
</center>
 
</center>
  
Here we could see severial systems that have been properly detected by Pandora FMS. Sometimes the name of the system would have been solved (if possible by DNS), and in other cases the OS would have been detected. When clicking on the name of the system (in this case the first of the screenshot), we'll go to Agent Detail view that will display all the information of that system.  
+
Here you may see several systems that have been properly detected by Pandora FMS. Sometimes the name of the system will have been discovered (if possible by DNS), and in other cases the OS will have been detected. When clicking on the system name (in this case the first one appearing on the screenshot), you will be forwarded to the Agent Detail view which displays all of the information gathered about that system.  
 
   
 
   
 
<center>
 
<center>
 
<br><br>
 
<br><br>
[[File:guiarapida_agentdetailedview.png|720px]]
+
[[File:guiarapida_agentdetailedview.png|800px]]
 
<br><br>
 
<br><br>
 
</center>
 
</center>
  
= Add the remote check over an already monitored system =
+
= Add remote check to an already monitored system =
  
Now that we have our systems detected, we are going to add some monitoring modules. Let's add the following monitoring:  
+
Now that the systems are detected, add some monitoring modules. These are the monitoring parameters to be added:  
  
 
* Network traffic on an interface.  
 
* Network traffic on an interface.  
* Packet loss in the network.  
+
* Network packet loss.  
* Check if a service is answering by the network trough a TCP port.  
+
* Check whether a service answers on the network through a TCP port.  
 
* Check a website.  
 
* Check a website.  
  
== Network traffic on the interface ==
+
== Interface network traffic ==
  
For that is essential that the SNMP is configured in the remote device. This usually needs to be activated and a minimum configuration that allows us to consult data. The SNMP devices allows to configure the IP that can make queries, and with which community, what is a kind of password.
+
To monitor network traffic, SNMP must be configured on the remote device. This usually needs to be activated and (minimally) configured to allow you to check data. The SNMP device allows you to configure which IP can make queries, and with which community. This ends up working as an additional security measure. 
 +
 
 +
First of all, locate the agent from which you want to obtain the network traffic, in this case it is 192.168.70.1. Following the same process (''Monitoring'' > ''Views'' > ''Agent detail'') go to the Main View of the agent you want to configure and click on the last tab on the right, which will take you to the edit view for that agent.
  
First of all we have to locate the agent from where we want to get the network traffic, in our case it's 192.168.70.1. Following the same process (Monitoring -> Agent Detail View) we'll go to the Main View of the agent we want to configure and we will click on the last tab on the right, which will take us to the edit view of that agent.
 
<br><br>
 
 
<center>
 
<center>
 
[[file:Guiarapida agentedit.png|730px]]
 
[[file:Guiarapida agentedit.png|730px]]
<br><br>
 
 
</center>
 
</center>
  
Now we will go to the Agent edit main view. We'll have to show the configuration wizard submenu for this agent, we'll choose the SNMP Interface wizard, as you can see in the next screen:   
+
Now go to the Agent edit main view section. Below you may see this agent's Wizard configuration submenu. Choose the SNMP Interface wizard, as you can see on the following screenshot:   
<br><br>
+
 
 
<center>
 
<center>
 
[[file:Guiarapida_snmpinterfacewizard.png|730px]]
 
[[file:Guiarapida_snmpinterfacewizard.png|730px]]
<br><br>
 
 
</center>
 
</center>
  
At this point, we must provide the "SNMP community" that we have configured in the machine, and make sure that the device supports SNMP queries enabled in the IP shown on the screen. We can change the IP address and the SNMP community by default, which is ''public'' (in our case is different, is 'artica06'). Once filled, we must click on the "SNMP Walk" button. If everything goes right, it will shoe the interfaces and the data that we can get from them.   
+
At this point, provide the ''SNMP community'' that you configured on the equipment, and make sure the device supports SNMP queries enabled in the IP shown on the screen. The IP address can be changed as well as the SNMP community, which is set to ''public'' by default. Once filled out, click on the "SNMP Walk" button. If everything is OK, it will show the interfaces and the data that can be obtained from them.   
<br><br>
+
 
 
<center>
 
<center>
 
[[file:Guiarapida_snmpinterfacewizard2.png|730px]]
 
[[file:Guiarapida_snmpinterfacewizard2.png|730px]]
<br><br>
 
 
</center>
 
</center>
  
With CONTROL-Click (or CMD-Click in Mac) we can select more than one element in both boxes such us in the following screenshot. We recommend to always monitor the outgoing traffic ('''ifOutOctets'''), the incoming traffic ('''ifInOctets''') and the status of the interface ('''ifOperStatus''') per each interface. In this particular case, eth1, eth2 y eth3.
+
With Ctrl+Click (or CMD+Click in Mac) you may select more than one element in both boxes, as shown in the following screenshot. Remember to monitor the outgoing traffic ('''ifOutOctets'''), the incoming traffic ('''ifInOctets'''), and the interface status ('''ifOperStatus''') on each interface. In this particular case, eth1, eth2 and eth3.
  
We click on "Create modules" button and a screen should inform us about the modules that have been created.  
+
Click on the "Create modules" button and a screen should display information about the modules that have been created.
 +
 
 +
Remember that the network traffic modules are '''incremental''', meaning its value is the difference between the information sample taken previously, and the current information. It shows a "rate" (in this case bytes/sec) so it takes some time (between 5 and 10 minutes) before it shows anything.
  
We must consider that the network traffic modules are '''incremental''' type, ie its value is the difference between the sample of information that we've just taken and the above, ie, it shows us a "rate" (in this case bytes/sec) so it takes time (between 5 and 10 minutes) before showing anything.
 
<br><br>
 
 
<center>
 
<center>
 
[[file:Guiarapida_opermode.png]]
 
[[file:Guiarapida_opermode.png]]
<br><br>
 
 
</center>
 
</center>
  
He have to click on "View" tab to return to the Agent View, and wait 5 minutes to have traffic data, refreshing or clicking on the "View" tab. After a while, we must have a screen similar to that, where we have data of the traffic modules (incoming and outcoming separated), and a new section in the agent, that shows information about the interfaces with a direct access to an aggregate graph with the outcoming and incoming traffic overlay (click on the title "Interface information (SNMP)").
+
Click on the "View" tab to go back to the agent view and wait 5 minutes until having traffic data, refreshing or clicking on the "View" tab. After some time, you should have a screen similar to this one, where you already have data from the traffic modules (incoming and outgoing, separately) and a new agent section, which shows information of the interfaces with direct access to an added graph with superimposed outgoing and incoming traffic (if you click on the title "Interface information (SNMP)").
<br><br>
+
 
 
<center>
 
<center>
 
[[file:guiarapida_interfaceinfo.png|730px]]
 
[[file:guiarapida_interfaceinfo.png|730px]]
<br><br>
 
 
</center>
 
</center>
  
If we don't want to wait or we don't want to force the execution of the network modules, we can use the force remote check icon (it wont work with local modules, or with modules collected in local by a software agent). Depending on the load of our server it could last between 2 and 15 seconds in executing the network test.  
+
If you do not wish to wait or you prefer to "force" network module execution, use the force remote check icon (it will not work on local modules, or on modules collected locally by a software agent). Depending on the server load, it may take between 2 and 15 seconds to execute the network test.  
<br><br>
+
 
 
<center>
 
<center>
 
[[file:guiarapida_forcenet.png]]
 
[[file:guiarapida_forcenet.png]]
<br><br>
 
 
</center>
 
</center>
  
The information of the traffic modules will be displayed like this, and the graphs per each metric. Clicking on the graph icon [[file:chart_curve.png]] it will show a window with the graph of this monitor, and when we click on the data icon [[file:binary.png]] it will show a table with data.
+
The information about the traffic modules will be displayed like this, with graphs for each metric. Clicking on the graph icon [[file:chart_curve.png]] will show a window with this monitor's graph, and clicking on the data icon [[file:binary.png]] will show a table with data.
<br><br>
+
 
 
<center>
 
<center>
 
[[file:guiarapida_moduledata.png|730px]]
 
[[file:guiarapida_moduledata.png|730px]]
<br><br>
 
 
</center>
 
</center>
  
== Packet loss in the network ==
+
== Network packets loss ==
  
We want to add a ''remote plugin'' preconfigured in Pandora FMS. Remote plugins are checks defined by the user that use a script or a software deployed in the Pandora FMS server, so that it could be used for monitoring, increasing the number of things that it could do.
+
A ''remote plugin'' that is pre-configured is to be added to Pandora FMS. Remote plugins are checks defined by the user that use a script or software deployed onto the Pandora FMS server, so that it can be used for monitoring, increasing the range of tasks it may carry out.
 +
 
 +
A serial plugin is used, so go to the Agent edit View, and then to the Module configuration tab.  
  
Let's use a serial plugin, for that we must go to the Agent edit View, and after to the Module configuration tab.
 
<br><br>
 
 
<center>
 
<center>
 
[[file:guiarapida_moduleeditor1.png|730px]]
 
[[file:guiarapida_moduleeditor1.png|730px]]
<br><br>
 
 
</center>
 
</center>
  
We will choose a module type plugin and we'll click on "Create" button, which will lead us to the interface of configuration of "plugin remote" type modules.  
+
Select a module type plugin and click on "Create", which will lead you to the configuration interface for "remote plugin" type modules.  
<br><br>
+
 
 
<center>
 
<center>
 
[[file:guiarapida_moduleeditor2.png|530px]]
 
[[file:guiarapida_moduleeditor2.png|530px]]
<br><br>
 
 
</center>
 
</center>
  
We'll choose the "Packet loss" using the drop down, and finally we'll introduce the IP address on which we want to launch the checks. We leave the rest of fields as they are.   
+
Choose the plugin "Package loss" using the drop down menu, and enter the target IP address on which you want to implement the checks. Leave the rest of fields as they were.   
<br><br>
+
 
 
<center>
 
<center>
 
[[file:guiarapida_moduleeditor3.png|730px]]
 
[[file:guiarapida_moduleeditor3.png|730px]]
<br><br>
 
 
</center>
 
</center>
  
We'll click on the "Create" button and return the Operation View, as in the case described above. We'll refresh a couple of times till the new module appears in the list:  
+
Click on the "Create" button and go back to the Operation View, as the previous case. Refresh a couple of times until the new module appears on the list:  
<br><br>
+
 
 
<center>
 
<center>
 
[[file:Guiarapida_packetloss.png|730px]]
 
[[file:Guiarapida_packetloss.png|730px]]
<br><br>
 
 
</center>
 
</center>
  
This is a very interesting plugin that used with the basic connectivity one (ping) and the latency time, help us to determine the quality of our network, because it indicates us the percentage of packet loss taking samples every 5 minutes.
+
This is a very interesting plugin that, when used together with basic connectivity (ping) and latency time, helps to determine the quality of your network, since the result reveals the package loss percentage, taking samples every 5 minutes.
  
 
== Monitor a TCP network service ==
 
== Monitor a TCP network service ==
  
In this particular case we are going to add a monitoring to verify that a SMTP services (mail) is active in a machine. Although it can be a very complex check (simulating that we send an email, or user and password credentials, etc) we'll simplify it checking only that the port is open and answers.  
+
For the following case, a monitor will be added to verify that an SMTP service (mail) is active on a machine. Although it might be a very complex check (simulating sending an email, or sending user and password credentials, etc) it can be simplified by only checking only whether the port is open and if it answers.  
  
For that we'll repeat the same initial steps of the previous example, but this time we will pick "network Module".
+
Repeat the same initial steps from the previous example, but this time select "Network module".
  
 
<center>
 
<center>
<br>
 
 
[[Image:guiarapida_networkmodule.png]]
 
[[Image:guiarapida_networkmodule.png]]
 
</center>
 
</center>
<br>
 
  
After that we'll use the drop down controls to find our check (Check SMTP Server) and we'll click to create the module.
+
After that, use the drop down controls to find the desired check (Check SMTP Server) and click to create the module.
  
 
<center>
 
<center>
<br><br>
 
 
[[Image:guiarapida_networkmodule2.png|730px]]
 
[[Image:guiarapida_networkmodule2.png|730px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Finally, we'll repeat the steps (go to the Operation View, and refresh till the monitor appears) so that the final result will be something similar to the following:  
+
Finally, repeat the steps (go to the Operation View, and refresh until the monitor appears) so that the final result will be something similar to the following:  
  
 
<center>
 
<center>
<br><br>
 
 
[[Image:guiarapida_networkmodule3.png|730px]]
 
[[Image:guiarapida_networkmodule3.png|730px]]
 
</center>
 
</center>
<br>
 
<br>
 
 
== Check a website ==
 
 
In Pandora FMS Enterprise version is possible to do synthetic WEB checks, ie sending data, keeping the session, and verifying step by step, that a sequence of logical steps is happening, something required to validate a complete transaction.
 
 
In this case we are going to do something easier, possible in Pandora FMS Open Source version. We're going to connect to a WEB and verify if it returns a specific code. Now we're going to connect to the Pandora FMS module library website (http://pandorafms.com/Library/repository/en) and verify if the text string "Main categories" is returned at the output (see image):
 
<center>
 
<br><br>
 
[[Image:guiarapida_webmonitor2.png|600px]]
 
</center>
 
<br>
 
<br>
 
  
For that, we'll create a network check, similar to the previous example. In this case, we'll use the "Check HTTP" generic template and we'll modify some advanced fields, as you can see in the following screenshot:
+
= Add an alert (email sending) when there is some issue =
<center>
 
<br><br>
 
[[Image:guiarapida_webmonitor.png|730px]]
 
</center>
 
<br>
 
<br>
 
  
^M characters has to be written just as it is and they represent a carriage return. For HTTP protocol it's necessary to do 2 carriage returns after the petition.  
+
In Pandora FMS, the most basic method of alerting is to assign an alert to a specific module. It is possible to perform more advanced alert configurations (event alerts, correlation, etc), but they are not included in this guide. The first alert will consist of simply sending an email when a monitored machine (with the Host module alive) is down.  
  
Final result must be a check that returns OK, as these one:
+
Alerts in Pandora FMS are made up by three elements: command, action and template. In this particular case, a predetermined command is used (email sending) an existing action will be modified (Mail to XXX) and the existing template ''Critical condition'' will be used, which will execute the alert when said module goes into critical status.   
<center>
 
<br><br>
 
[[Image:guiarapida_webmonitor3.png|730px]]
 
</center>
 
<br>
 
<br>
 
 
 
= Add an alert (email sending) when a problem occurs =
 
 
 
In Pandora FMS, the most basic way of alerts is assign an alert to a specific module. It's possible to do more advanced things (event alerts, correlation, etc), but they are not written in this guide. Our first alert will consist just in send an email when a monitored machine (with the Host alive module) is down.
 
 
 
Alerts in Pandora FMS are composed of three elements: Command, Action and Template. In this particular case we are going to use a predefined command (email sending). We're going to modify an action that already exists (Mail to XXX) and we'll use a template already existing to, the ''Critical condition'' template, that will execute the alert when the module in question will appear in critical status.   
 
  
 
== Server configuration ==
 
== Server configuration ==
  
For the correct performing of the email command, we must set up in the ''pandora_server.conf'' file a mail server that allows to do relay. In the example, the mail server placed at 192.168.50.2 has this function enabled. We must introduce the IP address of your local mail server or one on the Internet (configuring the Authentication fore it). To modify the configuration file of the server, we must access to it through a shell or terminal that we can open from:
+
For the email command to work properly, set up in the ''pandora_server.conf'' file a mail server that allows to perform relay actions. In the example, the mail server is placed on the localhost through postfix. Enter the local mail server's IP address or one that exists on the Internet (for which you would have to
<br><br>
+
configure the Authentication). To modify the server's configuration file located at ''/etc/pandora/pandora_server.conf'', access it as root user, so you should have executed sudo su before:
<center>
 
[[file:Guiarapida mailconf01.png|600px]]
 
<br><br>
 
</center>
 
  
Once the shell is open, we need to open the configuration file placed at ''/etc/pandora/pandora_server.conf'' as root user, so we should do root with sudo su before doing it:
 
 
<br><br>
 
<br><br>
 
<center>
 
<center>
Line 342: Line 355:
 
</center>
 
</center>
  
We look for the lines we can see in the screenshot above and we configure them as in the screen. In this case, we have to consider that the mail server is placed at 192.168.50.2. If we don't have a mail server, we can use a gmail account, for example. We can see a quick guide about how to configure the Pandora FMS server to make it work as a gmail account in this link: http://wiki.pandorafms.com/index.php?title=Pandora:Configuracion_alertas_emails
+
Look for the same lines shown on the screenshot above and configure them as the image shows. If you do not have a mail server, you may use a Gmail account for example. You can take a look at a quick guide about how to configure the Pandora FMS server to work with a gmail account following this link: http://wiki.pandorafms.com/index.php?title=Pandora:Configuration_emails_alerts
  
 +
Lines beginning with the "#" character are comments and they are not taken into account by the server.
  
Lines beginning with the # character are comments and they are not taken into account by the server.
 
 
<br><br>
 
<br><br>
 
<center>
 
<center>
Line 352: Line 365:
 
</center>
 
</center>
  
Once the changes are finished we press Ctrl+X to exit and we confirm to save the changes:  
+
Once the changes are finished, press "ESC" and ":wq" to exit and save the changes. After saving changes, restart pandora_server:  
<br><br>
 
<center>
 
[[file:Guiarapida mailconf04.png|600px]]
 
<br><br>
 
</center>
 
  
After save changes we restart pandora_server:
 
  
 
  service pandora_server restart
 
  service pandora_server restart
Line 365: Line 372:
 
== Alert configuration ==
 
== Alert configuration ==
  
As we comment previously, Pandora FMS alerts are composed of three parts: '''Command, Action and Template'''. we could find these options in '''Manage Alerts''' section.  
+
As previously mentioned, Pandora FMS alerts are made up by three components: '''command, action and template'''. You can find these options in the '''Alerts''' section.  
 +
 
 
<br><br>
 
<br><br>
 
<center>
 
<center>
[[file:Guiarapida mailconf8.png|750px]]
+
[[file:Guiarapida mailconf8.png|300px]]
 
<br><br>
 
<br><br>
 
</center>
 
</center>
  
To configure this alert we only need to modify the action. The action we will use is '''Mail to XXX'''. In this case, if we have to change the email address we want to use ([email protected]), we could modify "Mail to XXX" to "Mail to [email protected]" so that we can identify which action we are executing.  
+
To configure this alert just modify the action. The action to use is '''Mail to XXX'''. In this case, if you need to change the email address you want to use ([email protected]), you may modify "Mail to XXX" to "Mail to [email protected]" so that you can identify which action is executed.  
  
We will modify the field 1 and insert the destination email address.  
+
Modify field 1 and enter the desired target email address.
 +
 
 +
In field 2, leave the text shown on the screenshot. Here 2 macros that will replace the agent name and the module that has generated the alert during execution are used.  
  
In field 2, we leave the text that is shown in the screenshot. Here are using 2 macros that will replace in time execution the agent name and the module that has generated the alert.
 
<br><br>
 
 
<center>
 
<center>
 
[[file:Guiarapida mailconf13.png|750px]]
 
[[file:Guiarapida mailconf13.png|750px]]
<br><br>
 
 
</center>
 
</center>
  
We select the '''Mail to XXX''' action and we edit the email address ([email protected]).
+
Select the '''Mail to XXX''' action and edit the email address ([email protected]).
<br><br>
+
 
 
<center>
 
<center>
 
[[file:Guiarapida mailconf1.png|750px]]
 
[[file:Guiarapida mailconf1.png|750px]]
<br><br>
 
 
</center>
 
</center>
  
== Assign an alert to a module ==  
+
== Assigning an alert to a module ==  
 +
 
 +
Navigate to agent edition, where the module is defined and click on the 'alerts' tab:
  
We navigate to the edition of the agent where we have the defined module and we click on the alert tab:
 
<br><br>
 
 
<center>
 
<center>
 
[[file:Guiarapida mailconf5.png|800px]]
 
[[file:Guiarapida mailconf5.png|800px]]
<br><br>
 
 
</center>
 
</center>
  
Now we add the module (Host Alive), the template (Critical Condition) adn the action (Mail to XXX). We add the alert.
+
Now add the module (Host Alive), the template (Critical Condition) and the action (Mail to XXX). Then add the alert.
<br><br>
+
 
 
<center>
 
<center>
 
[[file:Guiarapida mailconf4.png|800px]]
 
[[file:Guiarapida mailconf4.png|800px]]
<br><br>
 
 
</center>
 
</center>
  
Once added, we could observe it in the Agent View checking whether is running or not, watching the color of its status:
+
Once added, you may see the alert from the Agent View to determine whether it is running or not, by observing the status color:
<br><br>
+
 
 
<center>
 
<center>
 
[[file:Guiarapida mailconf6.png|800px]]
 
[[file:Guiarapida mailconf6.png|800px]]
<br><br>
 
 
</center>
 
</center>
  
We can wait (or force) till the host is down to see if the alert works, or we can "force the alert" to see if it actually reaches the mail. We'll click on the Force icon (see image):
+
You may wait until the host fails (or force it) to see whether the alert works, or you may "force the alert" to see if the email is actually sent. Click on the Force icon (see image):
<br><br>
+
 
 
<center>
 
<center>
 
[[file:Guiarapida_forcealert.png]]
 
[[file:Guiarapida_forcealert.png]]
<br><br>
 
 
</center>
 
</center>
  
Finally, the mail with the alert should be in our inbox. As a "forced" alert it puts N/A in the field data. In a real case it'll put the real value of the module.
+
Finally, the email with the alert should appear in your inbox. As it is a "forced" alert it says N/A in the data field. In a real case, it should state the module's real values in the message.
<br><br>
+
 
 
<center>
 
<center>
 
[[file:guiarapida_mail.png|500px]]
 
[[file:guiarapida_mail.png|500px]]
<br><br>
 
 
</center>
 
</center>
  
Pandora FMS alerts are extremely flexible, so that in many occasions are difficult to use. There is a specific chapter in the official documentation for them: [[Pandora:Documentation_en:Alerts|Alertas en Pandora FMS]]
+
Pandora FMS alerts are extremely flexible. Sometimes they seem to be difficult to use. If you need a more in-depth explanation, there is a specific chapter in the official documentation for alert management: [[Pandora:Documentation_en:Alerts|Alerts in Pandora FMS]]
  
= Monitorizar un servidor windows con un agente software =
+
= Monitor a Windows Server with a software agent =
  
En Pandora FMS existen dos tipos de monitorización; remota ( la que se realiza desde el servidor de Pandora a los diferentes dispositivos ) y local ( se instala un agente software en cada una de las máquinas a monitorizar, éste se encarga de extraer la información y enviársela al servidor de Pandora )  
+
Pandora FMS provides two types of monitoring: remote (from the Pandora FMS server to different devices) and local (where Pandora FMS is installed as a software agent on each monitored machine and retrieves the information you wish to observe and forwards it to the Pandora FMS server).
  
En este punto vamos a tratar la instalación de un agente software en un equipo Windows y la monitorización básica del mismo.
+
This section explains a software agent installation on Windows computers and its basic monitoring:
  
== Instalación del Agente ==
 
  
Primero ante todo nos tenemos que descargar el agente de Windows. Lo podemos descargar desde:
+
== Agent Installation ==
 +
 
 +
First of all, download the Windows agent. You can get it from:  
  
 
http://sourceforge.net/projects/pandora/files/Pandora%20FMS%205.1/SP2Final/Windows/
 
http://sourceforge.net/projects/pandora/files/Pandora%20FMS%205.1/SP2Final/Windows/
  
En este enlace podemos elegir entre el agente de 32 bits o de 64 bits.
+
In this link, you may choose between the 32-bit or 64-bit agent.
  
Una vez descargado el agente, lo ejecutamos haciendo doble-click sobre el y nos aparecerá la pantalla de selección de idioma:
+
Once the agent is downloaded,run it by double-clicking on it and the language selection screen will appear::
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Pandora_agent_3.0_RC3_install_windows_01.png]]
 
[[image:Pandora_agent_3.0_RC3_install_windows_01.png]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Es un instalador estándar de Windows que nos pedirá seguir los pasos del instalador, aceptamos la licencia, avanzamos por las diferentes ventanas del instalador.
+
This is a standard Windows installer that will ask you to follow the steps. Accept the license and go through the different installer screens. Select the path where you want the Pandora FMS agent to be installed (it is installed at C:/Program Files/pandora_agent by default). You may modify the destination folder by clicking on "Browse". Once done, click "Next":  
Seleccionamos la ruta donde se instalará el agente de Pandora FMS (por defecto se instala en C:/Program Files/pandora_agent), puede cambiarse pulsando Browse..., una vez indicada correctamente pulsamos Next:
 
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Pandora_agent_3.0_RC3_install_windows_04.png]]
 
[[image:Pandora_agent_3.0_RC3_install_windows_04.png]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Esperamos a que se copien los ficheros.
+
Wait for the files to be completely copied. Configure the Pandora FMS server IP address (or name) that will receive the agent's data, and the group you want to associate the agent to.
Configuramos la dirección IP (o nombre) del servidor de Pandora FMS que recibirá los datos del agente y el grupo al que queremos que se asocie el agente.
 
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Pandora_agent_3.0_RC3_install_windows_07.png]]
 
[[image:Pandora_agent_3.0_RC3_install_windows_07.png]]
 
</center>
 
</center>
<br>
 
<br>
 
  
En la siguiente ventana nos aparece la opción de habilitar la configuración remota. Es importante tenerla activada mediante un 1, si queremos tener una copia del agente en el servidor de Pandora y desde ahí poder añadir, editar y borrar módulos locales directamente desde el agente.
 
  
<br>
+
In the following screen, you can see the option to enable remote configuration. It is important to have it enabled through '1' if you want to have a copy of the Pandora FMS server agent, and from there you may add, edit and delete local modules directly from the agent.
<br>
+
 
 
<center>
 
<center>
 
[[image:Pandora_agent_config_remoto.png]]
 
[[image:Pandora_agent_config_remoto.png]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Decidimos si queremos iniciar el servicio del agente al final la instalación del agente de Pandora FMS, de lo contrario tendrá que hacerlo de forma manual, o bien se iniciará cuando Windows se reinicie de nuevo.
+
Decide if you want to start the the agent service at the end of the Pandora FMS agent installation. Otherwise you will have to do it manually, or it will start when Windows is restarted.
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Pandora_agent_3.0_RC3_install_windows_08.png]]
 
[[image:Pandora_agent_3.0_RC3_install_windows_08.png]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Una vez terminado este proceso ya se queda instalado y corriendo el agente de Windows en el equipo.
+
Once this process is finished, the Windows agent should be installed and running on the computer.
  
== Comprobación de la información que devuelve el agente ==
+
== Checking the information returned by the agent ==
  
Una vez arrancado el agente de Windows tras su instalación, es la hora de comprobar que está reportando este agente. Para ello debemos conocer el nombre con el que va a reportar este agente. Por defecto se crea el agente con el nombre del host. Podríamos ver el nombre del host de Windows con la ejecución del comando hostname en un cmd.exe.
+
After installation, and when the Windows agent is launched, it is time to check what this agent reports. To do that, find out the name that the agent will use to report. The agent is created with the host name by default. You should see the name of the Windows host by executing the hostname command via cmd.exe.
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_windows1.png]]
 
[[image:Guia rapida_windows1.png]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Una vez sabemos el nombre del agente, el siguiente paso es ver si se ha creado en Pandora. Para ello tenemos varias opciones. La primera de ellas pasa por buscar en detalles del agente, dentro del grupo en el que se ha creado el agente, en nuestro ejemplo el grupo "Servers".
+
Now that you know the agent's name, the next step is to check if the agent has been created on Pandora FMS. To do that, there are several options. The first one is to search in the Agent Details, in the group where the agent has been created, which in our example is named "Servers".
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_windows2.png|800px]]
 
[[image:Guia rapida_windows2.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Una forma más rápida y eficaz de encontrar el agente, es realizando la búsqueda directamente a través del buscador de Pandora, indicando el nombre del agente.
+
A quicker and more efficient way to find the agent, is by performing the search directly through the Pandora FMS search engine, indicating the name of the agent.
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_windows3.png|400px]]
 
[[image:Guia rapida_windows3.png|400px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Nos aparecerá aqui el agente y pinchando en él accedemos a la información que está reportando.
+
Here the agent will appear, and by clicking on it you may look into the information that it is being reported.
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_windows4.png|800px]]
 
[[image:Guia rapida_windows4.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Por defecto el agente de Windows viene con varios módulos locales precargados, de monitorización básica, como son carga de CPU (CPU Load), % de memoria RAM libre (FreeMemory), espacio libre en MB de los discos, estado DHCP (DHCP Enabled) y número de procesos (Number processes).
+
By default, the Windows agent comes with several pre-configured local modules in charge of basic monitoring, such as CPU load, free RAM percentage (FreeMemory), disk free space in MB, DHCP status (DHCP Enabled) and number of active processes (Number processes).
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_windows5.png|800px]]
 
[[image:Guia rapida_windows5.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Si necesitamos añadir nuevos módulos a este agente, podemos consultar la documentación avanzada de [http://wiki.pandorafms.com/index.php?title=Pandora:Documentation_es:Operacion monitorización con agentes software].
+
If you need to add new modules to this agent, you may check the advanced documentation here: [http://wiki.pandorafms.com/index.php?title=Pandora:Documentation_en:Operations monitoring with software agents].
  
Podemos ver gráficas generadas con el histórico de datos del módulo y una tabla con el histórico de los mismos desde esta vista pinchando en los iconos marcados en la siguiente captura:
+
You may see graphs generated with the module's data history and a table with the module's data history from this screen by clicking on the icons marked in the following screenshot:
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_windows6.png|800px]]
 
[[image:Guia rapida_windows6.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
= Crear una pantalla visual con detalles de mi monitorización =
+
= Creating a Visual Screen with your monitoring details =
  
Una de las opciones de visualización que nos ofrece Pandora es la posibilidad de crear Consolas Visuales. La Consola Visual permite representar la información de monitorización, en tiempo real, deciéndolo el usuario, de una forma totalmente gráfica. Es este ejemplo de Consola Visual vamos a crear un ejemplo de una red distribuida por todo el mundo y cómo al pinchar en el nodo que aparece sobre España, podemos ver otro mapa de España con otros elementos propios de la instalación de España.
+
One of the visualization options that Pandora FMS offers is the possibility of creating Visual Consoles. The Visual Console allows to represent the monitoring information in real time in a totally graphical way. In this example of Visual Console, an example of a network distributed around the world will be created and it will show how by clicking on the node that appears over Spain, you may see another map of Spain with other elements of the installation there.
  
La potencia de los mapas es que permite "resumir" el estado de un mapa hijo en la visualización del mapa padre, es decir, si alguno de los elementos visualizados en el mapa de España se pone en estado critico el icono que representa España se pondrá en rojo. Esto permite establecer jerarquías muy personalizadas a la hora de mostrar información. Los mapas pueden contener información de estado de grupos, agentes, módulos. Además pueden incluirse gráficas y datos (numéricos o de texto), además de etiquetas de texto e iconos.
+
The power of the maps is that it allows you to "summarize" the status of a child map in the display of the parent map, that is, if any of the elements displayed on the map of Spain goes into critical state, the icon that represents Spain will turn red. This allows you to set up highly customized hierarchies when displaying information. Maps can contain group, agent and module status information. Graphics and data (numeric or text) can also be added, as well as text labels and icons.
  
== Creación de mapa 1 (Padre) ==
+
== Creating Map 1 ('Parent') ==
  
En este primer mapa vamos a añadir el estado de varios agentes distribuido en un mapa mundial. Se puede realizar de forma manual uno a uno, o mediante el wizard. Para facilitar la creación del mismo vamos a utilizar el wizard en el ejemplo.
+
In this first map the status of several agents are added distributed on a world map. It can be done manually, one by one, or using the Wizard. To make their creation easier, the Wizard is used in the example:
  
Lo primero que tenemos que hacer es crear un nuevo mapa, que llamaremos World Map.  
+
The first step is creating a new map, called World Map.  
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_consvisual1.png|800px]]
 
[[image:Guia rapida_consvisual1.png|800px]]
 
</center>
 
</center>
<br>
 
  
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_consvisual2.png|800px]]
 
[[image:Guia rapida_consvisual2.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Una vez creado pinchamos sobre el wizard de elementos:
+
Once created, click on the elements Wizard:
  
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_consvisual3.png|800px]]
 
[[image:Guia rapida_consvisual3.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
En el wizard seleccionamos el tipo de elemento, en este ejemplo Static Graph, la imagen que queremos usar, si queremos usar un item por agente o por módulo, en nuestro caso por agente, y seleccionamos los agentes que vamos a añadir dentro del listado que aparece.  
+
In the Wizard, select the type of element, in this example Static Graph, the desired image, if you want to use an item per agent or per module (in this case per agent), and select the agents to be added from the list.
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_consvisual4.png|800px]]
 
[[image:Guia rapida_consvisual4.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Pinchamos sobre el botón añadir y nos aparecerá en el mapa todos los elementos creados, tal y como vemos en la siguiente captura.
+
Click on the "Add" button and all the elements created will be shown on the map, as seen in the following screenshot.
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_consvisual5.png|800px]]
 
[[image:Guia rapida_consvisual5.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Movemos todos los elementos como los queramos tener posicionados en el mapa, pinchando y arrastrándolos sobre el mismo.
+
Move all the elements as you wish them to be placed on the map, clicking and dragging them to their new location.  
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_consvisual6.png|800px]]
 
[[image:Guia rapida_consvisual6.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
== Creación de mapa 2 (Mapa hijo)==
+
== Creating Map 2 ("Child" Map) ==
  
En el segundo mapa se va a crear un elemento que nos indica el estado de uno de los agentes principales, unidos a él todos los módulos dados. Visualizaremos en este mapa también una gráfica del módulo FreeRAM del mismo agente.
+
The second map will create an element that indicates the status of one of the main agents, together with all the given modules. A graph of the FreeRAM module of the same agent is also displayed on this map.
  
Primero de todos creamos el nuevo mapa como hicimos el anterior:
+
The first step is to create the new map just like you last time:
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_spain1.png|800px]]
 
[[image:Guia rapida_spain1.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Una vez creado añadimos el elemento que nos muestra el estado del agente en la sección Static Graph, tal y como aparece en la imagen adjunta:
+
Once created, add the element that shows the agent status in the Static Graph section, as shown on the following screenshot:
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_spain2.png|800px]]
 
[[image:Guia rapida_spain2.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Creamos también la gráfica con la configuración adjunta, pinchando en el icono de gráficas, añadiendo el agente y módulo del que vamos a ver reflejada la gráfica.
+
Create the graph with the attached configuration too, clicking on the icon of graphs, adding the agent and module whose graph you will see.
  
<br>
+
The main element of the map is already created, now create a new element for each of the modules that exist within the agent. To do this, use the Wizard by making its configuration as seen in the attached screenshot. Select the agent's Static Graph and the modules you indicate. Label it with the module's name and assign the item a parent you added previously in the Visual Map, in this case the element you added before.
<br>
 
<center>
 
[[image:Guia rapida_spain3.png|500px]]
 
</center>
 
<br>
 
<br>
 
 
 
Ya tenemos creado el elemento principal del mapa, ahora vamos a crear un elemento nuevo por cada uno de los módulos que existen en el agente. Para ello vamos a usar el Wizard realizando su configuración tal y como vemos en la captura adjunta. Seleccionamos Static Graph, del agente y los módulos que indicamos. Le ponemos como etiqueta el nombre del módulo y configuramos el parent a un Item creado en el mapa visual, en este caso el elemento anterior que hemos añadido.
 
 
 
<br>
 
<br>
 
<center>
 
[[image:Guia rapida_spain4.png|800px]]
 
</center>
 
<br>
 
<br>
 
  
Tras crear todos estos elementos nos aparecerán unidos al elemento principal y los podemos mover arrastrandolos directamente con el ratón en la posición que queramos.
+
After creating all of these elements, they will appear attached to the main element, and you can move them by dragging them with the mouse to wherever you want.  
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_spain5.png|800px]]
 
[[image:Guia rapida_spain5.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
== Linkado de ambos mapas ==
+
== Link both maps ==
  
Creamos en los pasos anteriores los dos mapas. En este paso vamos a indicar como al pinchar en el elemento situado sobre España en el mapa "World Map" se nos abre directamente el mapa "Spain Map".
+
The previous steps helped you create two maps. The purpose of the next step is ensuring that when clicking on the element placed over Spain on the "World Map" the "Spain Map" opens up.
  
Para ello abrimos el mapa World Map, en el modo edición, haciendo doble-click sobre el elemento 192.168.70.70. Se nos abrirá la edición del elemento, pinchamos sobre opciones avanzadas y en la opción Map Linked, seleccionamos el Spain Map. Actualizamos el elemento
+
Open the "World Map", in editing mode, by double-clicking on the 192.168.70.70 element. It will show the element editor. Click on advanced options and on the 'Linked Map' option, select the Spain Map and update the element.
  
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_link1.png|800px]]
 
[[image:Guia rapida_link1.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
  
Al volver sobre la vista del mapa World Map, hacemos click en el elemento situado sobre España y directamente se nos abrirá el mapa de España. Si en el mapa de España hubiera un solo elemento en rojo, el icono que representa a España en el mapa padre, se vería en rojo.
+
When returning to the World Map view, click on a element placed over Spain, which should directly open the Spain Map. If there were just one red element on the Spain Map, the icon representing Spain on the parent map would also be red.
  
<br>
 
<br>
 
<center>
 
[[image:Guia rapida_link2.png|800px]]
 
</center>
 
<br>
 
<br>
 
 
<br>
 
<br>
 
 
<center>
 
<center>
 
[[image:Guia rapida_spain5.png|800px]]
 
[[image:Guia rapida_spain5.png|800px]]
 
</center>
 
</center>
<br>
 
<br>
 
 
= Ajustar mi monitorización (umbrales, unidades, otros) =
 
 
En este apartado veremos como configurar algunas de las opciones avanzadas de un módulo.
 
  
 +
= Adjust your monitoring (threshold, units, others) =
  
Navegamos hasta la vista de los módulos del agente.
+
In this section, we will show you how to configure some of the more advanced options of a module.
  
 +
Go to agent module view.
  
 
<center>
 
<center>
 
[[file:moduloU.png|600px]]
 
[[file:moduloU.png|600px]]
<br><br>
 
 
</center>
 
</center>
  
Seleccionamos el módulo deseado a configurar.
+
Select the module you wish to configure:
 
 
  
 
<center>
 
<center>
 
[[file:moduloseleccionadoU.png|600px]]
 
[[file:moduloseleccionadoU.png|600px]]
<br><br>
 
 
</center>
 
</center>
  
 
+
After that, open the "Avanced Options" tab and proceed to configure the fields to reflect the information you want to see.
Posteriormente abrimos la pestaña de "Avanced Options" y procedemos a configurar los campos deseados.
 
 
 
  
 
<center>
 
<center>
 
[[file:advanced.png|600px]]
 
[[file:advanced.png|600px]]
<br><br>
 
 
</center>
 
</center>
  
 +
In the following sections, you will see how to configure the fields called "Unit" and "Interval", and the thresholds named as "Warning Status" and "Critical Status".
  
En los dos siguientes apartados veremos como configurar los campos "Unit" e "Interval" y los umbrales "Warning Status" y "Critical Status".
 
  
== Configuración de las unidades de un módulo ==
+
== Configuring module units ==
  
Permite definir las unidades del dato obtenido en un modulo. Esta unidad se incluirá en gráficas e informes, de forma que sea más fácil interpretar los datos que se muestran al usuario.  
+
This option allows the user to define the data units obtained from a module. These units will be included in graphs and reports, so that it is easier to manage and understand the data shown to the user.  
  
En nuestro ejemplo, el módulo ''IOWaitCPU'' queremos que tenga como unidad "ticks/sec". Nos situamos dentro del campo "Unit" y escribimos la unidad deseada.
+
In the example, the unit must be "%". Go to the "Unit" field and type in the desired unit.
  
 
<center>
 
<center>
<br><br>
 
 
[[file:unitU.png|730px]]
 
[[file:unitU.png|730px]]
<br><br>
 
 
</center>
 
</center>
  
Finalmente, hacemos click en el botón "Update" y comprobamos que se muestra correctamente nuestra unidad en la vista de los módulos.
+
Finally, click on the "Update" button and check whether your unit is properly shown in the module's view.
  
<center>
+
== Configuring a module interval ==
<br><br>
 
[[file:vistaunidadU.png|730px]]
 
<br><br>
 
</center>
 
  
== Configuración del intervalo de un módulo ==
+
By configuring/modifying the module interval, it is defined how often the module should be executed. This is applied to remote modules (not local ones), because local modules are configured in a more complex way. The more frequently you monitor a remote system, the heavier the load on the monitored system will be.
 
 
Configurando/Modificando el intervalo del módulo definiremos cada cuando queremos que se ejecute dicho módulo. Esto aplica a módulos remotos (no que se ejecuten en local), ya que los módulos locales se configuran de una manera algo más compleja. Cuanto más frecuentemente se monitorice un sistema remoto, más carga generará en el sistema.
 
  
 
<center>
 
<center>
<br><br>
 
 
[[file:intervaloU.png|650px]]
 
[[file:intervaloU.png|650px]]
<br><br>
 
 
</center>
 
</center>
  
Hacemos click en el botón "Update" y ya tendremos configurado el módulo.
 
  
== Configuración de los umbrales de un módulo ==
+
Click on the "Update" button and the module will be configured.
  
En esta sección configuraremos los umbrales "Warning" y "Critical" para un módulo, que definen que valores debe tener un modulo para estar en un estado CRITICAL, WARNING o NORMAL. La forma mas fácil de entenderlo es mediante un ejemplo:
+
== Module threshold configuration ==
  
En nuestro caso tenemos un módulo de la CPU al que queremos añadirle umbrales. Este módulo siempre estará en estado NORMAL (verde) siempre y cuando esté entre 0% y 100%. Si queremos que este módulo se muestre en estado "Critical" o "Warning" cuando la CPU alcance un % determinado, deberemos configurarlo determinando los umbrales de "Warning Status" y "Critical Status" deseados. En este ejemplo los configuraremos para que cuando la CPU llegue al 60% de uso el módulo se ponga en estado "Warning" y si supera el 80%, se ponga en "Critical".
+
In this section, "Warning" and "Critical" thresholds for a module are set up, which define what values a module must reach to get into critical, warning or normal status. The easiest way to understand this concept is through an example:
 +
 
 +
In this example you want to add thresholds to a CPU module. This module will always be in NORMAL (green) state as long as it is between 0% and 100%. If you want this module to be displayed in "Critical" or "Warning" status when the CPU reaches a certain %, configure it by determining thresholds for "Warning Status" and "Critical Status". In this example, configure them so that when the CPU reaches 60% of use, the module goes into "Warning" status and if it exceeds 80%, it goes into "Critical".
  
 
<center>
 
<center>
<br><br>
 
 
[[file:umbralesU.png|750px]]
 
[[file:umbralesU.png|750px]]
<br><br>
 
 
</center>
 
</center>
  
Después de configurar los umbrales, solo tendremos que pulsar en el botón "Update" y ya tendremos nuestro umbrales correctamente configurados. El próximo dato recibido ya interpretará esos umbrales.
+
After setting the thresholds, click "Update" to have them properly configured. The next pieces of data received will be compared against those thresholds.  
  
=== Parámetros avanzados de los umbrales ===
 
  
La casilla "inverse interval" sirve para definir rangos no contiguos. En este ejemplo, el modulo cambiará al estado critical si el valor está por debajo de 20 y/o por encima de 80:
+
=== Advanced Threshold Parameters ===
 +
 
 +
The "inverse interval" box is used to define non-contiguous ranges. In this example, the module will switch to critical status if the value is below 20 and/or above 80:
  
 
<center>
 
<center>
<br><br>
 
 
[[file:Quickguide_inverse1.PNG]]
 
[[file:Quickguide_inverse1.PNG]]
<br><br>
 
 
</center>
 
</center>
  
En módulos de tipo cadena de texto, el umbral se define como una subcadena. De igual manera, se puede invertir para que el modulo pase a critical si NO contiene la subcadena pasada como parámetro:
+
In text string type modules, the threshold is defined as a substring. Likewise, it is possible to invert it to make the module go into critical if it does not have the substring as a parameter:  
  
 
<center>
 
<center>
<br><br>
 
 
[[file:Quickguide_inverse2.PNG]]
 
[[file:Quickguide_inverse2.PNG]]
<br><br>
 
 
</center>
 
</center>
  
=== Otros parámetros avanzados ===
+
=== Other Advanced Parameters ===
  
La configuración de un módulo es muy flexible, con decenas de posibilidades. Explore la documentación de Pandora para descubrir todas ellas.
+
Module configuration is highly flexible, with dozens of possibilities. Explore the Pandora FMS official documentation to learn more about all of those options.
  
= Solución de problemas. Donde mirar, a quien preguntar =
+
= Solving problems. Where to look and who to ask =
  
== Ficheros de configuración y fuentes de información de diagnóstico ==
+
== Configuration files and sources for diagnostic information ==
  
Los principales ficheros de configuración que puedes necesitar tocar/revisar son los siguientes:
+
The main configuration files that you may need to modify/review are the following:  
  
* ''/etc/pandora/pandora_server.conf''. Fichero de configuración principal del servidor de Pandora. Si tocas algo ahí, tendrás que reiniciar el servidor de Pandora FMS.
+
* ''/etc/pandora/pandora_server.conf''. Pandora FMS sever main configuration file. If modify anything here, reboot the Pandora FMS server.
* ''/etc/pandora/pandora_agent.conf''. Fichero de configuración principal del agente software de Pandora en Unix. Si tocas algo ahí, tendrás que reiniciar el agente de Pandora FMS.
+
* ''/etc/pandora/pandora_agent.conf''. Pandora FMS main configuration file in Unix. If you change anything here, restart the Pandora FMS agent.  
* ''%PROGRAM_FILES%\pandora_agent\pandora_agent.conf''. Fichero de configuración principal del agente software de Pandora en Windows. Si tocas algo ahí, tendrás que reiniciar el servicio agente de Pandora FMS.
+
* ''%PROGRAM_FILES%\pandora_agent\pandora_agent.conf''. Pandora FMS main configuration file in Windows. If you change anything here, restart the Pandora FMS agent service.
* ''/etc/my.cnf''. Fichero de configuración principal de MySQL.
+
* ''/etc/my.cnf''. Main MySQL configuration file.
* ''/var/www/html/pandora_console/include/config.php'', fichero de configuración de la consola de Pandora. En la instalación se autoconfigura, pero si ha cambiado algun parámetro de entorno (path, IP, usuario/password de MySQL, host de MySQL) habrá que modificarlo manualmente.
+
* ''/var/www/html/pandora_console/include/config.php''. Pandora FMS console configuration file. During the installation it is auto-configured, but if you need to change any environment parameters (path, IP, user/password of MySQL, host of MySQL) modify it manually.
  
Fuentes de información (logs) donde puedes buscar más informacion, errores, etc:
+
Sources of information (logs) where you can find more info, errors, etc:
  
* ''/var/log/pandora/pandora_server.log''. Fichero log del servidor, contiene pistas muy importantes. Si quieres tener mas detalle modifica el parámetro "verbosity" del fichero de configuración del servidor para que muestre más detalle.
+
* ''/var/log/pandora/pandora_server.log''. Server log file, which contains very important clues. If you need more details, modify the "verbosity" parameter of the server configuration file to see more details.
* ''/var/log/pandora/pandora_server.error''. Fichero log de errores no capturados del servidor, contiene trazas de errores no manejados por el servidor, suelen ser cosas algo feas.
+
* ''/var/log/pandora/pandora_server.error''. Error log file not captured by the server, which contains error traces not handled by the server, usually nasty things.
* ''/var/log/pandora/pandora_agent.log''. Fichero log del agente unix.
+
* ''/var/log/pandora/pandora_agent.log''. Log file of the Unix agent.
* ''%PROGRAM_FILES%\pandora_agent\pandora_agent.log''. Fichero log del agente en windows.
+
* ''%PROGRAM_FILES%\pandora_agent\pandora_agent.log''. Log file of the Windows agent.  
* ''/var/www/html/pandora_console/pandora_console.log'', fichero log de la consola de pandora.
+
* ''/var/www/html/pandora_console/log/console.log''. Log file of the Pandora FMS console.
* ''/var/log/httpd/error_log'', fichero log de errores del servidor Apache (httpd).
+
* ''/var/log/httpd/error_log''. Error log file of the Apache server (httpd).
* ''/var/log/messages'', fichero log del sistema.
+
* ''/var/log/messages''. System log file.
* ''dmesg'', comando que muestra avisos del kernel.
+
* ''dmesg''. Command that shows Kernel warnings.
* ''/var/log/pandora/pandora_snmptrap.log'', log de traps SNMP. Si existe algun error en el arranque de la consola de traps SNMP puede mostrar trazas de error ahí.
+
* ''/var/log/pandora/pandora_snmptrap.log''. SNMP trap logs. If there are any errors in the SNMP traps console boot, it can show error traces there.  
* ''/var/log/mysqld.log'', log de Mysqld.
+
* ''/var/log/mysqld.log''. Mysqld log.
 +
* ''/var/log/pandora/web_socket.log''. Websocket log.
 +
* ''/var/www/html/pandora_console/log/cron.log''. Cron log.
  
Por otro lado es interesante saber algunas cosas respecto a los permisos de algunos directorios:
+
On the other hand, it is also helpful to know some things about the permissions of some directories:
  
* ''/var/spool/pandora/data_in/'' debe ser de pandora:apache con permisos 755.
+
* ''/var/spool/pandora/data_in/''. It should be pandora:apache with 755 permissions.
* ''/var/log/pandora/'' debe ser de pandora:root con permisos 755.
+
* ''/var/log/pandora/''. It should be pandora:root with 755 permissions.
* ''/var/www/html/pandora_console/include/config.php'' debe ser de apache:apache con permisos 600.
+
* ''/var/www/html/pandora_console/include/config.php''. It should be apache:apache with 600 permissions.
 +
 
 +
<br>
 +
 
 +
<b>IMPORTANT:</b>
 +
 
 +
For versions prior to 747, Pandora Console log path will be <b>/var/www/pandora_console/pandora_console.log.</b>
 +
 
 +
If updating from <b>OUM</b> you will need to modify the <b>logrotate</b> [http://pandorafms.com/docs/index.php?title=Pandora:Documentation_en:Managing_and_Administration#Local_server_logs file].
 +
 
 +
<br>
  
 
== Support ==
 
== Support ==
  
Our community forum is opened to everybody, create an account and ask freely!
+
Our community forum is open to everybody, create an account and ask away!
  
* [http://forum.pandorafms.com PandoraFMS forums]
+
* [http://pandorafms.org/forum/ PandoraFMS forums]
  
You have also a FAQ (Frequently Answered Questions) that can help you to find a tip or solve a problem:
+
There is also a FAQ (Frequently Asked Questions) that can help you find a tip or solve a certain problem:
  
 
* [http://wiki.pandorafms.com/index.php?title=Pandora:FAQ_EN Pandora FMS FAQ]
 
* [http://wiki.pandorafms.com/index.php?title=Pandora:FAQ_EN Pandora FMS FAQ]
  
And of course, you can have official training. There are several levels of certification on Pandora FMS, read more at:
+
And of course, you have the official training option. There are several certification levels for Pandora FMS. Read more at:
 +
 
 +
* [https://pandorafms.com/pandora-training/ Pandora FMS official training]
  
* [http://pandorafms.com/Soporte/training/en Pandora FMS official training]
+
[[Category:Pandora FMS]]

Latest revision as of 17:50, 2 April 2021

1 Introduction

The purpose of this guide is to quickly introduce Pandora FMS to someone unfamiliar with Pandora FMS, but who has medium to high knowledge of systems and networks. The purpose is not delving into all Pandora FMS features, but rather discussing the most important ones. That way, a user that reads the complete Quick Guide should be able to perform basic administration and operation tasks quickly. Considering that Pandora FMS official training takes 40 hours, and the official documentation has more than 1200 pages, this is meant to be just a small bridge to a larger documentation package for Pandora FMS, so that the first contact is not too complicated.

2 Installation

We recommend using the Pandora FMS Appliance CD because it is the quickest and easiest method for intermediate users. For further information about alternative installin methods, read the Pandora FMS Installation chapter .

The installation CD is based on Linux CentOS 7, and contains all the required elements and dependencies to make Pandora FMS work. You should have a machine with the minimum hardware requirements to make Pandora FMS run properly, including a minimum of 4GB of RAM and 20GB of disk-space.

Info.png

The more systems you want to monitor, the more resources (CPU, memory, disk speed) you will have to assign to the Pandora FMS server.

 


2.1 Installing the Appliance CD

Download the CD image from the Download section of our website and burn the ISO image onto a DVD, or run the system from that file if you are using a virtualized system (XenServer, VMware, VirtualBox, etc). There are CD images for both 32 and 64-bit installations.

The following screen will be displayed at the beginning of the boot process. If you do not press any key, the process will automatically load the Live CD, or you can press any key and select the "Install Pandora FMS" option.

Install 1.png

The graphic installer will lead you step by step through the whole installation process. This installer is a standard installation process used by CentOS, and is available in different languages. It is a quite easy process, just pay special attention when entering the superuser password (root), and when asked about the hard drive partitioning:

Install 2.png]
Select the language


Install 3.png

Select and configure all the necessary options to install, “Date & Time”, “Keyboard” and “Installation Destination”. Remember to activate the network interface, or else you will need to activate it manually after installation.

Install 4.png Install 5.png
Activate the network interface and optionally change the hostname.


When clicking the installation destination button, the partition process will start.

Install 6.png
Select the disk where the installation will be performed and click on "done". Install 7.png

Select the partitioning, unless you have advanced knowledge use the option "Click here to create them automatically".


Install 8.png
Verify the created partitions and click on "done".
Install 9.png
Accept changes.
Install 10.png
Click on "Begin Installation".
Install 11.png
Here you can assign the root password and optionally create a user.

Now just wait until the process is finished and the system restarts automatically.

2.2 First steps

Once installed, the system should boot, and after a few seconds, it will show a Terminal where to log in:

F step 1.png

The first step would be getting the system IP address to be able to connect to the server from outside. To retrieve it, execute the command:

ifconfig 

F step 2.png

Here is an example. In this particular case, the system's IP address is 192.168.70.158

If the system has booted and taken an IP from our network via DHCP it will be shown on the list. If you wish to set a static IP for this system, do it by using the nmtui command, which shows a graphic interface to do so.

F step 3.png

Once you know the IP address of the Pandora FMS system, you can access it from outside the virtual machine, which is always more convenient. You can do it via SSH or HTTP. Remember that you already set the root password (superuser) during the configuration in the installation process.

Open a browser and enter the IP address that you got from your server:

http://x.x.x.x/pandora_console

In the previous example it would be http://192.168.70.158/pandora_console, but you must retrieve your system's IP correctly to be able to continue. If everything is correct, you will see the Pandora FMS console welcome screen, which looks similar to this one:

F step 4.png

Info.png

Use the default credentials: user admin and password pandora

 


Once you reach this point, you have a complete installation of Pandora FMS ready to start using it.

2.3 Enterprise license activation

Template warning.png

This section is for Enterprise users only. You can safely skip it if you are using the Open Source version.

 


Info.png

It is very important to not boot the pandora_server daemon with the Enterprise version installed, without not having enable the console Enterprise version, since there will be failures.

 


Template warning.png

This process is not necessary if we have a Metaconsole license as this type of license automatically activates each associated node.

 


Once you access your Pandora FMS through the browser, you will be asked to enter a valid license:

Enterprise 1.png

Click on Request new license and proceed to the next step. In this step you need to fill out the contact information and the Auth key that the sales department has forwarded, if it is an Enterprise version.

Proceed to the next step by clicking on Online validation Enterprise 2.png

Once done, the license will pop out to validate it.

Once you are done with all the steps, your console is ready to use. More information can be found in the video tutorial «How to renew Pandora FMS License».


2.4 Enterprise server start

Template warning.png

This section is for Enterprise users only. You can safely skip it if you are using the Open Source version.

 


After activating your license, the Enterprise server should start. In your Pandora FMS server, open a terminal selecting Applications > System Tools > Terminal, and then type in:

sudo /etc/init.d/pandora_server start

To verify that everything works, access your Pandora FMS through the browser and go to Manage servers. You should see something like this:

Pandora servers.PNG

3 Detecting systems in your network

To start using Pandora FMS, detect and monitor the devices that are on your local network. It does not matter whether they are PCs with Windows, Macintosh, Linux servers or routers/switches because this is just a very basic monitoring task (checking if they answer to a ping). Once they are detected, you may improve the monitoring.


3.1 Create a Recon Task

Follow the next steps. From the side menu, go to Discovery > Discovery as shown in the image below, and click on "Host&Devices" and "NetScan".



Guiarapida recon1.png



Guiarapida recon1 2.png



Guiarapida recon1 3.png

Create the task as follows: modify the network range that is to be explored. In this screenshot the range is 192.168.70.0/24 which means that all the hosts in the 192.168.70.xx network will be explored. Use the appropriate IP address range here to define your network. Selecting the group "Applications", which is used to cointain de discovered devices. From now on, the services managed or monitored by Pandora FMS are called "agents".



Guiarapida recon2.png

The network template "Basic monitoring" has been selected, which only covers latency and network availability checks. You may select other type of checks such as SNMP or WMI, to be carrioed out during the recon task.



Guiarapida recon2 1.png

Once created, it will show the entry, and click on the magnifying glass icon to see the task details, as shown in the screenshot below:



Guiarapida viewrecon.png

By clicking on the magnifying glass icon, you will be shown the current task status, which in this case is completed. In this screenshot you can see the progress bar is not there, and the system has already found the network devices to add to the monitoring.



Guiarapida reconexec.png


3.2 Reviewing detected systems

At this point, we recommend you to wait until the network has been fully detected. When finished, access the agent detail view to see all detected systems. Menu Click on the Refresh tab Refreshtab.png. When you're finished, go to Agent Detail view to see all the detected systems. Menu Monitoring > Views > Agent detail, as seen in the image:



Guiarapida monitoringagentdetail.png

Here you may see several systems that have been properly detected by Pandora FMS. Sometimes the name of the system will have been discovered (if possible by DNS), and in other cases the OS will have been detected. When clicking on the system name (in this case the first one appearing on the screenshot), you will be forwarded to the Agent Detail view which displays all of the information gathered about that system.



Guiarapida agentdetailedview.png

4 Add remote check to an already monitored system

Now that the systems are detected, add some monitoring modules. These are the monitoring parameters to be added:

  • Network traffic on an interface.
  • Network packet loss.
  • Check whether a service answers on the network through a TCP port.
  • Check a website.

4.1 Interface network traffic

To monitor network traffic, SNMP must be configured on the remote device. This usually needs to be activated and (minimally) configured to allow you to check data. The SNMP device allows you to configure which IP can make queries, and with which community. This ends up working as an additional security measure.

First of all, locate the agent from which you want to obtain the network traffic, in this case it is 192.168.70.1. Following the same process (Monitoring > Views > Agent detail) go to the Main View of the agent you want to configure and click on the last tab on the right, which will take you to the edit view for that agent.

Guiarapida agentedit.png

Now go to the Agent edit main view section. Below you may see this agent's Wizard configuration submenu. Choose the SNMP Interface wizard, as you can see on the following screenshot:

Guiarapida snmpinterfacewizard.png

At this point, provide the SNMP community that you configured on the equipment, and make sure the device supports SNMP queries enabled in the IP shown on the screen. The IP address can be changed as well as the SNMP community, which is set to public by default. Once filled out, click on the "SNMP Walk" button. If everything is OK, it will show the interfaces and the data that can be obtained from them.

Guiarapida snmpinterfacewizard2.png

With Ctrl+Click (or CMD+Click in Mac) you may select more than one element in both boxes, as shown in the following screenshot. Remember to monitor the outgoing traffic (ifOutOctets), the incoming traffic (ifInOctets), and the interface status (ifOperStatus) on each interface. In this particular case, eth1, eth2 and eth3.

Click on the "Create modules" button and a screen should display information about the modules that have been created.

Remember that the network traffic modules are incremental, meaning its value is the difference between the information sample taken previously, and the current information. It shows a "rate" (in this case bytes/sec) so it takes some time (between 5 and 10 minutes) before it shows anything.

Guiarapida opermode.png

Click on the "View" tab to go back to the agent view and wait 5 minutes until having traffic data, refreshing or clicking on the "View" tab. After some time, you should have a screen similar to this one, where you already have data from the traffic modules (incoming and outgoing, separately) and a new agent section, which shows information of the interfaces with direct access to an added graph with superimposed outgoing and incoming traffic (if you click on the title "Interface information (SNMP)").

Guiarapida interfaceinfo.png

If you do not wish to wait or you prefer to "force" network module execution, use the force remote check icon (it will not work on local modules, or on modules collected locally by a software agent). Depending on the server load, it may take between 2 and 15 seconds to execute the network test.

Guiarapida forcenet.png

The information about the traffic modules will be displayed like this, with graphs for each metric. Clicking on the graph icon Chart curve.png will show a window with this monitor's graph, and clicking on the data icon Binary.png will show a table with data.

Guiarapida moduledata.png

4.2 Network packets loss

A remote plugin that is pre-configured is to be added to Pandora FMS. Remote plugins are checks defined by the user that use a script or software deployed onto the Pandora FMS server, so that it can be used for monitoring, increasing the range of tasks it may carry out.

A serial plugin is used, so go to the Agent edit View, and then to the Module configuration tab.

Guiarapida moduleeditor1.png

Select a module type plugin and click on "Create", which will lead you to the configuration interface for "remote plugin" type modules.

Guiarapida moduleeditor2.png

Choose the plugin "Package loss" using the drop down menu, and enter the target IP address on which you want to implement the checks. Leave the rest of fields as they were.

Guiarapida moduleeditor3.png

Click on the "Create" button and go back to the Operation View, as the previous case. Refresh a couple of times until the new module appears on the list:

Guiarapida packetloss.png

This is a very interesting plugin that, when used together with basic connectivity (ping) and latency time, helps to determine the quality of your network, since the result reveals the package loss percentage, taking samples every 5 minutes.

4.3 Monitor a TCP network service

For the following case, a monitor will be added to verify that an SMTP service (mail) is active on a machine. Although it might be a very complex check (simulating sending an email, or sending user and password credentials, etc) it can be simplified by only checking only whether the port is open and if it answers.

Repeat the same initial steps from the previous example, but this time select "Network module".

Guiarapida networkmodule.png

After that, use the drop down controls to find the desired check (Check SMTP Server) and click to create the module.

Guiarapida networkmodule2.png

Finally, repeat the steps (go to the Operation View, and refresh until the monitor appears) so that the final result will be something similar to the following:

Guiarapida networkmodule3.png

5 Add an alert (email sending) when there is some issue

In Pandora FMS, the most basic method of alerting is to assign an alert to a specific module. It is possible to perform more advanced alert configurations (event alerts, correlation, etc), but they are not included in this guide. The first alert will consist of simply sending an email when a monitored machine (with the Host module alive) is down.

Alerts in Pandora FMS are made up by three elements: command, action and template. In this particular case, a predetermined command is used (email sending) an existing action will be modified (Mail to XXX) and the existing template Critical condition will be used, which will execute the alert when said module goes into critical status.

5.1 Server configuration

For the email command to work properly, set up in the pandora_server.conf file a mail server that allows to perform relay actions. In the example, the mail server is placed on the localhost through postfix. Enter the local mail server's IP address or one that exists on the Internet (for which you would have to

configure the Authentication). To modify the server's configuration file located at /etc/pandora/pandora_server.conf, access it as root user, so you should have executed sudo su before:



Guiarapida mailconf02.png

Look for the same lines shown on the screenshot above and configure them as the image shows. If you do not have a mail server, you may use a Gmail account for example. You can take a look at a quick guide about how to configure the Pandora FMS server to work with a gmail account following this link: http://wiki.pandorafms.com/index.php?title=Pandora:Configuration_emails_alerts

Lines beginning with the "#" character are comments and they are not taken into account by the server.



Guiarapida mailconf03.png

Once the changes are finished, press "ESC" and ":wq" to exit and save the changes. After saving changes, restart pandora_server:


service pandora_server restart

5.2 Alert configuration

As previously mentioned, Pandora FMS alerts are made up by three components: command, action and template. You can find these options in the Alerts section.



Guiarapida mailconf8.png

To configure this alert just modify the action. The action to use is Mail to XXX. In this case, if you need to change the email address you want to use ([email protected]), you may modify "Mail to XXX" to "Mail to [email protected]" so that you can identify which action is executed.

Modify field 1 and enter the desired target email address.

In field 2, leave the text shown on the screenshot. Here 2 macros that will replace the agent name and the module that has generated the alert during execution are used.

Guiarapida mailconf13.png

Select the Mail to XXX action and edit the email address ([email protected]).

Guiarapida mailconf1.png

5.3 Assigning an alert to a module

Navigate to agent edition, where the module is defined and click on the 'alerts' tab:

Guiarapida mailconf5.png

Now add the module (Host Alive), the template (Critical Condition) and the action (Mail to XXX). Then add the alert.

Guiarapida mailconf4.png

Once added, you may see the alert from the Agent View to determine whether it is running or not, by observing the status color:

Guiarapida mailconf6.png

You may wait until the host fails (or force it) to see whether the alert works, or you may "force the alert" to see if the email is actually sent. Click on the Force icon (see image):

Guiarapida forcealert.png

Finally, the email with the alert should appear in your inbox. As it is a "forced" alert it says N/A in the data field. In a real case, it should state the module's real values in the message.

Guiarapida mail.png

Pandora FMS alerts are extremely flexible. Sometimes they seem to be difficult to use. If you need a more in-depth explanation, there is a specific chapter in the official documentation for alert management: Alerts in Pandora FMS

6 Monitor a Windows Server with a software agent

Pandora FMS provides two types of monitoring: remote (from the Pandora FMS server to different devices) and local (where Pandora FMS is installed as a software agent on each monitored machine and retrieves the information you wish to observe and forwards it to the Pandora FMS server).

This section explains a software agent installation on Windows computers and its basic monitoring:


6.1 Agent Installation

First of all, download the Windows agent. You can get it from:

http://sourceforge.net/projects/pandora/files/Pandora%20FMS%205.1/SP2Final/Windows/

In this link, you may choose between the 32-bit or 64-bit agent.

Once the agent is downloaded,run it by double-clicking on it and the language selection screen will appear::

Pandora agent 3.0 RC3 install windows 01.png

This is a standard Windows installer that will ask you to follow the steps. Accept the license and go through the different installer screens. Select the path where you want the Pandora FMS agent to be installed (it is installed at C:/Program Files/pandora_agent by default). You may modify the destination folder by clicking on "Browse". Once done, click "Next":

Pandora agent 3.0 RC3 install windows 04.png

Wait for the files to be completely copied. Configure the Pandora FMS server IP address (or name) that will receive the agent's data, and the group you want to associate the agent to.

Pandora agent 3.0 RC3 install windows 07.png


In the following screen, you can see the option to enable remote configuration. It is important to have it enabled through '1' if you want to have a copy of the Pandora FMS server agent, and from there you may add, edit and delete local modules directly from the agent.

Pandora agent config remoto.png

Decide if you want to start the the agent service at the end of the Pandora FMS agent installation. Otherwise you will have to do it manually, or it will start when Windows is restarted.

Pandora agent 3.0 RC3 install windows 08.png

Once this process is finished, the Windows agent should be installed and running on the computer.

6.2 Checking the information returned by the agent

After installation, and when the Windows agent is launched, it is time to check what this agent reports. To do that, find out the name that the agent will use to report. The agent is created with the host name by default. You should see the name of the Windows host by executing the hostname command via cmd.exe.

Guia rapida windows1.png

Now that you know the agent's name, the next step is to check if the agent has been created on Pandora FMS. To do that, there are several options. The first one is to search in the Agent Details, in the group where the agent has been created, which in our example is named "Servers".

Guia rapida windows2.png

A quicker and more efficient way to find the agent, is by performing the search directly through the Pandora FMS search engine, indicating the name of the agent.

Guia rapida windows3.png

Here the agent will appear, and by clicking on it you may look into the information that it is being reported.

Guia rapida windows4.png

By default, the Windows agent comes with several pre-configured local modules in charge of basic monitoring, such as CPU load, free RAM percentage (FreeMemory), disk free space in MB, DHCP status (DHCP Enabled) and number of active processes (Number processes).

Guia rapida windows5.png

If you need to add new modules to this agent, you may check the advanced documentation here: monitoring with software agents.

You may see graphs generated with the module's data history and a table with the module's data history from this screen by clicking on the icons marked in the following screenshot:

Guia rapida windows6.png

7 Creating a Visual Screen with your monitoring details

One of the visualization options that Pandora FMS offers is the possibility of creating Visual Consoles. The Visual Console allows to represent the monitoring information in real time in a totally graphical way. In this example of Visual Console, an example of a network distributed around the world will be created and it will show how by clicking on the node that appears over Spain, you may see another map of Spain with other elements of the installation there.

The power of the maps is that it allows you to "summarize" the status of a child map in the display of the parent map, that is, if any of the elements displayed on the map of Spain goes into critical state, the icon that represents Spain will turn red. This allows you to set up highly customized hierarchies when displaying information. Maps can contain group, agent and module status information. Graphics and data (numeric or text) can also be added, as well as text labels and icons.

7.1 Creating Map 1 ('Parent')

In this first map the status of several agents are added distributed on a world map. It can be done manually, one by one, or using the Wizard. To make their creation easier, the Wizard is used in the example:

The first step is creating a new map, called World Map.

Guia rapida consvisual1.png

Guia rapida consvisual2.png

Once created, click on the elements Wizard:

Guia rapida consvisual3.png

In the Wizard, select the type of element, in this example Static Graph, the desired image, if you want to use an item per agent or per module (in this case per agent), and select the agents to be added from the list.

Guia rapida consvisual4.png

Click on the "Add" button and all the elements created will be shown on the map, as seen in the following screenshot.

Guia rapida consvisual5.png

Move all the elements as you wish them to be placed on the map, clicking and dragging them to their new location.

Guia rapida consvisual6.png

7.2 Creating Map 2 ("Child" Map)

The second map will create an element that indicates the status of one of the main agents, together with all the given modules. A graph of the FreeRAM module of the same agent is also displayed on this map.

The first step is to create the new map just like you last time:

Guia rapida spain1.png

Once created, add the element that shows the agent status in the Static Graph section, as shown on the following screenshot:

Guia rapida spain2.png

Create the graph with the attached configuration too, clicking on the icon of graphs, adding the agent and module whose graph you will see.

The main element of the map is already created, now create a new element for each of the modules that exist within the agent. To do this, use the Wizard by making its configuration as seen in the attached screenshot. Select the agent's Static Graph and the modules you indicate. Label it with the module's name and assign the item a parent you added previously in the Visual Map, in this case the element you added before.

After creating all of these elements, they will appear attached to the main element, and you can move them by dragging them with the mouse to wherever you want.

Guia rapida spain5.png

7.3 Link both maps

The previous steps helped you create two maps. The purpose of the next step is ensuring that when clicking on the element placed over Spain on the "World Map" the "Spain Map" opens up.

Open the "World Map", in editing mode, by double-clicking on the 192.168.70.70 element. It will show the element editor. Click on advanced options and on the 'Linked Map' option, select the Spain Map and update the element.

Guia rapida link1.png

When returning to the World Map view, click on a element placed over Spain, which should directly open the Spain Map. If there were just one red element on the Spain Map, the icon representing Spain on the parent map would also be red.

Guia rapida spain5.png

8 Adjust your monitoring (threshold, units, others)

In this section, we will show you how to configure some of the more advanced options of a module.

Go to agent module view.

ModuloU.png

Select the module you wish to configure:

ModuloseleccionadoU.png

After that, open the "Avanced Options" tab and proceed to configure the fields to reflect the information you want to see.

Advanced.png

In the following sections, you will see how to configure the fields called "Unit" and "Interval", and the thresholds named as "Warning Status" and "Critical Status".


8.1 Configuring module units

This option allows the user to define the data units obtained from a module. These units will be included in graphs and reports, so that it is easier to manage and understand the data shown to the user.

In the example, the unit must be "%". Go to the "Unit" field and type in the desired unit.

UnitU.png

Finally, click on the "Update" button and check whether your unit is properly shown in the module's view.

8.2 Configuring a module interval

By configuring/modifying the module interval, it is defined how often the module should be executed. This is applied to remote modules (not local ones), because local modules are configured in a more complex way. The more frequently you monitor a remote system, the heavier the load on the monitored system will be.

IntervaloU.png


Click on the "Update" button and the module will be configured.

8.3 Module threshold configuration

In this section, "Warning" and "Critical" thresholds for a module are set up, which define what values a module must reach to get into critical, warning or normal status. The easiest way to understand this concept is through an example:

In this example you want to add thresholds to a CPU module. This module will always be in NORMAL (green) state as long as it is between 0% and 100%. If you want this module to be displayed in "Critical" or "Warning" status when the CPU reaches a certain %, configure it by determining thresholds for "Warning Status" and "Critical Status". In this example, configure them so that when the CPU reaches 60% of use, the module goes into "Warning" status and if it exceeds 80%, it goes into "Critical".

UmbralesU.png

After setting the thresholds, click "Update" to have them properly configured. The next pieces of data received will be compared against those thresholds.


8.3.1 Advanced Threshold Parameters

The "inverse interval" box is used to define non-contiguous ranges. In this example, the module will switch to critical status if the value is below 20 and/or above 80:

Quickguide inverse1.PNG

In text string type modules, the threshold is defined as a substring. Likewise, it is possible to invert it to make the module go into critical if it does not have the substring as a parameter:

Quickguide inverse2.PNG

8.3.2 Other Advanced Parameters

Module configuration is highly flexible, with dozens of possibilities. Explore the Pandora FMS official documentation to learn more about all of those options.

9 Solving problems. Where to look and who to ask

9.1 Configuration files and sources for diagnostic information

The main configuration files that you may need to modify/review are the following:

  • /etc/pandora/pandora_server.conf. Pandora FMS sever main configuration file. If modify anything here, reboot the Pandora FMS server.
  • /etc/pandora/pandora_agent.conf. Pandora FMS main configuration file in Unix. If you change anything here, restart the Pandora FMS agent.
  • %PROGRAM_FILES%\pandora_agent\pandora_agent.conf. Pandora FMS main configuration file in Windows. If you change anything here, restart the Pandora FMS agent service.
  • /etc/my.cnf. Main MySQL configuration file.
  • /var/www/html/pandora_console/include/config.php. Pandora FMS console configuration file. During the installation it is auto-configured, but if you need to change any environment parameters (path, IP, user/password of MySQL, host of MySQL) modify it manually.

Sources of information (logs) where you can find more info, errors, etc:

  • /var/log/pandora/pandora_server.log. Server log file, which contains very important clues. If you need more details, modify the "verbosity" parameter of the server configuration file to see more details.
  • /var/log/pandora/pandora_server.error. Error log file not captured by the server, which contains error traces not handled by the server, usually nasty things.
  • /var/log/pandora/pandora_agent.log. Log file of the Unix agent.
  • %PROGRAM_FILES%\pandora_agent\pandora_agent.log. Log file of the Windows agent.
  • /var/www/html/pandora_console/log/console.log. Log file of the Pandora FMS console.
  • /var/log/httpd/error_log. Error log file of the Apache server (httpd).
  • /var/log/messages. System log file.
  • dmesg. Command that shows Kernel warnings.
  • /var/log/pandora/pandora_snmptrap.log. SNMP trap logs. If there are any errors in the SNMP traps console boot, it can show error traces there.
  • /var/log/mysqld.log. Mysqld log.
  • /var/log/pandora/web_socket.log. Websocket log.
  • /var/www/html/pandora_console/log/cron.log. Cron log.

On the other hand, it is also helpful to know some things about the permissions of some directories:

  • /var/spool/pandora/data_in/. It should be pandora:apache with 755 permissions.
  • /var/log/pandora/. It should be pandora:root with 755 permissions.
  • /var/www/html/pandora_console/include/config.php. It should be apache:apache with 600 permissions.


IMPORTANT:

For versions prior to 747, Pandora Console log path will be /var/www/pandora_console/pandora_console.log.

If updating from OUM you will need to modify the logrotate file.


9.2 Support

Our community forum is open to everybody, create an account and ask away!

There is also a FAQ (Frequently Asked Questions) that can help you find a tip or solve a certain problem:

And of course, you have the official training option. There are several certification levels for Pandora FMS. Read more at: