Verwenden der Kennwerte-API
Mit der Kennwerte-API können Sie Anwendungen und die Infrastruktur überwachen und verwalten. Sie ermöglicht die Sammlung und Aggregation von Echtzeitdaten und bietet Erkenntnisse zur Systemleistung. Darüber hinaus können DevOps-Teams die API nutzen, um Warnungen einzurichten, Probleme zu behandeln und die Ressourcenzuweisung zu optimieren. Durch Bereitstellung dieser Leistungskennwerte sind Sie in der Lage, Anomalien und Engpässe besser zu erkennen und die Systemwartung proaktiver zu gestalten. Außerdem ermöglicht die Kennwerte-API die Integration einer breiten Palette von Überwachungs- und Visualisierungswerkzeugen und verbessert so die Fähigkeit, komplexe Systeme zu beobachten.
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 sammelt Informationen über Services, Benutzer und Inhaltselemente. Das Prometheus-Überwachungssystem wird von der Kennwerte-API verwendet, um die gesammelten Informationen in einer Zeitserien-Datenbank zu speichern.
Weitere Informationen dazu, wie Sie die Kennwerte-API zur Optimierung und für die Problembehebung von Services einsetzen können, finden Sie unter Service-Kennwerte. Unter Kennwerte anzeigen finden Sie weitere Informationen zur Visualisierung von Informationen, die von der Kennwerte-API gesammelt werden.
Zugreifen auf die Kennwerte-API
Die Kennwerte-API wird in der usagestatistics-API im ArcGIS Enterprise-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.
Von der Kennwerte-API verfügbar gemachte Informationen
Sie können Prometheus verwenden, um Kennwerte für ArcGIS Enterprise abzurufen. In den folgenden Tabellen werden die verfügbaren Kennwerte und Beschriftungen zusammengefasst, die Sie in PromQL-Abfragen und Ergebnisfiltern verwenden können, um auf die benötigten Informationen zuzugreifen.
Kennwerte mit dem Suffix _created geben die Unix-Zeit (Sekunden) von Histogrammen und Zusammenfassungen zum Zeitpunkt der ersten Erfassung des entsprechenden Kennwertes wieder. Dieser Wert gibt Einblick in den Lebenszyklus eines Kennwertes. Diese Kennwerte sind in den nachfolgenden Tabellen nicht enthalten.
Service-Kennwerte
Service-Kennwerte werden für jeden veröffentlichten Service berichtet.
|
Name |
Beschreibung |
Typ |
Beschriftungen |
|---|---|---|---|
|
requests_failed_total |
Anzahl der fehlgeschlagenen Anforderungen |
Zähler |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_response_time_seconds_bucket |
Kumulative Anzahl der beobachteten Anforderungen, die in einer Zeit von maximal der oberen Grenze des Bucket (in Sekunden) abgeschlossen wurden |
Histogramm |
apiType, folderName, instance, instancePool, job, le, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_count |
Gesamtzahl der beobachteten Antwortzeiten für Anforderungen über alle Buckets hinweg |
Histogramm |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_sum |
Kumulative Antwortzeit aller beobachteten Anforderungen in Sekunden |
Histogramm |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_counter_total |
Summe der Antwortzeiten von Anforderungen in Sekunden |
Zähler |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_succeeded_total |
Anzahl der erfolgreichen Anforderungen |
Zähler |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_total |
Anzahl der Anforderungen |
Zähler |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_usage_timedout_total |
Anzahl der Anforderungen, die durch Überschreitung der maximalen Nutzungszeit abgelaufen sind |
Zähler |
apiType, folderName, nodeName, operation, podName, serviceName, serviceType, username |
|
requests_wait_time_seconds_bucket |
Kumulative Anzahl der Anforderungen, die in einer Zeit von maximal der oberen Grenze des Bucket (in Sekunden) auf die Verarbeitung warten mussten |
Zähler |
apiType, folderName, instance, instancePool, job, le, nodeName, podName, serviceName, serviceType |
|
requests_wait_time_seconds_count |
Gesamtzahl der beobachteten Wartezeiten für Anforderungen über alle Buckets hinweg |
Zähler |
apiType, folderName, instance, instancePool, job, nodeName, podName, serviceName, serviceType |
|
requests_wait_time_seconds_sum |
Kumulative Wartezeit aller beobachteten Anforderungen in Sekunden |
Zähler |
apiType, folderName, instance, instancePool, job, nodeName, podName, serviceName, serviceType |
|
requests_wait_timedout_total |
Anzahl der Anforderungen, die durch Überschreitung der maximalen Wartezeit abgelaufen sind |
Zähler |
apiType, folderName, nodeName, operation, podName, serviceName, serviceType, username |
|
up |
Ausgeführte Pods |
Zähler |
instance, job |
Organisationskennwerte
|
Name |
Beschreibung |
Typ |
Beschriftungen |
|---|---|---|---|
|
items_added_total |
Gesamtzahl der hinzugefügten Elemente |
Zähler |
componentName, instance, job, nodeName |
|
items_count |
Gesamtzahl der Elemente |
Skala |
componentName, instance, job, nodeName |
|
items_deleted_total |
Gesamtzahl der gelöschten Elemente |
Zähler |
componentName, instance, job, nodeName |
|
items_updated_total |
Gesamtzahl der aktualisierten Elemente |
Zähler |
componentName, instance, job, nodeName |
|
items_viewed_total |
Gesamtzahl aller angezeigten Elemente |
Zähler |
componentName, instance, job, nodeName |
|
users_added_total |
Gesamtzahl der hinzugefügten Benutzer |
Zähler |
componentName, instance, job, nodeName |
|
users_count |
Gesamtzahl der Benutzer |
Skala |
componentName, instance, job, nodeName |
|
users_login_total |
Gesamtzahl der Benutzeranmeldungen |
Zähler |
componentName, instance, job, nodeName |
|
users_logout_total |
Gesamtzahl der Benutzerabmeldungen |
Zähler |
componentName, instance, job, nodeName |
Hinweis:
Der Kennwert "items_count" schließt keine Inhaltsemente von Esri wie beispielsweise Living Atlas-Inhalte ein.
Beschreibungen der Beschriftungen
| Name der Beschriftung | Beschreibung |
|---|---|
| apiType | Die API, über die der Kennwert gesammelt wird |
| folderName | Der Name des Ordners, in dem der Service erstellt wird |
| instance | Die Cluster-IP-Adresse und der Port des Service-Pods, der die Anforderung verarbeitet. |
| instancePool | Der vom Service verwendete Instanzpool ist entweder geteilt oder dediziert. |
| job | Der Auftragsname, der in der Prometheus-Konfiguration definiert ist. |
| le | Die obere Grenze eines Bucket in einem Histogrammkennwert |
| nodeName | Der Name des Computers mit dem Service, der die Anforderung verarbeitet |
| operation | Der angeforderte Vorgang, zum Beispiel eine Abfrage oder ein Export. Vorgangsinformationen sind nur für REST-Anforderungen verfügbar. Bei SOAP-Anforderungen wird nur der Wert "soap" zurückgegeben. |
| podName | Der Name des Service-Pods, der die Anforderung verarbeitet |
| responseCached | Boolescher Indikator, wenn die Antwort aus dem Cache bereitgestellt wurde |
| 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" |
| username | Der Benutzername des Benutzers, der die Anforderung gesendet hat |