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

---

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_build_info gauge
# HELP asf_build_info Build information about ASF in form of label values
asf_build_info{variant="source",version="6.0.2.5"} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Runtime information about ASF in form of label values
asf_runtime_info{framework=".NET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

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
    metric_name_escaping_scheme: guión bajo # Eliminar si se utiliza Prometheus V2. - leer más abajo
    metrics_path: /Api/metrics
    params:
      password:
        - Su contraseña
    static_configs:
      - targets:
          - 127. .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.

---

Prometheus, tablero de Grafana y esquema de escape de métricas

ASF soporta varios esquemas de escape de métricas desde V6.3.8.4, con solución completa unificada a partir de V6.3.9.4 (como parte de #3607).

Por desgracia, esto causa un ligero problema con respecto a nuestro tablero de Grafana, ya que para que funcione necesitas nombres métricos precisos como son analizados por Prometheus, y que el software se comporte de dos maneras diferentes por defecto dependiendo de si usas las versiones V2.x o V3.x. Revisa UTF-8 Prometheus docs para más información.

Mientras esperamos que Prometheus V3.x sea ampliamente adoptado (con Debian estable como pauta actual), recomendamos el enfoque de legado, que es:

• Nuestro tablero de Grafana por defecto viene con nombres con guion bajo, que son reconocidos por Prometheus V2.x
• Usa metric_name_escaping_scheme: underscores como parte de la configuración de raspado de ASF (como en el ejemplo anterior), si usas Prometheus V3.x

Esto es porque mientras que Prometheus V3.x puede configurarse fácilmente para usar el enfoque de legado, Prometheus V2. no tiene una opción específica para forzar que se use el nuevo.

En el futuro, probablemente refactorizaremos nuestro tablero de Grafana para usar los nuevos valores predeterminados recomendados, y la configuración ya no será requerida. Hoy hacer eso causaría problemas a los usuarios antiguos de Prometheus, lo que no está garantizado.

Por supuesto, el plugin en ASF soporta todas las diferentes opciones de formato, para que puedas elegir la que prefieras y adaptar el tablero de Grafana - solo lo estamos haciendo más fácil al ofrecer una recomendación que se puede cambiar con una sola línea.