Office365 OneDrive
Vue d'ensemble
La suite Microsoft Office 365 comprend Onedrive, un service d'hébergement et de synchronisation de fichiers.
Les informations de supervision de la suite Office sont mises à disposition par Microsoft au travers d'une API de gestion Office 365.
Les données mises à disposition par l'API de gestion Office 365 ne sont pas en temps réel et sont basées sur une période de 7 jours
Contenu du Plugin-Pack
Objets supervisés
- Utilisation de Onedrive
Métriques collectées
Plus d'informations sur les métriques collectées sur la documentation officielle de Microsoft : https://docs.microsoft.com/fr-fr/microsoft-365/admin/activity-reports/onedrive-for-business-usage?view=o365-worldwide
- Site-Usage
| Metric name | Description | Unit |
|---|---|---|
| onedrive.sites.active.count | Number of active sites | Count |
| onedrive.sites.active.usage.total.bytes | Total usage space (active sites) | Bytes |
| onedrive.sites.inactive.usage.total.bytes | Total usage space (inactive sites) | Bytes |
| onedrive.sites.active.files.total.count | Total number of files (active sites) | Count |
| onedrive.sites.inactive.files.total.count | Total number of files (inactive sites ) | Count |
| onedrive.sites.files.active.total.count | Total number of active files | Count |
Une fois l'hôte crée, les macros de services peuvent être configurées pour filtrer les métriques par utilisateurs ou par boites mail. Plus d'informations dans la section Configuration.
Prérequis
Si vous n'avez pas encore créé votre compte sous Office 365, reportez-vous à la documentation d'Office 365 Management ou suivez le lien dans la partie 'Aide supplémentaire'.
Enregistrez une application
Les API de gestion Office 365 utilisent Azure AD pour assurer l’authentification sécurisée des données dans Office 365. Pour accéder aux API de gestion Office 365, vous devez enregistrer votre application dans Azure AD. Le terme Application est utilisé comme concept, faisant référence non seulement au programme d’application, mais également à son inscription Azure AD et à son rôle lors des « dialogues » d’authentification/autorisation au moment de l’exécution. (https://docs.microsoft.com/fr-fr/azure/active-directory/develop/app-objects-and-service-principals)
Spécifiez les autorisations dont votre application a besoin pour accéder aux API de gestion Office 365
Afin de récupérer les données d'Onedrive Online, vous devez spécifier les autorisations que votre application requiert: dans le Portail de gestion Azure :
- Microsoft Graph :
- Reports.Read.All (Type : Application)
- User.Read (Type : Delegated)
- Office365 Management APIs :
- ServiceHealth.Read (Type : Application)
- ActivityFeed.Read (Type : Application)
Aide supplémentaire
Suivez le guide pratique pour obtenir une explication complète sur la façon d’enregistrer une demande et d’obtenir un ID client et un ID secret : https://docs.microsoft.com/fr-fr/office/office-365-management-api/get-started-with-office-365-management-apis
Installation
Pack de supervision
Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le pack dans le menu Configuration > Plugin Packs > Gestionnaire.
Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquet associé à sa distribution :
- Alma / RHEL / Oracle Linux 8
- CentOS 7
- Debian 11
dnf install centreon-pack-cloud-microsoft-office365-onedrive
yum install centreon-pack-cloud-microsoft-office365-onedrive
apt install centreon-pack-cloud-microsoft-office365-onedrive
Quel que soit le type de la licence (online ou offline), installez le Pack Office365 OneDrive depuis l'interface web et le menu Configuration > Plugin Packs > Gestionnaire.
Plugin
À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un pack. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.
Plus d'informations dans la section Installer le plugin.
Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :
- Alma / RHEL / Oracle Linux 8
- CentOS 7
- Debian 11
dnf install centreon-plugin-Cloud-Microsoft-Office365-Onedrive-Api
yum install centreon-plugin-Cloud-Microsoft-Office365-Onedrive-Api
apt install centreon-plugin-cloud-microsoft-office365-onedrive-api
Configuration
Lors de la création de votre Hôte dans Centreon, choisissez le modèle Cloud-Microsoft-Office365-Onedrive-Api-custom. Une fois celui-ci appliqué, certaines Macros liées à l'Hôte doivent être renseignées :
| Mandatory | Name | Description |
|---|---|---|
| X | OFFICE365CUSTOMMODE | Access mode for the Plugin (default: 'graphapi') |
| X | OFFICE365TENANT | Tenant-id of your Office365 organization |
| X | OFFICE365CLIENTID | Client-id of your registered application |
| X | OFFICE365CLIENTSECRET | Secret-if of your registered application |
| OFFICE365EXTRAOPTIONS | Any extra option you may want to add to the command (eg. a --verbose flag) |
La métrique perfdate enrengistre la date à laquelle celle-ci a été collectée.
Vous pouvez la filter en paramétrant la macro OFFICE365EXTRAOPTIONS avec
l'option --filter-perfdata='^(?!.*perfdate).*$'
Une fois l'hôte créé, il est également possible de paramétrer un ensemble de macros de service selon la configuration souhaitée :
| Mandatory | Name | Description |
|---|---|---|
| FILTERURL | Filter specific sites by URLs | |
| FILTEROWNER | Filter file by specific owners | |
| FILTERCOUNTER | Filter specific counters (default:'active-sites|total') |
FAQ
Comment tester le Plugin Office 365 Onedrive en ligne de commande et que signifient les options principales ?
Une fois le Plugin installé, vous pouvez tester directement celui-ci en ligne de commande depuis votre collecteur Centreon avec l'utilisateur centreon-engine :
/usr/lib/centreon/plugins//centreon_office365_onedrive_api.pl \
--plugin=cloud::microsoft::office365::onedrive::plugin \
--mode=site-usage \
--tenant='abcd1234-5678-90ab-cd12-34567890abcd' \
--client-id='9876dcba-5432-10dc-ba98-76543210dcba' \
--client-secret='8/RON4vUGhAcg6DRmSxc4AwgxSRoNfKg4d8xNizIMnwg='
Résultat attendu :
OK: Active sites on 2020-09-27 : 3/1031 (0.29%) - Total Usage (active sites)
893.84 MB, Usage (inactive sites): 149.03 GB, File Count (active sites): 154,
File Count (inactive sites): 26643, Active File Count (active sites): 5 |
'active_sites'=3sites;;;0;1031
'total_usage_active'=937260440B;;;0;
'total_usage_inactive'=160024822615B;;;0;
'total_file_count_active'=154;;;0;
'total_file_count_inactive'=26643;;;0;
'total_active_file_count'=5;;;0;
Les options des différents modes sont consultables via le paramètre --help
du mode :
/usr/lib/centreon/plugins//centreon_office365_onedrive_api.pl \
--plugin=cloud::microsoft::office365::onedrive::plugin \
--mode=site-usage \
--custommode='graphapi'\
--help
Tous les modes disponibles dans le Plugin peuvent être listés via la commande suivante :
/usr/lib/centreon/plugins//centreon_office365_onedrive_api.pl \
--plugin=cloud::microsoft::office365::onedrive::plugin \
--list-mode
Le Plugin renvoie les erreurs suivantes :
UNKNOWN: 500 Can't connect to ...:443
Cette erreur signifie que le Plugin Centreon n'a pas pu se connecter à l'API de
gestion Office 365. Vérifiez que la requête n'a pas bloquée par un outil externe
(un pare-feu par exemple). Si vous utilisez un proxy, renseignez son URL dans
les macros EXTRAOPTIONS des services correspondants ou directement dans la
commande avec l'option --proxyurl.
UNKNOWN: 501 Protocol scheme 'connect' is not supported |
Dans certains cas, et plus spécifiquement lors de l'usage d'un proxy d'entreprise, le protocole de connexion n'est pas supporté par la libraire lwp utlisée par défaut par le Plugin Centreon.
Cette erreur peut être résolue en utilisant le backend HTTP curl.
Pour ce faire, ajoutez l'option --http-backend='curl' à la commande.