From 1ad06b09c2b5546981898fb66d59df270c3a4f99 Mon Sep 17 00:00:00 2001
From: Grigory Bazilevich <g.bazilevich@ispras.ru>
Date: Thu, 6 Mar 2025 23:15:33 +0300
Subject: docs: async + new metrics gathering method
---
README.md | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index a76e690..047ad6c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
## Как это работает
Скрипт бесконечно (до ручного отключения) собирает информацию с сконфигурированных syz-manager с определенных endpoint'ов и сохраняет их последнее состояние, а также лог изменений в коротком виде (количество +, -) и развернутом (весь лог изменений).
+Запуск потоков выполняется с помощью asyncio, что гарантирует запуск получения информации каждые N секунд (поле `timeout` в конфиге).
## Установка
@@ -19,10 +20,13 @@ pip install -r requirements.txt
```json
{
"name": "*Имя менеджера для сохранения результатов и сообщений об ошибках*",
- "http_url": "*Адрес панели инфомации менеджера*"
+ "http_url": "*Адрес панели инфомации менеджера*",
+ "need_expert_mode": "*имеется ли настройка подробности вывода метрик у dashboard*"
}
```
+`need_expert_mode` необходимо для upstream версии, т.к. в ней dashboard изначально выводит лишь основные метрики, а мы хотим собирать полные.
+
Добавление (или отключение) наблюдаемых ручек выполняется через массив endpoints.
На текущий момент важными являются поля `name` и `http_uri`, имеющие аналогичное менеджеру значение.
Кроме того поддерживается парсинг метрик в csv, а также парсинг основной страницы syz-manager dashboard для проверки наличия крешей.
--
cgit mrf-deployment