MonitoringPlugin uk UA

Моніторинг та плагін

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

---

Скріншоти

Show

---

Вимоги

Через технічні обмеження, цей плагін вимагає generic варіант ASF.

---

Увімкнення плагіна

ASF не прийде за замовчуванням з MonitoringPlugin, проте він містить необов'язкове доповнення до кожного випуску ASF. Завантажити плагін з офіційного release, який відповідає вашій версії ASF, потім створити виділений plugins/ArchiSteamFarm. каталог fficialPlugins.Monitoring для плагіна і нарешті витягує архів там.

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

# 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
(...)

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

---

Конфігурація Prometheus

Once you verified the plugin is working correctly, you can add a scrape configuration to your Prometheus instance as such:

scrape_configs:
  - job_name: Архівування SteamFarm
    metric_name_escaping_scheme: підкреслення # Видалити, якщо використовується Prometheus V2. - прочитайте нижче
    metrics_path: /Api/metrics
    params:
      password:
        - YourIPCPassword
    static_configs:
      - цілі,
          - 127. .0.1:1242

Naturally, you need to ensure that your hosted Prometheus instance is able to reach ASF's IPC interface, adapt password and targets accordingly to your usage. Якщо у вас немає пароля IPC (яку не рекомендується), ви можете пропустити розділ "params". Якщо ви запускаєте декілька екземплярів ASF з різними IPC паролями, ви можете додати додаткові конфігурації шкрябання, для певної міри, як параметри запиту не можуть бути встановлені на цільовій основі. В іншому випадку ви можете оголосити кілька targets, якщо вони мають той же пароль.

---

Панель Grafana

Як тільки ваші показники будуть зібрані Prometheus, він має можливість використати Grafana для візуалізації. The plugin comes with /grafana-dashboard.json file served by standard IPC mechanisms, so assuming you're running your ASF instance with default settings, you can download it here. Крім того, ви також можете забрати файл JSON з нашого repository.

---

Панель керування Prometheus, Grafana та метрики, що екранують схему

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

На жаль, це не викликає невеликої проблеми з нашою панеллю Grafana з цього моменту для роботи вам потрібні точні метричні назви від проаналізованих Prometheus, і це програмне забезпечення має два різних способи використання за замовчуванням в залежності від використання V2. або V3.x версія. Перегляньте UTF-8 документацію Prometheus для отримання додаткової інформації.

Не дивлячись на те, що Prometheus V3.x буде широко прийнято (з дебійськими стабільними як поточною інструкцією), ми рекомендуємо застарілий підхід, це:

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

Це тому, що хоча Prometheus "V3.x" може бути легко налаштований для використання спадного підходу, Prometheus "V2. ` не має жодної можливості, специфічної для роботи, щоб змусити нову використовувати.

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

Звичайно, плагін у ASF сам по собі підтримує різні параметри форматування, так що ви завжди можете обрати улюблену панель і адаптувати її до себе на головній сторінці Grafana - ми полегшуємо вам простий варіант синхронізації з однорядковою конфігурацією.