docs: fix README formatting and add missing robot_id step
- Close unclosed YAML code block (table was inside it) - Fix code block indentation inside numbered lists (3->4 spaces) - Align comments in directory tree listing - Add explicit robot_id step to 'Adding new scenario' guide - Remove stale production IP from config example
This commit is contained in:
parent
bec273d7ac
commit
99c30d4993
40
README.md
40
README.md
@ -59,9 +59,9 @@ Zabbix агент по запросу сервера запускает скри
|
|||||||
2. Привязать шаблон к хосту (Configuration → Hosts → выберите хост → Templates)
|
2. Привязать шаблон к хосту (Configuration → Hosts → выберите хост → Templates)
|
||||||
3. В конфиге монитора `config/config.yaml` установить `mode: "userparameter"`
|
3. В конфиге монитора `config/config.yaml` установить `mode: "userparameter"`
|
||||||
4. В `/etc/zabbix/zabbix_agentd.conf` добавить строку:
|
4. В `/etc/zabbix/zabbix_agentd.conf` добавить строку:
|
||||||
```
|
```
|
||||||
Include=/opt/ses-monitor/config/zbx_agentd_ses.conf
|
Include=/opt/ses-monitor/config/zbx_agentd_ses.conf
|
||||||
```
|
```
|
||||||
5. Перезапустить Zabbix агента: `sudo systemctl restart zabbix-agent`
|
5. Перезапустить Zabbix агента: `sudo systemctl restart zabbix-agent`
|
||||||
|
|
||||||
## Структура проекта
|
## Структура проекта
|
||||||
@ -89,7 +89,7 @@ Zabbix агент по запросу сервера запускает скри
|
|||||||
├── zabbix/
|
├── zabbix/
|
||||||
│ ├── zbx_ses_template_5.0.xml # Шаблон для sender (trapper)
|
│ ├── zbx_ses_template_5.0.xml # Шаблон для sender (trapper)
|
||||||
│ ├── zbx_ses_template_5.0_up.xml # Шаблон для UserParameter
|
│ ├── zbx_ses_template_5.0_up.xml # Шаблон для UserParameter
|
||||||
│ └── zbx_ses_monitor.conf # UserParameter для Zabbix агента
|
│ └── zbx_ses_monitor.conf # UserParameter для Zabbix агента
|
||||||
├── scripts/
|
├── scripts/
|
||||||
│ └── zbx_get.py # Скрипт чтения JSON для UserParameter
|
│ └── zbx_get.py # Скрипт чтения JSON для UserParameter
|
||||||
├── systemd/
|
├── systemd/
|
||||||
@ -143,8 +143,8 @@ nano config/config.yaml
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
ses:
|
ses:
|
||||||
base_url: "http://10.101.60.31:6190" # URL вашего SES API
|
base_url: "http://YOUR_SES_HOST:6190" # URL вашего SES API
|
||||||
channel: "monitoring" # Имя канала в архиве
|
channel: "monitoring" # Канал для мониторинговых сессий
|
||||||
request_timeout: 30
|
request_timeout: 30
|
||||||
|
|
||||||
zabbix:
|
zabbix:
|
||||||
@ -195,7 +195,7 @@ journalctl -u ses-monitor -f
|
|||||||
### Полный формат
|
### Полный формат
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Имя сценария (используется в логах и ключах Zabbix)
|
# Имя сценария (используется в логах)
|
||||||
name: "example: проверка диалога"
|
name: "example: проверка диалога"
|
||||||
|
|
||||||
# Описание для документации
|
# Описание для документации
|
||||||
@ -236,6 +236,7 @@ steps:
|
|||||||
equals: 0
|
equals: 0
|
||||||
- path: "answer"
|
- path: "answer"
|
||||||
not_empty: true
|
not_empty: true
|
||||||
|
```
|
||||||
|
|
||||||
### Условия проверки (expect)
|
### Условия проверки (expect)
|
||||||
|
|
||||||
@ -266,22 +267,22 @@ path: "request.data[0].reply.confidence"
|
|||||||
## Как адаптировать под ваш проект
|
## Как адаптировать под ваш проект
|
||||||
|
|
||||||
1. **Узнайте robot_id** вашего сценария:
|
1. **Узнайте robot_id** вашего сценария:
|
||||||
```bash
|
```bash
|
||||||
curl -s http://<ses-host>:6190/ses/robot/listall
|
curl -s http://<ses-host>:6190/ses/robot/listall
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Пропишите robot_id** в файле сценария (поле `robot_id` в YAML)
|
2. **Пропишите robot_id** в файле сценария (поле `robot_id` в YAML)
|
||||||
|
|
||||||
3. **Создайте файл сценария**, описав шаги диалога:
|
3. **Создайте файл сценария**, описав шаги диалога:
|
||||||
```bash
|
```bash
|
||||||
cp config/scenarios/example_liveness.yaml config/scenarios/$(hostname).yaml
|
cp config/scenarios/example_liveness.yaml config/scenarios/$(hostname).yaml
|
||||||
vim config/scenarios/$(hostname).yaml
|
vim config/scenarios/$(hostname).yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Протестируйте вручную** шаги через curl:
|
4. **Протестируйте вручную** шаги через curl:
|
||||||
```bash
|
```bash
|
||||||
curl -X POST "http://<ses-host>:6190/ses/ask/<robot_id>?text=Привет&channel=monitoring"
|
curl -X POST "http://<ses-host>:6190/ses/ask/<robot_id>?text=Привет&channel=monitoring"
|
||||||
```
|
```
|
||||||
|
|
||||||
5. **Запустите демон** — метрики агрегируются автоматически (шаблон Zabbix универсален)
|
5. **Запустите демон** — метрики агрегируются автоматически (шаблон Zabbix универсален)
|
||||||
|
|
||||||
@ -291,8 +292,9 @@ path: "request.data[0].reply.confidence"
|
|||||||
|
|
||||||
1. Создать `config/scenarios/my_scenario.yaml`
|
1. Создать `config/scenarios/my_scenario.yaml`
|
||||||
2. Скопировать структуру из примеров
|
2. Скопировать структуру из примеров
|
||||||
3. Описать шаги и ожидания
|
3. Указать `robot_id` вашего робота (узнать: `GET /ses/robot/listall`)
|
||||||
4. Сценарий автоматически подхватится через hot-reload (каждые 60 секунд)
|
4. Описать шаги и ожидания
|
||||||
|
5. Сценарий автоматически подхватится через hot-reload (каждые 60 секунд)
|
||||||
|
|
||||||
### Добавление новой метрики
|
### Добавление новой метрики
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user