Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Einrichten eines Überwachungs-Dashboards für eine API

Die Aktivitätskachel des API-Fensters ist auf die letzten 10 Request-Status begrenzt. Wenn eine API für einen Datensatz aktiviert wurde, werden jedoch Metriken erfasst, die vom Überwachungs-Dashboard Ihrer Wahl verarbeitet werden können.

Weitere Informationen zu den verfügbaren Metriken finden Sie unter Für eine API verfügbare Metriken.

Prozedur

  1. Fügen Sie in Ihrem Remote Engine Gen2-Verzeichnis die folgende Konfiguration in der Datei default/nginx/nginx.conf hinzu, um den Metriken-Endpunkt sichtbar zu machen: 
    location /metrics {
      proxy_pass http://dataset-api-server/api/v1/metrics;
    }
    Diese Konfiguration kann unter dem Element location /apis in der Datei hinzugefügt werden. Beispiel:
    events { }
http {
  server {
    listen 9102;

    location /apis {
      proxy_pass http://dataset-api-server/apis;
    }

    location /metrics {
      proxy_pass http://dataset-api-server/api/v1/metrics;
    }

  }
}
  2. Starten Sie die Instanz von Remote Engine Gen2 neu, um die neue Konfiguration anzuwenden.
  3. Verwenden Sie im Überwachungssystem Ihrer Wahl die folgende URL mit den richtigen Parametern, um die Metriken für die auf der Remote Engine Gen2 ausgeführten APIs abzurufen:
    protocol://remote_engine_host:DATASET_API_SHARING_EXTERNAL_PORT/metrics
    Verschiedene Parameter zur URL-Erstellung
    Parameter Wert
    protocol Standardmäßig http oder https, sofern konfiguriert.
    remote_engine_host Host, auf dem die Remote Engine Gen2 installiert ist. Dies ist infrastrukturspezifisch. Wenn Ihnen der Host nicht bekannt ist, wenden Sie sich an Ihren Administrator.
    DATASET_API_SHARING_EXTERNAL_PORT Wert des Parameters DATASET_API_SHARING_EXTERNAL_PORT in der Datei default/.env im Remote Engine Gen2-Verzeichnis.
  4. Konfiguration Sie Ihr Überwachungssystem gemäß Ihren Anforderungen.

    Example

    Mit Prometheus können Sie die nachstehende Konfiguration verwenden. Weitere Informationen finden Sie in der Prometheus-Dokumentation.

     - job_name: 'dataset_api_sharing'
   scrape_interval: 10s
   metrics_path: /metrics
   static_configs:
    - targets: [ 'localhost:8080' ]

Ergebnisse

Beispiele für Grafana-Dashboards, die Prometheus-Daten beispielsweise für die Speichernutzung, die Anzahl der Requests pro API oder die durchschnittliche Latenz abfragen.
Beispiel für Grafana-Dashboards
Beispiel für Grafana-Dashboards

In diesem Abschnitt

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!

Geben Sie hier Ihr Feedback ab