Плагин для просмотра журналов ВМ

Общая информация

В разделе Виртуальные машины-Системные журналы пользователь может просматривать записи журналов виртуальных машин. Этот раздел доступен в меню, если включен UI-плагин Log View, который работает на основе бэкенд-плагина Log View. Это API плагин разработанный для обработки и просмотра журналов виртуальных машин. Он использует стек ELK для организации хранения журналов виртуальных машин. Экспорт журналов из виртуальной машины в хранилище организуется с помощью Filebeat. Плагин протестирован с Apache CloudStack 4.11.2.0.

Чтобы подключить раздел Системные журналы, нужно сначала установить бэкенд-плагин Log View, а затем включить UI-плагин через файл конфигурации config.json .

Установка плагина

Полная инструкция по установке бэкенд-плагина Log View представлена на странице описания плагина.

Чтобы подключить UI-плагин Log View, необходимо:

  1. Установить бэкенд-плагин в CloudStack.
  2. Установить необходимые компоненты: ElasticSearch, Filebeat, Logstash, Curator.
  3. Подключить UI-расширение через файл конфигурации config.json.

Примечание

Для повышения безопасности экспорта журналов ВМ в хранилище, помимо UUID виртуальной машины необходимо использовать секретный токен. Вы можете создать и скопировать новый токен через интерфейс. Токен может быть заново сгенерирован в случае компрометации. Более подробную информацию о том, как это сделать, можно найти в разделе Список действий с ВМ. Подробные инструкции о конфигурировании сервиса экспорта журналов в виртуальной машине представлены в документации по плагину.

Просмотр системных журналов

После успешного подключения плагина в UI вы увидите раздел Системные журналы в разделе Виртуальные машины основного меню слева. В этом разделе можно просматривать записи журналов ВМ за указанный период времени или в режиме реального времени.

_images/LogView.png

Для просмотра журналов необходимо указать аккаунт (доступно для Администраторов), машину и журнал этой машины, записи из которого нужно просмотреть. Подробнее см. описание ниже.

Фильтрация записей

Для просмотра логов в списке задайте параметры фильтрации.

Выберите из ниспадающих списков следующие параметры в указанном порядке:

Примечание

Обязательные поля отмечены «звездочкой» (*).

  • Аккаунты * - позволяют Администратору в следующем шаге выбрать машину конкретного(ых) аккаунта(ов), для которой необходимо просмотреть журналы . Выберите из ниспадающего списка один или несколько аккаунтов.
  • ВМ * - позволяют выбрать журнылы конкретной ВМ. Выберите ВМ из ниспадающего списка. Список доступных ВМ определяется аккаунтом(ами), выбранным(и) на предыдущем шаге, если вы Администратор. Если вы пользователь, в списке вы увидите те машины, которые принадлежат вашему пользователю.
  • Журнал * - позволяет просматривать записи конкретного журнала. Выберите из ниспадающего списка журнал для показа записей из него. Если не выбирать конкретный журнал, в списке будут отображены записи из всех журналов выбранной машины.
  • Дата - позволяет просматривать журналы за определенный период времени. Нажмите date icon и в появившемся календаре выберите начальную и конечную дату. По умолчанию показываются логи за последние сутки.
_images/Logs_Datepicker.png
  • Время - позволяет задать конкретный промежуток времени в рамках заданного периода. Формат времени определяется настройкой формата, заданной в разделе «Настройки». Вы можете ввести желаемое время в полях для начального и конечного времени.
_images/Logs_Timepicker1.png

Нажмите «Показать логи» для вывода логов согласно параметрам фильтрации.

_images/Logs_Filtering1.png

В списке будут отражены логи за указанный период.

Можно изменить параметры фильтрации и обновить список логов, нажав «ПОКАЗАТЬ ЛОГИ».

Заданные параметры фильтрации сохраняются в теги пользователя. Это значит, что покинув систему и снова вернувшись в нее, вы продолжите просмотр журналов машин с теми же параметрами фильтрации, которые были заданы прежде.

Список записей журналов

Кликом на «ПОКАЗАТЬ ЛОГИ» пользователь может просматривать записи из журналов в соответствии с параметрами фильтрации. Записи в списке показаны в хронологическом порядке, от самых ранних до самых поздних.

По умолчанию, отображаются записи за последние сутки.

Пользователь может просматривать логи только для своих машин. Администратор может просматривать логи для машин всех аккаунтов в домене.

_images/Logs_List1.png

Для каждой записи в таблице представлена следующая информация:

  • Дата
  • Журнал
  • Текст

Можно изменить параметры фильтрации и обновить список логов, нажав «ПОКАЗАТЬ ЛОГИ».

Сортировка записей

Для сортировки записей можно активировать опцию «Новые сверху» справа и обновить список кликом на «ПОКАЗАТЬ ЛОГИ».

_images/Logs_Newest1.png

Поиск по записям

Для быстрого поиска по списку записей воспользуйтесь строкой поиска, расположенной над списком. Введите слово или текст и нажмите «ПОКАЗАТЬ ЛОГИ», чтобы обновить список. Записи будут отфильтрованы по заданным критериям поиска.

_images/Logs_Search2.png

Просмотр записей в режиме реального времени

После определения параметров фильтрации и нажатия на «ПОКАЗАТЬ ЛОГИ» пользователь может включить просмотр записей в режиме реального времени, чтобы отслеживать записи журналов машины.

При активации отслеживания журналов в режиме реального времени UI-плагин Log View запрашивает журналы с той частотой и за тот период времени, которые заданы в конфигурационном файле. По умолчанию, журналы запрашиваются с частотой один раз в секунду, и при каждом запросе по умолчанию возращаются записи за последние 30 секунд. Пользователь может задать другие значения данных настроек в конфигурационном файле (см. подробнее в руководстве по конфигурациям)

Для отслеживания журналов в режиме реального времени нажмите «Отслеживать» follow icon. Кнопка доступна после выбора виртуальной машины в параметрах фильтрации, или после установки всех необходимых параметров фильтрации и нажатия кнопки «ПОКАЗАТЬ ЛОГИ». При активации режима отслеживания журналов вы увидите, что список записей журналов автоматически обновляется каждую секунду. При этом параметры фильтрации недоступны для выбора.

_images/Logs_Follow.png

Кнопка «Отслеживать» меняет положение в зависимости от применения режима сортировки. Если сортировка «Новые сверху» отключена, кнопка находится в правом нижнем углу, как на изображении выше. Если сортировка «Новые сверху» включена, кнопка отображается в правом верхнем углу, и записи в списке будут отображаться в обратном хронологическом порядке - от более ранних к более поздним.

_images/Logs_FollowUp.png

По умолчанию, в списке отображаются записи за последнюю минуту. Максимальное количество записей - 1000.

Если в списке большое количество записей, они будут подгружаться частями при «прокрутке» списка вниз.

Вы можете изменить параметры по умолчанию в разделе настроек “Системные журналы (режим реального времени)”:

  • Показывать за последние (минуты) - время, за которое вы желаете отображать записи при каждом обновлении списка; допустимые значения - от 1 (по умолчанию) до 10 минут.
  • Максимальное количество отображаемых записей - позволяет задать максимальное число записей для показа; допустимые значения - от 1 до бесконечности. По умолчанию, показываются 1000 записей.

Нажмите «Обновить» для применения заданных значений.

_images/Settings_LogView.png

Чтобы остановить отслеживание записей, нажмите unfollow icon.