Pandora Azure SQL

• Introduction
• Compatibility matrix
• Pre requisites
• Previous configuration
• Parameters
• Manual execution
• Configuration in pandora
• Modules generated by the plugin

Introduction

Ver. 11-05-2022

With this plugin you can monitor an azureSQL database and extract data from it.
Type: Server plug-in

Compatibility matrix

Systems where tested	CentOS 7, Fedora, rocky linux
Systems where it should work	Cualquier sistema linux

 

Pre requisites

- Pandora FMS Data Server enabled
- Have the Pandora FMS Plugin Server enabled.
- Know some credentials of your account, such as your tenant id, secret, client id and the resource_Id of the database.

Previous configuration

The plugin makes use of a file in which two types of data can be entered.

#credentials
tenant_id:<tenant-id>
client_id:<client-id>
secret:<secret>
#id resources
database_id:<database_resource_id>

Obtaining credentials necessary for the use of the plugin.

1. Credentials to authenticate:

-Tenant id

-Client id

-Secret

2. Resource id

The resource id of each resource monitored by the plugin is required these are :

- Database resource id

Obtaining tenant id and client id.

1. To obtain the tenant id and the client id, we will go to the application registry menu inside active directory:

2. We will enter inside the application.

3. The tenant id and client id will appear in the application menu.

4. To find the secret we will go to certificates and secrets inside the active directory menu.

5. Within this menu we will be able to see the secret keys or generate them (it has to be the key value, not the id).

 

Obtaining the resource id of the database.

In the database, in general information, we can see the resource id of the database by clicking on json view.

 

 

 

Parameters

Parámetro	Descripción
--tentacle_port	Tentacle port (default 41121)(optional)
--tentacle_address	Ip of the tentacle server to send the data (optional)
--agent_name	To name the agent that will contain the modules, by default: "Azure SQL" (optional).
--prefix_module	To prefix the modules in case you want to differentiate them from other executions (optional).
--conf	Path of the conf file with the queries (required)
-g,--group	Pandora FMS target group (optional)
--data_dir	Pandora FMS data directory. By default it is /var/spool/pandora/data_in/ (optional)
--as_agent_plugin	It is optional, if you want the plugin to be an agent plugin and put the modules in the pandora agent, execute this with a 1 (optional)

 

Manual execution

Example of manual execution:

./pandora_azuresql -c <path_conf>

./pandora_azure -c <path_conf> --as_agent_plugin 1 [--data_dir <path> --agent_name <agent name>]

Configuration in pandora

As a server plugin

Installation from console

To register the plugin, from the console, go to the "register plugin" section.

Click on select file.

Select the pspz2 file that contains the plugin

Nos saldrá un mensaje que indicará si se ha registrado correctamente

Once the plugin is registered, we will see it in the plugins section.

Click on the title to access the plugin menu.

In parameters, we will see all the parameters of the plugin, remember that not all of them are mandatory, only in the ones that are specified

Below, in the parameter macros we can add the required value.

 

Manual installation

Go to servers > plugins:

Click on add:

We put the name and description of your choice:

 

We enter as command the execution with the path of the plugin:

/path_pandora_azuresql

And in plugin parameters we will introduce these followed by the macro "_field_", the mandatory ones for the plugin to work are -c and --as_agent_plugin (in case we want to run it as a server plugin, otherwise the latter is not essential.

We will define these with the macros below.

Once this is done, click on "create".

You can check that you have entered the values correctly by executing the terminal preview command

If it does not give errors, it means that it has been introduced well.

Once this is done, the only thing left to do is to call it, so we will go to some agent's view and create an add-in module:

We will give it a name and in the section "plugin" we will put the one we have just configured.

Once this is done, click on create.

If the module is shown with 1, it means that it is running correctly.

Modules generated by the plugin

The plugin will create an agent with the name we have set with the --agent_name parameter.

And it will create the following modules:

allocated_data_storage

app_cpu_billed

app_cpu_percent

app_memory_percent

blocked_by_firewall

connection_failed

connection_successful

cpu_limit

cpu_percent

cpu_used

deadlock

log_write_percent

physical_data_read_percent

sessions_percent

sql_server_process_core_percent

sql_server_process_memory_percent

storage

storage_percent

tempdb_size

tempdb_log_size

tempdb_log_used_Percent

workers percent

xtp_storage_percent