Skip to content

MonitoringPlugin da DK

ArchiBot edited this page Aug 8, 2026 · 8 revisions

OvervågningPlugin

MonitoringPlugin er en officiel ASF plugin, som giver dig mulighed for at overvåge ASF proces via Prometheus tidsserie database.


Skærmbilleder

Vis

screenshot


Krav

På grund af tekniske begrænsninger, kræver dette plugin 'generisk' variant af ASF.


Aktivering af plugin

ASF kommer ikke med MonitoringPlugin bundtet som standard, men det er inkluderet som valgfri tilføjelse i hver ASF udgivelse. Download plugin fra den officielle release, der matcher din ASF-version, og opret derefter en dedikeret plugins/ArchiSteamFarm. fficialPlugins.Monitoring mappe til plugin, og endelig udtrække arkivet der.

På den næste lancering af ASF, vil logfilerne indikere, at plugin er blevet indlæst med succes gennem standard ASF logning mekanisme. Du kan også bekræfte dette ved at navigere til URL /Api/metrics i din IPC-grænseflade. Hvis du bruger IPC-adgangskode, skal du bruge korrekt godkendelse, f.eks. tilføjelse af ?password=<YourIPCPassword>til URL'en /Api/metrics` Det indhold, du ser, skal se ud som nedenfor:

# TYPE asf_build_info gauge
# HELP asf_build_info Byg information om ASF i form af etiketværdier
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 af etiketværdier
asf_runtime_info{framework=". ET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

Metrics vedrørende ASF og bots har dedikeret præfiks asf_ i deres navn. Andre målinger, f.eks. vedrørende .NET runtime eller ASF's 'HttpClient' genereres automatisk på basis af universelle .NET procesregler og bærer ikke sådanne præfiks.


Prometheus config

Når du har verificeret plugin fungerer korrekt, kan du tilføje en scrape konfiguration til din Prometheus instans som sådan:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: understregninger # Fjern hvis du bruger Prometheus V2. - læs mere nedenfor
    metrics_path: /Api/metrics
    params:
      password:
        - YourIPCPassword
    static_configs:
      - targets:
          - 127. .0.1:1242

Naturligvis skal du sikre, at din hosted Prometheus instans er i stand til at nå ASF's IPC interface, tilpasse password og mål i overensstemmelse hermed til din brug. Hvis du ikke har IPC kodeord indstillet (som ikke anbefales), kan du springe over tilføjelsen af 'params'-sektionen. Hvis du kører flere ASF forekomster med forskellige IPC adgangskoder, kan du tilføje yderligere scrape konfigurationer, en pr. instans, da forespørgselsparametrene ikke kan indstilles på en per-target-basis. Ellers kan du erklære flere 'mål', hvis de deler den samme adgangskode.


Grafana betjeningspanel

Når dine målinger er indsamlet af Prometheus, er det muligt at bruge **Grafana ** til visualisering. Dette plugin leveres med /grafana-dashboard. son fil serveret af standard IPC mekanismer, så forudsat at du kører din ASF instans med standardindstillinger, du kan downloade det here. Alternativt kan du også få fat i JSON-filen fra vores **repository ** også.


Prometheus, Grafana dashboard og målinger undslipper ordning

ASF understøtter forskellige målinger undslipper ordninger siden V6.3.8.4, med samlet, komplet løsning startende fra V6.3.9.4 (som en del af #3607).

Det giver desværre anledning til et lille problem i forbindelse med vores Grafana-instrumentbræt da for at det kan fungere, du har brug for præcise metriske navne som fortolket af Prometheus, og at software opfører sig på to forskellige måder som standard, afhængigt af om du bruger V2. eller V3.x version af den. Se UTF-8 Prometheus docs for mere info.

Mens vi venter på Prometheus V3.x at få bredt vedtaget (med debian stabil som nuværende retningslinje), anbefaler vi arven tilgang, der er:

  • Vores Grafana dashboard kommer med understregning navne som standard, der er anerkendt af Prometheus V2.x
  • Brug metric_name_escaping_scheme: understregning som en del af ASF scrape config (som i eksempel ovenfor), hvis du bruger Prometheus V3.x

Dette skyldes, at mens Prometheus V3.x nemt kan konfigureres til at bruge arven tilgang, Prometheus V2. har ikke en sådan jobspecifik mulighed for at tvinge den nye, der skal anvendes.

I fremtiden vil vi sandsynligvis refaktorisere vores Grafana dashboard for at bruge de nye anbefalede standardindstillinger, og indstillingen vil ikke længere være påkrævet. I dag gør det ville forårsage problemer for ældre Prometheus brugere, som ikke er berettiget.

Selvfølgelig plugin i ASF selv understøtter alle forskellige formatering muligheder, så du altid kan vælge den du kan lide og tilpasse Grafana instrumentbrættet til det selv - vi gør det bare lettere for dig med en simpel one-line config ændre anbefaling.

Clone this wiki locally