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 connecteur de supervision 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 connecteur de supervision​
Objets supervisés​
- Instances Azure Functions
Règles de découverte​
Le connecteur de supervision 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:
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​
- App-Usage
- Cpu-Time
- Data
- Executions
- File-System
- Gc-Usage
- Health
- Http-Requests
- IO-Operations
- Memory
- Response-Time
- Status
Metric Name | Description | Unit |
---|---|---|
appservice.connections.count | The number of bound sockets existing in the sandbox | Count |
appservice.assemblies.current.count | The current number of assemblies loaded across all AppDomains in this application | Count |
appservice.handle.count | The total number of handles currently open by the app process | Count |
appservice.thread.count | The number of threads currently active in the app process | Count |
appservice.appdomains.count | The current number of AppDomains loaded in this application | Count |
appservice.appdomains.unloaded.count | The total number of AppDomains unloaded since the start of the application | Count |
Metric Name | Description | Unit |
---|---|---|
appservice.cpu.consumed.seconds | The amount of CPU consumed by the app in seconds | s |
Metric Name | Description | Unit |
---|---|---|
appservice.data.in.bytes | The amount of incoming bandwidth consumed by the app | B |
appservice.data.out.bytes | The amount of outgoing bandwidth consumed by the app | B |
Metric Name | Description | Unit |
---|---|---|
functions.executions.count | The number of function exectution | Count |
functions.executions.units.count | The number of functon execution units | Count |
Metric Name | Description | Unit |
---|---|---|
appservice.filesystem.usage.bytes | Filesystem quota consumed by the app | B |
Metric Name | Description | Unit |
---|---|---|
appservice.gc.gen0.count | The number of times the generation 0 objects are garbage collected since the start of the app process | Count |
appservice.gc.gen1.count | The number of times the generation 1 objects are garbage collected since the start of the app process | Count |
appservice.gc.gen2.count | The number of times the generation 2 objects are garbage collected since the start of the app process | Count |
Status Name | Description |
---|---|
status | Current operational status |
summary | Last related status message |
Metric Name | Description | Unit |
---|---|---|
appservice.http.request.count | The total number of requests regardless of their resulting HTTP status code | Count |
appservice.http.request.queue.count | The number of requests in the application request queue | Count |
appservice.htpp.request.XXX.count | The count of requests resulting in an HTTP status code = XXX | Count |
Metric Name | Description | Unit |
---|---|---|
appservice.bytes.other.bytespersecond | The rate at which the app process is issuing bytes to I/O operations that don't involve data | B/s |
appservice.operations.other.bytespersecond | The rate at which the app process is issuing I/O operations that aren't read or write operations | B/s |
appservice.bytes.read.bytespersecond | The rate at which the app process is reading bytes from I/O operations | B/s |
appservice.operations.read.bytespersecond | The rate at which the app process is issuing read I/O operations | B/s |
appservice.bytes.write.bytespersecond | The rate at which the app process is writing bytes to I/O operations | B/s |
appservice.operations.write.bytespersecond | The rate at which the app process is issuing write I/O operations | B/s |
Metric Name | Description | Unit |
---|---|---|
appservice.memory.average.usage.bytes | The average amount of memory used by the app | B |
appservice.memory.usage.bytes | The current amount of memory used by the app | B |
Metric Name | Description | Unit |
---|---|---|
appservice.http.response.time.seconds | The time taken for the app to serve requests | s |
Metric Name | Description | Unit |
---|---|---|
appservice.status.count | Health check status | Count |
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é.
- Azure Monitor API
- Azure AZ CLI
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.
Afin d'utiliser le custom-mode 'azcli', installez le binaire associé sur tous les Collecteurs Centreon devant superviser des resources Azure:
- La CLI requiert une version de Python >= 2.7 (https://github.com/Azure/azure-cli/blob/dev/doc/install_linux_prerequisites.md)
Sur un système utilisant le packaging RPM, utilisez les commandes ci-dessous avec l'utilisateur root ou un utilisateur avec les droits 'sudo' adéquats:
sudo rpm --import https://packages.microsoft.com/keys/microsoft.asc
sudo echo -e "[azure-cli]\nname=Azure CLI\nbaseurl=https://packages.microsoft.com/yumrepos/azure-cli\nenabled=1\ngpgcheck=1\ngpgkey=https://packages.microsoft.com/keys/microsoft.asc" > /etc/yum.repos.d/azure-cli.repo
sudo yum install azure-cli
Ensuite, réalisez les opérations suivantes avec l'utilisateur centreon-engine afin de récupérer le token d'authentification Azure:
su - centreon-engine
az login
La commande retourne le message ci-dessous contenant un code:
*To sign in, use a web browser to open the page https://microsoft.com/devicelogin*
*and enter the code CWT4WQZAD to authenticate.*
Rendez-vous sur https://microsoft.com/devicelogin afin de saisir le code obtenu, puis connectez vous avec le compte de service dédié à la supervision.
Une fois ces actions effectuées, des informations d'auhtentification de la forme suivante devraient s'afficher dans le terminal du collecteur Centreon:
[
{
"cloudName": "AzureCloud",
"id": "0ef83f3a-d83e-2039-d930-309df93acd93d",
"isDefault": true,
"name": "N/A(tenant level account)",
"state": "Enabled",
"tenantId": "0ef83f3a-03cd-2039-d930-90fd39ecd048",
"user": {
"name": "email@mycompany.onmicrosoft.com",
"type": "user"
}
}
]
Vous avez désormais les informations stockées localement dans un fichier accessTokens.json qui sera utilisé automatiquement par le Plugin.
Installation​
- Online License
- Offline License
- Installer le Plugin sur tous les collecteurs Centreon devant superviser des resources Azure Functions:
yum install centreon-plugin-Cloud-Azure-Compute-Functions-Api
- Sur l'interface Integration de Centreon, installer le connecteur de supervision Azure Functions depuis la page Configuration > Gestionnaire de connecteurs de supervision
- Installer le Plugin sur tous les collecteurs Centreon devant superviser des resources Azure Functions:
yum install centreon-plugin-Cloud-Azure-Compute-Functions-Api
- Sur le serveur Central Centreon, installer le RPM du connecteur de supervision Azure Functions:
yum install centreon-pack-cloud-azure-compute-functions.noarch
- Sur l'interface Integration de Centreon, installer le connecteur de supervision Azure Functions depuis la page Configuration > Gestionnaire de connecteurs de supervision
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é:
- Azure Monitor API
- Azure AZ CLI
Mandatory | Nom | Description |
---|---|---|
X | AZURECUSTOMMODE | Custom mode 'api' |
X | AZURESUBSCRIPTION | Subscription ID |
X | AZURETENANT | Tenant ID |
X | AZURECLIENTID | Client ID |
X | AZURECLIENTSECRET | Client secret |
X | AZURERESOURCE | Id of the Functions instance |
Mandatory | Nom | Description |
---|---|---|
X | AZURECUSTOMMODE | Custom mode 'azcli' |
X | AZURESUBSCRIPTION | Subscription ID |
X | AZURERESOURCE | Id 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.