Windows Centreon Monitoring Agent
Pour le moment, ce connecteur de supervision est en version BETA.
Vous pouvez consulter cette page pour plus d'informations sur ce que permet Centreon Monitoring Agent.
Contenu du pack​
Modèles​
Le connecteur de supervision Windows Centreon Monitoring Agent apporte un modèle d'hôte :
- OS-Windows-Centreon-Monitoring-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) :
- OS-Windows-Centreon-Monitoring-Agent-custom
- Non rattachés à un modèle d'hôte
Alias | Modèle de service | Description |
---|---|---|
Ntp | OS-Windows-Ntp-Centreon-Monitoring-Agent-custom | Contrôle la synchronisation avec un serveur NTP. |
Pending-Reboot | OS-Windows-Pending-Reboot-Centreon-Monitoring-Agent-custom | Contrôle si Windows nécessite un redémarrage. |
Sessions | OS-Windows-Sessions-Centreon-Monitoring-Agent-custom | Contrôle le nombre de sessions actives. |
Updates | OS-Windows-Updates-Centreon-Monitoring-Agent-custom | Contrô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-Centreon-Monitoring-Agent-custom est utilisé.
Alias | Modèle de service | Description |
---|---|---|
Certificates | OS-Windows-Certificates-Centreon-Monitoring-Agent-custom | Contrôle les certificats locaux. |
Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, créez un service manuellement et appliquez le modèle de service souhaité.
Métriques & statuts collectés​
Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.
- Certificates
- Ntp
- Pending-Reboot
- Sessions
- Updates
Métrique | Unité |
---|---|
certificates.detected.count | count |
certificate#certificate.expires.days | d |
Métrique | Unité |
---|---|
offset | s |
Pas de métrique pour ce service.
Métrique | Unité |
---|---|
sessions.created.total.count | count |
sessions.disconnected.total.count | count |
sessions.reconnected.total.count | count |
sessions.active.current.count | count |
sessions.disconnected.current.count | count |
Pour obtenir ce nouveau format de métrique, incluez la valeur --use-new-perfdata dans la macro de service EXTRAOPTIONS.
Métrique | Unité |
---|---|
windows.pending.updates.count | count |
Prérequis​
Flux réseau​
Un flux TCP doit être ouvert depuis l'hôte supervisé vers le collecteur.
Source | Destination | Protocole | Port | Objet |
---|---|---|---|---|
Hôte supervisé | Collecteur | TCP | 4317 | Obtention de la configuration et envoi des données au format OpenTelemetry. |
Prérequis système sur le collecteur​
Rappel: pour pouvoir utiliser l'agent Centreon Monitoring Agent, vous devez utiliser un collecteur ayant au minimum la version
24.09.0
pour les utilisateurs de Centreon Cloud, et la version24.04.6
ou24.10.0
pour les utilisateurs On Prem decentreon-engine
. L'agent devra se configurer en se connectant à Centreon Engine.
Configuration de Centreon Engine​
Référez-vous à cette page pour la procédure de configuration de centreon-engine.
Prérequis système sur l'hôte à superviser​
L'installateur de Centreon Monitoring Agent pour Windows peut se télécharger à partir des pages de release du projet centreon-collect.
Installation de Centreon Monitoring Agent​
La procédure d'installation et de configuration de Centreon Monitoring Agent pour Windows est détaillée dans la documentation dédiée à ce sujet.
Installer le connecteur de supervision​
Pack​
- 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 :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-pack-operatingsystems-windows-centreon-monitoring-agent
dnf install centreon-pack-operatingsystems-windows-centreon-monitoring-agent
apt install centreon-pack-operatingsystems-windows-centreon-monitoring-agent
Aucune version de Centreon Engine supportée sur CentOS 7 n'est compatible avec Centreon Monitoring Agent.
Quel que soit le type de la licence (online ou offline), installez le connecteur Windows Centreon Monitoring Agent depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.
Créez le connecteur suivant :
Dans le menu Configuration > Commandes > Connecteurs, cliquez sur Ajouter puis saisissez les champs suivants :
Paramètre | Valeur |
---|---|
Nom du connecteur | Centreon Monitoring Agent |
Description du connecteur | Centreon Monitoring Agent |
Ligne de commande | opentelemetry --processor=centreon_agent --extractor=attributes --host_path=resource_metrics.resource.attributes.host.name --service_path=resource_metrics.resource.attributes.service.name |
Utilisé par la commande | Selectionner toutes les commandes dont le nom correspond à OS-Windows-Centreon-Monitoring-Agent-* |
Statut du connecteur | Activé |
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​
- Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
- Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
- Appliquez le modèle d'hôte OS-Windows-Centreon-Monitoring-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.
- Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
SYSTEMLANGUAGE | Language installed on the Windows system. | en | |
CENTREONAGENTPLUGINS | Path where the centreon_plugins.exe plugin can be found. | C:/Program Files/Centreon/Plugins | X |
- 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.
Utiliser un modèle de service issu du connecteur​
- 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.
- 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.
- Certificates
- Ntp
- Pending-Reboot
- Sessions
- Updates
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
FILTERSUBJECT | Filter certificate by subject (can be a regexp). | ||
FILTERTHUMBPRINT | Filter certificate by thumbprint (can be a regexp). | ||
FILTERPATH | Filter certificate by path (can be a regexp). | ||
THRESHOLDSUNIT | Select 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 | |
WARNINGCERTIFICATEEXPIRES | Thresholds. | 60: | |
CRITICALCERTIFICATEEXPIRES | Thresholds. | 30: | |
WARNINGCERTIFICATESDETECTED | Thresholds. | ||
CRITICALCERTIFICATESDETECTED | Thresholds. | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
NTPHOSTNAME | Set the NTP server to use (if not set, we try to find it with w32tm command). | ||
NTPPORT | Set the NTP port (default: 123). | ||
WARNINGOFFSET | Thresholds. | -1:1 | |
CRITICALOFFSET | Thresholds. | -2:2 | |
TIMEOUT | Set timeout time for 'w32tm' command execution (default: 30 sec). | 10 | |
EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{RebootPending}, %{WindowsUpdate}, %{CBServicing}, %{CCMClientSDK}, %{PendFileRename}, %{PendComputerRename} | %{RebootPending} =~ /true/i | |
CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (Default: ''). You can use the following variables: %{RebootPending}, %{WindowsUpdate}, %{CBServicing}, %{CCMClientSDK}, %{PendFileRename}, %{PendComputerRename} | ||
TIMEOUT | Set timeout time for command execution | 10 | |
EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
FILTERSESSIONNAME | Filter session name (can be a regexp). | ||
CONFIG | The command can be localized by using a configuration file. This parameter can be used to specify an alternative location for the configuration file | ||
WARNINGSESSIONSACTIVE | Thresholds. | ||
CRITICALSESSIONSACTIVE | Thresholds. | ||
WARNINGSESSIONSCREATED | Thresholds. | ||
CRITICALSESSIONSCREATED | Thresholds. | ||
WARNINGSESSIONSDISCONNECTED | Thresholds. | ||
CRITICALSESSIONSDISCONNECTED | Thresholds. | ||
WARNINGSESSIONSRECONNECTED | Thresholds. | ||
CRITICALSESSIONSRECONNECTED | Thresholds. | ||
WARNINGSESSIONSDISCONNECTEDCURRENT | Thresholds. | ||
CRITICALSESSIONSDISCONNECTEDCURRENT | Thresholds. | ||
TIMEOUT | Timeout in seconds for the command | 10 | |
EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
WARNINGPENDINGUPDATES | Thresholds | 1 | |
CRITICALPENDINGUPDATES | Thresholds | ||
TIMEOUT | Set timeout time for command execution. | 30 | |
EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici | --filter-mandatory |
- 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) :
"C:\Program Files\Centreon\Plugins\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 :
Mode | Modèle de service associé |
---|---|
certificates [code] | OS-Windows-Certificates-Centreon-Monitoring-Agent-custom |
pending-reboot [code] | OS-Windows-Pending-Reboot-Centreon-Monitoring-Agent-custom |
sessions [code] | OS-Windows-Sessions-Centreon-Monitoring-Agent-custom |
time [code] | OS-Windows-Ntp-Centreon-Monitoring-Agent-custom |
updates [code] | OS-Windows-Updates-Centreon-Monitoring-Agent-custom |
Options disponibles​
Options génériques​
Les options génériques sont listées ci-dessous :
Option | Description |
---|---|
--mode | Define the mode in which you want the plugin to be executed (see--list-mode). |
--dyn-mode | Specify a mode with the module's path (advanced). |
--list-mode | List all available modes. |
--mode-version | Check minimal version of mode. If not, unknown error. |
--version | Return the version of the plugin. |
--pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. |
--verbose | Display extended status information (long output). |
--debug | Display debug messages. |
--filter-perfdata | Filter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. |
--filter-perfdata-adv | Filter 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-max | Create 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-perfdata | Change 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-group | Add 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-output | Modify 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-exit | Replace 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-perfdata | Rewrite 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-uom | Mask the units when they don't match the given regular expression. |
--opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. |
--output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. |
--output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...' |
--output-xml | Return the output in XML format (to send to an XML API). |
--output-json | Return the output in JSON format (to send to a JSON API). |
--output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). |
--output-file | Write 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-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). |
--disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. |
--float-precision | Define the float precision for thresholds (default: 8). |
--source-encoding | Define 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 :
- Certificates
- Ntp
- Pending-Reboot
- Sessions
- Updates
Option | Description |
---|---|
--filter-thumbprint | Filter certificate by thumbprint (can be a regexp). |
--filter-subject | Filter certificate by subject (can be a regexp). |
--filter-path | Filter certificate by path (can be a regexp). |
--unit | Select 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-detected | Thresholds. |
--critical-certificates-detected | Thresholds. |
--warning-certificate-expires | Thresholds. |
--critical-certificate-expires | Thresholds. |
--no-ps | Don't encode powershell. To be used with --command and 'type' command. |
--command | Command to get information (default: 'powershell.exe'). Can be changed if you have output in a file. To be used with --no-ps option!!! |
--command-path | Command path (default: none). |
--command-options | Command options (default: '-InputFormat none -NoLogo -EncodedCommand'). |
--ps-display | Display powershell script. |
--ps-exec-only | Print powershell output. |
Option | Description |
---|---|
--warning | Warning threshold. |
--critical | Critical threshold. |
--ntp-hostname | Set the ntp hostname (if not set, we try to find it with w32tm command). |
--ntp-port | Set the ntp port (Default: 123). |
--timeout | Set timeout time for 'w32tm' command execution (Default: 30 sec) |
Option | Description |
---|---|
--timeout | Set timeout time for command execution (Default: 50 sec) |
--no-ps | Don't encode powershell. To be used with --command and 'type' command. |
--command | Command to get information (Default: 'powershell.exe'). Can be changed if you have output in a file. To be used with --no-ps option!!! |
--command-path | Command path (Default: none). |
--command-options | Command options (Default: '-InputFormat none -NoLogo -EncodedCommand'). |
--ps-display | Display powershell script. |
--ps-exec-only | Print powershell output. |
--warning-status | Define the conditions to match for the status to be WARNING (Default: '%{RebootPending} =~ /true/i'). You can use the following variables: %{RebootPending}, %{WindowsUpdate}, %{CBServicing}, %{CCMClientSDK}, %{PendFileRename}, %{PendComputerRename}. |
--critical-status | Define the conditions to match for the status to be CRITICAL (Default: ''). You can use the following variables: %{RebootPending}, %{WindowsUpdate}, %{CBServicing}, %{CCMClientSDK}, %{PendFileRename}, %{PendComputerRename}. |
Option | Description |
---|---|
--config | command can be localized by using a configuration file. This parameter can be used to specify an alternative location for the configuration file |
--language | Set the language used in config file (default: 'en'). |
--command | Command to get information (Default: 'qwinsta'). Can be changed if you have output in a file. |
--command-path | Command path (Default: none). |
--command-options | Command options (Default: '/COUNTER'). |
--timeout | Timeout in seconds for the command (Default: 30). |
--filter-sessionname | Filter session name (can be a regexp). |
--warning- --critical- | Thresholds. Can be: 'sessions-created', 'sessions-disconnected', 'sessions-reconnected', 'sessions-active', 'sessions-disconnected-current'. |
Option | Description |
---|---|
--timeout | Set timeout time for command execution (Default: 50 sec) |
--no-ps | Don't encode powershell. To be used with --command and 'type'command. |
--command | Command to get information (Default: 'powershell.exe'). Can be changed if you have output in a file. To be used with --no-ps option!!! |
--command-path | Command path (Default: none). |
--command-options | Command options (Default: '-InputFormat none -NoLogo -EncodedCommand'). |
--ps-display | Display powershell script. |
--ps-exec-only | Print powershell output. |
--filter-title | Filter windows updates by title (can be a regexp). |
--exclude-title | Exclude windows updates by title (regexp can be used). |
--display-updates | Display updates in verbose output. |
--warning- --critical- | Thresholds. Can be: 'pending-updates'. |
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 :
"C:\Program Files\Centreon\Plugins\centreon_plugins.exe" --plugin=os::windows::local::plugin --mode=certificates --help