windows_exporter

Windows_exporter

Ein Prometheus -Exporteur für Windows -Maschinen.

Sammler

Name	Beschreibung	Standardmäßig aktiviert
Anzeige	Active Directory Domain Services
ADCs	Active Directory -Zertifikatsdienste
adfs	Active Directory Federation Services
Cache	Cache -Metriken
CPU	CPU -Verwendung	✓
cpu_info	CPU -Informationen
CS	Metriken "Computersystem" (Systemeigenschaften, Num -CPUs/Gesamtspeicher)
Container	Containermetriken
Diskdrive	Diskdrive -Metriken
DFSR	DFSR -Metriken
DHCP	DHCP -Server
DNS	DNS -Server
Austausch	Metriken austauschen
Filetime	Filetime Metriken
fsrmquota	Microsoft File Server Resource Manager (FSRM) Quotas Collector
Hyperv	Hyper-V-Hosts
iis	IIS -Websites und -anwendungen
Lizenz	Windows -Lizenzstatus
logical_disk	Logische Festplatten, Festplatten I/O	✓
Anmeldung	Benutzeranmeldesitzungen
Erinnerung	Speicherverbrauchsmetriken	✓
mscluster	MSCLUSTER -Metriken
MSMQ	MSMQ -Warteschlangen
MSSQL	SQL Server Performance -Objekte Metriken
NetFramework	.NET Framework Metriken
netto	Netzwerkschnittstelle I/O	✓
Betriebssystem	Betriebssystemmetriken (Speicher, Prozesse, Benutzer)	✓
Pagefile	Pagefile -Metriken
Performancecounter	Benutzerdefinierte Leistungszählermetriken
Physic_disk	Metriken für physische Festplatten	✓
Drucker	Druckermetriken
Verfahren	Metriken pro Prozess
Remote_fx	RemoteFX -Protokoll (RDP) -Metriken
afuled_task	Geplante Aufgabenmetriken
Service	Service State Metriken	✓
SMB	SMB -Server
smbclient	SMB -Client
SMTP	IIS SMTP -Server
System	Systemaufrufe	✓
TCP	TCP -Verbindungen
terminal_services	Terminal Services (RDS)
Textdatei	Lesen Sie Prometheus -Metriken aus einer Textdatei
Thermalzone	Wärmeinformationen
Zeit	Windows Time Service
UDP	UDP -Verbindungen
aktualisieren	Windows Update -Dienst
VMware	Performance -Zähler, die vom VMware -Gastagenten installiert wurden

Weitere Informationen zu gemeldeten Metriken, Konfigurationseinstellungen und Verwendungsbeispielen finden Sie in der verknüpften Dokumentation in jedem Kollektor.

Filtering fähige Sammler

Der windows_exporter enthält standardmäßig alle Metriken von aktivierten Sammlern. Dies ist die empfohlene Möglichkeit, Metriken zu sammeln, um Fehler beim Vergleich von Metriken verschiedener Familien zu vermeiden.

Für erweiterte Verwendung kann der windows_exporter eine optionale Liste von Sammlern übergeben werden, um Metriken zu filtern. Der Parameter collect[] kann mehrmals verwendet werden. In der Prometheus -Konfiguration können Sie diese Syntax unter der Scape -Konfiguration verwenden.

  params:
    collect[]:
      - foo
      - bar

Dies kann nützlich sein, damit verschiedene Prometheus -Server bestimmte Metriken von Knoten sammeln.

Flaggen

Windows_exporter akzeptiert Flags, um bestimmte Verhaltensweisen zu konfigurieren. Diejenigen, die das globale Verhalten des Exporteers konfigurieren, sind unten aufgeführt, während die kollektorspezifischen in der jeweiligen Collector-Dokumentation oben dokumentiert sind.

Flagge	Beschreibung	Standardwert
--web.listen-address	Host: Port für den Exporteur.	:9182
--telemetry.path	URL -Pfad zum Auftauchen gesammelter Metriken.	/metrics
--telemetry.max-requests	Maximale Anzahl der gleichzeitigen Anfragen. 0 zu deaktivieren.	5
--collectors.enabled	Komma getrennte Liste der zu verwendenden Sammler. Verwenden Sie [defaults] als Platzhalter, der alle standardmäßigen Kollektoren erweitert werden. "	[defaults]
--collectors.print	Wenn wahr, drucken Sie die verfügbaren Sammler und beenden Sie.
--scrape.timeout-margin	Sekunden, um von der vom Kunden zugelassenen Zeitüberschreitung abzuziehen. Schalten Sie sich auf, um Overhead oder hohe Lasten zu ermöglichen.	0.5
--web.config.file	Eine Webkonfiguration zum Einrichten von TLS und Auth	Keiner
--config.file	Verwenden einer Konfigurationsdatei von Pfad oder URL	Keiner
--config.file.insecure-skip-verify	Überspringen Sie TLS beim Laden der Konfigurationsdatei aus der URL	FALSCH
--log.file	Datei mit Protokollnachrichten ausgeben. Einer von [StDout, Stderr, EventLog, <Pfad zur Protokolldatei>] Hinweis: Der MSI -Installationsprogramm fügt dem installierten Dienst ein Standardargument hinzu	Stderr

Installation

Die neueste Veröffentlichung kann von der Releases -Seite heruntergeladen werden.

Jede Version bietet ein .msi -Installationsprogramm. Der Installateur setzt den Windows_Exporter als Windows -Dienst ein und erstellt eine Ausnahme in der Windows -Firewall.

Wenn der Installationsprogramm ohne Parameter ausgeführt wird, wird der Exporteur mit Standardeinstellungen für aktivierte Sammler, Ports usw. ausgeführt.

Der Installationsprogramm bietet eine Konfigurationsdatei zum Anpassen des Exporteurs.

Die Konfigurationsdatei

• befindet sich im selben Verzeichnis wie die ausführbare Exporteurin.
• hat das YAML -Format und ist mit dem Parameter --config.file versehen.
• Kann verwendet werden, um Sammler zu aktivieren oder zu deaktivieren, kollektorspezifische Parameter festzulegen und globale Parameter festzulegen.

Die folgenden Parameter sind verfügbar:

Name	Beschreibung
ENABLED_COLLECTORS	Geben Sie als Flag --collectors.enabled eine von Kommas getrennte Liste aktivierter Sammler an
CONFIG_FILE	Verwenden Sie das Flag --config.file -Flag, um eine Konfigurationsdatei anzugeben. Wenn leer, wird keine Konfigurationsdatei festgelegt. Die Sonderwert config.yaml setzen den Pfad zur config.yaml bei Installation DIR
LISTEN_ADDR	Die IP -Adresse zu binden. Standardeinstellungen zu einer leeren Zeichenfolge. (jede lokale Adresse)
LISTEN_PORT	Der Port zu binden an. Standardeinstellungen zu 9182 .
METRICS_PATH	Der Weg, auf dem Metriken dienen. Standardeinstellungen zu /metrics
TEXTFILE_DIRS	Verwenden Sie das Flag --collector.textfile.directories , um ein oder mehrere Verzeichnisse anzugeben, die durch Kommas getrennt sind, wobei der Sammler Textdateien lesen sollte, die Metriken enthalten
REMOTE_ADDR	Ermöglicht das Einstellen von COMA -getrennten Remote -IP -Adressen für die Windows -Firewall -Ausnahme (Liste zulassen). Standardeinstellungen zu einer leeren Zeichenfolge (jede Remote -Adresse).
EXTRA_FLAGS	Ermöglicht das Übergeben der vollen CLI -Flags. Standardeinstellungen zu einer leeren Zeichenfolge. Verwenden Sie die spezialisierten Eigenschaften ENABLED_COLLECTORS und CONFIG_FILE für --collectors.enabled und --config.file
ADDLOCAL	Aktiviert Funktionen im Windows_Exporter -Installationsprogramm. Unterstützte Werte: FirewallException
REMOVE	Deaktiviert Funktionen im Windows_Exporter -Installationsprogramm. Unterstützte Werte: FirewallException

Parameter werden über msiexec an das Installationsprogramm gesendet. Bei PowerShell sollten das --% vor dem Definieren von Immobilien verabschiedet werden.

Beispielaufrufe:

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

Beispiel Service Collector mit einer benutzerdefinierten Abfrage.

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

Definieren Sie eine Konfigurationsdatei.

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

Bei einigen älteren Versionen von Windows müssen Sie möglicherweise Parameterwerte mit doppelten Zitaten umgeben, um den Installationsbefehl ordnungsgemäß zu analysieren:

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

Verwenden Sie den folgenden Befehl, um den Exporteur mit einer Firewall -Ausnahme zu installieren:

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

PowerShell -Versionen 7.3 und höher erfordern psnativecommandargumentpassing, um bei Verwendung --% EXTRA_FLAGS auf Legacy eingestellt zu werden:

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

Implementierung von Docker

Der Windows_Exporter kann als Docker -Container ausgeführt werden. Das Docker -Bild ist auf verfügbar

• Docker Hub: docker.io/prometheuscommunity/windows-exporter
• GitHub Container Registrierung: ghcr.io/prometheus-community/windows-exporter

Tags

Das Docker -Bild wird mit der Version des Exporteurs markiert. Das latest Tag ist ebenfalls verfügbar und zeigt auf die neueste Version.

Darüber hinaus basiert ein Flavor hostprocess mit -hostprocess als Suffix auf https://github.com/microsoft/windows-host-process-containers-base-image, die als Windows-Host-Prozesscontainer ausgeführt werden soll. Die Größe dieser Bilder ist kleiner als der Standard.

Kubernetes -Implementierung

Weitere Informationen finden Sie in Windows Kubernetes.

Unterstützte Versionen

windows_exporter unterstützt Windows Server -Versionen 2016 und später sowie Desktop Windows Version 10 und 11 (21H2 oder später).

Windows Server 2012 und 2012R2 werden nur als Best-Effort unterstützt, aber nicht garantiert.

Verwendung

 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

Die Prometheus -Metriken werden auf Localhost: 9182 freigelegt

HTTP -Endpunkte

Windows_exporter liefert die folgenden HTTP -Endpunkte:

• /metrics : Enthält Metriken im Prometheus -Textformat.
• /health : Gibt 200 OK zurück, wenn der Exporteur läuft.
• /debug/pprof/ : Enthält die PPROF -Endpunkte. Nur wenn --debug.enabled ist festgelegt.

Beispiele

Aktivieren Sie nur den Service Collector und geben Sie eine benutzerdefinierte Abfrage an

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

Aktivieren Sie nur den Prozesssammler und geben Sie eine benutzerdefinierte Abfrage an

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

Wenn es mehrere Prozesse mit demselben Namen gibt, repräsentiert WMI diejenigen nach der ersten Instanz als process-name#index . Um sie alle zu bekommen, anstatt nur der erste, muss der reguläre Ausdruck verwendet werden .+ . Weitere Informationen finden Sie unter Prozess.

Verwenden von [Standardeinstellungen] mit --collectors.enabled Argument

Verwenden von [defaults] mit --collectors.enabled Argument, das mit allen Standardsammlern erweitert wird.

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

Dies ermöglicht den zusätzlichen Prozess- und Containersammlern zusätzlich zu den Standardeinstellungen.

Verwenden einer Konfigurationsdatei

YAML -Konfigurationsdateien können mit dem Flag --config.file -Flag angegeben werden. .windows_exporter.exe --config.file=config.yml Wenn Sie den absoluten Pfad verwenden, zitieren Sie den Pfad, z .windows_exporter.exe --config.file="C:Program Fileswindows_exporterconfig.yml"

Es ist auch möglich, die Konfiguration aus einer URL zu laden. z .windows_exporter.exe --config.file="https://example.com/config.yml"

Wenn Sie die TLS-Überprüfung überspringen müssen, können Sie das Flag --config.file.insecure-skip-verify verwenden. z .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

Eine Beispielkonfigurationsdatei finden Sie hier.

Konfigurationsdateinotizen

Konfigurationsdateiwerte können mit CLI -Flags gemischt werden. Z.B

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

 log :
  level : debug

CLI -Flags haben eine höhere Priorität gegenüber den in der Konfigurationsdatei angegebenen Werten.

Lizenz

Unter MIT