windows_exporter

windows_exporter

Eksportir Prometheus untuk mesin Windows.

Kolektor

Nama	Keterangan	Diaktifkan secara default
iklan	Layanan Domain Direktori Aktif
ADC	Layanan Sertifikat Direktori Aktif
ADFS	Layanan Federasi Direktori Aktif
cache	Metrik cache
CPU	Penggunaan CPU	✓
cpu_info	Informasi CPU
CS	Metrik "Sistem Komputer" (Properti Sistem, NUM CPU/Total Memory)
wadah	Metrik kontainer
Diskdrive	Metrik Diskdrive
dfsr	Metrik DFSR
DHCP	Server DHCP
DNS	Server DNS
menukarkan	Metrik pertukaran
filetime	Metrik filetime
fsrmquota	Microsoft File Server Server Resource Manager (FSRM) KUTA COLLECTOR
hyperv	Host Hyper-V
IIS	Situs dan Aplikasi IIS
lisensi	Status Lisensi Windows
Logical_disk	Disk logis, disk I/O	✓
logon	Sesi Logon Pengguna
ingatan	Metrik Penggunaan Memori	✓
mscluster	Metrik MSCluster
MSMQ	Antrian MSMQ
mssql	Metrik Objek Kinerja SQL Server
Netframework	.NET Framework Metrics
bersih	Antarmuka jaringan I/O.	✓
os	OS Metrics (Memori, Proses, Pengguna)	✓
pagefile	metrik pagefile
Performancecounter	Metrik penghitung kinerja khusus
fisik_disk	Metrik Disk Fisik	✓
pencetak	Metrik printer
proses	Metrik per proses
remote_fx	Metrik Protokol Remotefx (RDP)
Terjadwal_task	Metrik Tugas Terjadwal
melayani	Metrik Negara Layanan	✓
SMB	Server SMB
SMBClient	Klien SMB
SMTP	IIS SMTP Server
sistem	Panggilan Sistem	✓
TCP	Koneksi TCP
terminal_services	Layanan Terminal (RDS)
TextFile	Baca metrik prometheus dari file teks
termalzone	Informasi termal
waktu	Layanan Waktu Windows
UDP	Koneksi UDP
memperbarui	Layanan Pembaruan Windows
vmware	Penghitung kinerja yang diinstal oleh agen tamu VMware

Lihat dokumentasi yang ditautkan pada masing -masing kolektor untuk informasi lebih lanjut tentang metrik yang dilaporkan, pengaturan konfigurasi dan contoh penggunaan.

Penyaringan kolektor yang diaktifkan

windows_exporter akan mengekspos semua metrik dari pengumpul yang diaktifkan secara default. Ini adalah cara yang disarankan untuk mengumpulkan metrik untuk menghindari kesalahan saat membandingkan metrik keluarga yang berbeda.

Untuk penggunaan lanjutan windows_exporter dapat dilewatkan daftar kolektor opsional untuk memfilter metrik. Parameter collect[] dapat digunakan beberapa kali. Dalam konfigurasi Prometheus, Anda dapat menggunakan sintaks ini di bawah Konfigurasi Scrape.

  params:
    collect[]:
      - foo
      - bar

Ini dapat berguna untuk memiliki server Prometheus yang berbeda mengumpulkan metrik spesifik dari node.

Bendera

Windows_Exporter menerima bendera untuk mengonfigurasi perilaku tertentu. Yang mengkonfigurasi perilaku global eksportir tercantum di bawah ini, sedangkan yang spesifik kolektor didokumentasikan dalam dokumentasi kolektor masing-masing di atas.

Bendera	Keterangan	Nilai default
--web.listen-address	Host: Port untuk Eksportir.	:9182
--telemetry.path	Jalur URL untuk memunculkan metrik yang dikumpulkan.	/metrics
--telemetry.max-requests	Jumlah maksimum permintaan bersamaan. 0 untuk menonaktifkan.	5
--collectors.enabled	Daftar kolektor yang dipisahkan secara koma untuk digunakan. Gunakan [defaults] sebagai placeholder yang diperluas berisi semua kolektor yang diaktifkan secara default. "	[defaults]
--collectors.print	Jika benar, cetak kolektor dan keluar yang tersedia.
--scrape.timeout-margin	Detik untuk mengurangi dari batas waktu yang diizinkan oleh klien. Tune untuk memungkinkan muatan overhead atau tinggi.	0.5
--web.config.file	Konfigurasi web untuk mengatur TLS dan auth	Tidak ada
--config.file	Menggunakan file konfigurasi dari path atau url	Tidak ada
--config.file.insecure-skip-verify	Lewati TLS saat memuat file konfigurasi dari URL	PALSU
--log.file	File output pesan log. Salah satu [stdout, stderr, eventlog, <path to log file>] Catatan: Pemasang MSI akan menambahkan argumen default ke pengaturan layanan yang diinstal ini ke EventLog	Stderr

Instalasi

Rilis terbaru dapat diunduh dari halaman rilis.

Setiap rilis menyediakan penginstal .msi. Penginstal akan mengatur Windows_Exporter sebagai layanan Windows, serta membuat pengecualian di firewall Windows.

Jika penginstal dijalankan tanpa parameter apa pun, eksportir akan berjalan dengan pengaturan default untuk kolektor, port, dll.

Penginstal menyediakan file konfigurasi untuk menyesuaikan eksportir.

File konfigurasi

• terletak di direktori yang sama dengan eksportir yang dapat dieksekusi.
• memiliki format YAML dan dilengkapi dengan parameter --config.file .
• Dapat digunakan untuk mengaktifkan atau menonaktifkan kolektor, mengatur parameter spesifik kolektor, dan mengatur parameter global.

Parameter berikut tersedia:

Nama	Keterangan
ENABLED_COLLECTORS	Sebagai --collectors.enabled bendera yang dapat diaktifkan, berikan daftar kolektor yang diaktifkan secara koma
CONFIG_FILE	Gunakan flag --config.file untuk menentukan file konfigurasi. Jika kosong, tidak ada file konfigurasi yang akan diatur. config.yaml Nilai Khusus.YAML Mengatur jalur ke config.yaml di Install Dir
LISTEN_ADDR	Alamat IP untuk mengikat. Default ke string kosong. (Alamat lokal apa pun)
LISTEN_PORT	Port untuk mengikat. Default ke 9182 .
METRICS_PATH	Jalan untuk melayani metrik. Default ke /metrics
TEXTFILE_DIRS	Gunakan bendera --collector.textfile.directories untuk menentukan satu atau lebih direktori, dipisahkan oleh koma, di mana kolektor harus membaca file teks yang berisi metrik
REMOTE_ADDR	Mengizinkan Pengaturan Alamat IP jarak jauh yang terpisah untuk pengecualian Windows Firewall (Izinkan Daftar). Default ke string kosong (alamat jarak jauh apa pun).
EXTRA_FLAGS	Memungkinkan melewati bendera CLI penuh. Default ke string kosong. Untuk --collectors.enabled dan --config.file , gunakan properti khusus ENABLED_COLLECTORS dan CONFIG_FILE
ADDLOCAL	Mengaktifkan fitur dalam pemasang Windows_Exporter. Nilai yang Didukung: FirewallException
REMOVE	Menonaktifkan fitur dalam pemasang Windows_Exporter. Nilai yang Didukung: FirewallException

Parameter dikirim ke penginstal melalui msiexec . Pada PowerShell, --% harus dilewati sebelum mendefinisikan properti.

Contoh doa:

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

Contoh pengumpul layanan dengan kueri khusus.

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

Tentukan file konfigurasi.

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

Pada beberapa versi Windows yang lebih lama, Anda mungkin perlu mengelilingi nilai parameter dengan kutipan ganda untuk mendapatkan perintah instalasi yang dikurangi dengan benar:

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

Untuk menginstal eksportir dengan membuat pengecualian firewall, gunakan perintah berikut:

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

Versi PowerShell 7.3 dan di atas membutuhkan psnativeCommandargumentpassing untuk diatur ke Legacy saat menggunakan --% EXTRA_FLAGS :

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

Implementasi Docker

Windows_Exporter dapat dijalankan sebagai wadah Docker. Gambar Docker tersedia di

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

Tag

Gambar Docker ditandai dengan versi eksportir. Tag latest juga tersedia dan menunjuk untuk rilis terbaru.

Selain itu, rasa hostprocess dengan -hostprocess sebagai akhiran didasarkan pada https://github.com/microsoft/windows-host-process-containers-base-image yang dirancang untuk berjalan sebagai wadah proses host Windows. Ukuran gambar itu lebih kecil dari yang default.

Implementasi Kubernetes

Lihat langkah -langkah terperinci untuk menginstal di Windows Kubernetes di sini.

Versi yang didukung

windows_exporter mendukung Windows Server Version 2016 dan yang lebih baru, dan desktop Windows versi 10 dan 11 (21h2 atau lebih baru).

Windows Server 2012 dan 2012r2 didukung hanya sebagai upaya terbaik, tetapi tidak dijamin akan berhasil.

Penggunaan

 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

Metrik Prometheus akan diekspos pada localhost: 9182

Http titik akhir

Windows_Exporter menyediakan titik akhir HTTP berikut:

• /metrics : Mengekspos metrik dalam format teks Prometheus.
• /health : Pengembalian 200 OK saat eksportir berjalan.
• /debug/pprof/ : Mengekspos titik akhir PPROF. Hanya, jika --debug.enabled diatur.

Contoh

Aktifkan hanya pengumpul layanan dan tentukan kueri khusus

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

Aktifkan hanya kolektor proses dan tentukan kueri khusus

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

Ketika ada beberapa proses dengan nama yang sama, WMI mewakili mereka setelah instance pertama sebagai process-name#index . Jadi untuk mendapatkan semuanya, bukan hanya yang pertama, ekspresi reguler harus digunakan .+ . Lihat proses untuk informasi lebih lanjut.

Menggunakan [default] dengan --collectors.enabled argumen

Menggunakan [defaults] dengan --collectors.enabled Argumen yang dapat diaktifkan yang diperluas dengan semua kolektor default.

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

Ini memungkinkan proses tambahan dan pengumpul kontainer di atas default.

Menggunakan file konfigurasi

File konfigurasi YAML dapat ditentukan dengan flag --config.file . mis .windows_exporter.exe --config.file=config.yml . Jika Anda menggunakan jalur absolut, pastikan untuk mengutip path, mis .windows_exporter.exe --config.file="C:Program Fileswindows_exporterconfig.yml"

Dimungkinkan juga untuk memuat konfigurasi dari URL. mis .windows_exporter.exe --config.file="https://example.com/config.yml"

Jika Anda perlu melewatkan verifikasi TLS, Anda dapat menggunakan bendera --config.file.insecure-skip-verify . mis .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

Contoh file konfigurasi dapat ditemukan di sini.

Catatan File Konfigurasi

Nilai file konfigurasi dapat dicampur dengan bendera CLI. MISALNYA

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

 log :
  level : debug

Bendera CLI menikmati prioritas yang lebih tinggi daripada nilai yang ditentukan dalam file konfigurasi.

Lisensi

Di bawah MIT