Directum Harvester — новый инструмент для сбора диагностической информации

10 2

Как и почему родилась идея утилиты

Главная цель любой службы поддержки — как можно быстрее помочь заказчику с его вопросом и при возможности с первого шага выдать его решение. Однако долгое время мы сталкиваемся с тем, что решение вопросов заказчиков затягивается из-за отсутствия необходимой для анализа информации, вследствие чего приходится тратить первый шаг на её запрос.

Драгоценное время заказчика уходит на получение и осознание нашего запроса, поиск и сбор информации (лог-файлов и конфигурационных файлов), её упаковку, выбор способа передачи и прочее.

После получения необходимой информации ответственный за обращение должен вновь пробиться к вопросу заказчика через тернии других обращений, что опять же займет время — в ожидании информации он без дела не сидит и занят другими задачами.

Все это в конечном итоге откладывает долгожданный результат — оперативную передачу заказчику рекомендаций по решению его вопроса за один шаг.

Проанализировав немалое количество обращений и опросив "потерпевших", мы выявили ряд первопричин того, почему информация не предоставляется сразу:

  • заказчики не всегда знают, какую именно информацию необходимо прислать в той или иной ситуации;
  • заказчики не всегда знают (а если редко приходят с обращениями — забывают), где именно расположена эта информация (актуально также для прикладных администраторов, которые не взаимодействуют с аппаратной частью);
  • заказчикам бывает сложно ориентироваться в большом количестве ежедневно формирующихся лог-файлов различных сервисов.

Логическая цепочка по решению ситуации выстроилась следующим образом:

  1. Для того, чтобы ускорить решение вопроса заказчиков, необходимо сразу получать от них необходимую информацию о системе Directum RX вместе с обращением.
  2. Для того, чтобы получить информацию о системе сразу, необходимо помочь собрать её на этапе формирования обращения — сориентировать его в том, какую именно информацию необходимо отправить и облегчить сбор файлов.
  3. Чем можем помочь — Directum RX "знает" о местонахождении информации внутри системы, и мы как вендор, основываясь на нашем опыте, с большой достоверностью понимаем, какая информация нужна при решении типовых ситуаций.

Например, для решения ситуаций в области "обмен с контрагентами " нам чаще всего требуются: лог-файлы общего сервиса (или сервиса асинхронных событий, если он вынесен из состава общего), а также его изолированной области (когда дело касается преобразования в PDF), веб-сервера, сервиса выполнения блоков схем задач (когда обработка документов выполняется в рамках процесса/регламента).


В итоге мы сформулировали гипотезу: если аккумулировать наш опыт, знания о системе и знания системы о самой себе в некоем инструменте, мы сможем облегчить сбор информации, что позволит нам значительно ускорить решение вопроса заказчика.

Для проверки этой гипотезы в кузнице технической поддержки Directum был выкован инструмент, имя которому "Directum Harvester". Свое звучное название инструмент получил благодаря рекомендации одного из заказчиков. Он оценил простоту и эффективность инструмента, который буквально «собирает» все необходимые данные в пару кликов, значительно экономя время.

 

Назначение утилиты

Directum Harvester автоматизирует сбор диагностической информации по системе Directum RX при создании обращения. Помогает сократить время на анализ и ускорить решение проблем за счет предоставления службе поддержки данных. 

 

Функциональность и принцип работы

1. Запустите утилиту на сервере с системой Directum RX.
2. При запуске осуществляется автоматический поиск папки с Directum Launcher и конфигурационного файла «config.yml»:

3. Из конфигурационного файла извлекается информация о расположении лог-файлов и конфигурационных файлов сервисов:

4. На пользователя выводится окно с возможностью выбора интервала дат для выгрузки лог-файлов:

5. Выполняется переход к выбору области возникновения ситуации — именно этот этап поможет сориентироваться при определении перечня необходимых лог-файлов:

6. При необходимости можно указать для выгрузки лог-файлы конкретных сервисов:

7. Создается архив с лог-файлами выбранной области за указанный интервал дат, а также конфигурационные файлы: системы Directum RX «config.yml» (конфиденциальные данные можно "зашифровать" звездочками), а также задействованных сервисов.

8. Сформированный архив выгружается в папку c Directum Harvester (папку для выгрузки можно настроить в разделе «Настройки»), после чего его можно передать в техническую поддержку Directum.

 

Особенности использования 

Использование в распределенной архитектуре

Если какой-то из сервисов вынесен на другой сервер, то для сбора информации о сервисах системы, размещенных на других узлах, необходимо запускать отдельный экземпляр Directum Harvester на каждом из этих узлов (данное ограничение обусловлено архитектурой системы).

Интерфейс

Для того, чтобы по максимуму закрыть потребности заказчиков, мы сделали реализацию для ОС Windows и Linux как с графическим интерфейсом, так и в консольном виде (в случае, если на сервере используется операционная система без GUI). Также доступен вариант в виде исходных кодов, если запуск исполняемых файлов в инфраструктуре заказчика затруднен по требованиям информационной безопасности.

В итоге Directum Harvester превращает сложный технический квест в быструю и прозрачную процедуру.

 

Как получить утилиту

Дистрибутив Directum Harvester доступен на сайте поддержки по ссылке Directum Harvester

 

Отзывы

Мы уже получили первые отзывы от наших партнеров и заказчиков, решение вопросов которых значительно ускорилось за счет использования инструмента:

"Удобно. Спасибо. Оценка 10 из 10."

Ринат, АО "Сургутнефтегазбанк"

"Я нажал 2 кнопки и отправил архив."

Сергей, АО "ДонБиоТех"

"Утилиту возьмем на вооружение, спасибо!"

Дмитрий, ООО "Авис Эксперт"

Будет здорово, если вы используете Directum Harvester и дадите обратную связь по опыту использования — это крайне важно для нас, чтобы мы могли дальше развивать инструменты для повышения удобства пользователей.

 

Ilja Orl

Получаю ошибку после выбора области:

Сбор лог-файлов для области 8:
################
Выгружаю лог-файлы веб-сервера, сервиса хранилищ, сервиса отложенных операций
################

✗ Ошибка при сборе лог-файлов: 'CollectionProgressPage' object has no attribute 'collect_region_8'
Traceback (most recent call last):
  File "DirectumHarvester.py", line 4219, in collect_logs_worker
  File "DirectumHarvester.py", line 4938, in collect_by_region
  File "DirectumHarvester.py", line 4929, in <lambda>
AttributeError: 'CollectionProgressPage' object has no attribute 'collect_region_8'

При этом сбор из компонентов RX выполняется

Ilja, Добрый день! Спасибо, что решили использовать нашу утилиту для сбора лог-файлов системы DirectumRX. Провели тестирование с нашей стороны, действительно на операционной системе Windows возникала ошибка, дефект исправили и актуализировали дистрибутив на сайте поддержки. Для повторного использования утилиты вам необходимо:
1) Скачать нужный вам дистрибутив с сайта поддержки
2) Если вы использовали исходные коды:
Заменить файл DirectumHarvester.py у себя на сервере на новый из дистрибутива
Если вы использовали готовый файл DirectumHarvester.exe:
Заменить файл DirectumHarvester.exe у себя на сервере на новый из дистрибутива
После повторной проверки, прошу вас вернуться с обратной связью. Спасибо за вклад в развитие утилиты для сбора лог-файлов

Авторизуйтесь, чтобы написать комментарий