MonitoringPlugin sv SE

ÖvervakningPlugin

MonitoringPlugin är en officiell ASF plugin, som låter dig övervaka ASF-processen via Prometheus tidsseriedatabas.

---

Skärmdumpar

Visa

---

Krav

På grund av tekniska begränsningar, kräver denna plugin generic variant av ASF.

---

Aktiverar plugin

ASF innehåller inte MonitoringPlugin som standard men ingår som tillägg i varje ASF-utgåva. Ladda ner insticksprogrammet från den officiella release som matchar din ASF-version och skapa sedan en dedikerad plugins/ArchiSteamFarm. fficialPlugins.Monitoring-katalogen för plugin, och slutligen extrahera arkivet där.

Vid nästa lansering av ASF, loggarna kommer att indikera att plugin har laddats framgångsrikt genom standard ASF loggningsmekanism. Du kan också verifiera detta genom att navigera till /Api/metrics-URL i ditt IPC-gränssnitt. Om du använder IPC-lösenordet behöver du korrekt behörighet, t.ex. lägga till ?password=<YourIPCPassword> till /Api/metrics URL. Innehållet du ser ska se ut som nedan:

# TYPE asf_build_info gauge
# HELP asf_build_info Bygg information om ASF i form av etikettvärden
asf_build_info{variant="source",version="6.0.2. "} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Runtime information om ASF i form av etikettvärden
asf_runtime_info{framework=". ET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

Mätningar gällande ASF och robotarna har dedikerat prefixet asf_ i deras namn. Andra mätvärden t.ex. avseende .NET runtime eller ASF's HttpClient genereras automatiskt baserat på universella .NET-processregler och har inte ett sådant prefix.

---

Prometheus konfiguration

När du har verifierat att insticksprogrammet fungerar korrekt, kan du lägga till en skrapkonfiguration till din Prometheus instans som sådan:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: understreck # Ta bort om du använder Prometheus V2. - läs mer nedan
    metrics_path: /Api/metrics
    parametrar:
      lösenord:
        - YourIPCPassword
    static_configs:
      - targets:
          - 127. .0.1:1242

Naturligtvis måste du se till att din värd Prometheus instans kan nå ASFs IPC-gränssnitt, anpassa password och targets i enlighet med din användning. Om du inte har IPC-lösenord (vilket inte rekommenderas) kan du hoppa över tillägget av params-sektionen. Om du kör flera ASF-instanser med olika IPC-lösenord kan du lägga till ytterligare skrapkonfigurationer, en per exempel, eftersom frågeparametrar inte kan ställas in per mål-basis. Annars kan du deklarera flera mål om de delar samma lösenord.

---

Grafana instrumentpanel

När dina mätvärden är samlade av Prometheus är det möjligt att använda Grafana för visualisering. Pluginen levereras med /grafana-instrumentbrädan. son-fil som betjänas av standard IPC-mekanismer, så förutsatt att du kör din ASF-instans med standardinställningar, du kan ladda ner den here. Alternativt kan du också ta JSON-filen från vår repository också.

---

Prometheus, Grafana instrumentbräda och mätvärden flyr systemet

ASF stöder olika mätsystem sedan V6.3.8.4, med enhetlig, komplett lösning med start från V6.3.9.4 (som del av #3607).

Detta orsakar tyvärr en liten fråga när det gäller vår Grafana instrumentbräda, sedan för att det ska fungera behöver du exakta metriska namn som tolkas av Prometheus, och att programvaran beter sig på två olika sätt som standard beroende på om du använder V2. eller V3.x version av den. Se UTF-8 Prometheus docs för mer info.

I väntan på att Prometheus V3.x ska bli allmänt antagen (med debian stable som nuvarande riktlinjer) rekommenderar vi ett äldre tillvägagångssätt, det vill säga

• Vår Grafana instrumentpanel kommer med understreck namn som standard, som känns igen av Prometheus V2.x
• Använd metric_name_escaping_scheme: underscores som en del av ASF-skrapkonfiguration (som i exempel ovan), om Prometheus V3.x

Detta beror på att, medan Prometheus V3.x lätt kan konfigureras för att använda äldre tillvägagångssätt, Prometheus V2. har inget sådant jobbspecifikt alternativ för att tvinga den nya att användas.

I framtiden kommer vi sannolikt att refaktorisera vår Grafana instrumentpanel för att använda de nya rekommenderade standardinställningarna, och inställningen kommer inte längre att krävas. I dag skulle detta orsaka problem för äldre Prometheus-användare, vilket inte är motiverat.

Naturligtvis stöder plugin i ASF själv alla olika formateringsalternativ, så att du alltid kan välja den du gillar och anpassa Grafana instrumentpanelen till den själv - vi gör det bara enklare för dig med en enkel en-line config change rekommendation.