Office365-Generic : superviser son abonnement Office 365 via les API

Prérequis

Avant de pouvoir superviser un abonnement Office 365, il est nécessaire de mettre en place les prérequis décrits dans la documentation : Prérequis pour la supervision Azure et Office365.

Que peut-on superviser ?

Le portail web d’Office 365 met à disposition des rapports concernant l’usage des différents services disponibles.

Ces rapports sont visibles dans le Centre d’Administration Office 365 dans l’onglet « Rapports » –> « Utilisation »

Voici les services qui fournissent des rapports sur leur utilisation.

    • Exchange
    • Microsoft Team
    • Office 365
    • OneDrive
    • SharePoint
    • Skype Entreprise
    • Yammer

Documentation complète de l’API : https://docs.microsoft.com/en-us/graph/api/resources/report?view=graph-rest-1.0.

Comment récupérer ces métriques ?


Nous avons identifié deux types de données.

Données d’utilisation globale d’un service

En général, ce sont les métriques visibles sur les graphiques.

Exemple sur OneDrive :
Nombre de fichiers par type d’activité.

Exemple sur Exchange :
Nombre d’actions par type.

On peut retrouver ces deux exemples au niveau de la documentation des API Microsoft Graph :

La réponse de l’API contient bien les mêmes informations que sur le graphique de l’interface web :

Pour OneDrive, on retrouve les champs : Affichage ou Modification, Synchronisé, Partagé en interne, Partagé en externe.

Données d’utilisation d’un service par utilisateur

Ce sont les métriques présentes dans les tableaux sous les graphiques.
Elles donnent des informations d’utilisation du service pour chaque utilisateur.

Exemple sur OneDrive :
Nombre de fichiers par type d’activité pour chaque utilisateur.

Il y a une ligne par utilisateur.

Au niveau de l’API, sur le site Microsoft pour cet exemple : https://docs.microsoft.com/en-us/graph/api/reportroot-getonedriveactivityuserdetail?view=graph-rest-1.0&tabs=cs

La réponse de l’API contient le champ « User Principal Name », signe qu’il y aura une ligne par utilisateur.

On retrouve les champs présents dans le tableau visible sur l’interface web.

Quel plugin utiliser ?

Disponible depuis la version 4.1, ServiceNav propose le modèle de service Office365-Generic permettant de collecter les données d’utilisation globale d’un service.

La supervision des données d’utilisation d’un service par utilisateur sera possible dans un modèle de service disponible dans une prochaine version.

Comment utiliser le modèle Office365-Generic

Comme mentionné plus haut, le modèle de service Office365-Generic permet de superviser uniquement les données d’utilisation globale d’un service.
Comment déterminer si une métrique est disponible via ce plugin ou pas ?

Pour se faire, deux moyens à disposition :

  1. Si les informations sont visibles depuis le portail web sur un graphique, alors elles peuvent être collectées par le plugin Office365-Generic.
    Exemple pour l’activation des licences Office365 :
  2. Se rendre sur la documentation des API Microsoft Graph. Sélectionner le service et la métrique à superviser.
    Par exemple, le nombre d’activations des licences Office365 :

    Si dans la réponse il n’y a pas le champ « User Principal Name » alors la supervision est possible avec le modèle de service Office365-Generic.

Une fois assurés que la métrique est compatible avec le plugin, nous pouvons passer au paramétrage du point de contrôle.

Paramétrage du point de contrôle

Le point de contrôle se veut le plus générique possible pour récupérer le maximum d’informations. Il faudra donc le paramétrer selon le besoin.

Dans l’exemple suivant, nous allons superviser le stockage global utilisé du service OneDrive.

Voici les paramètres du point de contrôle :

 

  • Paramètre « Requête API » : requête que le plugin utilisera pour récolter la métrique. Ce fragment de requête est présent en titre sur la documentation de chaque métrique Office 365 :

  • Paramètre « Champs à traiter » : champ du CSV que retourne l’API à prendre en compte. Chaque service Office 365 à ses propres champs CSV visibles sur la documentation.
    Dans notre exemple, 5 champs sont disponibles :

Il est possible de renseigner plusieurs champs séparés par le symbole pipe « | » dans le cas où le plugin doit faire un calcul. Les valeurs seront rangées dans des variables $VAR1, $VAR2, $VAR3, etc…selon l’ordre défini dans le paramètre.

  • Paramètre « Calcul » : calcul à effectuer sur la ou les valeur(s) récupérée(s). Possible de faire un calcul pour changer l’unité.
    Dans notre exemple la valeur est en Octets, elle est transformée en Téraoctets grâce au calcul « $VAR1/1024**4 ».
    A noter : l’opérateur « Puissance » s’écrit : **.
    Il est possible d’effectuer des calculs entre différentes valeurs issues des différents champs du paramètre « Champs à traiter ». Exemple : $VAR2*100/$VAR1
  • Paramètre « Données de performances » : nom de la donnée de performance pour les graphiques de métriques.
  • Paramètre « Sortie texte » : Texte affiché dans l’interface web de ServiceNav. La variable $RESULT contient la valeur récupérée par le plugin ou le résultat du calcul effectué dans le paramètre « Calcul ».

Résultat sur ServiceNav :

Affichage des informations grâce à Dataviz.

Consultant sur le produit ServiceNav, très curieux de découvrir de nouvelles technologies et de nouveaux équipements pour pouvoir les intégrer à la supervision. J’ai à cœur de mener à bien nos projets et de trouver des solutions pour parfaire l’expérience de nos clients.