Skip to main content

Azure SQL Server

Pack Assets​

Templates​

The Centreon Plugin Pack Azure SQL Server brings a host template:

  • Cloud-Azure-Database-SqlServer-custom

It brings the following service template:

Service AliasService TemplateService DescriptionDefault
Server-StatusCloud-Azure-Database-SqlServer-Server-Status-ApiCheck SQL server statusX

Discovery rules​

The Centreon Plugin Pack Azure SQL Server includes a Host Discovery provider to automatically discover the Azure instances of a given subscription and add them to the Centreon configuration. This provider is named Microsoft Azure SQL Server:

image

This discovery feature is only compatible with the api custom mode. azcli is not supported.

More information about discovering hosts automatically is available on the dedicated page.

Collected metrics & status​

Metric NameUnit
Server health statusstring

Prerequisites​

Please find all the prerequisites needed for Centreon to get information from Azure on the dedicated page.

Setup​

  1. Install the plugin package on every Centreon poller expected to monitor Azure SQL Server resources:
yum install centreon-plugin-Cloud-Azure-Database-SqlServer-Api
  1. On the Centreon web interface, on page Configuration > Plugin Packs, install the Azure SQL Server Centreon Plugin Pack.

Configuration​

Host​

  • Log into Centreon and add a new host through Configuration > Hosts.
  • In the IP Address/DNS field, set the following IP address: 127.0.0.1.
  • Aplly the Cloud-Azure-Database-SqlServer-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory. These mandatory macros differ depending on the custom mode used.

Two methods can be used to set the macros:

  • Full ID of the Resource (/subscriptions/<subscription_id>/resourceGroups/<resourcegroup_id>/providers/XXXXX/XXXXX/<resource_name>) in AZURERESOURCE
  • Resource name in the AZURERESOURCE macro, and resource group name in the AZURERESOURCEGROUP macro.
MandatoryMacroDescription
AZUREAPICUSTOMMODECustom mode api
AZURECLIENTIDClient ID
AZURECLIENTSECRETClient secret
AZURERESOURCEID or name of the Azure SQL Server resource
AZURERESOURCEGROUPResource group name if resource name is used
AZURESUBSCRIPTIONSubscription ID
AZURETENANTTenant ID

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine) and test the plugin by running the following command:

/usr/lib/centreon/plugins//centreon_azure_database_sqlserver_api.pl \
    --plugin=cloud::azure::database::sqlserver::plugin \
    --mode=server-status \
    --resource='SQLSRV001ABCD' \
    --resource-group='RSG1234' \
    --custommode='api' \
    --subscription='xxxxxxxxx' \
    --tenant='xxxxxxxxx' \
    --client-id='xxxxxxxxx' \
    --client-secret='xxxxxxxxx' \
    --proxyurl='' \
    --location='' \
    --filter-name='' \
    --warning-status='' \
    --critical-status='%{state} ne "Ready"' \

The expected command output is shown below:

OK: Server 'SQLSRV001ABCD' State: '%s' [FQDN:'%s'] |

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins//centreon_azure_database_sqlserver_api.pl \
    --plugin=cloud::azure::database::sqlserver::plugin \
    --mode=server-status \
    --help

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins//centreon_azure_database_sqlserver_api.pl \
    --plugin=cloud::azure::database::sqlserver::plugin \
    --list-mode

Troubleshooting​

Please find the troubleshooting documentation for the API-based plugins in this chapter.