MonitoringPlugin ru RU

Плагин мониторинга

MonitoringPlugin является официальным ASF plugin, который позволяет отслеживать процесс ASF через Prometheus базу данных временных рядов.

---

Скриншоты

Раскрыть

---

Требования

Из-за технических ограничений для этого плагина требуется generic вариант ASF.

---

Активация плагина

ASF не поставляется в комплекте MonitoringPlugin по умолчанию, однако он включен в качестве дополнения в каждом релизе ASF. Загрузите плагин с официального релиза, который соответствует вашей версии ASF, а затем создайте выделеннyю папкуplugins/ArchiSteamFarm.OfficialPlugins.Monitoring для плагина, и, наконец, распакуйте архив там.

При следующем запуске ASF логи указывают, что плагин был успешно загружен через стандартный механизм ASF регистрации. Вы также можете проверить это, перейдя по ссылке /Api/metrics в интерфейсе IPC. Если вы используете пароль IPC, вам понадобится соответствующая авторизация, например добавить ?password=<YourIPCPassword> к адресу/Api/metrics. Контент, который вы видите должен выглядеть примерно так:

# TYPE asf_build_info gauge
# HELP asf_build_info Информация о сборке ASF в виде значений меток
asf_build_info{variant="source",version="6.0.2. "} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Информация о работе ASF в виде значений меток
asf_runtime_info{фреймворк=". ET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

Метрики, касающиеся ASF и ботов, в их имени выделены префикс asf_. Другие метрики, например, относительно .NET runtime или HttpClient ASF автоматически генерируются на основе универсальных правил .NET процесса и не содержат такого префикса.

---

Настройка Prometheus

Как только вы подтвердите правильность работы плагина, вы можете добавить конфигурацию scrape к вашему Prometheus как таковую:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: underscores # Remove if using Prometheus V2. - подробнее см. ниже
    metrics_path: /Api/metrics
    params:
      password:
        - YourIPCPassword
    static_configs:
      - цели:
          - 127. .0.1:1242

Естественно, вам нужно убедиться, что ваш хостинг Prometheus способен достичь IPC интерфейса ASF, соответственно адаптируйте password и targets. Если у вас нет пароля IPC (который не рекомендуется), вы можете пропустить добавление раздела params. В случае, если вы запускаете несколько ASF экземпляров с различными IPC паролями, вы можете добавить дополнительные конфигурации обломков, по одному на один случай, так как параметры запроса не могут быть заданы на каждую целевую основу. Иначе вы можете объявить несколько targets, если они разделяют один и тот же пароль.

---

Панель Grafana

Как только ваши метрики собраны Prometheus, можно использовать Grafana для визуализации. Плагин поставляется с /grafana-dashboard. файл son, обслуживаемый стандартными механизмами IPC, поэтому при условии, что вы запустили ваш экземпляр ASF с настройками по умолчанию, вы можете скачать его here. Кроме того, вы также можете захватить файл JSON из нашего repository.

---

Панель управления Prometheus, Grafana и метрики побега

ASF поддерживает различные метрики экранирующих схем с V6.3.8.4, с единым полным решением, начиная с V6.3.9.4 (в качестве части #3607).

К сожалению, это вызывает небольшую проблему в отношении нашей панели инструментов Grafana, так как для этого для работы вам нужны точные метрические имена, которые анализируют Prometheus, и это программное обеспечение ведет себя двумя разными способами по умолчанию в зависимости от того, используете ли вы V2. или V3.x версия. Смотрите UTF-8 Prometheus docs для получения дополнительной информации.

В ожидании широкого внедрения Prometheus V3.x (с стабильной debian в качестве действующего руководства), мы рекомендуем придерживаться:

• Наша панель Grafana поставляется с названиями подчеркивания по умолчанию, которые распознаются Prometheus V2.x
• Используйте metric_name_escaping_scheme: underscores как часть конфигурации ASF (например выше), если используете Prometheus V3.x

Это потому что в то время как Prometheus V3.x можно легко сконфигурировать для использования унаследованного подхода, Prometheus V2. не имеет такого варианта задания для принудительного применения нового.

В будущем мы, скорее всего, рефакторинг нашей панели Grafana использовать рекомендованные значения по умолчанию, и настройка больше не требуется. Сегодня это может вызвать проблемы для старых пользователей Prometheus, что не является гарантией.

Конечно, плагин в самом ASF поддерживает все различные опции форматирования, так что вы всегда можете выбрать тот, который вам нравится, и адаптировать панель Grafana к ней самому. Мы просто делаем ее проще с простой рекомендацией по изменению конфигурации в одной строке.