MonitoringPlugin nl NL

MonitoringPlugin

MonitoringPlugin is een officiële ASF plugin, waarmee u ASF kunt monitoren via Prometheus tijdseizoendatabase.

---

Schermafbeeldingen

Toon

---

Vereisten

Vanwege technische beperkingen, heeft deze plugin generic variant van ASF nodig.

---

De plugin inschakelen

ASF komt niet met MonitoringPlugin gebundeld, maar het is standaard opgenomen als optionele toevoeging in elke ASF release. Download de plugin van de officiële release die overeenkomt met uw ASF-versie, en maak daarna een speciaal plugins/ArchiSteamFarm. De map fficialPlugins.Monitoring voor de plugin en pak het archief daar eindelijk uit.

Bij de volgende lancering van ASF zullen de logs aangeven dat de plugin met succes is geladen via het standaard ASF-logmechanisme. Je kunt dit ook verifiëren door te navigeren naar de /Api/metrics URL in je IPC interface. Als u een IPC-wachtwoord gebruikt, moet u de juiste autorisatie gebruiken, bijvoorbeeld '?password=' toevoegen aan de /Api/metrics URL. De inhoud die je ziet zou er net zo uit moeten zien als hieronder:

# TYPE asf_build_info gauge
# HELP asf_build_info Build informatie over ASF in de vorm van label waarden
asf_build_info{variant="source",version="6.0.2. "} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Runtime informatie over ASF in de vorm van label waarden
asf_runtime_info{framework=". ET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

Metrieken met betrekking tot ASF en de bots hebben een speciale prefix asf_ in hun naam. Andere statistieken, bijvoorbeeld met betrekking tot de .NET runtime of ASF's 'HttpClient' worden automatisch gegenereerd op basis van universele .NET procesregels en dragen geen prefix.

---

Prometheus configuratie

Zodra u heeft geverifieerd dat de plugin correct werkt, kunt u een scrape configuratie toevoegen aan uw Prometheus instantie als dus:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: underscores # Verwijderen als Prometheus V2 wordt gebruikt. - lees meer onder
    metrics_path: /Api/metrics
    params:
      password:
        - YourIPCPassword
    static_configs:
      - targets:
          - 127. .0.1:1242

Natuurlijk moet u ervoor zorgen dat uw gehoste Prometheus instantie de ASF's IPC interface kan bereiken pas password en targets dus aan op jouw gebruik. Als u geen IPC wachtwoord hebt ingesteld (wat niet wordt aanbevolen), kunt u de toevoeging van de params sectie overslaan. In het geval je meerdere ASF-instanties met verschillende IPC-wachtwoorden gebruikt, kun je extra schraapconfiguraties toevoegen, één per voorbeeld, omdat de queryparameters niet per doel kunnen worden ingesteld. Anders kan je meerdere targets opgeven als ze hetzelfde wachtwoord delen.

---

Grafana dashboard

Zodra je statistieken verzameld zijn door Prometheus, is het mogelijk om Grafana te gebruiken voor visualisatie. De plugin komt met /grafana-dashboard. son bestand geserveerd met standaard IPC mechanismen, dus ga ervan uit dat je jouw ASF instantie draait met standaard instellingen, je kan het downloadenhere. Als alternatief kun je ook het JSON-bestand van onzerepository pakken.

---

Prometheus, Grafana dashboard en statistieken

ASF ondersteunt verschillende metrieken ontsnappingsschema's sinds V6.3.8.4, met verenigde, volledige oplossing beginnend op V6.3.9.4 (als onderdeel van #3607).

Dit stelt helaas een klein probleem in verband met ons Grafana dashboard, Omdat je daarvoor nauwkeurige metrische namen nodig hebt zoals Prometheus, en die software gedraagt zich op twee verschillende manieren standaard afhankelijk van het gebruik van V2. of V3.x versie ervan. Zie UTF-8 Prometheus documenten voor meer informatie.

Terwijl we wachten tot Prometheus V3.x breed geadopteerd wordt (met debiaanse stabiliteit als huidige richtlijn), raden we de aanpak aan:

• Ons Grafana dashboard komt standaard met underscore namen, die herkend worden door Prometheus V2.x
• Gebruik metric_name_escaping_scheme: underscores als onderdeel van de ASF scrape config (zoals in het voorbeeld hierboven), als je Prometheus V3.x gebruikt

Dit is omdat hoewel Prometheus V3.x gemakkelijk kan worden geconfigureerd om de oude benadering te gebruiken, Prometheus `V2. heeft een dergelijke werkgelegenheidsspecifieke optie om de nieuwe te forceren te gebruiken.

In de toekomst zullen we waarschijnlijk ons Grafana dashboard herfactor om de nieuwe aanbevolen standaardwaarden te gebruiken, en de instelling zal niet langer nodig zijn. Vandaag de dag zou dat de oudere Prometheus gebruikers in de problemen brengen, wat niet gerechtvaardigd is.

Natuurlijk ondersteunt de plugin in ASF zelf alle verschillende opmaakmogelijkheden, zodat u altijd de gewenste kunt kiezen en het Grafana dashboard zelf aan kunt passen - we maken het eenvoudig voor u met een eenvoudige aanbeveling voor het wijzigen van configuratie in één regel.