MonitoringPlugin de DE

Überwachungserweiterung

Die Überwachungserweiterung ist eine offizielles ASF Erweiterung, welche Ihnen erlaubt den ASF Fortschritt mittels Prometheus Datenbanken zu überwachen.

---

Screenshots

Anzeigen

---

Voraussetzungen

Aufgrund technischer Einschränkungen erfordert diese Erweiterung eine generische Variante von ASF.

---

Aktivierung der Erweiterung

ASF wird nicht standardmäßig mit der Überwachungserweiterung ausgeliefert, es ist jedoch als optionale Erweiterung in jeder ASF Version enthalten. Laden Sie die Erweiterung aus der offiziellen Version, die Ihrer ASF Version entspricht, herunter, erstellen Sie dann ein eigenes Verzeichnis plugins/ArchiSteamFarm.OfficialPlugins.Monitoring für die Erweiterung und entpacken Sie das Archiv dorthin.

Beim nächsten Start von ASF wird in den Protokollen angezeigt, dass die Erweiterung über den Standard ASF Protokollierer erfolgreich geladen wurde. Sie können dies auch überprüfen, indem Sie in Ihrer IPC Schnittstelle zur URL /Api/metrics navigieren. Wenn Sie ein IPC Passwort verwenden, benötigen Sie eine entsprechende Autorisierung, z.B. durch das Anhängen von ?password=<YourIPCPassword> an die URL /Api/metrics. Der Inhalte, den Sie sehen, sollte ähnlich wie unten aussehen:

# TYPE asf_build_info gauge
# HELP asf_build_info Build information about ASF in form of label values
asf_build_info{variant="source",version="6.0.2.5"} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Runtime information about ASF in form of label values
asf_runtime_info{framework=".NET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

Messwerte, die ASF und die Bots betreffen, haben das asf_ Präfix im Namen. Andere Messwerte, welche z.B. die .NET Laufzeit oder den HttpClient von ASF betreffen, werden automatisch auf der Grundlage universeller .NET Prozessregeln generiert und tragen kein solches Präfix.

---

Prometheus Konfiguration

Sobald Sie sichergestellt haben, dass die Erweiterung korrekt funktioniert, können sie eine Scrape Konfiguration zu Ihrer Prometheus Instanz hinzufügen, wie:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: unterstreicht # Entfernen wenn Prometheus V2. - Lesen Sie weiter unten
    metrics_path: /Api/metrics
    Parameter:
      Passwort:
        - YourIPCPassword
    static_configs:
      - Ziele:
          - 127. 0.0.1:1242

Natürlich müssen Sie sicherstellen, dass Ihre gehostete Prometheus Instanz in der Lage ist, die IPC Schnittstelle von ASF zu erreichen, passen Sie password und targets dementsprechend an. Wenn Sie kein IPC Passwort vergeben haben (was nicht empfohlen wird), können Sie das Hinzufügen des Abschnitts params überspringen. Falls Sie mehrere ASF Instanzen mit unterschiedlichen IPC Passwörtern betreiben, können Sie zusätzliche Scrape Konfigurationen hinzufügen, pro Instanz eine, da die Abfrageparameter nicht pro Ziel festgelegt werden können. Andernfalls können Sie mehrere Ziele angeben, wenn sie das gleiche Kennwort haben.

---

Grafana Dashboard

Sobald Ihre Messwerte von Prometheus erfasst wurden, ist es möglich Grafana zur Visualisierung zu verwenden. Die Erweiterung wird mit der Datei /grafana-dashboard.json geliefert, die über Standard IPC Mechanismen bereitgestellt wird. Wenn Sie also Ihre ASF-Instanz mit den Standardeinstellungen betreiben, können Sie es hier herunterladen. Alternativ können Sie die JSON-Datei auch aus unserem Repository herunterladen.

---

Prometheus, Grafana Dashboard und Metriken Escaping Schema

ASF unterstützt verschiedene Metriken seit V6.3.8.4, mit einheitlicher, vollständiger Lösung ab V6.3.9.4 (als Teil von #3607).

Das wirft leider ein kleines Problem in Bezug auf unser Grafana-Dashboard auf da Sie dafür genaue metrische Namen benötigen, wie von Prometheus analysiert und die Software verhält sich in zwei verschiedenen Weisen standardmäßig abhängig davon, ob Sie V2. oder V3.x Version davon. Siehe UTF-8 Prometheus docs für weitere Informationen.

Während wir darauf warten, dass Prometheus V3.x weithin angenommen wird (mit debian stable als aktuelle Richtlinie), empfehlen wir einen Legacy-Ansatz, das heißt:

• Unser Grafana-Dashboard enthält standardmäßig Unterstrich-Namen, die von Prometheus V2.x erkannt werden
• Verwende metric_name_escaping_scheme: unterstrichen als Teil der ASF scrape config (wie im Beispiel oben), wenn Prometheus V3.x verwendet wird

Dies liegt daran, dass, während Prometheus V3.x leicht konfiguriert werden kann, um den Legacy Ansatz, Prometheus V2. hat keine solche Job-spezifische Option, um die neue zu verwenden.

In Zukunft werden wir wahrscheinlich unser Grafana-Dashboard neu berechnen und die neuen empfohlenen Standardwerte verwenden und die Einstellung wird nicht mehr benötigt. Dies würde heute zu Problemen für ältere Prometheus-Nutzer führen, was nicht gerechtfertigt ist.

Natürlich unterstützt das Plugin in ASF selbst alle verschiedenen Formatierungsoptionen, damit Sie immer das passende auswählen und das Grafana-Dashboard selbst an das Programm anpassen können - wir machen es Ihnen einfach mit einer einfachen Ein-Zeilen-Änderungsempfehlung.