Als Administrator können Sie die Kennwerte-API mit PromQL-Abfragen verwenden, um direkt unverarbeitete Kennwerte abzufragen und abzurufen, die von innerhalb oder außerhalb Ihres Clusters ausgeführten Viewern oder grafischen Anwendungen von Drittanbietern wie beispielsweise Grafana verwendet werden können.
Die Kennwerte-API verwendet zum Sammeln dieser Kennwerte von den einzelnen GIS-Service-Pods und zum dauerhaften Speichern der Informationen in einer Zeitserien-Datenbank das Überwachungssystem Prometheus. Der Metrics Viewer registriert die Kennwerte-API als Data Store, damit er Abfragen an die Kennwerte-API senden kann, um Statistiken abzurufen.
Die Kennwerte-API wird in der usagestatistics-API im Administratorverzeichnis verfügbar gemacht. Führen Sie die folgenden Schritte aus, um auf die Kennwerte-API zuzugreifen:
- Wechseln Sie zur usagestatistics-API im Administratorverzeichnis: https://organization.example.com/<context>/admin/usagestatistics.
- Klicken Sie auf Rest Metrics API.
Die Kennwerte-API-Anwendung wird in einer neuen Registerkarte geöffnet.
- Melden Sie sich bei der Prometheus-Webseite an.
Standardmäßig werden für die Anmeldung vom System generierte Anmeldeinformationen verwendet. Bevor Sie sich beim Prometheus-Dashboard anmelden, müssen Sie Ihre Organisation konfigurieren und Ihre Anmeldeinformationen aktualisieren. Verwenden Sie zum Aktualisieren dieser Anmeldeinformationen den Vorgang "Anmeldeinformationen aktualisieren" in admin/usagestatistics. Das neue Kennwort muss aus mindestens acht Zeichen bestehen und mindestens einen Buchstaben (A–Z, a–z), eine Ziffer (0–9) und ein Sonderzeichen enthalten.
Von der Kennwerte-API gesammelte unverarbeitete Kennwerte
In der folgenden Tabelle werden die von der Kennwerte-API gesammelten unverarbeiteten Kennwerte beschrieben:
S.no | Name des Kennwerts | Beschreibung | Typ |
---|---|---|---|
1 | requests | Anforderungen, die verwendet werden können, um die Anforderungsrate zu ermitteln | Zähler |
2 | requests_succeeded | Erfolgreiche Anforderungen, die verwendet werden können, um die Rate der erfolgreichen Anforderungen zu ermitteln | Zähler |
3 | requests_failed | Fehlgeschlagene Anforderungen, die verwendet werden können, um die Rate der fehlgeschlagenen Anforderungen zu ermitteln | Zähler |
4 | requests_usage_timedout | Anforderungen, bei denen das Nutzungszeitlimit überschritten wurde und die verwendet werden können, um die Rate der Anforderungen mit überschrittenem Nutzungszeitlimit zu ermitteln | Zähler |
5 | requests_wait_timedout | Anforderungen, bei denen das Wartezeitlimit überschritten wurde und die verwendet werden können, um die Rate der Anforderungen mit überschrittenem Wartezeitlimit zu ermitteln | Zähler |
6 | requests_response_time_seconds | Antwortzeiten in Sekunden. Beispiele, Beobachtungen und Anzahlen werden in den folgenden Buckets angegeben: 0,05, 0,1, 0,25, 0,5, 0,75, 1, 2,5, 5, 7,5, 10 und Unendlich. | Histogramm |
Von der Kennwerte-API erfasste Beschriftungen
Zusammen mit den einzelnen von der Kennwerte-API gesammelten unverarbeiteten Kennwerten werden die in der folgenden Tabelle beschriebenen Beschriftungen gesammelt. Sie können verwendet werden, um mithilfe von PromQL-Abfragen und Ergebnisfiltern Kennwerte aus der Kennwerte-API abzufragen.
Name der Beschriftung | Beschreibung |
---|---|
nodeName | Der Name des Computers mit dem Service-Pod, der die Anforderung verarbeitet |
podName | Der Name des Service-Pods, der die Anforderung verarbeitet |
apiType | Die API, über die der Kennwert gesammelt wird Der aktuelle mögliche Wert ist service und stellt eine Service-Anforderung dar. |
folderName | Der Name des Ordners, in dem der Service erstellt wird |
serviceName | Der Name des Service einschließlich des Namens des Ordners, in dem sich der Service befindet |
serviceType | Der Service-Typ, zum Beispiel "MapService" oder "FeatureService" |
Vorgang | Der angeforderte Vorgang, zum Beispiel eine Abfrage oder ein Export. Hinweis:Vorgangsinformationen sind nur für REST-Anforderungen verfügbar. Bei SOAP-Anforderungen wird nur der Wert soap zurückgegeben. |
orgId | Die Organisations-ID |
username | Der Benutzername des Benutzers, der die Anforderung gesendet hat |