MonitoringPlugin pl PL

Wtyczka Monitorująca

MonitoringPlugin jest oficjalnym ASF plugin, który pozwala na monitorowanie procesu ASF poprzez Prometheus bazę szeregów czasowych.

---

Zrzuty ekranu

Pokaż

---

Wymagania

Ze względu na ograniczenia techniczne, ta wtyczka wymaga wariantu generic ASF.

---

Włączanie wtyczki

ASF nie posiada domyślnie MonitoringPlugin dołączony do każdego wydania ASF. Pobierz wtyczkę z oficjalnego release, która odpowiada twojej wersji ASF, a następnie utwórz dedykowane plugins/ArchiSteamFarm. katalog fficialPlugins.Monitoring dla wtyczki i wreszcie wypakuj tam archiwum.

Po następnym uruchomieniu ASF dzienniki będą wskazywały, że wtyczka została pomyślnie załadowana za pomocą standardowego mechanizmu logowania ASF. Możesz to również zweryfikować, przechodząc do adresu URL /Api/metrics w swoim interfejsie IPC. Jeśli używasz hasła IPC, będziesz potrzebować poprawnej autoryzacji, np. dołączenie ?password=<YourIPCPassword> do adresu URL /Api/metrics. Zawartość którą widzisz, powinna wyglądać podobnie, jak poniżej:

# TYPE asf_build_info gauge
# HELP asf_build_info Budowanie informacji o ASF w formie wartości etykiet
asf_build_info{variant="source",version="6.0.2. "} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Informacje o ASF w formie wartości etykiet
asf_runtime_info{framework=". ET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

Metryki dotyczące ASF i botów mają dedykowany prefiks asf_ w swojej nazwie. Inne wskaźniki np. dotyczące czasu pracy .NET lub HttpClient ASF są generowane automatycznie na podstawie uniwersalnych reguł procesu .NET i nie mają takiego prefiksu.

---

Konfiguracja Prometheus

Po zweryfikowaniu poprawności wtyczki możesz dodać konfigurację złomowania do swojej instancji Prometheus jako taką:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: podkreślenia # Usuń jeśli używasz Prometheus V2. - czytaj więcej poniżej
    metrics_path: /Api/metrics
    parametry:
      hasło:
        - YourIPCPassword
    static_configs:
      - targets:
          - 127. .0.1:1242

Oczywiście musisz upewnić się, że instancja Prometheus jest w stanie dotrzeć do interfejsu ASF IPC, dostosować odpowiednio password i targets do swojego użycia. Jeśli nie masz ustawionego hasła IPC (co nie jest zalecane), możesz pominąć dodanie sekcji params. Jeśli używasz wielu instancji ASF z różnymi hasłami IPC, możesz dodać dodatkowe konfiguracje złomu, jeden na przykład, ponieważ parametry zapytania nie mogą być ustawione dla każdego celu. W przeciwnym razie możesz zadeklarować kilka targets jeśli używają tego samego hasła.

---

Panel Grafany

Gdy Twoje metryki są zbierane przez Prometheus, możliwe jest użycie Grafana do wizualizacji. Wtyczka zawiera /grafana-dashboard. plik son obsługiwany przez standardowe mechanizmy IPC, więc zakładając, że używasz instancji ASF z domyślnymi ustawieniami, możesz pobrać here. Alternatywnie, możesz również pobrać plik JSON z naszego repository.

---

Schemat unikania wskaźników Prometheus, Grafana

ASF obsługuje różne systemy ucieczki metryk od V6.3.8.4, z uniwersalnym, kompletnym rozwiązaniem zaczynającym się od V6.3.9.4 (jako część #3607).

Niestety, powoduje to nieznaczny problem w odniesieniu do naszej tablicy rozdzielczej Grafany, ponieważ aby to zadziałało, potrzebujesz dokładnych nazw metrycznych, które zostały przeanalizowane przez Prometheus, i to oprogramowanie zachowuje się domyślnie na dwa różne sposoby, w zależności od tego, czy używasz V2. lub V3.x w jego wersji. Zobacz UTF-8 Prometheus docs, aby uzyskać więcej informacji.

Czekając na to, aby Prometheus V3.x został szeroko przyjęty (przy stabilnym debianie jako aktualna wytyczna), zalecamy podejście dotychczasowe, a mianowicie:

• Nasz panel Grafany ma domyślnie nazwy podkreśleń, które są rozpoznawane przez plik Prometheus V2.x
• Użyj metric_name_escaping_scheme: underscores jako części konfiguracji złomu ASF (jak w przykładzie powyżej), jeśli używasz pliku Prometheus V3.x

Dzieje się tak dlatego, że podczas gdy plik V3.x Prometheus można łatwo skonfigurować do stosowania dotychczasowego podejścia, Prometheus V2. nie ma takiej opcji specyficznej dla danej pracy, aby zmusić do zastosowania nowego.

W przyszłości będziemy prawdopodobnie refakturować naszą tablicę rozdzielczą Grafany, aby użyć nowych zalecanych domyślnych ustawień i ustawienia nie będą już wymagane. Dziś takie działanie spowodowałoby problemy dla starszych użytkowników Prometheus, co jest nieuzasadnione.

Oczywiście wtyczka w ASF obsługuje wszystkie różne opcje formatowania, więc zawsze możesz wybrać ten sam, który lubisz i dostosować do niego panel Grafany - po prostu ułatwiamy Ci to dzięki prostej, jednoliniowej zmianie konfiguracji.