MonitoringPlugin fr FR

Plugin de surveillance

MonitoringPlugin est un ASF officiel plugin, qui vous permet de surveiller le processus ASF via une base de données de séries temporelles Prometheus .

---

Captures d'écran

Afficher

---

Exigences

En raison de contraintes techniques, ce plugin nécessite une variante generic d'ASF.

---

Activer le plugin

ASF n'inclut pas le MonitoringPlugin fourni par défaut, cependant, il est inclus comme ajout facultatif dans chaque version ASF. Téléchargez le plugin à partir de la version officielle release qui correspond à votre version ASF, puis créez un plugins/ArchiSteamFarm dédié. fficialPlugins.Monitoring répertoire pour le plugin, et enfin extraire l'archive là.

Lors du prochain lancement d'ASF, les journaux indiqueront que le plugin a été chargé avec succès par le mécanisme d'enregistrement ASF standard. Vous pouvez également vérifier cela en accédant à l'URL /Api/metrics dans votre interface IPC. Si vous utilisez un mot de passe IPC, vous aurez besoin d'une autorisation appropriée, par exemple en ajoutant ?password=<YourIPCPassword> à l'URL /Api/metrics. Le contenu que vous voyez devrait ressembler à ce qui suit :

# TYPE asf_build_info jauge
# AIDE asf_build_info Build des informations sur ASF sous forme de valeurs d'étiquette
asf_build_info{variant="source",version="6.0.2. "} 1 1713715703686

# TYPE asf_runtime_info jauge
# AIDE asf_runtime_info Informations Runtime sur ASF sous forme de valeurs d'étiquette
asf_runtime_info{framework=". ET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

Les indicateurs concernant ASF et les bots ont un préfixe dédié asf_ en leur nom. Les autres métriques, par exemple en ce qui concerne le runtime .NET ou le HttpClient d'ASF, sont générées automatiquement sur la base de règles universelles de processus .NET et ne portent pas ce préfixe.

---

Configuration de Prometheus

Une fois que vous avez vérifié que le plugin fonctionne correctement, vous pouvez ajouter une configuration de scrape à votre instance Prometheus en tant que telle :

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: underscores # Supprimer si vous utilisez Prometheus V2. - en savoir plus ci-dessous
    metrics_path: /Api/metrics
    params:
      password:
        - YourIPCPassword
    static_configs:
      - targets:
          - 127. 0.1:1242

Naturellement, vous devez vous assurer que votre instance hébergée Prometheus est en mesure d'accéder à l'interface IPC d'ASF, adaptez password et targets en conséquence à votre utilisation. Si vous n'avez pas de mot de passe IPC défini (ce qui n'est pas recommandé), vous pouvez sauter l'ajout de la section params. Dans le cas où vous exécutez plusieurs instances ASF avec différents mots de passe IPC, vous pouvez ajouter des configurations de scrape supplémentaires, une par instance, car les paramètres de la requête ne peuvent pas être définis sur une base par cible. Sinon, vous pouvez déclarer plusieurs targets s'ils partagent le même mot de passe.

---

Tableau de bord Grafana

Une fois que vos mesures sont collectées par Prometheus, il est possible d'utiliser Grafana pour la visualisation. Le plugin est livré avec /grafana-dashboard. le fichier son servi par les mécanismes IPC standard, donc en supposant que vous exécutiez votre instance ASF avec les paramètres par défaut, vous pouvez le télécharger here. Vous pouvez également récupérer le fichier JSON de notre repository également.

---

Prometheus, tableau de bord Grafana et schéma d'échappement des métriques

ASF prend en charge divers schémas d'échappement de métriques depuis V6.3.8.4, avec une solution unifiée et complète à partir de V6.3.9.4 (dans le cadre de #3607).

Cela provoque malheureusement un léger problème en ce qui concerne notre tableau de bord Grafana, depuis pour que cela fonctionne, vous avez besoin de noms métriques précis tels qu'analysés par Prometheus, et que le logiciel se comporte de deux manières différentes selon que vous utilisez V2. ou la version V3.x de celui-ci. Voir UTF-8 Prometheus docs pour plus d'informations.

En attendant que Prometheus V3.x soit largement adopté (avec debian stable comme ligne directrice actuelle), nous recommandons une approche héritée qui est :

• Notre tableau de bord Grafana est fourni avec les noms de soulignement par défaut, qui sont reconnus par Prometheus V2.x
• Utilisez metric_name_escaping_scheme: underscores dans la configuration d'ASF scrape (comme dans l'exemple ci-dessus), si vous utilisez Prometheus V3.x

C'est parce que, alors que Prometheus V3.x peut être facilement configuré pour utiliser l'approche héritée, Prometheus V2. n'a pas d'option spécifique à un emploi pour forcer le nouveau à être utilisé.

Dans le futur, nous allons probablement refactoriser notre tableau de bord Grafana pour utiliser les nouveaux paramètres recommandés par défaut, et le paramètre ne sera plus nécessaire. Aujourd'hui, cela causerait des problèmes aux anciens utilisateurs de Prometheus, ce qui n'est pas justifié.

Bien sûr, le plugin dans ASF lui-même prend en charge toutes les différentes options de formatage pour que vous puissiez toujours choisir celui que vous aimez et adapter le tableau de bord Grafana à vous-même - nous vous facilitons la tâche avec une simple recommandation de changement de configuration en une ligne.