Aller au contenu principal

Azure SQL Managed Instance

Vue d'ensemble​

Azure SQL Managed Instance est un service facilitant la migration d'applications locales vers un environment sécurisé cloud PaaS avec les avantages correspondants à savoir les correctifs et mises à jour de versions automatiques, les sauvegardes automatisées et une service de haute disponibilité.

Le Plugin-Pack Centreon Azure SQL Managed Instance s'appuie sur les API Azure Monitor afin de récuperer les métriques relatives au service SQL Managed Instance. Il est possible d'utiliser les 2 modes proposés par Microsoft: RestAPI ou Azure CLI.

Contenu du Plugin-Pack​

Objets supervisés​

  • Instances Azure SQL Managed Instance

Règles de découverte​

Le Plugin-Pack Centreon Azure SQL Managed Instance inclut un provider de découverte d'Hôtes nommé Microsoft Azure SQL Managed Instance. Celui-ci permet de découvrir l'ensemble des instances SQL Managed Instance rattachés à une souscription Microsoft Azure donnée:

image

La découverte Azure SQL Managed Instance n'est compatible qu'avec le mode 'api'. Le mode 'azcli' n'est pas supporté dans le cadre de cette utilisation.

Vous trouverez plus d'informations sur la découverte d'Hôtes et son fonctionnement sur la documentation du module: Découverte des hôtes

Métriques & statuts collectés​

Metric NameDescriptionUnit
sqlmanagedinstance.cpu.utilization.percentageAverage CPU percentage%
sqlmanagedinstance.cpu.virtualcores.countVirtual core countCount

Prérequis​

Deux moyens sont disponibles pour interroger les API Microsoft Azure.

Centreon préconise l'utilisation de la méthode API plutôt que la CLI, cette dernière étant significativement moins performante. L'API permet également une authentification Application et ne nécessite pas de compte de service dédié.

Pour le custom-mode 'api', récupérez les informations en suivant la procédure ci-dessous (en anglais) et notez celles-ci en lieu sûr. Elles seront en effet indispensables lors de la configuration des ressources dans Centreon.

  • Create an application in Azure Active Directory:

    • Log in to your Azure account.
    • Select Azure Active directory in the left sidebar.
    • Click on App registrations.
    • Click on + Add.
    • Enter Centreon as the application name (or any name of your choice), select application type(api) and sign-on-url.
    • Click on the Create button.

  • Get Subscription ID

    • Log in to your Azure account.
    • Select Subscriptions in the left sidebar.
    • Select whichever subscription is needed.
    • Click on Overview.
    • Copy the Subscription ID.

  • Get Tenant ID

    • Log in to your Azure account.
    • Select Azure Active directory in the left sidebar.
    • Click on Properties.
    • Copy the directory ID.

  • Get Client ID

    • Log in to your Azure account.
    • Select Azure Active directory in the left sidebar.
    • Click on Enterprise applications.
    • Click on All applications.
    • Select the application previously created.
    • Click on Properties.
    • Copy the Application ID.

  • Get Client secret

    • Log in to your Azure account.
    • Select Azure Active directory in the left sidebar.
    • Click on App registrations.
    • Select the application previously created.
    • Click on All settings.
    • Click on Keys.
    • Enter the key description and select the duration.
    • Click on Save.
    • Copy and store the key value. You won't be able to retrieve it after you leave this page.

Installation​

  1. Installer le Plugin sur tous les collecteurs Centreon devant superviser des resources Azure SQL Managed Instance:
yum install centreon-plugin-Cloud-Azure-Database-SqlManagedInstance-Api
  1. Sur l'interface Integration de Centreon, installer le Plugin-Pack Azure SQL Managed Instance depuis la page "Configuration > Plugin packs > Manager"

Configuration​

Hôte​

  • Ajoutez un Hôte à Centreon, remplissez le champ Adresse IP/DNS avec l'adresse 127.0.0.1 et appliquez-lui le Modèle d'Hôte Cloud-Azure-Database-SqlManagedInstance-custom.
  • Une fois le modèle appliqué, les Macros ci-dessous indiquées comme requises (Mandatory) doivent être renseignées selon le custom-mode utilisé:
MandatoryNomDescription
XAZURECUSTOMMODECustom mode 'api'
XAZURESUBSCRIPTIONSubscription ID
XAZURETENANTTenant ID
XAZURECLIENTIDClient ID
XAZURECLIENTSECRETClient secret
XAZURERESOURCEId of the SQL Managed Instance instance

FAQ​

Comment puis-je tester le Plugin et que signifient les options des commandes ?​

Une fois le Plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine:

/usr/lib/centreon/plugins/centreon_azure_database_sqlmanagedinstance_api.pl \
    --plugin=cloud::azure::database::sqlmanagedinstance::plugin \
    --mode=cpu \
    --custommode=api \
    --subscription='xxxxxxxxx' \
    --tenant='xxxxxxxxx' \
    --client-id='xxxxxxxxx' \
    --client-secret='xxxxxxxxx' \
    --resource='SQL01' \
    --resource-group='xxxxxxxxx' \
    --timeframe='900' \
    --interval='PT5M' \
    --aggregation='Average' \
    --warning-cpu-average='80' \
    --critical-cpu-average='90'

La commande devrait retourner un message de sortie similaire à:

OK: Instance 'SQL01' Statistic 'average' Metrics Average CPU percentage: 55.00, Virtual core count: 2 | 'SQL01~average#qlmanagedinstance.cpu.utilization.percentage'=55.00%;0:80;0:90;0; 'SQL01~average#sqlmanagedinstance.cpu.virtualcores.count'=2;;;0;

La commande ci-dessus vérifie l'utilisation CPU de l'instance SQL Managed Instance nommée SQL01 (--plugin=cloud::azure::database::sqlmanagedinstance::plugin --mode=cpu --resource='SQL01').

Le mode de connexion utilisé est 'api' (--custommode=api), les paramètres d'authentification nécessaires à l'utilisation de ce mode sont donc renseignés en fonction (--subscription='xxxxxxxxx' --tenant='xxxxxxx' --client-id='xxxxxxxx' --client-secret='xxxxxxxxxx').

Les statuts caculés se baseront sur les valeurs moyenne d'un échantillon dans un intervalle de 15 minutes / 900 secondes (--timeframe='900') avec un état retourné par tranche de 5 minutes (--interval='PT5M').

Dans cet exemple, une alarme de type WARNING sera déclenchée si l'utilisation CPU pendant l'intervalle donné est supérieure à 80% de la capacité de l'instance (--warning-cpu-average='80'); l'alarme sera de type CRITICAL au-delà de 90% d'utilisation (--critical-cpu-average='90').

La liste de toutes les options complémentaires et leur signification peut être affichée en ajoutant le paramètre --help à la commande:

/usr/lib/centreon/plugins/centreon_azure_database_sqlmanagedinstance_api.pl \
    --plugin=cloud::azure::database::sqlmanagedinstance::plugin \
    --mode=cpu \
    --help

Diagnostic des erreurs communes​

Les identifiants ont changé et mon Plugin ne fonctionne plus​

Le Plugin utilise un fichier de cache pour conserver les informations de connexion afin de ne pas se ré-authentifier à chaque appel. Si des informations sur le Tenant, la Souscription ou les Client ID / Secret changent, il est nécessaire de supprimer le fichier de cache du Plugin.

Celui ci se trouve dans le répertoire /var/lib/centreon/centplugins/ avec le nom azureapi<md5>_<md5>_<md5>_<md5>.

UNKNOWN: Login endpoint API returns error code 'ERROR_NAME' (add --debug option for detailed message)​

Lors du déploiement de mes contrôles, j'obtiens le message suivant : UNKNOWN: Login endpoint API returns error code 'ERROR_NAME' (add --debug option for detailed message).

Cela signifie que l'un des paramètres utilisés pour authentifier la requête est incorrect. Le paramètre en question est spécifié dans le message d'erreur en lieu et place de 'ERROR_DESC'.

Par exemple, 'invalid_client' signifie que le client-id et/ou le client-secret n'est (ne sont) pas valide(s).

UNKNOWN: 500 Can't connect to login.microsoftonline.com:443​

Si l'utilisation d'un proxy est requise pour les connexions HTTP depuis le collecteur Centreon, il est nécessaire de le préciser dans la commande en utilisant l'option --proxyurl='http://proxy.mycompany.com:8080'.

Il est également possible qu'un équipement tiers de type Pare-feu bloque la requête effectuée par le Plugin.

UNKNOWN: No metrics. Check your options or use --zeroed option to set 0 on undefined values​

Lors du déploiement de mes contrôles, j'obtiens le message suivant 'UNKNOWN: No metrics. Check your options or use --zeroed option to set 0 on undefined values'.

Cela signifie qu'Azure n'a pas consolidé de données sur la période.

Vous pouvez ajouter --zeroed à la macro EXTRAOPTIONS du service en question afin de forcer le stockage d'un 0 et ainsi éviter un statut UNKNOWN.