Quelltext der Seite Zabbix: VMware vSphere Leistungsdaten Performance Counter abfragen

<u>'''Changelog:'''</u>
* 05.06.2018: Erste Version
<br>
----
==Vorwort==
Es gibt Momente im Leben eines Administrators (Techniker, IT-Consultant usw.) die fühlen sich an wie eine Offenbarung, als ob sich eine große Tür vor einem öffnet und man viele neue Dinge sieht.<br>
So einen Moment hatte ich gerade und teile nun mein Wissen mit euch.<br>
Ich könnte es auch als "Jetzt wo ich weiß wie es geht, weiß ich auch wonach ich hätte suchen müssen".<br>
<br>
Bei einem Kunden soll ich diverse Leistungsdaten von virtuellen Maschinen mit Zabbix überwachen.<br>
Aber - für mich Premiere - ich darf den Zabbix Agenten nicht nutzen sondern die VMs nur von außen überwachen.<br>
Es gibt dazu ja schon fertige Templates in Zabbix und diverse eingebaute '''Item-Keys''', z.B.
 vmware.vm.cpu.num[<url>,<uuid>]
 vmware.vm.cpu.usage[<url>,<uuid>]
welche einem die Anzahl der konfigurierten CPU-Kerne und deren Auslastung in Hz zurückgeben.<br>
<br>
Und da war auch schon eines meiner Probleme. CPU-Last in Hz. Ok, das hatte ich bei den ESX-Hosts schon, dort hatte ich aber auch die Maximale-Hz Zahl so das man sich den Rest per '''Calculated Item''' selbst ausrechnen konnte.<br>
Direkt auf der VM habe ich diesen Wert nicht. Und da nicht alle Hosts in meinen Szenario gleich schnelle CPUs haben konnte ich auch keinen festen Wert nehmen.<br>
<br>
Besser wäre wenn man die CPU Last gleich in Prozent bekäme, das vCenter und der ESXi-Host zeigen mir schließlich diesen Wert in den Leistungsdiagrammen auch an.<br>
Und überhaupt, es sind ja nun nicht besonders viele Werte die Zabbix da sammelt, ist ein wenig dünn.<br>
<br>
'''Tja, das war heute mein Glücksmoment: Zabbix kann! CPU gleich in Prozent! Und noch mehr Leistungsdaten von Hypervisor, VM und CLuster liefern. Mit Bordmittel.'''<br>
<br>
<br>
----
==Voraussetzungen==
Nachfolgend wird das alles von Hand eingerichtet. Man könnte das auch in den entsprechenden Vorlagen mit Autodiscover von ESXi-Hosts und VMs machen.<br>
<br>
----
===Zabbix Server===
In der Konfigurationsdatei des Zabbix-Servers müssen '''VMwareCollectors''' gestartet werden:
 nano /etc/zabbix/zabbix_server.conf
und im Abschnitt
 ### Option: StartVMwareCollectors
 #       Number of pre-forked vmware collector instances.
 #
 # Mandatory: no
 # Range: 0-250
 # Default:
 StartVMwareCollectors=5
und mindestens einen '''VMwareCollector'' starten (hier sind es 5)<br>
<br>
Falls Ihr da etwas geändert habt muss der VMware-Server Dienst neu gestartet werden:<br>
 systemctl restart zabbix-server.service
<br>
----
===Makros / Macros===
Alle Templates und Items benötigen die folgenden Makros um Daten abzufragen:<br>
 {$URL}       : Pfad zum SDK des ESXi-Hosts oder des vCenters
                https://vcenter.meinedom.local/sdk
                https://12.34.56.78/sdk
 
 {$USERNAME}  : Benutzername der sich am ESXi-Hosts bzw. vCenter anmelden darf. Sollte zumindest alles lesen können
                root
                administrator@vsphere.local
                Spezieller Zabbix Benutzer
 
 {$PASSWORD}  : Das Passwort des vorstehenden Benutzers
Zusätzlich müsst Ihr bei allen Hypervisior / ESXi-Host die Ihr überwachen wollt folgende Makro hinterlegen:<br>
 {$UUID}      : Die UUID des ESXi-Hosts der abgefragt werden soll
                00000000-0000-0000-0000-000000000000
                12334567-1234-1234-1234-123456789012

Und bei allen VMs:<br>
 {$UUID_VM}   : Die UUID der VM die abgefragt werden soll
                12334567-1234-1234-1234-123456789012
Nachfolgend beschreibe ich woher Ihr die UUIDs bekommt.<br>
<br>
----
====UUID ESXi-Server====
<u>'''Variante 1: per SSH Zugriff auf den Hosts'''</u>
Wir melden uns per puTTY am ESXi an und nehmen einen oder alle der folgenden Befehle:<br>
 vim-cmd hostsvc/hosthardware | grep uuid
 grep uuid /etc/vmware/esx.conf
 esxcfg-info -y | grep "System UUID"
Die Ausgabe sieht wie folgt aus:<br>
 [root@ns3050687:~] vim-cmd hostsvc/hosthardware | grep uuid
       uuid = "00000000-0000-0000-0000-000000000000",
 [root@ns3050687:~] grep uuid /etc/vmware/esx.conf
 /system/uuid = "59f0eb9a-b44f-32bc-4b9f-0cc47acb91a0"
 [root@ns3050687:~] esxcfg-info -y | grep "System UUID"
    |----System UUID.................................................59f0eb9a-b44f-32bc-4b9f-0cc47acb91a0
Ja, die UUID kann auch schon mal nur aus Nullen bestehen. Meist wenn es keine richtige Server-Hardware ist. Im Zweifel ausprobieren.<br>
Wenn die Werte unterschiedlich sind - probiert es mit dem aus dem ersten Befehl zu erst - der ist es in der Regel (wenn die Hardware eine UUID bereit stellt)<br>
<br>
<u>'''Variante 2: per Webzugriff Zugriff auf den Hosts'''</u>
Dazu rufen wir im Browser
 https://<host>/mob/?moid=ha%2dhost&doPath=hardware%2esystemInfo
auf. Sehr wahrscheinlich bekommt Ihr da eine Fehlermeldung wie diese:<br>
:[[Datei:ClipCapIt-180605-155635.PNG]]<br>
Die kommt in der Regel ab vSphere 6.0. Abhilfe ist das MOB Plugin wieder zu aktivieren:<br>
:[[Datei:ClipCapIt-180605-160029.PNG]]<br>
oder per Browser im Host Client:<br>
:[[Datei:ClipCapIt-180605-160529.PNG]]<br>
Unmittelbar danach funktioniert es, er wird Benutzername (root) und Passwort abfragen und euch dann die Info anzeigen:<br>
:[[Datei:ClipCapIt-180605-160756.PNG]]<br>
Mein Testsystem hat halt nur Nullen, auf euren Profi-Systemen sollte da etwas eindeutiges stehen.
<br>
----

====UUID VM Virtuelle Maschine====
Die UUID einer VM bekommen wir am einfachsten im Client heraus:<br>
<u>'''vSphere Client (bis 6.0)'''</u><br>
Geht auf den Host auf den Reiter "Virtuelle Maschinen", rechte Maustaste auf die Zeile mit den Überschriften und den Haken bei '''UUID''' setzen:<br>
:[[Datei:ClipCapIt-180605-162236.PNG]]<br>
Danach habt die UUID der VMs in einer eigene Spalte aus der Ihr den Wert auch heraus kopieren könnt:<br>
:[[Datei:ClipCapIt-180605-162426.PNG]]<br>
{{Warnung|Wenn Ihr die Abfragen gegen ein vCenter und nicht direkt gegen einen ESXi-Hosts stellt ist dieser Wert der Falsche. Nutzt die PowerShell-Abfrage oder die LLD-Abfrage von Zabbix}}<br>
<br>
<br>
<u>'''VMware PowerCLI PowerShell'''</u><br>
Mit vCenter verbinden:<br>
<!-- Connect-VIServer ce-vcsa-01.corbox-engine.lan -->
 Connect-VIServer IP_oder_Name_vCenter
Und die 
 Get-VM NameDerVM | Get-View | Select-Object -ExpandProperty Config | ForEach-Object { $_.InstanceUuid }
Der benötigte Wert ist die '''''InstanceUuid''''' (gibt der Einzeiler direkt aus), über diese könnt Ihr das vCenter nach der VM fragen.<br>
<br>
Falls Ihr die PowerShell gegen den ESXi nutzt (ohne vCenter so wollt Ihr die UUID:<br>
 Get-VM NameDerVM | Get-View | Select-Object -ExpandProperty Config | ForEach-Object { $_.Uuid }
<u>'''per Browser: (ab 6.5)'''</u><br>
habe ich noch keine Möglichkeit gefunden.<br>
<br>
----

==Abfragen von VM Daten==
Ihr legt die VM als Host an. Auf diesen sollten dann folgende Makros gelten:<br>
:[[Datei:ClipCapIt-180605-165210.PNG]]<br>
<br>
===Grundlagen===
Das Item was wir nutzen ist dieses:<br>
 vmware.vm.perfcounter[{$URL},{$UUID_VM},<path>,<instance>]
 {$URL}      : Die URL zu /sdk des vCenters oder des ESXi-Hosts 
 {$UUID_VM}  : Die eindeutige ID der VM
 <path>      : Pfad zum gewünschten Messwert, genaueres folgt in diesem Text
 <instance>  : Manche Messwerte benötigen genauere Angaben, zum Beispiel bei Festplatten welche
Siehe auch https://www.zabbix.com/documentation/3.0/manual/config/items/itemtypes/simple_checks/vmware_keys
Für unsere Zwecke rufen wir dieses wie folgt auf: (zum kopieren)<br>
 vmware.vm.perfcounter[{$URL},{$UUID_VM},"Pfad/Counter[Parameter]"]
Um zum Beispiel die CPU-Auslastung der VM in Prozent zu erhalten verwenden wir folgenden Key:<br>
 vmware.vm.perfcounter[{$URL},{$UUID_VM},"cpu/usage[average]"]
Als fertiges Item sieht es so aus:<br>
:[[Datei:ClipCapIt-180605-165915.PNG]]<br>
Wenn Ihr eines fertig und funktionierend habt könnt Ihr ja klonen.<br>
Beachtet das die CPU-Last durch 100 geteilt wird - das ist nur hier so weil der Wert angepasst werden muss.<br>
<br>
Der Aufbau ist also immer gleich - entscheidend ist der Pfad/Counter[Parameter].<br>
Die findet Ihr alle hier:<br>
 https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.PerformanceManager.html
gleich im oberen Abschnitt gibt es Links zu den einzelnen Bereichen:<br>
:[[Datei:ClipCapIt-180605-170258.PNG]]<br>
Auf den Unterseiten, z.B. CPU sind dann die einzelnen Counter beschrieben:<br>
:[[Datei:ClipCapIt-180605-170431.PNG]]<br>
Nutzen könnt Ihr alle Counter bei denen in der Spalte '''ENTITY''' auch '''VirtualMachine''' aufgeführt ist.<br>
Wenn Ihr diese Einträge nutzt müsst Ihr diese wie folgt im Item-Key eintragen:<br>
 cpu/usage[average]
 
 cpu       : Pfad, cpu weil die Daten von der Seite CPU stammen
 usage     : Ist der Wert aus der ersten Spalte '''COUNTER'''
 [average] : Ist einer der möglichen Wert aus der Spalte '''ROLLUPTYPE''' welxhe für diesen Counter angegeben wurde

Leider musste ich etwas probieren um die richtigen Namen für die Pfade zu Ermitteln, hier meine bisherigen Ergebnisse:<br>
 CPU Counters          = cpu
 Memory Counters       = mem
 Virtual Disk Counters = virtualDisk
 Disk I/O Counters     = disk
 System                = sys
<br>
----

===Fertige Abfragen===
<u>'''CPU usage %'''</u><br>
 vmware.vm.perfcounter[{$URL},{$UUID_VM},"cpu/usage[average]"]
:[[Datei:ClipCapIt-180606-085208.PNG]]<br>
<br>
----
<u>'''Guest memory usage'''</u><br>
wird über einen Zabbix-Simple Key zur Verfügung gestellt, den Wert den wir im vCenter sehen müssen wir errechnen aus '''usage''' und '''shared''':<br>
 last("vmware.vm.memory.size.usage.guest[{$URL},{$UUID_VM}]")+last("vmware.vm.memory.size.shared[{$URL},{$UUID_VM}]")
Das ist dann wieder ein Zahlenwert.<br>
Um das ganze als Prozentwert zu bekommen:<br>
 (last("vmware.vm.memory.size.usage.guest[{$URL},{$UUID_VM}]")+last("vmware.vm.memory.size.shared[{$URL},{$UUID_VM}]"))/last("vmware.vm.memory.size[{$URL},{$UUID_VM}]")*100
:[[Datei:ClipCapIt-180606-090232.PNG]]<br>
<br>
----
<u>'''Guest Operating System Uptime'''</u><br>
 vmware.vm.perfcounter[{$URL},{$UUID_VM},"sys/osUptime[latest]"]
:[[Datei:ClipCapIt-180606-101136.PNG]]<br>
Die liefert mir bei einem ESXi-Solo-System Werte die nahezu Identisch mit dem Wertes eines Zabbix-Agenten sind (Item <code>system.uptime</code>).<br>
In einem Cluster via vCenter kommen manchmal komische Werte ... da ist die VM dann schon länger gebootet als Eingeschaltet (<code>vmware.vm.uptime</code>).<br>
Scheinbar kommt dieser Wert durcheinander wenn die VMs zwischen Clustern verschoben werden, ich habe eine Stichproben überprüft und der Rückgabe ist glaubwürdig.<br>
<br>
----<u>'''Disk Hard Disk 1 outstanding read requests'''</u><br>
 vmware.vm.perfcounter[{$URL},{$UUID_VM},"virtualDisk/readOIO[latest]",scsi0:0]
oder bei Nutzung von Discovery per <code>vmware.vm.vfs.dev.discovery[{$URL},{$UUID_VM}]</code>:<br>
 vmware.vm.perfcounter[{$URL},{$UUID_VM},"virtualDisk/readOIO[latest]",{#DISKNAME}]
:[[Datei:ClipCapIt-180606-085645.PNG]]<br>
----
<u>'''Disk Hard Disk 1 outstanding write requests'''</u><br>
 vmware.vm.perfcounter[{$URL},{$UUID_VM},"virtualDisk/writeOIO[latest]",scsi0:0]
oder bei Nutzung von Discovery per <code>vmware.vm.vfs.dev.discovery[{$URL},{$UUID_VM}]</code>:<br>
 vmware.vm.perfcounter[{$URL},{$UUID_VM},"virtualDisk/writeOIO[latest]",{#DISKNAME}]
----
<br>

==Abfragen von ESXi-Host Daten==
Ihr legt den ESXi als Host an. Auf diesen sollten dann folgende Makros gelten:<br>
:[[Datei:ClipCapIt-180606-090712.PNG]]<br>
Eure UUID besteht bestimmt nicht nur aus Nullen, siehe Erklärung weiter oben.<br>
<br>
===Grundlagen===
Das Item was wir nutzen ist dieses:<br>
 vmware.hv.perfcounter[{$URL},{$UUID},<path>,<instance>]
 {$URL}      : Die URL zu /sdk des vCenters oder des ESXi-Hosts 
 {$UUID}     : Die eindeutige ID des ESXi-Hosts
 <path>      : Pfad zum gewünschten Messwert, genaueres folgt in diesem Text
 <instance>  : Manche Messwerte benötigen genauere Angaben, zum Beispiel bei Festplatten welche
Siehe auch https://www.zabbix.com/documentation/3.0/manual/config/items/itemtypes/simple_checks/vmware_keys
<br>
Der Rest funktioniert 1:1 wie bei den VMs.<br>
Nutzen könnt Ihr in diesem Falle alle '''Counter''' bei denen in der Spalte '''ENTITY''' der Typ
 HostSystem
aufgeführt ist.<br>
----
===Fertige Abfragen===
<u>'''CPU usage %'''</u><br>
 vmware.hv.perfcounter[{$URL},{$UUID},"cpu/usage[average]"]
auch hier wieder einen Multiplikator von 
 0.01
verwenden.<br>
<br>
----

==Verfügbare Counter==
Hier noch mal die "Übersetzungstabelle":<br>
 CPU Counters          = cpu             : https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/cpu_counters.html
 Memory Counters       = mem             : https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/memory_counters.html
 Virtual Disk Counters = virtualDisk     : https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/virtual_disk_counters.html
 Disk I/O Counters     = disk            : https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/disk_counters.html
 System                = sys             : https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/system_counters.html
Die Liste ist noch unvollständug, das Inhaltsverzeichnis findet Ihr hier:<br>
 https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.PerformanceManager.html
<br>
----
==Links==
* Hat mich erst auf die richtige Spur gebracht: https://www.zabbix.com/forum/zabbix-help/42965-create-an-item-for-total-cpu-usage-on-vmware-guest-template
* Die Anleitung für 3.0: https://www.zabbix.com/documentation/3.0/manual/config/items/itemtypes/simple_checks/vmware_keys
* Die Die Referenz für vSphere 6.0: https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.PerformanceManager.html
* CPU: https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/cpu_counters.html
* Memory: https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/memory_counters.html
* Virtual Disk: https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/virtual_disk_counters.html
<br>
----

==Kommentare==
<comments />