ADT: различия между версиями
Мария (обсуждение | вклад) (страница в разработке) |
Мария (обсуждение | вклад) (руководство пользователя и администратора) |
||
| Строка 11: | Строка 11: | ||
'''ADT - ALT Diagnostic Tool''' - представляет собой инструмент для запуска тестов в терминале или в графическом интерфейсе. | '''ADT - ALT Diagnostic Tool''' - представляет собой инструмент для запуска тестов в терминале или в графическом интерфейсе. | ||
=== Цель создания === | |||
Цель создания ADT — упрощение проведения диагностики и анализа работы системы. Работа ADT по поиску доступных тестов, их запуску и получению результатов работы теста осуществляется через D-Bus с использованием Alterator Manager и его модуля Executor. | Цель создания ADT — упрощение проведения диагностики и анализа работы системы. Работа ADT по поиску доступных тестов, их запуску и получению результатов работы теста осуществляется через D-Bus с использованием Alterator Manager и его модуля Executor. | ||
Благодаря подобной схеме реализации утилита диагностики системы получает доступ к интерфейсу взаимодействия на шине D-Bus. С использованием Alterator Manager и D-Bus возвращается информация о результатах выполнения теста. | Благодаря подобной схеме реализации утилита диагностики системы получает доступ к интерфейсу взаимодействия на шине D-Bus. С использованием Alterator Manager и D-Bus возвращается информация о результатах выполнения теста. | ||
=== Назначение === | |||
Программа ADT предназначена для: | |||
#Cистемных администраторов; | |||
#Опытных пользователей; | |||
#Cлужбы технической поддержки. | |||
Возможности программы позволяют проводить диагностику системы в графическом приложении и записать файл с отчетом. Запуск инструментов диагностики регулируется системным администратором, позволяя создавать отчеты пользователям, не передавая административные полномочия. | |||
= Установка = | |||
Команды установки alterator-manager и ADT | |||
<pre> | |||
# apt-get update | |||
# apt-get install alterator-manager | |||
# apt-get install adt | |||
</pre> | |||
Запуск службы alterator-manager | |||
<pre> | |||
# systemctl start alterator-manager.service | |||
# systemctl enable alterator-manager.service | |||
</pre> | |||
Вызов утилиты ADT возможен через графическое меню, либо через терминал. | |||
[[Файл:Adt_first_launch.png|Внешний вид программы без установленных инструментов диагностики]] | |||
Диагностические инструменты добавляются установкой отдельных пакетов. | |||
=== Интерфейс === | |||
Пользовательский интерфейс программы состоит из секций: | |||
* Список инструментов диагностики; | |||
* Описание инструмента; | |||
* Действия пользователя. | |||
== Руководство администратора == | |||
=== Алгоритм работы ALT Diagnostic Tool === | |||
#Systemd служба alterator-manager во время запуска создает на шине D-Bus службу с именем "ru.basealt.alterator"; | |||
#Systemd служба alterator-module-executor собирает информацию из файлов .backend обо всех установленных диагностических инструментах и создает объекты на D-Bus; | |||
#ADT формирует список диагностических инструментов, обращаясь к D-Bus службе "ru.basealt.alterator"; | |||
#Таким же способом ADT запускает тест и получает информацию о результате его выполнения. | |||
=== Разработка инструмента диагностики === | |||
=== Пример инструмента диагностики === | |||
[[Файл:Adt_scheme_illustration.png|Схема взаимодействия компонентов]] | |||
== Руководство пользователя == | |||
Для работы с инструментом диагностики его необходимо выбрать в списке. | |||
[[Файл:Adt_overlook.png|список инструментов]] | |||
Двойной щелчок мыши либо кнопка "Выбрать инструмент" перемещают пользователя к работе с набором тестов инструмента. Кнопка "Запустить все" автоматически запускает весь набор тестов выбранного инструмента. | |||
[[Файл:Adt_test_overlook.png|Запуск всего набора тестов выбранного инструмента|1000x1000пкс]] | |||
В области управления инструментом диагностики доступны опции: "Отчет", "Запустить все тесты", "Назад". Напротив каждого теста находятся кнопки "Запустить" и "Журнал". | |||
Пример выполнения всех тестов: | |||
[[Файл:Adt_result.png|Пример выполнения всех тестов|1000x1000пкс]] | |||
Кнопка "Журнал" выводит отчет теста от утилиты инструмента диагностики (если инструмент поддерживает такую возможность): | |||
[[Файл:Adt_report.png| ]] | |||
Кнопка "Отчет" сохраняет в файл полный текст информации инструмента диагностики (если инструмент поддерживает такую возможность). | |||
= Спецификация = | |||
* [https://gitlab.basealt.space/alt/alterator-entry/-/blob/master/doc/README.md Документация] относится к [[Alterator-manager|Alterator Manager]], компоненту [[Alterator_на_D-Bus|Alterator на D-Bus]]. | |||
* [https://gitlab.basealt.space/alt/adt Код проекта] | |||
=== Компоненты === | |||
* [[Alterator-manager|Alterator Manager]] | |||
* [https://gitlab.basealt.space/alt/alterator-manager/-/blob/master/docs/README-ru.md?ref_type=heads#executor executor] | |||
Версия от 10:08, 24 июня 2024
ADT - ALT Diagnostic Tool - представляет собой инструмент для запуска тестов в терминале или в графическом интерфейсе.
Цель создания
Цель создания ADT — упрощение проведения диагностики и анализа работы системы. Работа ADT по поиску доступных тестов, их запуску и получению результатов работы теста осуществляется через D-Bus с использованием Alterator Manager и его модуля Executor. Благодаря подобной схеме реализации утилита диагностики системы получает доступ к интерфейсу взаимодействия на шине D-Bus. С использованием Alterator Manager и D-Bus возвращается информация о результатах выполнения теста.
Назначение
Программа ADT предназначена для:
- Cистемных администраторов;
- Опытных пользователей;
- Cлужбы технической поддержки.
Возможности программы позволяют проводить диагностику системы в графическом приложении и записать файл с отчетом. Запуск инструментов диагностики регулируется системным администратором, позволяя создавать отчеты пользователям, не передавая административные полномочия.
Установка
Команды установки alterator-manager и ADT
# apt-get update # apt-get install alterator-manager # apt-get install adt
Запуск службы alterator-manager
# systemctl start alterator-manager.service # systemctl enable alterator-manager.service
Вызов утилиты ADT возможен через графическое меню, либо через терминал.
Диагностические инструменты добавляются установкой отдельных пакетов.
Интерфейс
Пользовательский интерфейс программы состоит из секций:
- Список инструментов диагностики;
- Описание инструмента;
- Действия пользователя.
Руководство администратора
Алгоритм работы ALT Diagnostic Tool
- Systemd служба alterator-manager во время запуска создает на шине D-Bus службу с именем "ru.basealt.alterator";
- Systemd служба alterator-module-executor собирает информацию из файлов .backend обо всех установленных диагностических инструментах и создает объекты на D-Bus;
- ADT формирует список диагностических инструментов, обращаясь к D-Bus службе "ru.basealt.alterator";
- Таким же способом ADT запускает тест и получает информацию о результате его выполнения.
Разработка инструмента диагностики
Пример инструмента диагностики
Руководство пользователя
Для работы с инструментом диагностики его необходимо выбрать в списке.
Двойной щелчок мыши либо кнопка "Выбрать инструмент" перемещают пользователя к работе с набором тестов инструмента. Кнопка "Запустить все" автоматически запускает весь набор тестов выбранного инструмента.
В области управления инструментом диагностики доступны опции: "Отчет", "Запустить все тесты", "Назад". Напротив каждого теста находятся кнопки "Запустить" и "Журнал".
Пример выполнения всех тестов:
Кнопка "Журнал" выводит отчет теста от утилиты инструмента диагностики (если инструмент поддерживает такую возможность):
Кнопка "Отчет" сохраняет в файл полный текст информации инструмента диагностики (если инструмент поддерживает такую возможность).
Спецификация
- Документация относится к Alterator Manager, компоненту Alterator на D-Bus.
- Код проекта