Pandora Azure Storage
With this plugin you can monitor a storage account and retrieve data from it, from the blob storage, queue storage and file storage.
- Introduction
- Compatibility matrix
- Pre requisites
- Previous configuration
- Parámeters
- Manual execution
- Configuration in pandora
- Módules generated by the plugin
Introduction
Ver. 09-05-2022
With this plugin you can monitor a storage account and retrieve data from it, from the blob storage, queue storage and file storage.
Type: Server plug-in
Compatibility matrix
Systems where tested |
CentOS 7, Fedora, rocky linux |
Systems where it should work |
Any linux system |
Pre requisites
- Pandora FMS Data Server enabled
- Have the Pandora FMS Plugin Server enabled.
- Know some of your account credentials, such as your tenant id, secret, subscription id, client id and connection string.
Previous configuration
Obtaining credentials necessary for the use of the plugin.
The plugin makes use of a .conf file in which three types of data can be entered.
#credentials
tenant_id:<tenant_id>
client_id:<client_id>
secret:<secret>
#id resources
account_id:<account_id>
blobservice_id:<blobservice_id>
fileservice_id:<fileservice_id>
queueservice_id:<queueservice_id>
tableservice_id:<tableservice_id>
datalakestorage_id:<datalakestorage_id>
#active agents
account_agent:1
blobservice_agent:1
fileservice_agent:1
queueservice_agent:1
tableservice_agent:1
datalakestorage_agent:1
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 :
- Account resource ID
- blobs service resource ID
- Resource ID of file service
- tables service resource ID
- resource ID of queues service
- datalakestorage resource ID
3. Active agents
We will be able to decide which agents to activate or deactivate by putting a 1 or a 0 in the line of each service.
Obtaining tenant id and client id.
1. To obtain the tenant id and the client id, we will go to the applications 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 can see the secret keys or generate them (it has to be the value of the key, not the id).
Obtaining the resource id of all services.
Resource id of the storage account.
Inside the storage account, in the main view we will select json view.
Inside we will find the resource id.
To find the ID of the other resources from which the plug-in is drawing data, we will go to connection points.
Inside you will find all the necessary resource IDs.
Parámeters
Parámetro | Descripción |
--tentacle_port | Tentacle port (default 41121)(optional) |
--tentacle_address | Ip of the tentacle server to send the data to (optional) |
--agent_name | To name the agent that will contain the modules, by default : "Azure monitor". (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
As an agent plugin
./pandora_azure -c <path_conf>
As a server plugin
./pandora_azure -c <path_conf> --as_agent_plugin 1 [--data_dir <path> --agent_name <nombre del agente>]
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
A message will appear indicating whether the registration has been successful.
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_azure
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 is 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 the view of some agent and create a module of complements:
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.
Módules generated by the plugin
Agentes
Agente Storage account
UsedCapacity |
Ingress |
Egress |
Transactions |
Availity |
SucessE2ELatency |
SucessServerLatency |
Agente blobs
BlobCapacity |
BlobCount |
ContainerCount |
Availity |
Indexcapacity |
Ingress |
Egress |
Transactions |
SuccessE2ELatency |
SucessServerLatency |
Agente files
FIleCapacity |
FileCount |
Availity |
FileShareCapacityQuota |
FileShareCount |
FileShareSnapshotCount |
FileShareSnapshotSize |
Ingress |
Egress |
SucessServerLatency |
SuccessE2ELatency |
Transactions |
Agente tables
TableCapacity |
TableCount |
TableentityCount |
Transaction |
Availity |
Ingress |
Egress |
SucessServerLatency |
SucessE2ELatency |
Agente datalake storage
a
BlobCapacity |
BlobCount |
ContainerCount |
Availity |
Indexcapacity |
Ingress |
Egress |
Transactions |
SuccessE2ELatency |
SucessServerLatency |
Agente queue
QueueCount |
QueueCapacity |
Availity |
QueueMessageCount |
Transaction |
Ingress |
Egress |
SuccessE2ELatency |
SuccessServerLatency |