6 min de lecture

Aperçu

L'exportateur Prometheus de Quicknode vous permet de diffuser les métriques de la plateforme et de l'infrastructure vers votre pile d'observabilité existante pour une surveillance en temps réel de l'état du système.

Dans ce guide, nous vous expliquerons comment tirer parti du support Prometheus de l'API d'administration Quicknode pour créer un tableau de bord Grafana permettant une visualisation avancée des métriques afin de surveiller vos endpoints Quicknode.

Rétention des logs

Quicknode assure également une rétention des logs de 14 jours pour la plateforme et l'infrastructure sur les plans Enterprise. Pour plus d'informations, veuillez consulter notre page de tarification.

Ce que vous ferez

• Mettre en place un exportateur Prometheus et créer un tableau de bord Grafana pour surveiller votre infrastructure RPC

Ce dont vous aurez besoin

• Un compte Quicknode avec un plan Enterprise
• Docker Desktop installé et fonctionnel sur votre ordinateur
• Connaissances de base de Prometheus et Grafana (Nous vous guiderons à chaque étape)

L'exportateur Prometheus est uniquement disponible pour nos clients Enterprise. Si vous êtes intéressé, veuillez nous contacter.

Introduction à l'API d'administration Quicknode

L'API d'administration Quicknode offre un accès programmatique puissant à toutes les actions disponibles dans le tableau de bord utilisateur, vous permettant de gérer votre infrastructure, de surveiller les performances et de contrôler vos coûts plus efficacement. Dans ce guide, nous nous concentrerons spécifiquement sur l'utilisation de l'exportateur Prometheus pour accéder à des métriques système détaillées et créer un tableau de bord de surveillance complet avec Grafana.

Si vous souhaitez apprendre à utiliser l'API d'administration pour la gestion des endpoints, consultez notre guide : Comment gérer votre infrastructure RPC avec l'API d'administration Quicknode.

Prérequis

Compte Quicknode et clé API

La création de votre clé API est simple.

1. Connectez-vous à votre compte Quicknode.
2. Cliquez sur l'icône de l'avatar en haut à gauche, puis sélectionnez Clés API pour accéder à la page Clés API.
3. Générez une clé API avec les permissions appropriées (vous aurez besoin CONSOLE_REST d'utiliser l'API d'administration) et gardez-la à portée de main, car vous l'utiliserez sous peu.

Docker Desktop

Assurez-vous que vous avez Docker Desktop installé et en cours d'exécution. Nous utiliserons Docker pour lancer rapidement Prometheus et Grafana.

Création d'un tableau de bord Grafana avec Prometheus Exporter

Dans cette section, nous vous guiderons à travers la configuration de Prometheus et Grafana à l'aide de Docker pour surveiller vos métriques Quicknode. Puisque nous utiliserons Docker, vous n'avez pas besoin d'installer Prometheus et Grafana séparément.

informations

Prometheus : Un système de surveillance open source qui collecte et stocke les métriques sous forme de données de séries temporelles, vous permettant de suivre et d'analyser diverses métriques de performance au fil du temps.

Grafana : Un puissant outil d'analyse et de visualisation open source qui vous permet de créer des tableaux de bord dynamiques et interactifs pour visualiser les métriques provenant de sources de données telles que Prometheus.

Docker : Une plateforme pour le développement, la livraison et l'exécution d'applications dans des conteneurs. Dans cette configuration, nous utiliserons Docker pour exécuter Prometheus et Grafana dans des conteneurs isolés, simplifiant ainsi le processus d'installation et de configuration.

Nous avons créé un dossier dans le dépôt qn-guide-examples de Quicknode, qui contient tous les fichiers de configuration nécessaires pour Prometheus et Grafana.

Structure du projet

.
├── docker-compose.yaml                     # Fichier Docker Compose pour lancer Prometheus et Grafana
├── grafana
│   ├── dashboards                          
│   │   │   └── Quicknode Admin API.json  # Fichier JSON du tableau de bord Grafana
│   ├── provisioning
│   │   ├── dashboards
│   │   │   └── main.yaml                   # Configuration pour le chargement des tableaux de bord dans Grafana
│   │   └── datasources
│   │       └── prometheus-source.yaml      # Configuration pour connecter Grafana à Prometheus
├── prometheus
│   └── prometheus.yaml                     # Fichier de configuration Prometheus

Suivez ces étapes pour commencer :

Étape 1 : Cloner le dépôt du projet exemple

Ouvrez votre terminal/invite de commande et clonez le dépôt :

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

Accédez au grafana-dashboard dossier au sein du dépôt cloné :

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

Étape 2 : Mettre à jour votre clé API

Ouvrez le prometheus.yaml fichier situé dans le prometheus répertoire.

Remplacez <YOUR_API_KEY> par votre clé API Quicknode réelle que vous avez générée précédemment :

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"]

informations

Remarque: Si vous utilisez Prometheus 3.x, vous devrez peut-être ajouter le champ fallback_scrape_protocol à la section scrape_configs . Pour ce faire, il vous suffit de décommenter la ligne surlignée dans l'exemple ci-dessus.

Étape 3 : Lancer Prometheus et Grafana avec Docker

Nous avons préconfiguré un docker-compose.yaml fichier pour simplifier la configuration. Vous pouvez lancer Prometheus et Grafana en exécutant la commande ci-dessous depuis le répertoire racine (c'est-à-dire, grafana-dashboard):

docker-compose up

Ajoutez l' -d option pour démarrer les services en mode détaché, les exécutant en arrière-plan.

Étape 4 : Accéder à Grafana et visualiser votre tableau de bord

1. Ouvrez un navigateur web et accédez à http://localhost:3000.
2. Connectez-vous avec les identifiants du projet (nom d'utilisateur : admin, mot de passe : password) (tel que défini dans le docker-compose.yaml fichier)
3. Accédez à Tableaux de bord.
4. Recherchez et cliquez sur le tableau de bord Quicknode Admin API.

Vous devriez maintenant voir le tableau de bord affichant les métriques de votre point de terminaison Quicknode.

Remarque : Si le tableau de bord apparaît vide, cela signifie qu'il n'y a pas encore eu d'activité sur votre point de terminaison. Assurez-vous d'effectuer une activité (par exemple, envoyer des requêtes RPC à votre point de terminaison) pour commencer à générer des données qui seront affichées sur le tableau de bord.

Le tableau de bord fournit les panneaux suivants pour vous aider à surveiller votre infrastructure Quicknode :

• Requêtes RPC Quicknode (Jauge) : Affiche le nombre total actuel de requêtes RPC effectuées vers votre point de terminaison Quicknode.
• Crédits RPC Quicknode (Jauge) : Indique le total des crédits utilisés par votre point de terminaison Quicknode.
• Total des requêtes RPC Quicknode sur les 30 derniers jours : Un graphique de séries chronologiques affichant le nombre total de requêtes RPC sur les 30 derniers jours.
• Total des crédits RPC Quicknode sur les 30 derniers jours : Un graphique de séries chronologiques affichant l'utilisation totale des crédits sur les 30 derniers jours.
• Statut de réponse des endpoints Quicknode : Affiche le statut de réponse (par exemple, 200, 400, etc.) de vos requêtes d'endpoint Quicknode.
• Temps de réponse maximal des endpoints Quicknode : Indique le temps de réponse maximal de votre endpoint.

N'hésitez pas à personnaliser le tableau de bord en modifiant les panneaux, en en ajoutant de nouveaux ou en ajustant la plage horaire selon vos besoins.

Exploration directe des métriques Prometheus

Si vous souhaitez explorer directement les métriques collectées par Prometheus, vous pouvez suivre ces étapes :

• Ouvrez un navigateur web et accédez à http://localhost:9090
• Accédez à Status > Targets dans l'interface Prometheus pour confirmer que la cible Quicknode est listée et en état UP.
• Vérifiez les métriques clés exposées par Quicknode :
  • Accédez à l'onglet Graph.
  • Dans le champ d'expression, saisissez l'une de ces métriques une par une et cliquez sur Exécuter:
    • quicknode_rpc_credits
    • quicknode_rpc_requests
    • quicknode_rpc_response_status
    • quicknode_rpc_response_time_max
  • Cela vous permettra de visualiser les données brutes collectées, sous forme de graphique ou de tableau.

Une fois terminé, vous pouvez arrêter les services en exécutant :

docker-compose down

Conclusion

Félicitations ! 🎉 Vous vous êtes connecté avec succès à l'exportateur Prometheus de Quicknode pour extraire des métriques avancées de votre infrastructure RPC et avez créé un tableau de bord Grafana pour surveiller la santé de votre système. Cette configuration vous offre des informations précieuses en temps réel sur votre infrastructure RPC, vous permettant d'optimiser les performances et de maintenir une visibilité.

Si vous avez des questions, des idées ou des suggestions, veuillez nous contacter directement. Restez également informé des dernières actualités en nous suivant sur X et en rejoignant notre Discord et notre canal d'annonces Telegram.

Nous ❤️ les commentaires !

Faites-nous savoir si vous avez des commentaires ou des suggestions de nouveaux sujets. Nous serions ravis de vous entendre.

Ressources supplémentaires

• Documentation de l'API d'administration Quicknode
• Swagger de l'API d'administration Quicknode
• Guide : Comment gérer votre infrastructure RPC avec l'API d'administration Quicknode