Aller au contenu principal

Windows Telegraf Agent

Telegraf est un agent d'observabilité implémentant le protocole OpenTelemetry.

Ce connecteur de supervision est une preuve de concept, Centreon ne recommande pas sa mise en oeuvre en production. Il présente par ailleurs certaines limitations, telles que :

  • la nécessité de redémarrer l'agent pour prendre en compte des changements sur la configuration.
  • l'impossibilité de récupérer le message d'information lié au statut du service ou de l'hôte (limitation liée au protocole OpenTelemetry).

Vous pouvez consulter cette page pour plus d'informations sur ce que permet l'intégration avec Telegraf.

Contenu du pack​

Modèles​

Le connecteur de supervision Windows Telegraf Agent apporte un modèle d'hôte :

  • OS-Windows-Telegraf-Agent-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescription
NtpOS-Windows-Telegraf-Ntp-Agent-customContrôle la synchronisation avec un serveur NTP.
Pending-RebootOS-Windows-Telegraf-Pending-Reboot-Agent-customContrôle si Windows nécessite un redémarrage.
SessionsOS-Windows-Telegraf-Sessions-Agent-customContrôle le nombre de sessions actives.
UpdatesOS-Windows-Telegraf-Updates-Agent-customContrôle si des mises à jour sont en attente.

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte OS-Windows-Telegraf-Agent-custom est utilisé.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

MétriqueUnité
certificates.detected.countcount
certificate#certificate.expires.daysd

Prérequis​

Flux réseau​

Deux flux TCP doivent être ouverts depuis l'hôte supervisé vers le collecteur.

SourceDestinationProtocolePortObjet
Hôte superviséCollecteurTCP1443Obtention de la configuration de Telegraf.
Hôte superviséCollecteurTCP4317Envoi des données au format OpenTelemetry.

Prérequis système sur le collecteur​

Rappel: pour pouvoir utiliser l'agent Telegraf, vous devez utiliser un collecteur ayant au minimum la version 24.04.2 de centreon-engine. L'agent Telegraf devra se configurer via une requête HTTPS adressée à Centreon Engine.

  1. Pour cela il faut commencer par obtenir un certificat valide pour le collecteur, ou le générer, par exemple avec la commande ci-dessous :

Dans les prérequis suivants, remplacez ${HOSTNAME} par le FQDN du collecteur si la valeur de cette variable ne correspond pas. 

openssl req -new -subj "/CN=${HOSTNAME}" -addext "subjectAltName = DNS:${HOSTNAME}" -newkey rsa:2048 -sha256 -days 365 -nodes -x509 -keyout /etc/centreon-engine/conf-server.key -out /etc/centreon-engine/conf-server.crt
chown centreon-engine: /etc/centreon-engine/conf-*

L'option -days 365 limite la durée de validité du certificat à un an. Vous pouvez adapter celle-ci en fonction de vos préférences concernant la sécurité ou la maintenabilité.

  1. Puis indiquez à Engine les informations de connexion qu'il devra fournir à l'agent Telegraf afin qu'il puisse envoyer des informations à Engine.
cat > /etc/centreon-engine/otl_server.json <<EOF
{
    "otel_server": {
        "host": "0.0.0.0",
        "port": 4317,
        "encryption": true,
        "certificate_path": "/etc/centreon-engine/conf-server.crt",
        "key_path": "/etc/centreon-engine/conf-server.key"
    },
    "max_length_grpc_log": 0,
    "telegraf_conf_server": {
        "http_server" : {
            "port": 1443,
            "encryption": true,
            "certificate_path": "/etc/centreon-engine/conf-server.crt",
            "key_path": "/etc/centreon-engine/conf-server.key"
        },
        "engine_otel_endpoint": "${HOSTNAME}:4317",
        "check_interval":60
    }
}
EOF
chown centreon-engine: /etc/centreon-engine/otl_server.json

Configuration de Centreon Engine​

  1. Dans le menu Configuration > Collecteurs> Configuration de Centreon Engine, sous l'onglet Données, ajoutez une entrée dans les modules Broker à charger et inscrivez-y la directive /usr/lib64/centreon-engine/libopentelemetry.so /etc/centreon-engine/otl_server.json. Sauvegardez le formulaire.

  2. Exportez la configuration du collecteur en sélectionnant l'option Redémarrer.

Prérequis système sur l'hôte à superviser​

La procédure officielle d'installation de Telegraf se trouve ici mais voici ci-dessous les étapes nécessaires.

Installation de Telegraf​

  1. Téléchargez et désarchivez l'agent :
wget https://dl.influxdata.com/telegraf/releases/telegraf-1.30.1_windows_amd64.zip -UseBasicParsing -OutFile telegraf-1.30.1_windows_amd64.zip
Expand-Archive .\telegraf-1.30.1_windows_amd64.zip -DestinationPath 'C:\Program Files\InfluxData\telegraf\'
  1. Installez le service :
"C:\Program Files\InfluxData\telegraf\telegraf-1.30.3\telegraf.exe" --config https://<poller_ip_address>:1443/engine?host=<windows_server_name> --service install

Les éléments poller_ip_address et windows_server_name doivent être remplacés par l'adresse ou le FQDN du collecteur (en étant cohérent avec la valeur entrée plus haut dans le serveur de configuration d'Engine) et le nom de l'hôte sous lequel le serveur Windows sera connu de Centreon.

Téléchargement de centreon_plugins.exe​

Téléchargez le plugin centreon_plugins.exe de la release la plus récente disponible ici et déposez-le au même emplacement que l'agent Telegraf (soit "C:\Program Files\InfluxData\telegraf\telegraf-1.30.3\") si la procédure a été suivie à la lettre.

Import du certificat du poller​

  1. Ouvrez Edge.
  2. Saisissez https://poller_ip_address:1443 dans la barre d'URL.
  3. Acceptez le certificat. Normalement le navigateur affiche No host service found from get parameters.
  4. Cliquez sur le certificat à gauche de la barre d'URL.
  5. Allez dans Détails.
  6. Exportez le certificat.
  7. Ouvrez l'explorateur de fichiers.
  8. Faites un clic droit sur le certificat depuis l'emplacement où il a été téléchargé.
  9. Installez le certificat.
  10. Sélectionnez Ordinateur local puis Suivant.
  11. Sélectionnez Placer tous les certificats dans le magasin suivant puis Parcourir.
  12. Sélectionnez Autorités de certification racines de confiance puis OK.
  13. Cliquez sur Suivant puis sur Terminer.

Installer le connecteur de supervision​

Pack​

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Gestionnaire de connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-operatingsystems-windows-telegraf-agent

  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Windows Telegraf Agent depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

  2. Créez le connecteur suivant :

Dans le menu Configuration > Commandes > Connecteurs, cliquez sur Ajouter puis saisissez les champs suivants :

ParamètreValeur
Nom du connecteurTelegraf Agent
Description du connecteurTelegraf Agent
Ligne de commandeopentelemetry --processor=nagios_telegraf --extractor=attributes --host_path=resourceMetrics.scopeMetrics.metrics.dataPoints.attributes.host --service_path=resourceMetrics.scopeMetrics.metrics.dataPoints.attributes.service
Utilisé par la commandeSelectionner toutes les commandes dont le nom correspond à OS-Windows-Telegraf-Agent-*
Statut du connecteurActivé

Plugin​

Ce connecteur de supervision s'appuie sur une intégration prise en charge par Centreon Engine et ne requiert pas de plugin.

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
  3. Appliquez le modèle d'hôte OS-Windows-Telegraf-Agent-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
MacroDescriptionValeur par défautObligatoire
SYSTEMLANGUAGELanguage installed on the Windows system (default: 'en')en
TELEGRAFPLUGINSPath where the centreon_plugins.exe plugin can be found./Program\\ Files/InfluxData/telegraf/telegraf-1.30.3X

  1. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

  2. Redémarrez le service Telegraf Data Collector Service sur le serveur Windows. Les statuts de l'hôte et des services se mettront à jour dans les minutes qui suivront.

Utiliser un modèle de service issu du connecteur​

  1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
  2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
MacroDescriptionValeur par défautObligatoire
FILTERSUBJECTFilter certificate by subject (can be a regexp).
FILTERTHUMBPRINTFilter certificate by thumbprint (can be a regexp).
FILTERPATHFilter certificate by path (can be a regexp).
THRESHOLDSUNITSelect the time unit for the expiration thresholds. May be 's' for seconds,'m' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds.d
WARNINGCERTIFICATEEXPIRESThresholds.60:
CRITICALCERTIFICATEEXPIRESThresholds.30:
WARNINGCERTIFICATESDETECTEDThresholds.
CRITICALCERTIFICATESDETECTEDThresholds.
EXTRAOPTIONSAny extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici
  1. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Vous pouvez tester que le plugin parvient bien à superviser votre serveur Windows en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

"\Program Files\InfluxData\telegraf\telegraf-1.30.3\centreon_plugins.exe" --plugin os::windows::local::plugin --mode sessions --language='fr' --timeout='30' --use-new-perfdata

NB : Cette commande ne peut pas s'exécuter sur les collecteurs, il faut la lancer directement sur le serveur Windows.

La commande devrait retourner un message de sortie similaire à :

OK: Sessions created: 0, disconnected: 0, reconnected : 0, current active : 1, current disconnected : 1 | 'sessions.created.total.count'=0;;;0; 'sessions.disconnected.total.count'=0;;;0; 'sessions.reconnected.total.count'=0;;;0; 'sessions.active.current.count'=1;;;0; 'sessions.disconnected.current.count'=1;;;0;

Modes disponibles​

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Le plugin apporte les modes suivants :

ModeModèle de service associé
certificates [code]OS-Windows-Telegraf-Certificates-Agent-custom
pending-reboot [code]OS-Windows-Telegraf-Pending-Reboot-Agent-custom
sessions [code]OS-Windows-Telegraf-Sessions-Agent-custom
time [code]OS-Windows-Telegraf-Ntp-Agent-custom
updates [code]OS-Windows-Telegraf-Updates-Agent-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Eg: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Eg: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata=free,used,invert() Convert storage free perfdata into used: --change-perfdata=used,free,invert() Scale traffic values automatically: --change-perfdata=traffic,,scale(auto) Scale traffic values in Mbps: --change-perfdata=traffic_in,,scale(Mbps),mbps Change traffic values in percent: --change-perfdata=traffic_in,,percent()
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Eg: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'.

Options des modes​

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

OptionDescription
--filter-thumbprintFilter certificate by thumbprint (can be a regexp).
--filter-subjectFilter certificate by subject (can be a regexp).
--filter-pathFilter certificate by path (can be a regexp).
--unitSelect the time unit for the expiration thresholds. May be 's' for seconds,'m' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds.
--warning-certificates-detectedThresholds.
--critical-certificates-detectedThresholds.
--warning-certificate-expiresThresholds.
--critical-certificate-expiresThresholds.
--no-psDon't encode powershell. To be used with --command and 'type' command.
--commandCommand to get information (default: 'powershell.exe'). Can be changed if you have output in a file. To be used with --no-ps option!!!
--command-pathCommand path (default: none).
--command-optionsCommand options (default: '-InputFormat none -NoLogo -EncodedCommand').
--ps-displayDisplay powershell script.
--ps-exec-onlyPrint powershell output.

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

"\Program Files\InfluxData\telegraf\telegraf-1.30.3\centreon_plugins.exe" --plugin=os::windows::local::plugin --mode=certificates --help