Работа с сервисами

Данный раздел описывает процесс работы с сервисами в системе. Работа осуществляется в разделе Настройки → Пространства и сервисы → Сервисы веб-интерфейса системы.

Раздел доступен администраторам, пользователям, которые имеют соответствующее разрешение в составе своих ролей, а также учетным записям со статусом Суперадминистратор.

О сервисах

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

Каждый сервис поставляется в виде Docker-образов при установке продукта и представляет собой набор контейнеров, приложений и их конфигураций.

В системе доступны следующие типы сервисов:

  • Коллектор — сервис, который осуществляет сбор событий из источников, их обработку и дальнейшую отправку на хранение или во внешние системы.

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

Конфигурация сервиса:

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

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

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

  • Контроллер пространства — разворачивается в каждом пространстве и предназначен для контроля за ресурсами пространства и за состоянием его сервисов:

    • Контроль за ресурсами: при попытке запуска сервиса контроллер определяет, достаточно ли в пространстве системных ресурсов для его развертывания. При достаточном объеме ресурсов контроллер запустит сервис.

    • Контроль за сервисами: контроллер регулярно отслеживает состояние сервисов, собирает логи об их изменении и следит, чтобы все запущенные сервисы работали. Так, например, если какой-нибудь сателлит будет перезапущен, контроллер заново развернет все необходимые сервисы на этом сателлите.

  • Менеджер сервисов — представляет собой конкретную реализацию менеджера определенного типа сервисов. Отвечает за формирование Runtime-конфигурации нужного типа сервиса и взаимодействие этого сервиса с системой.

Интерфейс раздела

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

  • Кнопка Создать (plus) позволяет создать новый сервис.

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

  • Выпадающий список Тип позволяет настроить отображение списка сервисов в соответствии с их выбранными типами.

В рабочей области отображается таблица имеющихся сервисов. Таблица содержит следующие столбцы:

  • Активен — переключатель статуса сервиса.

    Переключатель доступен, если сервис находится в одном из следующих статусов:

    • Запущен;

    • Остановлен;

    • Ошибка;

    • Неизвестная ошибка.

  • Название — название сервиса, используемое для его идентификации в системе.

  • Тип — тип сервиса.

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

  • Статус — текущий статус сервиса:

    • Неустановленный — сервис создан и еще не запускался.

    • Ожидание — сервис находится в очереди на запуск.

    • Запускается — сервис находится в процессе запуска.

    • Запущен — сервис запущен и находится в активном состоянии.

    • Останавливается — сервис находится в процессе остановки.

    • Остановлен — сервис остановлен и недоступен для работы.

    • Ошибка — ошибка при запуске сервиса.

    • Неизвестная ошибка — неизвестная ошибка при работе сервиса.

При работе с таблицей сервисов доступны следующие операции:

  • Поиск сервисов по полям Название и Пространство.

  • Фильтрация сервисов по полю Тип. Тип выбирается из выпадающего списка. Доступен множественный выбор.

  • Сортировка сервисов по полям Название и Пространство.

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

Работа с сервисом

Доступные операции над сервисами:

Создание сервиса

Чтобы создать сервис:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Нажмите на кнопку Создать (plus) и выберите тип сервиса. Откроется окно создания сервиса.

  3. Задайте настройки сервиса.

    Настройки сервисов идентичны их настройкам в разделах системы, в которых они используются:

  4. Нажмите на кнопку Создать. Система создаст сервис и отобразит соответствующее уведомление. Сервис отобразится в списке раздела Настройки → Пространства и сервисы → Сервисы, а также в списке сервисов в карточке соответствующего подключения к пространству.

    Новый сервис типа Коллектор также отобразится в списке раздела Ресурсы → Коллекторы, а новый сервис типа Шлюз — в списке раздела Агенты → Шлюзы.

Вы также можете создать сервис из карточки подключения к пространству. Для этого:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Пространства. Система отобразит сведения об имеющихся подключениях к пространствам.

  2. Нажмите на строку подключения в списке. Система отобразит в правой части экрана карточку этого подключения с подробной информацией о нем.

  3. Нажмите на кнопку Добавить (plus) над списком сервисов в карточке подключения и выберите тип сервиса. Откроется окно создания сервиса.

  4. Задайте настройки сервиса.

  5. Нажмите на кнопку Создать. Система создаст сервис и отобразит соответствующее уведомление. Сервис отобразится в списке раздела Настройки → Пространства и сервисы → Сервисы, а также в списке сервисов в карточке соответствующего подключения к пространству.

Просмотр сервиса

Чтобы просмотреть сервис:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Нажмите на строку сервиса в списке. Система отобразит в правой части экрана карточку этого сервиса с подробной информацией о нем.

Вы также можете открыть карточку сервиса из карточки подключения к пространству:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Пространства. Система отобразит сведения об имеющихся подключениях к пространствам.

  2. Нажмите на строку подключения в списке. Система отобразит в правой части экрана карточку этого подключения с подробной информацией о нем.

  3. Нажмите на кнопку arrow right в правой части строки нужного сервиса в списке сервисов. Система осуществит переход в раздел Настройки → Пространства и сервисы → Сервисы и откроет карточку выбранного сервиса.

В верхней части карточки отображается название сервиса.

В карточке расположен переключатель состояния сервиса.

Переключатель доступен, если сервис находится в одном из следующих статусов:

  • Запущен;

  • Остановлен;

  • Ошибка;

  • Неизвестная ошибка.

Карточка содержит основные сведения о сервисе:

  • Метрики сервиса:

    • CPU — количество ядер и уровень загруженности процессора в сервисе.

    • RAM — объем и уровень загруженности оперативной памяти в сервисе.

  • Информация о сервисе:

    • ID — уникальный идентификационный код сервиса, генерируемый автоматически при его создании.

    • Название — имя сервиса, используемое для его идентификации в системе.

    • Тип — тип сервиса.

    • Статус — текущий статус сервиса:

      • Неустановленный — сервис создан и еще не запускался.

      • Ожидание — сервис находится в очереди на запуск.

      • Запускается — сервис находится в процессе запуска.

      • Запущен — сервис запущен и находится в активном состоянии.

      • Останавливается — сервис находится в процессе остановки.

      • Остановлен — сервис остановлен и недоступен для работы.

      • Ошибка — ошибка при запуске сервиса.

      • Неизвестная ошибка — неизвестная ошибка при работе сервиса.

      В строке поля также отображается кнопка refresh, по которой можно инициировать обновление статуса.

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

    • Тенант — название тенанта, к которому относится сервис.

    • Дата создания — дата и время создания сервиса.

    • Создал — пользователь, инициировавший создание сервиса.

    • Дата изменения — дата и время последнего изменения сервиса.

    • Изменил — пользователь, выполнивший последнее изменение сервиса.

    • Статус конфигурации — статус Runtime-конфигурации сервиса: Сохранен, Применен или Ошибка.

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

Удаление сервиса

Чтобы удалить сервис:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Нажмите на строку сервиса в списке. Система отобразит в правой части экрана карточку этого сервиса с подробной информацией о нем.

  3. Нажмите на кнопку trash в верхней части карточки сервиса. Отобразится окно подтверждения действия.

  4. Нажмите на кнопку Удалить. Система удалит выбранный сервис и отобразит соответствующее уведомление. Удаленный сервис будет исключен из списка раздела, а также из списка сервисов в карточке соответствующего подключения к пространству.

Запуск сервиса

Для того чтобы сервис мог начать работу, его нужно запустить.

Чтобы запустить сервис:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Нажмите на строку сервиса в списке. Система отобразит в правой части экрана карточку этого сервиса с подробной информацией о нем.

  3. Убедитесь, что в карточке сервиса открыта вкладка Информация.

  4. Переведите переключатель в верхней части карточки в активное положение и подтвердите запуск сервиса. Система запустит сервис и отобразит соответствующее уведомление.

Вы также можете запустить сервис из списка сервисов. Для этого:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Переведите переключатель слева от строки сервиса в списке в активное положение и подтвердите запуск сервиса. Система запустит сервис и отобразит соответствующее уведомление.

Запуск сервиса также возможен через карточку подключения к пространству, в котором создан сервис. Для этого:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Пространства. Система отобразит сведения об имеющихся подключениях к пространствам.

  2. Нажмите на строку подключения в списке. Система отобразит в правой части экрана карточку этого подключения с подробной информацией о нем.

  3. Переведите переключатель слева от строки сервиса в карточке подключения в активное положение и подтвердите запуск сервиса. Система запустит сервис и отобразит соответствующее уведомление.

Остановка сервиса

Чтобы остановить работающий сервис:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Нажмите на строку сервиса в списке. Система отобразит в правой части экрана карточку этого сервиса с подробной информацией о нем.

  3. Убедитесь, что в карточке сервиса открыта вкладка Информация.

  4. Переведите переключатель в верхней части карточки в неактивное положение и подтвердите остановку сервиса. Система остановит сервис и отобразит соответствующее уведомление.

Вы также можете остановить сервис через список сервисов. Для этого:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Переведите переключатель слева от строки сервиса в списке в неактивное положение и подтвердите остановку сервиса. Система остановит сервис и отобразит соответствующее уведомление.

Остановка сервиса также возможна через карточку подключения к пространству, в котором запущен сервис. Для этого:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Пространства. Система отобразит сведения об имеющихся подключениях к пространствам.

  2. Нажмите на строку подключения в списке. Система отобразит в правой части экрана карточку этого подключения с подробной информацией о нем.

  3. Переведите переключатель слева от строки сервиса в карточке подключения в неактивное положение и подтвердите остановку сервиса. Система остановит сервис и отобразит соответствующее уведомление.

Работа с логами сервиса

Логирование сервисов обеспечивает запись событий и состояний сервисов, что позволяет администраторам отслеживать и анализировать работу системы.

Функционал просмотра логов доступен через карточку сервиса.

Доступные операции над логами сервиса:

Просмотр логов сервиса

Чтобы просмотреть логи сервиса:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Нажмите на строку сервиса в списке. Система отобразит в правой части экрана карточку этого сервиса с подробной информацией о нем.

  3. Нажмите на кнопку Посмотреть логи в нижней части карточки. Система отобразит окно со списком логов сервиса.

В левом верхнем углу окна отображается ID просматриваемого сервиса.

Доступны два режима вывода логов:

  • Режим мониторинга — вывод логов в реальном времени.

  • Режим поиска по временному периоду — вывод логов в рамках заданного периода. Максимальный период запроса — 30 дней.

Переключатель Мониторинг позволяет управлять режимом вывода логов.

Время событий отображается в логах в формате YYYY-MM-DDThh:mm:ss.sssZ независимо от настроек интерфейса.

Фильтрация списка логов сервиса

Просмотр логов за конкретный временной интервал недоступен в режиме мониторинга.

Чтобы отфильтровать список логов сервиса:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Нажмите на строку сервиса в списке. Система отобразит в правой части экрана карточку этого сервиса с подробной информацией о нем.

  3. Нажмите на кнопку Посмотреть логи в нижней части карточки. Система отобразит окно со списком логов сервиса.

  4. Переведите переключатель Мониторинг в неактивное положение. Настройки фильтрации станут доступными для редактирования.

  5. Настройте период поиска логов. Для этого нажмите на кнопку calendar и выберите из выпадающего списка способ задания периода:

    • Последний период — задайте значение вручную или с помощью кнопок minus и plus, после чего выберите единицы времени из выпадающего списка. Поиск логов будет выполняться в указанном диапазоне вплоть до нынешнего момента.

    • Задать период — укажите даты начала и конца периода, за который будет выполняться поиск логов.

    • Часто используемые — выберите в разделе один из предлагаемых периодов.

  6. Нажмите на кнопку Найти. Список логов, соответствующий заданному периоду, отобразится в окне.

Копирование логов сервиса

Чтобы скопировать записи журнала логов сервиса:

  1. Перейдите в раздел Настройки → Пространства и сервисы → Сервисы. Система отобразит сведения об имеющихся сервисах.

  2. Нажмите на строку сервиса в списке. Система отобразит в правой части экрана карточку этого сервиса с подробной информацией о нем.

  3. Нажмите на кнопку Посмотреть логи в нижней части карточки. Система отобразит окно со списком логов сервиса.

  4. Нажмите на кнопку Скопировать в правой нижней части окна. Система скопирует записи журнала в буфер обмена и отобразит соответствующее уведомление.

Была ли полезна эта страница?

Обратная связь