Aller au contenu principal

Azure Functions

Vue d'ensemble​

Azure Functions est une plateforme serverless qui permet d'écrire et de déployer rapidement du code réagissant aux événements survenant dans les services Azure ou tiers.

Le Plugin-Pack Centreon Azure Functions s'appuie sur les API Azure Monitor afin de récuperer les métriques relatives au service Functions. 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 Functions

Règles de découverte​

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

image

La découverte Azure Functions 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
appservice.connections.countThe number of bound sockets existing in the sandboxCount
appservice.assemblies.current.countThe current number of assemblies loaded across all AppDomains in this applicationCount
appservice.handle.countThe total number of handles currently open by the app processCount
appservice.thread.countThe number of threads currently active in the app processCount
appservice.appdomains.countThe current number of AppDomains loaded in this applicationCount
appservice.appdomains.unloaded.countThe total number of AppDomains unloaded since the start of the applicationCount

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 Functions:
yum install centreon-plugin-Cloud-Azure-Compute-Functions-Api
  1. Sur l'interface Integration de Centreon, installer le Plugin-Pack Azure Functions 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-Compute-Functions-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 Functions 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_compute_functions_api.pl \
    --plugin=cloud::azure::compute::functions::plugin \
    --mode=cpu-time \
    --custommode=api \
    --subscription='xxxxxxxxx' \
    --tenant='xxxxxxxxx' \
    --client-id='xxxxxxxxx' \
    --client-secret='xxxxxxxxx' \
    --resource='APP01' \
    --resource-group='xxxxxxxxx' \
    --timeframe='900' \
    --interval='PT5M' \
    --aggregation='Total' \
    --warning-cpu-time='1' \
    --critical-cpu-time='2'

La commande devrait retourner un message de sortie similaire à:

OK: Instance 'APP01' Statistic 'total' Metrics CPU Time: 0.08s | 'APP01~total#appservice.cpu.consumed.seconds'=0.08s;;;0;

La commande ci-dessus vérifie le temps processeur consommé sur l'instance Functions nommée APP01 (--plugin=cloud::azure::compute::functions::plugin --mode=cpu-time --resource='APP01').

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 totales 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 le temps de processeur consommé pendant l'intervalle donné est supérieur à 1 (--warning-cpu-time='1'); l'alarme sera de type CRITICAL au-delà de 2 (--critical-cpu-time='2').

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_compute_functions_api.pl \
    --plugin=cloud::azure::compute::functions::plugin \
    --mode=cpu-time \
    --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.