Konfigurieren des Zugriffs auf Kennwerte

Die Kennwerte-API erfasst Informationen zu den Komponenten von ArcGIS Enterprise und den Computern, auf denen diese Komponenten ausgeführt werden. Wenn Sie die von der Kennwerte-API bereitgestellten Informationen nutzen möchten, müssen Sie einen Schlüssel oder ein Token erstellen, um den Zugriff auf die Kennwerte zu autorisieren, und danach Prometheus konfigurieren, um die Kennwerte auszulesen. Optional können Sie Grafana konfigurieren, um die Kennwerte zu visualisieren.

Kennwerte sind standardmäßig aktiviert, Sie können jedoch ggf. die Kennwerte deaktivieren.

Konfigurieren der Zugriffsberechtigungen

Bevor Sie die Kennwerte auslesen, müssen Sie die richtigen Zugriffsberechtigungen aktivieren.

Das Konto, mit dem die einzelnen Softwarekomponenten ausgeführt werden, muss Teil der Gruppe zur Performance-Überwachung sein, damit Computer-Kennwerte erfasst werden können.

Authentifizeren Sie Anforderungen bei ArcGIS Enterprise-Bereitstellungen mit einem API-Schlüssel. Das gilt auch für Verbundserver. Authentifizieren Sie Anforderungen bei eigenständigen ArcGIS Server-Sites mit einem administrativen Token.

[!NOTE]Damit eine erfolgreiche Authentifizierung stattfinden kann, um Metriken für eine ArcGIS Enterprise-Komponente abzurufen, muss der Portal for ArcGIS-Service zugänglich sein. Bei der Authentifizierung für ArcGIS Data Store-Kennwerte muss zusätzlich auch der Hosting-Server zugänglich sein.

Abrufen eines API-Schlüssels mit ArcGIS Enterprise

Gehen Sie zum Abrufen eines geeigneten API-Schlüssels für den Zugriff auf die Kennwerte-API wie folgt vor:

Melden Sie sich als Administrator bei Ihrer Organisation an.
Klicken Sie auf der Registerkarte Eigene Inhalte der Inhaltsseite auf Neues Element und dann auf Entwickler-Anmeldeinformationen.
Wählen Sie Anmeldeinformationen für API-Schlüssel aus, und klicken Sie auf Weiter.
Wählen Sie Private Anwendung mit ausgewählten Berechtigungen und Zugriffsberechtigungen aus, und klicken Sie auf Weiter.
Wählen Sie Kein Elementzugriff aus, und klicken Sie dann auf Weiter.
Wählen Sie die Berechtigung Observability aus, und klicken Sie auf Weiter.
Wählen Sie ein Ablaufdatum und optional die Referrer-URLs aus, und klicken Sie auf Weiter.
Fügen Sie einen Titel für das API-Schlüsselelement und optional Tags und eine Zusammenfassung hinzu, und klicken Sie auf Weiter.
Überprüfen Sie die API-Schlüsselkonfiguration im Hinblick auf ihre Richtigkeit, und klicken Sie auf Weiter.
Stellen Sie sicher, dass die Option API-Schlüssel jetzt generieren ausgewählt ist, und klicken Sie auf Weiter.
Kopieren Sie den API-Schlüssel.

Abrufen eines administrativen Tokens mit ArcGIS Server

Für eigenständige ArcGIS Server-Sites können Sie ein administratives Token mit ArcGIS Server abrufen. Für verbundene ArcGIS Server-Verbundsites rufen Sie stattdessen einen API-Schlüssel ab.

Melden Sie sich als Benutzer mit Administratorberechtigungen beim ArcGIS Server-Administratorverzeichnis an.
Klicken Sie auf generateToken.
Geben Sie die folgenden Informationen ein:
- Username: Der Benutzername eines Benutzers mit Administratorberechtigungen.
- Password: Das Kennwort für den angegebenen Benutzernamen.
- Client: HTTP-Referrer.
- HTTP referrer: Eine URL, die mit dem in der Prometheus-Konfiguration angegebenen Referrer übereinstimmt. Bei der Beispiel-Prometheus-Konfiguration wird ARCGIS.COM als Referrer verwendet.
Legen Sie optional eine Ablaufzeit in Minuten fest.

[!NOTE]Standardmäßig beträgt die Ablaufzeit 60 Minuten. Die maximal mögliche Standardablaufzeit beträgt 1.440 Minuten (24 Stunden). Um ein langlebigeres Token zu generieren, muss ein Administrator die Token-Konfiguration aktualisieren, um die Eigenschaft "longTimeout" zu erhöhen, bevor ein Token generiert wird. Gehen Sie vorsichtig vor, wenn Sie den Wert "LongTimeout" erhöhen, damit der aktualisierte Wert Ihren Sicherheitsanforderungen entspricht.
Klicken Sie auf Generate.
Kopieren Sie das Token.

Konfigurieren des Prometheus-Servers

Sie müssen die Prometheus-Konfiguration aktualisieren, um die Kennwerte-API als Ausleseziel hinzuzufügen. Eine Anleitung zum Bereitstellen von Prometheus finden Sie in der Bereitstellungsanleitung.

Konfigurieren Sie für jede Komponente von ArcGIS Enterprise, aus der Sie Kennwerte abrufen möchten, einen separaten Ausleseauftrag. Für jede Auslesekonfiguration sind die folgenden Informationen erforderlich:

job_name: Ein eindeutiger Name für den Auftrag.
http_sd_configs: Die Konfiguration für den Service-Discovery-Endpunkt. Die folgenden Informationen sind erforderlich:
- url: Die URL des Service-Discovery-Endpunkts. Sie hat das Format <scheme>://<machine fqdn>/<context>/monitoring/discovery.
  
  Bei Portal for ArcGIS und ArcGIS Server wird empfohlen, die URL für ArcGIS Web Adaptor oder den Reverseproxy zu verwenden. Beispielsweise kann eine Organisation https://portal.example.com/portal/monitoring/discovery zur Service-Discovery für Portal-Kennwerte oder https://gisserver.example.com/server/monitoring/discovery zur Service-Discovery für eine ArcGIS Server-Site verwenden.
  
  Bei ArcGIS Data Store müssen Sie den Computer, auf dem der Data Store vom Typ "relational" installiert ist, und die Portnummer angeben. Beispiel: https://relational.example.com:2443/arcgis/monitoring/discovery.
- bearer_token oder bearer_token_file: Der ArcGIS Enterprise-API-Schlüssel oder das administrative ArcGIS Server-Token.
  
  Das Token wird als Teil von http_sd_configs für die Authentifizierung am Service-Discovery-Endpunkt bereitgestellt.
bearer_token oder bearer_token_file: Der ArcGIS Enterprise-API-Schlüssel oder das administrative ArcGIS Server-Token.

Das Token wird erneut als Teil der Auslesekonfiguration für die Authentifizierung an den Endpunkten für die Kennwerterfassung bereitgestellt.
metrics_path: Der Wert muss /arcgis/monitoring/metrics sein.

Für das Auslesen von Computerkennwerten müssen direkt Anforderungen an die einzelnen Computer gesendet werden. Diese Anforderungen werden nicht über einen von Ihnen konfigurierten ArcGIS Web Adaptor oder Reverseproxy geleitet. Stellen Sie sicher, dass der Prometheus-Server alle ArcGIS Server-Computer über Port 6443 und alle Portal for ArcGIS-Computer über Port 7443 erreichen kann.
scheme: Entweder http oder https, abhängig davon, ob die unter https_sd_configs angegebene URL so konfiguriert ist, dass sie über HTTP oder HTTPS erreichbar ist.

In der Beispiel-Prometheus-Konfiguration finden Sie eine YAML-Vorlagendatei für das Auslesen von ArcGIS Enterprise-Kennwerten. Sie können Grafana mit der Beispiel-Dashboard-Vorlage konfigurieren, um die Kennwerte nach ihrer Erfassung mit Prometheus zu visualisieren.

Konfigurieren des Bereinigungsintervalls für Kennwerte

Das Standardintervall für das Löschen von Kennwerten aus dem System beträgt eine Stunde und ist für die meisten Organisationen ein geeigneter Wert. Überlegungen, die beim Ändern des Löschintervalls berücksichtigt werden sollten, finden Sie im Thema zum Löschen von Kennwerten.

Wenn Sie das Löschintervall ändern müssen, hängt die weitere Vorgehensweise von der jeweiligen ArcGIS Enterprise-Komponente ab.

Konfigurieren des Bereinigungsintervalls für Kennwerte für ArcGIS Server

Melden Sie sich als Benutzer mit Administratorberechtigungen beim ArcGIS Server-Administratorverzeichnis an.
Navigieren Sie zu System > Properties > Update.
Fügen Sie im Textfeld Properties einen Wert für den Schlüssel metricsClearingIntervalInHours als JSON hinzu.

Um beispielsweise ein Intervall von zwei Stunden festzulegen, verwenden Sie die folgende JSON:
```
{
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}
```
Klicken Sie auf Update.
Starten Sie den ArcGIS Server-Service neu.

Konfigurieren des Bereinigungsintervalls für Kennwerte für Portal for ArcGIS

Melden Sie sich als Administrator Ihrer Organisation beim Portal-Administratorverzeichnis an.
Navigieren Sie zu System > Properties > Update Properties.
Fügen Sie im Textfeld Properties einen Wert für den Schlüssel metricsClearingIntervalInHours als JSON hinzu.

Um beispielsweise ein Intervall von zwei Stunden festzulegen, verwenden Sie die folgende JSON:
```
{
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}
```
Klicken Sie auf Update Properties.

Daraufhin wird der Portal for ArcGIS-Service automatisch neu gestartet.

Konfigurieren des Bereinigungsintervalls für Kennwerte für ArcGIS Data Store

Führen Sie das Dienstprogramm "datastoremetrics" auf dem Computer aus, auf dem der Data Store vom Typ "relational" installiert ist, und geben Sie den Parameter interval an. Um beispielsweise ein Intervall von zwei Stunden festzulegen, verwenden Sie den folgenden Befehl:

./datastoremetrics --enabled true --interval 2

datastoremetrics --enabled true --interval 2

Wenn Sie das Bereinigungsintervall für Kennwerte für einen primären und Standby-Data-Store vom Typ "relational" ändern möchten, müssen Sie das Dienstprogramm für beide Data Stores ausführen.

Deaktivieren von Kennwerten

Die Vorgehensweise zum Deaktiveren von Kennwerten hängt von der jeweiligen ArcGIS Enterprise-Komponente ab.

Deaktivieren von Metriken für eine ArcGIS Server-Site

Melden Sie sich als Benutzer mit Administratorberechtigungen beim ArcGIS Server-Administratorverzeichnis an.
Navigieren Sie zu System > Properties > Update.
Legen Sie im Textfeld Properties für den Schlüssel isMetricsEnabled den Wert false fest:
```
{"isMetricsEnabled": false}
```
Klicken Sie auf Aktualisieren.
Starten Sie den ArcGIS Server-Service neu.

Deaktivieren von Metriken für Portal for ArcGIS

Melden Sie sich als Administrator Ihrer Organisation beim Portal-Administratorverzeichnis an.
Navigieren Sie zu System > Properties > Update Properties.
Legen Sie im Textfeld Properties für den Schlüssel isMetricsEnabled den Wert false fest:
```
{"isMetricsEnabled": false}
```
Klicken Sie auf Update Properties.

Daraufhin wird der Portal for ArcGIS-Service automatisch neu gestartet.

Deaktivieren von Metriken für ArcGIS Data Store

Um Kennwerte für ArcGIS Data Store zu deaktivieren, führen Sie das Dienstprogramm "datastoremetrics" auf dem Computer aus, auf dem der Data Store vom Typ "relational" installiert ist. Verwenden Sie dazu den folgenden Befehl:

./datastoremetrics --enabled false

datastoremetrics --enabled false

Wenn Sie Kennwerte für einen primären und Standby-Data-Store vom Typ "relational" deaktivieren möchten, müssen Sie das Dienstprogramm für beide Data Stores ausführen.