windows_exporter

windows_exporter

Un exportateur de Prométhée pour les machines Windows.

Collectionneurs

Nom	Description	Activé par défaut
annonce	Services de domaine Active Directory
ADC	Services de certificat Active Directory
adfs	Services de la Fédération Active Directory
cache	Métriques de cache
processeur	Utilisation du processeur	✓
CPU_INFO	Informations CPU
CS	Métriques "Système informatique" (Propriétés du système, CPU NUM / Mémoire totale)
récipient	Métriques de conteneurs
disque de disque	Métriques disque
dfsr	Métriques DFSR
dhcp	Serveur DHCP
DNS	Serveur DNS
échange	Échange de mesures
temps file	Métriques en temps file
fsrmquota	Collecteur de quotas Microsoft File Server Resource Manager (FSRM)
hyperv	Hôtes Hyper-V
IIS	IIS Sites et applications
licence	État de la licence Windows
logical_disk	Disques logiques, E / S de disque	✓
se connecter	Sessions de connexion utilisateur
mémoire	Métriques d'utilisation de la mémoire	✓
mscluster	Métriques MSCluster
MSMQ	Files d'attente MSMQ
MSSQL	SQL Server Performance Objects Metrics
netframework	.NET Framework Metrics
filet	E / S d'interface réseau	✓
OS	Métriques du système d'exploitation (mémoire, processus, utilisateurs)	✓
page de page	Métriques de fichiers de page
performanceCounter	Métriques de comptoir de performance personnalisées
Physical_disk	Métriques de disque physique	✓
imprimante	Métriques d'imprimante
processus	Métriques par processus
Remote_fx	Métriques du protocole RemoteFX (RDP)
Scheduled_task	Tâches programmées Métriques
service	Métriques de l'État de service	✓
pME	Serveur SMB
SMBClient	Client SMB
smtp	Iis SMTP Server
système	Appels système	✓
TCP	Connexions TCP
terminal_services	Services de terminal (RDS)
fichier de texte	Lire les métriques de Prométhée à partir d'un fichier texte
thermalzone	Information thermique
temps	Service de temps Windows
UDP	Connexions UDP
mise à jour	Service de mise à jour Windows
vmware	Compteurs de performances installés par l'agent invité VMware

Consultez la documentation liée sur chaque collecteur pour plus d'informations sur les métriques, les paramètres de configuration et les exemples d'utilisation signalés.

Filtrage des collectionneurs activés

Le windows_exporter exposera toutes les mesures de collectionneurs activées par défaut. Il s'agit du moyen recommandé de collecter des mesures pour éviter les erreurs lors de la comparaison des mesures de différentes familles.

Pour une utilisation avancée, windows_exporter peut être passé, une liste facultative des collectionneurs pour filtrer les mesures. Le paramètre collect[] peut être utilisé plusieurs fois. Dans la configuration de Prométhée, vous pouvez utiliser cette syntaxe sous la configuration de scrasse.

  params:
    collect[]:
      - foo
      - bar

Cela peut être utile pour que différents serveurs Prometheus collectent des mesures spécifiques à partir de nœuds.

Drapeaux

Windows_Exporter accepte les drapeaux pour configurer certains comportements. Ceux qui configuraient le comportement global de l'exportateur sont répertoriés ci-dessous, tandis que ceux des collectionneurs sont documentés dans la documentation du collecteur respectif ci-dessus.

Drapeau	Description	Valeur par défaut
--web.listen-address	Hôte: port pour l'exportateur.	:9182
--telemetry.path	Chemin d'URL pour faire surface les mesures collectées.	/metrics
--telemetry.max-requests	Nombre maximum de demandes simultanées. 0 pour désactiver.	5
--collectors.enabled	Liste des collectionneurs séparée par des virgules à utiliser. Utilisez [defaults] comme espace réservé qui est élargi contenant tous les collectionneurs activés par défaut. "	[defaults]
--collectors.print	Si c'est vrai, imprimez les collectionneurs disponibles et sortez.
--scrape.timeout-margin	Quelques secondes à soustraire du délai d'attente autorisé par le client. Assurez-vous pour permettre des frais généraux ou des charges élevées.	0.5
--web.config.file	Une configuration Web pour configurer TLS et AUTH	Aucun
--config.file	Utilisation d'un fichier de configuration à partir du chemin ou de l'URL	Aucun
--config.file.insecure-skip-verify	Sauter TLS lors du chargement du fichier de configuration à partir de l'URL	FAUX
--log.file	Fichier de sortie des messages de journal. L'un des [stdout, stderr, eventlog, <path to journal fichier>] Remarque: Le programme d'installation MSI ajoutera un argument par défaut au service de service installé	stderr

Installation

La dernière version peut être téléchargée à partir de la page des versions.

Chaque version fournit un programme d'installation .msi. Le programme d'installation configurera le service Windows_Exporter en tant que Windows, ainsi que de créer une exception dans le pare-feu Windows.

Si l'installateur est exécuté sans aucun paramètre, l'exportateur s'exécutera avec des paramètres par défaut pour les collectionneurs activés, les ports, etc.

Le programme d'installation fournit un fichier de configuration pour personnaliser l'exportateur.

Le fichier de configuration

• est situé dans le même répertoire que l'exportateur exécutable.
• a le format YAML et est fourni avec le paramètre --config.file .
• Peut être utilisé pour activer ou désactiver les collecteurs, définir des paramètres spécifiques au collecteur et définir des paramètres globaux.

Les paramètres suivants sont disponibles:

Nom	Description
ENABLED_COLLECTORS	En tant que --collectors.enabled FALLE SÉCOURNÉE, fournissez une liste de collectionneurs activés par des virgules
CONFIG_FILE	Utilisez l'indicateur --config.file pour spécifier un fichier de configuration. Si vide, aucun fichier de configuration ne sera défini. La valeur spéciale config.yaml définissez le chemin d'accès sur la configuration.yaml à installer dir
LISTEN_ADDR	L'adresse IP pour se lier. Par défaut est une chaîne vide. (Toute adresse locale)
LISTEN_PORT	Le port pour se lier à. Par défaut à 9182 .
METRICS_PATH	Le chemin sur lequel servir les mesures. Par défaut en /metrics
TEXTFILE_DIRS	Utilisez l'indicateur --collector.textfile.directories pour spécifier un ou plusieurs répertoires, séparés par des virgules, où le collectionneur doit lire des fichiers texte contenant des mesures
REMOTE_ADDR	Permet de définir des adresses IP distantes séparées par les virgules pour l'exception du pare-feu Windows (Autoriser la liste). Par défaut est une chaîne vide (toute adresse distante).
EXTRA_FLAGS	Permet de passer des drapeaux CLI complets. Par défaut est une chaîne vide. Pour --collectors.enabled et --config.file , utilisez les propriétés spécialisées ENABLED_COLLECTORS et CONFIG_FILE
ADDLOCAL	Active les fonctionnalités du programme d'installation de Windows_Exporter. Valeurs prises en charge: FirewallException
REMOVE	Désactive les fonctionnalités de l'installateur Windows_Exporter. Valeurs prises en charge: FirewallException

Les paramètres sont envoyés au programme d'installation via msiexec . Sur PowerShell, le --% doit être passé avant de définir les propriétés.

Exemples d'invocations:

msiexec / i < path - to - msi - file > --% ENABLED_COLLECTORS=os,iis LISTEN_PORT=5000

Exemple de collecteur de services avec une requête personnalisée.

msiexec / i < path - to - msi - file > --% ENABLED_COLLECTORS=os,service EXTRA_FLAGS="--collectors.exchange.enabled=""ADAccessProcesses"""

Définir un fichier de configuration.

msiexec / i < path - to - msi - file > --% CONFIG_FILE="D:config.yaml"

Sur certaines anciennes versions de Windows, vous devrez peut-être entourer les valeurs des paramètres avec des devis doubles pour obtenir correctement la commande d'installation:

msiexec / i C:UsersAdministratorDownloadswindows_exporter.msi --% ENABLED_COLLECTORS="ad,iis,logon,memory,process,tcp,textfile,thermalzone" TEXTFILE_DIRS="C:custom_metrics"

Pour installer l'exportateur avec la création d'une exception de pare-feu, utilisez la commande suivante:

msiexec / i < path - to - msi - file > --% ADDLOCAL=FirewallException

Les versions PowerShell 7.3 et plus nécessitent PSNATIVECOMANDArgumentPassing pour être définie sur Legacy lors de l'utilisation --% EXTRA_FLAGS :

 $PSNativeCommandArgumentPassing = ' Legacy '
msiexec / i < path - to - msi - file > ENABLED_COLLECTORS = os , service --% EXTRA_FLAGS="--collectors.exchange.enabled=""ADAccessProcesses""" 

Implémentation de Docker

Le Windows_exporter peut être exécuté en tant que conteneur Docker. L'image Docker est disponible sur

• Docker Hub: docker.io/prometheuscommunity/windows-exporter
• Registre des conteneurs GitHub: ghcr.io/prometheus-community/windows-exporter

Balises

L'image Docker est taguée avec la version de l'exportateur. La latest balise est également disponible et indique la dernière version.

De plus, une saveur hostprocess avec -hostprocess en tant que suffixe est basée sur le https://github.com/microsoft/windows-host-process-ntoniners-base-image qui est conçue pour s'exécuter en tant que récipient de processus hôte Windows. La taille de ces images est plus petite que celle par défaut.

Implémentation de Kubernetes

Voir les étapes détaillées à installer sur Windows Kubernetes ici.

Versions prises en charge

windows_exporter prend en charge les versions Windows Server 2016 et ultérieurement, et le bureau Windows version 10 et 11 (21h2 ou version ultérieure).

Windows Server 2012 et 2012R2 sont pris en charge uniquement comme le meilleur effort, mais pas garantis pour fonctionner.

Usage

 go get -u github.com/prometheus/promu
go get -u github.com/prometheus-community/windows_exporter
cd $env:GOPATH/src/github.com/prometheus-community/windows_exporter
promu build -v
.windows_exporter.exe

Les métriques de Prométhée seront exposées sur LocalHost: 9182

Points de terminaison HTTP

Windows_Exporter fournit les points de terminaison HTTP suivants:

• /metrics : expose les mesures dans le format de texte Prometheus.
• /health : renvoie 200 ok lorsque l'exportateur est en cours d'exécution.
• /debug/pprof/ : expose les points de terminaison PPROF. Seulement, si --debug.enabled est défini.

Exemples

Activer uniquement le collecteur de services et spécifier une requête personnalisée

 .windows_exporter.exe --collectors.enabled "service" --collector.service.include="windows_exporter"

Activer uniquement le collecteur de processus et spécifier une requête personnalisée

 .windows_exporter.exe --collectors.enabled "process" --collector.process.include="firefox.+"

Lorsqu'il y a plusieurs processus avec le même nom, WMI représente ceux après la première instance en tant process-name#index . Donc, pour les obtenir tous, plutôt que le premier, l'expression régulière doit utiliser .+ . Voir le processus pour plus d'informations.

Utilisation de [par défaut] avec --collectors.enabled

Utilisation de [defaults] avec --collectors.enabled Argument qui se développe avec tous les collectionneurs par défaut.

 .windows_exporter.exe --collectors.enabled "[defaults],process,container"

Cela permet le processus supplémentaire et les collectionneurs de conteneurs en plus des défauts.

Utilisation d'un fichier de configuration

Les fichiers de configuration YAML peuvent être spécifiés avec l'indicateur --config.file . par exemple .windows_exporter.exe --config.file=config.yml . Si vous utilisez le chemin absolu, assurez-vous de citer le chemin, par exemple .windows_exporter.exe --config.file="C:Program Fileswindows_exporterconfig.yml"

Il est également possible de charger la configuration à partir d'une URL. par exemple .windows_exporter.exe --config.file="https://example.com/config.yml"

Si vous avez besoin de sauter la vérification TLS, vous pouvez utiliser l'indicateur --config.file.insecure-skip-verify . par exemple .windows_exporter.exe --config.file="https://example.com/config.yml" --config.file.insecure-skip-verify

 collectors :
  enabled : cpu,net,service
collector :
  service :
    include : windows_exporter
log :
  level : warn

Un exemple de fichier de configuration peut être trouvé ici.

Notes de fichiers de configuration

Les valeurs de fichiers de configuration peuvent être mélangées avec des drapeaux CLI. Par exemple

.windows_exporter.exe --collectors.enabled=cpu,logon

 log :
  level : debug

Les drapeaux CLI jouissent d'une priorité plus élevée sur les valeurs spécifiées dans le fichier de configuration.

Licence

Sous le mit