Edit

Google GSuite

Vue d'ensemble

GSuite est une suite d'outils et de logiciels de productivité de type Cloud computing et de groupware destinée aux professionnels, proposée par Google sous la forme d'un abonnement.

Le Plugin-Pack Centreon permet de récupérer le statut en temps réel de la disponibilité des applications composant cette suite, ceci par le biais du portail dédié mis à disposition par Google.

Contenu du Plugin-Pack

Objets supervisés

  • Applications: Gmail, Meet, Drive, etc...

La liste complète des applications prises en charge est disponible ici: https://workspace.google.fr/intl/en/features/

Règles de découvertes

Rule nameDescription
App-Google-Gsuite-Api--Application-NameDiscover GSuite applications and monitor their status

Métriques collectées

Metric nameDescription
google.apps.current.countNumber of applications currently monitored
statusstatus of the GSuite application

Prérequis

Le collecteur Centreon doit pouvoir joindre les serveurs Google (www.google.com) sur Internet sur le port TCP/443 (HTTPS). Il est possible de spécifier un proxy à utiliser le cas échéant.

Installation

  1. Installer le Plugin sur chaque collecteur Centreon devant superviser les applications Google GSuite:
yum install centreon-plugin-Applications-Google-Gsuite-Api
  1. Sur l'interface Web de Centreon, installer le Plugin-Pack Google GSuite depuis la page "Configuration > Plugin Packs > Gestionnaire"
  1. Installer le Plugin sur chaque collecteur Centreon devant superviser les applications Google GSuite:
yum install centreon-plugin-centreon-plugin-Applications-Google-Gsuite-Api
  1. Installer le RPM du Plugin-Pack sur le serveur Centreon Central:
yum install centreon-pack-applications-google-gsuite-api
  1. Sur l'interface Web de Centreon, installer le Plugin-Pack Google GSuite depuis la page "Configuration > Plugin Packs > Gestionnaire"

Configuration

  • Ajoutez un nouvel Hôte depuis la page "Configuration > Hôtes"
  • Complétez le champ "IP Address / DNS" en indiquant une IP localhost (par exemple 127.0.0.1)
  • Appliquez le Modèle d'Hôte App-Google-Gsuite-Api

Ce modèle d'Hôte est de type dummy afin de ne pas initier de commande de vérification (ping) vers Internet (ce type de requête étant souvent bloquée). l'Hôte ajouté renverra donc par défaut OK.

MandatoryNameDescription
XGOOGLEAPPSSTATUSHOSTNAMEIP or name of the Status server (Default: 'www.google.com')
XGOOGLEAPPSSTATUSPORTPort used to reach the Google server (Default: '443')
XGOOGLEAPPSSTATUSPROTOProtocol used to reach the Google server (Default: 'https')
XGOOGLEAPPSSTATUSLANGUAGELanguage for the Application names (Default: 'en')
PROXYURLConfigure a proxy URL to use if needed
EXTRAOPTIONSAny extra option you may want to add to every command_line (eg. a --verbose flag)
DUMMYSTATUSHost state. Default is OK, do not modify it unless you know what you are doing
DUMMYOUTPUTHost check output. Default is 'This is a dummy check'. Customize it with your own if needed

Par défaut, un Service de type "Global" sera déployé, supervisant l'ensemble des applications GSuite. Utilisez la fonctionnalité Service Discovery si vous souhaitez obtenir un Service par application.

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 un collecteur Centreon en vous connectant avec l'utilisateur centreon-engine:

/usr/lib/centreon/plugins/centreon_google_gsuite_api.pl \
    --plugin='apps::google::gsuite::plugin' \
    --mode=applications \
    --hostname='www.google.com' \
    --proto='https' \
    --port='443' \
    --proxyurl='http://myproxy.mycompany.org:8080' \
    --language='en' \
    --filter-app='gmail|drive|meet' \
    --warning-status='%{status} eq "DEGRADED"' \
    --critical-status='%{status} eq "UNAVALAIBLE"' \
    --verbose

La commande devrait retourner un message de sortie de la forme ci-dessous:

OK: 3 GApps - All Google Apps are ok | 'google.apps.current.count'=3;;;0;
Gmail (OK): '' (since '2020-10-10T10:00:00')
Google Drive (OK): '' (since '2020-10-10T10:00:00')
Google Meet (OK): '' (since '2020-10-10T10:00:00')

Dans cet exemple, le Plugin récupère les statuts des applications GSuite (--plugin='apps::google::gsuite::plugin' --mode=applications) depuis le site dédié (--hostname='www.google.com'). On choisit ci-desus de n'afficher que le statut des applications gmail, drive et meet (--filter-app='gmail|drive|meet').

Une alarme WARNING sera ainsi déclenchée si le statut d'une de ces applications est signalée comme dégradée (--warning-status='%{status} eq "DEGRADED"'); l'alarme sera de type CRITICAL pour une application inaccessible (--critical-status='%{status} eq "UNAVALAIBLE"').

Pour chaque mode, la liste de toutes les métriques, seuils associés et options complémentaires peut être affichée en ajoutant le paramètre --help à la commande:

/usr/lib/centreon/plugins/centreon_google_gsuite_api.pl \
--plugin='apps::google::gsuite::plugin' \
--mode=applications \
--help

J'obtiens le message d'erreur suivant: UNKNOWN: 500 Can't connect to www.google.com.443 |

Lors du déploiement de mes contrôles, j'obtiens le message suivant: UNKNOWN: 500 Can't connect to www.google.com.443 |.

Cela signifie que Centreon n'a pas réussi à se connecter à l'API du serveur Google.

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'.

← GithubHaproxy SNMP →