safronovba_cw

Национальный исследовательский
Томский Политехнический университет
Институт – Кибернетический Центр
Направление – Информатика и вычислительная техника
Кафедра – Оптимизации систем управления
ПОЯСНИТЕЛЬНАЯ ЗАПИСКА К КУРСОВОЙ РАБОТЕ
по дисциплине «Технология разработки программного обеспечения»
на тему «Создание системы мониторинга узла сети»
Выполнил
Студент группы 8в83
Проверил
___________
___________
Томск 2011
Б.А. Сафронов
И.А. Заикин
Оглавление
Введение............................................................................................................ 5
1. Анализ предметной области..................................................................... 6
2. Техническое задание ................................................................................. 7
2.1 Введение .............................................................................................. 7
2.2 Основания для разработки ................................................................. 7
2.3 Назначение разработки....................................................................... 7
2.4 Требования к программе или программному изделию:.................. 8
2.5 Требования к видам обслуживания................................................... 9
2.6 Требования к численности и квалификации персонала................ 10
2.7 Требования к составу и параметрам технических средств ........... 10
2.8 Требования к информационной и программной совместимости 11
2.9 Требования к маркировке и упаковке ............................................. 11
2.10 Требования к транспортированию и хранению ............................ 12
2.11 Специальные требования. ............................................................... 13
2.12 Стадии и этапы разработки ............................................................. 14
2.13 Порядок контроля и приемки ......................................................... 16
3. Проектирование программного продукта ............................................ 17
3.1. Варианты использования ................................................................. 17
3.1.1. Вариант использования «Проверить доступность узла» ....... 18
3.1.2. Вариант использования «Настроить интервал проверки
доступности узла» .............................................................................................. 18
2
3.1.3. Вариант использования «Настроить параметры отправки
уведомлений» ..................................................................................................... 18
3.1.4. Вариант использования «Показать лог пингов» .................... 19
3.1.5. Вариант использования «Показать график» ........................... 19
3.2. Диаграмма классов ........................................................................... 20
3.3. Диаграмма компонентов .................................................................. 21
3.4. Диаграмма развертывания ............................................................... 21
3.5. Диаграмма взаимодействия ............................................................. 22
4. Тестирование и отладка .......................................................................... 23
5. Описание программы .............................................................................. 23
5.1. Общие сведения ................................................................................ 23
5.2. Функциональное назначение ........................................................... 23
5.3. Используемые технические средства ............................................. 23
5.4. Запуск ................................................................................................. 23
5.5. Входные данные................................................................................ 24
5.6. Выходные данные ............................................................................. 24
6. Руководство пользователя ...................................................................... 25
6.1. Введение ............................................................................................ 25
6.2. Назначение системы ......................................................................... 25
6.3. Основные возможности.................................................................... 25
6.4. Документация системы .................................................................... 25
6.5. Установка и удаление системы ....................................................... 25
6.6. Требования к информационной и программной совместимости 25
3
6.7. Процедура установки ....................................................................... 25
6.8. Процедура удаления ......................................................................... 26
6.9. Описание интерфейса ....................................................................... 27
6.9.1. Главное окно приложения ............................................................ 27
6.9.2. Вкладка настроек ........................................................................... 28
6.10. Основные возможности пользователя .......................................... 29
6.10.1. Выбор узла для опроса ................................................................ 29
6.10.2. Начать опрос узла ........................................................................ 29
6.10.3. Выход из программы ................................................................... 29
Литература ...................................................................................................... 30
4
Введение
В ходе выполнения курсового проекта будет создано приложение для
мониторинга узла сети. Выполнение будет сопровождаться
анализом
предметной области, составлением технического задания, UML-диаграммами и
написанием руководства пользователя.
5
1. Анализ предметной области
Система мониторинга будет предоставлять возможность своевременно
получать информацию о доступности узлов сети и вести статистику разрывов
соединения для выявления слабых мест сети.
Приложение избавит пользователя от необходимости опрашивать узел и
следить за его доступностью.
6
2. Техническое задание
2.1 Введение
Наименование программы: «Приложение для мониторинга узла сети»
Программа
предназначена
для
использования
на
компьютерах,
работающих под управлением Windows.
2.2 Основания для разработки
Основанием для проведения разработки является необходимость в
программе данного рода. Задание согласовано с Сафроновым Борисом
Александровичем, именуемым в дальнейшем Заказчиком, и утверждено
Сафроновым
Борисом
Александровичем,
именуемым
в
дальнейшем
Исполнителем, 16 ноября 2011 г.
Наименование
темы
разработки:
«Разработка
приложения
для
мониторинга узла сети».
Условное обозначение темы разработки (шифр темы): «РТФ-256».
2.3 Назначение разработки
Функциональным назначением программы является предоставление
пользователю возможности своевременно узнать о неисправности канала связи
или узла сети.
Эксплуатационное назначение
Программа должна эксплуатироваться в серверах Заказчика.
7
Конечными пользователями программы должны являться системные
администраторы и сетевые архитекторы Заказчика.
2.4 Требования к программе или программному изделию:
1. Требования к функциональным характеристикам:
 Система должна работать со всеми типами оборудования,
существующего в сети (РРС, мультиплексорами, оборудование
передачи данных по протоколам IP, MPLS, спутниковых модемов,
оборудования ШБД, межсетевых и сетевых экранов, ИБП,
контроллеры ДЭС, систем жизнеобеспечения и др.);
 Простой и доступный оператору алгоритм изменения цели
мониторинга;
 Передача данных и запросов по событиям и расписанию с
дискретностью до секунды;
 Наличие монитора событий в реальном времени. Реализовать функцию
информирования об авариях и событиях по электронной почте или
телефону;
 Реализация наблюдения за трафиком:
 определять время отклика приложений и качество связи для
конечных пользователей.
2. Требования к надежности:
Заказчик обязуется эксплуатировать программный комплекс,
используя программное и аппаратное обеспечение не меньше чем
указанное в требованиях к аппаратному и программному обеспечению.
Заказчик обязуется обеспечить устойчивое функционирование системы
 организацией бесперебойного питания технических средств;
 использованием лицензионного программного обеспечения;
 регулярным выполнением рекомендаций Министерства труда и
социального развития РФ, изложенных в Постановлении от 23 июля
1998 г. «Об утверждении межотраслевых типовых норм времени на
работы по сервисному обслуживанию ПЭВМ и оргтехники и
сопровождению программных средств»;
8
 регулярным выполнением требований ГОСТ 51188-98. Защита
информации. Испытания программных средств на наличие
компьютерных вирусов.
Время восстановления после отказа, вызванного сбоем электропитания
технических средств (иными внешними факторами), не фатальным сбоем (не
крахом) операционной системы, не должно быть больше 10 минут при условии
соблюдения условий эксплуатации технических и программных средств.
Время восстановления после отказа, вызванного неисправностью
технических средств, фатальным сбоем (крахом) операционной системы, не
должно превышать времени, требуемого на устранение неисправностей
технических средств и переустановки программных средств.
Отказы из-за некорректных действий оператора
Отказы программы возможны вследствие некорректных действий
оператора (пользователя) при взаимодействии с операционной системой. Во
избежание возникновения отказов программы по указанной выше причине
следует обеспечить работу конечного пользователя без предоставления ему
административных привилегий.
3. Условия эксплуатации:
Климатические условия: Температура окружающей среды от 18 до
28 °С. Влажность воздуха не более 75%.
2.5 Требования к видам обслуживания
См.
Требования
к
обеспечению
надежного
(устойчивого)
функционирования программы.
9
2.6 Требования к численности и квалификации персонала
Количество персонала, требуемого для работы программы, должно
составлять не менее 2 штатных единиц – системный администратор и
сетевой архитектор. Системный администратор должен иметь высшее
профильное
образование
и
сертификаты
операционной системы. В перечень
компании-производителя
задач, выполняемых системным
администратором, должны входить:
 задача поддержания работоспособности технических средств;
 задачи установки (инсталляции) и поддержания работоспособности
системных программных средств – операционной системы;
 задача установки (инсталляции) программы.
Персонал должен быть аттестован на II квалификационную группу по
электробезопасности (для работы с конторским оборудованием).
2.7 Требования к составу и параметрам технических средств
В состав технических средств должен входить IBM-совместимый
персональный компьютер (ПЭВМ), включающий в себя:




процессор Intel с тактовой частотой, МГц – 300, не менее;
материнскую плату с FSB, МГц – 300, не менее;
оперативную память объемом, Мб – 256, не менее;
ПЗУ объемом, Гб – 80, не менее.
10
2.8 Требования к информационной и программной совместимости
Исполнитель обязуется обеспечить совместимость с операционной
системой Windows.
Требования к информационным структурам и методам решения не
предъявляются.
Исходные коды программы должны быть реализованы на языке C#. В
качестве интегрированной среды разработки программы должна быть
использована среда Visual Studio.
Требования к защите информации и программ не предъявляются.
2.9 Требования к маркировке и упаковке
Требование к маркировке
Программное изделие должно иметь маркировку с обозначением
товарного знака компании-разработчика, типа (наименования), номера
версии, порядкового номера, даты изготовления и номера сертификата
соответствия Госстандарта России.
Маркировка должна быть нанесена на программное изделие в виде
наклейки, выполненной полиграфическим способом с учетом требований
ГОСТ 9181-74.
Требования к упаковке
Упаковка программного изделия должна осуществляться в упаковочную
тару предприятия-изготовителя.
11
Условия упаковывания
Упаковка программного изделия должна проводиться в закрытых
вентилируемых помещениях при температуре от плюс 15 до плюс 40 °С и
относительной влажности не более 80 % при отсутствии агрессивных примесей
в окружающей среде.
Заказчик получит программное изделие надлежащего внешнего вида. В
случае возврата программного изделия в ненадлежащем виде (наличие царапин,
трещин и прочих дефектов) Исполнитель сможет предъявить претензии в части
нарушения Заказчиком условий упаковывания и не принять программное
изделие.
2.10
Требования к транспортированию и хранению
Допускается транспортирование программного изделия в транспортной
таре всеми видами транспорта (в том числе в отапливаемых герметизированных
отсеках
самолетов
без
ограничения
расстояний).
При
перевозке
в
железнодорожных вагонах вид отправки – мелкий малотоннажный.
При транспортировании и хранении программного изделия должна быть
предусмотрена
защита
от
попадания
пыли
и
атмосферных
осадков.
Климатические условия транспортирование приведены ниже:
 температура окружающего воздуха, 25°C +-5°C;
 относительная влажность воздуха при 25°C – 75%.
12
2.11 Специальные требования.
Программа должна обеспечивать взаимодействие с пользователем
(оператором)
разработанного
посредством
графического
согласно
пользовательского
рекомендациям
интерфейса,
компании-производителя
операционной системы.
Требования к программной документации;
Состав программной документации должен включать в себя:





техническое задание;
программу и методики испытаний;
руководство системного программиста;
руководство оператора;
ведомость эксплуатационных документов.
Технико-экономические показатели;
Предполагаемое число использования программы в год – 365 сеансов
работы на одном рабочем месте. Программный продукт является свободно
распространяемым и бесплатным.
13
2.12
Стадии и этапы разработки
Стадии разработки
Разработка должна быть проведена в три стадии:
 разработка технического задания;
 рабочее проектирование;
 внедрение.
Этапы разработки
На стадии разработки технического задания должен быть выполнен этап
разработки, согласования и утверждения настоящего технического задания.
На стадии рабочего проектирования
перечисленные ниже этапы работ:
должны
быть
выполнены
 разработка программы;
 разработка программной документации;
 испытания программы.
На стадии внедрения должен быть выполнен этап разработки подготовка и передача программы.
Содержание работ по этапам
На этапе разработки технического задания должны быть выполнены
перечисленные ниже работы:




постановка задачи;
определение и уточнение требований к техническим средствам;
определение требований к программе;
определение стадий, этапов и сроков разработки программы и
документации на неё;
 выбор языков программирования;
 согласование и утверждение технического задания.
14
На этапе разработки программы должна быть выполнена работа по
программированию (кодированию) и отладке программы.
На
этапе
разработки
программной
документации
должна
быть
выполнена разработка программных документов в соответствии с требованиями
ГОСТ 19.101-77 с требованием п. Предварительный состав программной
документации настоящего технического задания.
На
этапе
испытаний
программы
должны
быть
выполнены
перечисленные ниже виды работ:
 разработка, согласование и утверждение программы в ГОСТ и методики
испытаний;
 проведение приемо-сдаточных испытаний;
 корректировка программы и программной документации по результатам
испытаний.
15
2.13
Порядок контроля и приемки
Заказчик и Исполнитель обязуются провести совместные испытания по
завершению работы Исполнителем. В ходе испытаний необходимо провести
проверку всех заявленных Заказчиком требований.
Приемо-сдаточные испытания программы должны проводиться согласно
разработанной (не позднее 1 месяца со дня заключения договора) Исполнителем
и согласованной Заказчиком Программы и методик испытаний.
Ход проведения приемо-сдаточных испытаний Заказчик и Исполнитель
документируют в Протоколе проведения испытаний.
Общие требования к приемке работы
На
основании
Протокола
проведения
испытаний
Исполнитель,
совместно с Заказчиком, подписывают Акт приемки-сдачи программы в
эксплуатацию.
16
3. Проектирование программного продукта
Далее
представлены
UML
диаграммы
вариантов
использования,
диаграмма классов, состояний и компонентов.
3.1.
Варианты использования
Рисунок 1 Диаграмма вариантов использования
Пользователь в приложении может опросить узел, настроить
уведомления, показать график времени ответа узла и просматривать логи.
17
3.1.1. Вариант использования «Проверить доступность узла»
1. Вариант использования начинается тогда, когда пользователь запускает
приложение;
2. Пользователь вводит адрес или имя интересующего узла;
3. Пользователь нажимает кнопку старт;
4. Программа делает запрос удаленному узлу;
5. Приложение выводит на экран время доступности узла;
6. Вариант использования завершается.
3.1.2. Вариант использования «Настроить интервал проверки
доступности узла»
1. Вариант использования начинается тогда, когда пользователь хочет
изменить время таймера опроса узла;
2. Пользователь меняет поле «интервал», задав необходимое значение в
поле;
3. Вариант использования завершается.
3.1.3. Вариант использования «Настроить параметры отправки
уведомлений»
1. Вариант использования начинается тогда, когда пользователь переходит
на вкладку «настройки»;
2. Пользователь меняет значение поля «порог ошибок» и значение поля
«текст
письма»,
а
также
разрешает
(либо
запрещает)
отправку
уведомлений установкой соответствующего флажка;
3. Вариант использования завершается.
18
3.1.4. Вариант использования «Показать лог пингов»
1. Вариант использования начинается тогда, когда пользователь хочет
посмотреть статистику разрывов;
2. Пользователь
выбирает
вкладку
«настройки»
и
ставит
флажок
«Показывать пинги»;
3. Приложение меняет свой размер и появляется поле с логами пингов;
4. Вариант использования завершается.
3.1.5. Вариант использования «Показать график»
1. Вариант использования начинается тогда, когда пользователь хочет
посмотреть статистику времени отклика;
2. Пользователь выбирает вкладку «настройки» и ставит флажок «Строить
график»;
3. Приложение меняет свой размер и появляется поле с графиком;
4. Вариант использования завершается.
19
3.2.
Диаграмма классов
Диаграмма классов показана на рисунке 2.
Рисунок 2 Диаграмма классов
Класс Errors представляет собой базу с типами ошибок.
Класс Sender отвечает за отправку уведомлений пользователю.
Класс MGraph отвечает за построение и прорисовку графика.
Класс Ping отвечает за опрос узла.
20
3.3.
Диаграмма компонентов
Диаграмма компонентов показана на рисунке 3.
Рисунок 3 Диаграмма компонентов
3.4.
Диаграмма развертывания
Диаграмма развертывания показана на рисунке 4.
Рисунок 4 Диаграмма развертывания
Приложение имеет локальное хранилище, в котором содержится информация о
прошедших опросах узла, такая как время опроса и время ответа узла.
Удаленный узел – узел заданный пользователем для опроса.
21
3.5.
Диаграмма взаимодействия
Диаграмма взаимодействия для варианта использования «Опрос узла»
показана на рисунке 5.
Рисунок 5 Диаграмма взаимодействия
Пользователь вводит данные узла (имя или ip адрес) и нажимает кнопку старт.
Приложение опрашивает сервер и передает результат в модуль рисования
графика. Если от удаленного сервера не было ответа заданное количество раз,
сообщение об ошибке отправляется пользователю. Если отправка не удалась –
приложение уведомляет об этом пользователя.
22
4. Тестирование и отладка
Тестирование проводилось в виде постоянного запуска приложения на
компьютере и проверки его работы при различных режимах работы интернет
соединения. Конечная версия явных ошибок не содержит.
5. Описание программы
5.1.
Общие сведения
Название программы «Pinger».
Программа предназначена для работы в системе под управлением ОС
Windows.
Приложение разработано на языке C# в среде Visual Studio.
5.2.
Функциональное назначение
Приложение предоставляет пользователю возможность своевременно
узнать о неисправности канала связи или узла сети.
5.3.
Используемые технические средства
1.
2.
3.
4.
5.4.
процессор Intel с тактовой частотой, МГц – 300, не менее;
материнская плата с FSB, МГц – 300, не менее;
оперативная память объемом, Мб – 256, не менее;
ПЗУ объемом, Гб – 80, не менее.
Запуск
Для запуска приложения необходимо нажать на ярлык приложения.
23
Входные данные
5.5.
Входными данными служит информация об адресе узла и периодичности
опроса.
5.6.
Выходные данные
Выходные данные содержат информацию о времени последнего
успешного опроса.
24
6. Руководство пользователя
6.1.
Введение
6.2.
Назначение системы
Приложение
предназначено
для
предоставления
пользователю
возможности своевременно узнать о неисправности канала связи или узла сети.
6.3.
Основные возможности
В программе реализованы возможности:

Просмотр последнего время успешного опроса узла;

Просмотр статистики опросов в виде графика;

Изменение адреса узла и времени опроса;
6.4.
Документация системы
Программа поставляется в комплекте с электронным руководством
пользователя.
6.5.
Установка и удаление системы
6.6.
Требования к информационной и программной совместимости
Программная
система
должна
функционировать
под
операционной
системой Windows.
6.7.
Процедура установки
Установка программы осуществляется загрузкой с сайта производителя.
25
6.8.
Процедура удаления
Удаление
программы
может
быть
произведено
путем
удаления
исполняемого файла.
26
6.9.
Описание интерфейса
6.9.1. Главное окно приложения
При запуске системы пользователь видит перед собой основное окно
приложения (рисунок 6). На нем отображается адрес узла по умолчанию,
интервал опроса по умолчанию и кнопки управления.
Рисунок 1 Основное окно приложения
Нажав на кнопку «Старт», начнется опрос узла (рисунок 7).
Рисунок 2 Опрос узла
Нажав на вкладку «Настройки», откроется вкладка настроек (рисунок 8).
27
6.9.2. Вкладка настроек
Окно настроек вызывается при нажатии на вкладку «Настройки». Здесь
можно указать порог ошибок, после которого будет отправлено уведомление на
почту, текст письма об ошибке и другие настройки.
Рисунок 3 Окно настроек
28
6.10. Основные возможности пользователя
6.10.1.
Выбор узла для опроса
Чтобы выбрать узел, нужно на главном экране приложения ввести адрес
узла в графу «адрес».
6.10.2.
Начать опрос узла
Для начала опроса узла необходимо нажать на кнопку «старт» на главном
экране приложения.
6.10.3.
Выход из программы
Для выхода из программы достаточно нажать кнопку «выход» или крестик
в углу окна.
29
Литература
1. ГОСТ 19.106-78. Требования к программным документам, выполненным
печатным способом.
2. ГОСТ 19.201-78. Техническое задание. Требования к содержанию и
оформлению.
3. ГОСТ 19.402-78. Описание программы.
4. ГОСТ 19.505-79. Руководство оператора. Требования к содержанию и
оформлению.
30