6 Minuten Lesezeit

Übersicht

Mit dem Prometheus Exporter von Quicknode können Sie Plattform- und Infrastrukturmetriken an Ihren bestehenden Observability-Stack übertragen, um den Systemzustand in Echtzeit zu überwachen.

In dieser Anleitung zeigen wir Ihnen, wie Sie die Prometheus-Unterstützung der Quicknode-Admin-API nutzen können, um ein Grafana-Dashboard zur Visualisierung erweiterter Metriken zu erstellen und so Ihre Quicknode-Endpunkte zu überwachen.

Aufbewahrung von Protokollen

Quicknode bietet in den Enterprise-Tarifen zudem eine 14-tägige Protokollaufbewahrung sowohl für die Plattform als auch für die Infrastruktur. Weitere Informationen finden Sie auf unserer Preisseite.

Ihre Aufgaben

• Richten Sie einen Prometheus-Exporter ein und erstellen Sie ein Grafana-Dashboard zur Überwachung Ihrer RPC-Infrastruktur

Was Sie benötigen

• Ein Quicknode-Konto mit einem Enterprise -Tarif
• Docker Desktop ist auf Ihrem Computer installiert und läuft
• Grundkenntnisse in Prometheus und Grafana (Wir begleiten Sie Schritt für Schritt)

Der Prometheus-Exporter steht ausschließlich unseren Enterprise -Kunden zur Verfügung. Bei Interesse wenden Sie sich bitte an uns.

Einführung in die Quicknode-Admin-API

Die Quicknode Admin API bietet leistungsstarken programmatischen Zugriff auf alle im Benutzer-Dashboard verfügbaren Funktionen und ermöglicht es Ihnen so, Ihre Infrastruktur zu verwalten, die Leistung zu überwachen und Ihre Kosten effektiver zu kontrollieren. In dieser Anleitung konzentrieren wir uns insbesondere auf die Verwendung des Prometheus-Exporters, um auf detaillierte Systemmetriken zuzugreifen und mit Grafana ein umfassendes Überwachungs-Dashboard zu erstellen.

Wenn Sie erfahren möchten, wie Sie die Admin-API für die Endpunktverwaltung nutzen können, lesen Sie unseren Leitfaden: So verwalten Sie Ihre RPC-Infrastruktur mit der Quicknode Admin-API.

Voraussetzungen

Quicknode-Konto und API-Schlüssel

Die Erstellung Ihres API-Schlüssels ist ganz einfach.

1. Melden Sie sich bei Ihrem Quicknode-Konto an.
2. Klicken Sie oben links auf das Avatar-Symbol und wählen Sie „API-Schlüssel“ aus, um die Seite „API-Schlüssel“ aufzurufen.
3. Erstellen Sie einen API-Schlüssel mit den entsprechenden Berechtigungen (Du brauchst CONSOLE_REST um die Admin-API zu nutzen) und halten Sie es griffbereit, da Sie es in Kürze benötigen werden.

Docker Desktop

Stellen Sie sicher, dass Sie Docker Desktop installiert und ausgeführt ist. Wir werden Docker verwenden, um Prometheus und Grafana schnell zu starten.

Erstellen eines Grafana-Dashboards mit dem Prometheus-Exporter

In diesem Abschnitt führen wir Sie durch die Einrichtung von Prometheus und Grafana mit Docker, um Ihre Quicknode-Metriken zu überwachen. Da wir Docker verwenden, müssen Sie Prometheus und Grafana nicht separat installieren.

Info

Prometheus: Ein Open-Source-Überwachungssystem, das Metriken als Zeitreihendaten erfasst und speichert, sodass Sie verschiedene Leistungskennzahlen über einen bestimmten Zeitraum hinweg verfolgen und analysieren können.

Grafana: Ein leistungsstarkes Open-Source-Tool für Analysen und Visualisierungen, mit dem Sie dynamische, interaktive Dashboards erstellen können, um Metriken aus Datenquellen wie Prometheus zu visualisieren.

Docker: Eine Plattform zur Entwicklung, Bereitstellung und Ausführung von Anwendungen in Containern. In dieser Konfiguration werden wir Docker nutzen, um Prometheus und Grafana in isolierten Containern auszuführen, was den Installations- und Konfigurationsprozess vereinfacht.

Wir haben im Repository „qn-guide-examples“ von Quicknode einen Ordner angelegt, der alle erforderlichen Konfigurationsdateien für Prometheus und Grafana enthält.

Projektstruktur

.
├── docker-compose.yaml                     # Docker Compose file to launch Prometheus and Grafana
├── grafana
│   ├── dashboards                          
│   │   │   └── Quicknode Admin API.json  # Grafana dashboard JSON file
│   ├── provisioning
│   │   ├── dashboards
│   │   │   └── main.yaml                   # Configuration for loading dashboards into Grafana
│   │   └── datasources
│   │       └── prometheus-source.yaml      # Configuration for connecting Grafana to Prometheus
├── prometheus
│   └── prometheus.yaml                     # Prometheus configuration file

Befolgen Sie diese Schritte, um loszulegen:

Schritt 1: Das Repository des Beispielprojekts klonen

Öffnen Sie Ihr Terminal bzw. Ihre Eingabeaufforderung und klonen Sie das Repository:

git clone https://github.com/quiknode-labs/qn-guide-examples.git

Navigieren Sie zu der grafana-dashboard Ordner innerhalb des geklonten Repositorys:

cd qn-guide-examples/admin-api/grafana-dashboard

Schritt 2: Aktualisieren Sie Ihren API-Schlüssel

Öffnen Sie die prometheus.yaml Datei, die sich im Prometheus Verzeichnis.

Ersetzen <YOUR_API_KEY> mit Ihrem tatsächlichen Quicknode-API-Schlüssel, den Sie zuvor generiert haben:

prometheus/prometheus.yaml

global:
  scrape_interval: 30s

scrape_configs:
  - job_name: "quicknode_prometheus_exporter"
    metrics_path: "v0/prometheus/metrics"
    scheme: "https"
    authorization:
      type: "bearer"
      credentials: "<API_KEY>"
    # fallback_scrape_protocol: PrometheusText0.0.4
    static_configs:
      - targets: ["api.quicknode.com"]

Info

Anmerkung: Wenn Sie Prometheus 3.x, müssen Sie möglicherweise die Fallback-Scrape-Protokoll Feld zum scrape_configs Abschnitt. Dazu können Sie einfach die im obigen Beispiel hervorgehobene Zeile auskommentieren.

Schritt 3: Prometheus und Grafana mit Docker starten

Wir haben ein docker-compose.yaml Datei, um die Einrichtung zu vereinfachen. Sie können sowohl Prometheus als auch Grafana starten, indem Sie den folgenden Befehl vom Stammverzeichnis aus ausführen (d. h., grafana-dashboard):

docker-compose up

Hinzufügen -d Flag, um die Dienste im Hintergrundmodus zu starten und sie im Hintergrund auszuführen.

Schritt 4: Rufen Sie Grafana auf und zeigen Sie Ihr Dashboard an

1. Öffnen Sie einen Webbrowser und rufen Sie folgende Seite auf: http://localhost:3000.
2. Melden Sie sich mit den Anmeldedaten des Projekts an (Benutzername: admin, Passwort: Passwort) (wie in der docker-compose.yaml Datei)
3. Gehen Sie zu Dashboards.
4. Suchen Sie das Quicknode Admin API -Dashboard und klicken Sie darauf.

Sie sollten nun das Dashboard sehen, auf dem die Kennzahlen Ihres Quicknode-Endpunkts angezeigt werden.

Hinweis: Wenn das Dashboard leer angezeigt wird, bedeutet dies, dass an Ihrem Endpunkt noch keine Aktivitäten stattgefunden haben. Führen Sie unbedingt einige Aktionen durch (z. B. das Senden von RPC-Anfragen an Ihren Endpunkt), um Daten zu generieren, die dann im Dashboard angezeigt werden.

Das Dashboard bietet die folgenden Bereiche, mit denen Sie Ihre Quicknode-Infrastruktur überwachen können:

• Quicknode-RPC-Anfragen (Anzeige): Zeigt die aktuelle Gesamtzahl der an Ihren Quicknode-Endpunkt gesendeten RPC-Anfragen an.
• Quicknode-RPC-Credits (Anzeige): Zeigt die Gesamtzahl der von Ihrem Quicknode-Endpunkt verbrauchten Credits an.
• Gesamtzahl der Quicknode-RPC-Anfragen in den letzten 30 Tagen: Ein Zeitreihendiagramm, das die Gesamtzahl der RPC-Anfragen in den letzten 30 Tagen darstellt.
• Quicknode-RPC-Guthaben insgesamt in den letzten 30 Tagen: Ein Zeitreihendiagramm, das die gesamte Guthabenverwendung in den letzten 30 Tagen darstellt.
• Quicknode-Endpunkt-Antwortstatus: Zeigt den Antwortstatus (z. B. 200, 400 usw.) Ihrer Quicknode-Endpunktanfragen an.
• Quicknode – Maximale Antwortzeit des Endpunkts: Zeigt die maximale Antwortzeit Ihres Endpunkts an.

Sie können das Dashboard ganz nach Ihren Bedürfnissen anpassen, indem Sie die Anzeigen bearbeiten, neue hinzufügen oder den Zeitbereich anpassen.

Prometheus-Metriken direkt erkunden

Wenn Sie die von Prometheus erfassten Metriken direkt untersuchen möchten, können Sie die folgenden Schritte ausführen:

• Öffnen Sie einen Webbrowser und rufen Sie folgende Seite auf: http://localhost:9090
• Navigieren Sie in der Prometheus-Oberfläche zu „Status > Targets“, um zu überprüfen, ob das Quicknode-Ziel aufgeführt ist und sich im Status „UP“ befindet.
• Überprüfen Sie die wichtigsten Kennzahlen, die Quicknode bereitstellt:
  • Wechseln Sie zur Registerkarte „Diagramm “.
  • Geben Sie im Ausdrucksfeld nacheinander eine dieser Kennzahlen ein und klicken Sie auf Ausführen:
    • quicknode_rpc_credits
    • quicknode_rpc_requests
    • quicknode_rpc_response_status
    • quicknode_rpc_response_time_max
  • Auf diese Weise können Sie die erfassten Rohdaten entweder als Diagramm oder in Tabellenform einsehen.

Wenn Sie fertig sind, können Sie die Dienste mit folgendem Befehl beenden:

docker-compose down

Fazit

Herzlichen Glückwunsch! 🎉 Sie haben erfolgreich eine Verbindung zum Quicknode Prometheus Exporter hergestellt, um erweiterte Metriken aus Ihrer RPC-Infrastruktur abzurufen, und ein Grafana-Dashboard zur Überwachung des Systemzustands erstellt. Diese Konfiguration liefert Ihnen wertvolle Echtzeit-Einblicke in Ihre RPC-Infrastruktur, sodass Sie die Leistung optimieren und den Überblick behalten können.

Wenn Sie Fragen, Ideen oder Vorschläge haben, wenden Sie sich bitte direkt an uns. Bleiben Sie außerdem auf dem Laufenden, indem Sie uns auf X folgen und unserem Ankündigungskanal auf Discord und Telegram beitreten.

Wir ❤️ Feedback!

Teilen Sie uns gerne mit, wenn Sie Feedback oder Vorschläge für neue Themen haben. Wir freuen uns auf Ihre Rückmeldung.

Weitere Ressourcen

• Quicknode Admin-API-Dokumentation
• Quicknode Admin-API Swagger
• Anleitung: So verwalten Sie Ihre RPC-Infrastruktur mit der Quicknode Admin API