MonitoringPlugin es ES

MonitoringPlugin

MonitoringPlugin es un plugin oficial de ASF, que te permite monitorear el proceso de ASF a través de la base de datos de serie temporal Prometheus.

Capturas de pantalla

Mostrar

screenshot

Requisitos

Debido a restricciones técnicas, este plugin requiere la variante generic de ASF.

Habilitando el plugin

ASF no viene con MonitoringPlugin empaquetado por defecto, sin embargo, está incluido como una adición opcional en cada versión de ASF. Descarga el plugin desde la publicación oficial que coincida con tu versión de ASF, luego crea un directorio plugins/ArchiSteamFarm.OfficialPlugins.Monitoring dedicado para el plugin, y finalmente extrae ahí el archivo.

En la próxima ejecución de ASF, los registros indicarán que el plugin ha sido cargado exitosamente a través del mecanismo de registro estándar de ASF. También puedes verificar esto navegando a la URL /Api/metrics en tu interfaz IPC. Si estás usando una contraseña para IPC, necesitarás la autorización adecuada, por ejemplo, añadir ?password=<YourIPCPassword> a la URL /Api/metrics. El contenido que verás debería ser similar al siguiente:

# TYPE asf_ipc_banned_ips gauge
# HELP asf_ipc_banned_ips Number of IP addresses currently banned by ASFs IPC module
asf_ipc_banned_ips{otel_scope_name="ArchiSteamFarm",otel_scope_version="6.0.1.21"} 0 1712215803518
# TYPE asf_active_plugins gauge
# HELP asf_active_plugins Number of plugins currently loaded in ASF
asf_active_plugins{otel_scope_name="ArchiSteamFarm",otel_scope_version="6.0.1.21"} 4 1712215803518
# TYPE asf_bots gauge
# HELP asf_bots Number of bots that are currently loaded in ASF
asf_bots{otel_scope_name="ArchiSteamFarm",otel_scope_version="6.0.1.21",state="configured"} 5 1712215803518
asf_bots{otel_scope_name="ArchiSteamFarm",otel_scope_version="6.0.1.21",state="online"} 4 1712215803518
asf_bots{otel_scope_name="ArchiSteamFarm",otel_scope_version="6.0.1.21",state="offline"} 1 1712215803518
asf_bots{otel_scope_name="ArchiSteamFarm",otel_scope_version="6.0.1.21",state="farming"} 0 1712215803518
(...)

Las métricas relativas a ASF y los bots tienen el prefijo dedicado asf_ en su nombre. Otras métricas, por ejemplo, relativas a .NET runtime o el HttpClient de ASF son generadas automáticamente con base en las reglas universales del proceso .NET y no llevan dicho prefijo.

Configuración de Prometheus

Una vez que hayas verificado que el plugin funciona correctamente, puedes añadir una configuración a tu instancia de Prometheus, tal como:

scrape_configs:
  - job_name: ArchiSteamFarm
    metrics_path: /Api/metrics
    params:
      - password:
          - YourIPCPassword
    static_configs:
      - targets:
          - 127.0.0.1:1242

Naturalmente, necesitas asegurarte de que tu instancia de Prometheus es capaz de conectarse con la interfaz IPC de ASF, adapta password y targets de acuerdo a tu uso. Si no tienes establecida una contraseña para IPC (lo cual no se recomienda), puedes omitir la adición de la sección params. En caso de que ejecutes múltiples instancias de ASF con diferentes contraseñas para IPC, puedes añadir configuraciones adicionales, una por instancia, ya que los parámetros de consulta no pueden establecerse por cada objetivo. De lo contrario, puedes declarar varios targets si comparten la misma contraseña.

Grafana dashboard

Una vez que tus métricas sean recolectadas por Prometheus, es posible usar Grafana para su visualización. El plugin viene con el archivo /grafana-dashboard.json servido por mecanismos estándar de IPC, asumiendo que estás ejecutando tu instancia de ASF con los ajustes predeterminados, puedes descargarlo aquí. Alternativamente, también puedes tomar el archivo JSON de nuestro repositorio.