MonitoringPlugin cs CZ

MonitoringPlugin

MonitoringPlugin je oficiální ASF plugin, který vám umožňuje sledovat proces ASF prostřednictvím Prometheus databáze časových řad.

---

Snímek obrazovky

Zobrazit

---

Požadavky

Kvůli technickým omezením, tento plugin vyžaduje generic variantu ASF.

---

Povolení pluginu

ASF není přichází s MonitoringPlugin ve výchozím nastavení ve svazku, ale v každém vydání ASF je zahrnut jako volitelný doplněk. Stáhněte si plugin z oficiálního release, který odpovídá vaší verzi ASF, pak vytvořte vyhrazený plugins/ArchiSteamFarm. fficialPlugins.Monitoring adresář pro zásuvný modul a konečně rozbalte archiv tam.

Při příštím spuštění ASF, logy budou znamenat, že plugin byl úspěšně načten pomocí standardního ASF logovacího mechanismu. Můžete to také ověřit navigací na adresu /Api/metrics ve vašem IPC rozhraní. Pokud používáte IPC heslo, budete potřebovat řádné autorizaci, např. appending ?password=<YourIPCPassword> na /Api/metrics URL. Obsah, který vidíte, by měl vypadat podobně jako níže:

# TYPE asf_build_info měřidlo
# HELP asf_build_info Informace o ASF v podobě hodnot označení
asf_build_info{variant="source",version="6.0.2. "} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Runtime informace o ASF v podobě hodnot štítku
asf_runtime_info{framework=". ET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

Metriky týkající se ASF a botů mají ve svém jménu vyhrazenou prefix asf_. Další metriky, např. pokud jde o běh .NET nebo ASF HttpClient jsou automaticky generovány na základě všeobecných pravidel procesu .NET a neobsahují takovou prefix.

---

Nastavení Prometheus

Jakmile ověříte, že zásuvný modul funguje správně, můžete přidat konfiguraci skriptů do vaší instance Prometheus:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: podtržítka # Odebrat pokud používáte Prometheus V2. - přečtěte si více níže
    metrics_path: /Api/metrics
    params:
      heslo:
        - YourIPCPassword
    static_configs:
      - Cíly:
          - 127. .0.1:1242

Přirozeně se musíte ujistit, že vaše hostovaná instance Prometheus je schopna dosáhnout rozhraní IPC ASF, odpovídajícím způsobem přizpůsobte heslo a cíle Vašemu používání. Pokud nemáte nastavenou IPC heslo (což není doporučeno), můžete přeskočit přidání sekce params. V případě, že používáte více instancí ASF s různými IPC hesly, můžete přidat další nastavení scrape jeden na jednu instanci, protože parametry dotazu nelze nastavit na základě jednotlivých cílů. V opačném případě můžete vyhlásit několik cílů, pokud sdílejí stejné heslo.

---

Nástěnka Grafany

Jakmile jsou vaše metriky shromážděny Prometheusem, je možné použít Grafana pro vizualizaci. Plugin přichází s /grafana-dashboard. son soubor obsluhovaný standardními mechanismy IPC, takže za předpokladu, že používáte instanci ASF s výchozím nastavením, můžete si jej stáhnout here. Případně můžete také uchytit soubor JSON z našich repository.

---

Prometheus, Grafana dashboard a metrika unikající schéma

ASF podporuje různá metrická schémata od V6.3.8.4, s jednotným a kompletním řešením začínajícím od V6.3.9.4 (jako součást #3607).

To naneštěstí způsobuje lehký problém našemu řídícímu panelu Grafany, pro to potřebujete přesné metrické názvy podle Prometheus, a tento software se ve výchozím nastavení chová dvěma různými způsoby v závislosti na tom, zda používáte V2. " nebo V3.x` jeho verze. Více informací viz UTF-8 Prometheus docs.

Zatímco čekáme na široce přijaté Prometheus V3.x (s debianovou stabilitou jako aktuální příručka), doporučujeme starší přístup, tj.:

• Náš nástěnka Grafany má ve výchozím nastavení podtržítka, která jsou rozpoznána Prometheus V2.x
• Používejte metric_name_escaping_scheme: underscores jako součást ASF scrape config (jako například výše), pokud používáte Prometheus V3.x

Je tomu tak proto, že zatímco Prometheus V3.x může být snadno nakonfigurován tak, aby používal starší přístup, Prometheus V2. nemá žádnou takovou možnost pro konkrétní zaměstnání, která by nutila použít novou.

V budoucnu pravděpodobně revalvujeme náš nástěnku Grafana a použijeme nová doporučená výchozí nastavení a nastavení již nebude vyžadováno. Dnes by to způsobilo problémy starším Prometheusovým uživatelům, což není oprávněné.

Samozřejmě, zásuvný modul v aplikaci ASF podporuje všechny různé možnosti formátování, Vždy si můžete vybrat ten, který se vám líbí a přizpůsobit Grafanově nástěnce - jen vám to usnadňujeme s jednoduchým jednořádkovým doporučením pro změnu konfigurace.