MonitoringPlugin it IT

MonitoringPlugin

MonitoringPlugin è un ASF ufficiale plugin, che consente di monitorare il processo di ASF tramite Prometheus banca dati serie temporali.

---

Screenshot

Mostra

---

Requisiti

A causa di vincoli tecnici, questo plugin richiede la variante generic di ASF.

---

Abilitare il plugin

ASF non viene fornito con MonitoringPlugin in bundle per impostazione predefinita, tuttavia, è incluso come aggiunta opzionale in ogni rilascio di ASF. Scarica il plugin dalla versione ufficiale release che corrisponde alla tua versione di ASF, quindi crea un plugins/ArchiSteamFarm. fficialPlugins.Monitoring directory per il plugin, ed infine estrarre l'archivio lì.

Al prossimo lancio di ASF, i registri indicheranno che il plugin è stato caricato con successo attraverso il meccanismo di registrazione ASF standard. Puoi anche verificarlo navigando all'URL /Api/metrics nella tua interfaccia IPC. Se stai usando la password IPC, avrai bisogno di un'autorizzazione adeguata, ad esempio aggiungendo ?password=<YourIPCPassword> all'URL /Api/metrics. Il contenuto che vedi dovrebbe apparire simile a sotto:

# TYPE asf_build_info gauge
# HELP asf_build_info Costruisci informazioni su ASF sotto forma di valori di etichetta
asf_build_info{variant="source",version="6.0.2. "} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Informazioni sull'esecuzione di ASF in forma di valori di etichetta
asf_runtime_info{framework=". ET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

Le metriche riguardanti ASF e i bot hanno dedicato il prefisso asf_ a loro nome. Altre metriche, ad esempio per quanto riguarda il runtime .NET o il HttpClient di ASF, vengono generate automaticamente in base alle regole di processo .NET universali e non portano tale prefisso.

---

Configurazione di Prometheus

Una volta verificato che il plugin funziona correttamente, è possibile aggiungere una configurazione scrape alla tua istanza Prometheus come tale:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: underscore # Remove se si utilizza Prometheus V2. - leggi di più sotto
    metrics_path: /Api/metrics
    params:
      password:
        - YourIPCPassword
    static_configs:
      - targets:
          - 127. .0.1:1242

Naturalmente, è necessario assicurarsi che l'istanza Prometheus ospitata sia in grado di raggiungere l'interfaccia IPC di ASF, adatta di conseguenza password e targets al tuo utilizzo. Se non si dispone di un set di password IPC (che non è raccomandato), è possibile saltare l'aggiunta della sezione params. Nel caso in cui stai eseguendo più istanze di ASF con diverse password IPC, puoi aggiungere ulteriori configurazioni di scrape, uno per esempio, poiché i parametri della query non possono essere impostati per ogni obiettivo. Altrimenti, puoi dichiarare più targets se condividono la stessa password.

---

Cruscotto Grafana

Una volta che le metriche sono raccolte da Prometheus, è possibile utilizzare Grafana per la visualizzazione. Il plugin viene fornito con /grafana-dashboard. file son servito da meccanismi IPC standard, quindi supponendo che tu stia eseguendo la tua istanza ASF con impostazioni predefinite, puoi scaricarlo here. In alternativa, puoi anche prendere il file JSON dalla nostra repository

---

Schema di scappamento Prometheus, Grafana e metriche

ASF supporta vari schemi di escape delle metriche da V6.3.8.4, con una soluzione unificata e completa a partire da V6.3.9.4 (come parte di #3607).

Questo purtroppo causa un leggero problema per quanto riguarda il nostro cruscotto Grafana, dal momento che per lavorare è necessario precisi nomi metrici come analizzati da Prometheus, e che il software si comporta in due modi diversi per impostazione predefinita a seconda che si utilizzi V2. o V3.x versione di esso. Vedi UTF-8 Prometheus docs per maggiori informazioni.

In attesa che Prometheus V3.x diventi ampiamente adottato (con debian stabile come linea guida attuale), si consiglia l'approccio legacy, cioè:

• Il nostro cruscotto Grafana viene fornito con nomi di sottolineatura per impostazione predefinita, che sono riconosciuti da Prometheus V2.x
• Usa metric_name_escaping_scheme: underscores come parte della configurazione di ASF scrape (come ad esempio sopra), se usi Prometheus V3.x

Questo perché, mentre Prometheus V3.x può essere facilmente configurato per utilizzare l'approccio legacy, Prometheus V2. non ha questa opzione specifica per il lavoro per forzare l'uso di quella nuova.

In futuro, probabilmente rifletteremo il nostro cruscotto Grafana per utilizzare i nuovi valori predefiniti raccomandati, e l'impostazione non sarà più richiesta. Oggi fare questo causerebbe problemi per gli utenti Prometheus più anziani, che non è giustificato.

Naturalmente, il plugin in ASF stesso supporta tutte le diverse opzioni di formattazione, in modo da poter sempre scegliere quello che ti piace e adattare il cruscotto Grafana ad esso da soli - stiamo semplicemente rendendo più facile per voi con un semplice consiglio di modifica di una riga di configurazione.