Руководство по системному администрированию#

О документе#

Документ содержит описание системного администрирования компонента Индексированный поиск (IDXS) продукта Platform V Search (SRH).

Расшифровку основных понятий см. в документе "Термины и определения".

Сценарии администрирования#

Администратору рекомендуется регулярно выполнять:

контроль состояния работы системы;
мониторинг производительности системы;
контроль свободного места на жестких дисках всех серверов системы, а также в файловой системе.

При выявлении нештатных ситуаций необходимо:

проверить работоспособность всех сервисов компонента Индексированный поиск (IDXS);
проверить логи на наличие ошибок.

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

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

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

Специалисты, занимающиеся администрированием компонента Индексированный поиск (IDXS), должны обладать следующими навыками:

развертывание и администрирование приложений в среде контейнеризации;
настройка сервера NGINX.

События системного журнала#

В компоненте IDXS реализован механизм логирования с использованием внешнего платформенного компонента журналирования. В качестве такого компонента рекомендуется использовать платформенный компонент Журналирование ЕФС (LOGE). В журналах событий содержится информация об ошибках, возникших в процессе работы приложения, отладочная информация, обращения к REST-сервису. Существует возможность настройки уровней логирования, нет возможности отключения логирования. Уровни логирования настраиваются системным администратором во внешнем платформенном компоненте Журналирование ЕФС (LOGE) при его использовании в соответствии с его эксплуатационной документацией. По умолчанию выполняется регистрация с уровнем логирования error.

Фильтрация и публикация зарегистрированных событий осуществляется c использованием внешнего платформенного компонента журналирования.

Если в системном журнале нет сообщений об ошибках, значит все работает штатно.

Сообщение	Уровень логирования	Компонент	Описание события
"Inner exception $exception"	ERROR	ETL	Ошибка при определении типа исключения. Подробности в логе
"Error migration"	ERROR	ETL	Ошибка при миграции данных
"Error create index"	ERROR	ETL	Ошибка создания индекса при миграции данных
"Error reconfiguration tasks"	ERROR	ETL	Ошибка при переконфигурации задания
"Error domain schema migration"	ERROR	ETL	Ошибка при миграции схемы
"Error has occurred in job execution."	ERROR	ETL	Ошибка при обновлении домена
"Unknown version conflict. Response \n{}", response	ERROR	ETL	В ответе не найден json-узел «/version_conflicts»
"Actualize failed for task domain {}", domainConfig.getId()	ERROR	ETL	Ошибка при актуализации задания
"Something wrong. DomainConfiguration is null"	ERROR	ETL	Конфигурация для синхронизации информации в домене не установлена
"Something wrong. Config is null"	ERROR	ETL	Конфигурация для синхронизации информации в домене не установлена
"Error transition change status in IN_PROGRESS"	ERROR	ETL	Ошибка при установке домену статуса "IN_PROGRESS"
"Audit send event UFS_INDEX_SEARCH_SET_UPDATES is failed"	ERROR	ETL	Ошибка при попытке отправить в аудит событие UFS_INDEX_SEARCH_SET_UPDATES]. Подробности в логе.
"Audit send event UFS_INDEX_SEARCH_LOAD_BATCH is failed"	ERROR	ETL	Ошибка при попытке отправить в аудит событие UFS_INDEX_SEARCH_LOAD_BATCH. Подробности в логе.
"Audit send event UFS_INDEX_SEARCH_VERSION_INIT is failed"	ERROR	ETL	Ошибка при попытке отправить в аудит событие UFS_INDEX_SEARCH_VERSION_INIT]. Подробности в логе.
"Audit send event UFS_INDEX_SEARCH_VERSION_ACTIVATE is failed"	ERROR	ETL	Ошибка при попытке отправить в аудит событие UFS_INDEX_SEARCH_VERSION_ACTIVATE. Подробности в логе.
"Audit send event UFS_INDEX_SEARCH_VERSION_CANCEL is failed"	ERROR	ETL	Ошибка при попытке отправить в аудит событие UFS_INDEX_SEARCH_VERSION_CANCEL. Подробности в логе.
"Ошибка во время работы сервиса сбора метрик кластера"	ERROR	Proxy	При сборе метрик кластера произошла ошибка. Подробности указаны в логе.
"Ошибка сбора метрик индексов"	ERROR	Proxy	При сборе метрик индексов произошла ошибка. Подробности указаны в логе.
"Ошибка сбора метрик node"	ERROR	Proxy	При сборе метрик node произошла ошибка. Подробности указаны в логе.
"Ошибка сбора метрик кластера"	ERROR	Proxy	При сборе метрик произошла ошибка. Подробности указаны в логе.
"Ошибка сбора метрик здоровья"	ERROR	Proxy	При сборе метрик здоровья произошла ошибка. Подробности указаны в логе.
"Error send event {} to audit. Domain {}", eventCode, domain	ERROR	Proxy	При отправке события в аудит произошла ошибка
"Error sent event {} to audit", eventCode	ERROR	Proxy	При отправке события в аудит произошла ошибка
"Missing permission for domain: {}", domain	ERROR	Proxy	Не указаны права для домена
"Error extract content from response"	WARN	ETL	Невозможно получить содержимое из ответа
"{} out of bound. Actual {} > Max {}", entity, v, Int.MAX_VALUE	WARN	ETL	Номер страницы превышает максимальное допустимое значение для Integer
"Can not acquire lock"	WARN	ETL	Невозможно получить блокировку
"Error transform _id"	WARN	ETL	Ошибка при преобразовании идентификатора
"Error transform field {}", fieldName	WARN	ETL	Ошибка при преобразовании поля fieldName
"Version conflict count {}. Attempt {} of {}", versionConflict, attempt, retryCount	WARN	ETL	Количество документов, которые не удалось удалить. Количество попыток обновления при удалении данных, общее количество ошибок.
"Error while parsing field avaliableServices"	WARN	ETL	Ошибка парсинга поля «avaliableServices».
"Channel in session is null or empty. Security may be work with an error. Return project subsystemChannel {}", subsystemChannel	WARN	Proxy	В сессии не указан канал. Будет использован канал подсистемы. Авторизация может работать с ошибками.
"Ошибка парсинга телефона " + phone	WARN	Proxy	Ошибка парсинга телефона. Формат телефонного номера должен быть «(X…X)X…X», где X…X – последовательность цифр
"Ошибка парсинга геокоординат"	WARN	Proxy	Ошибка парсинга геокоординат. Координаты должны быть представлены числом с плавающей точкой

События мониторинга#

В компоненте Индексированный поиск (IDXS) реализован мониторинг событий с использованием компонента Прикладной мониторинг ЕФС (MONE).

Требования к мониторингу dashboard-компонента#

Название	Значение	Описание	Метрика/Событие
HTTP_REQUEST_FAIL	Не удалось выполнить http запрос	Неуспешное выполнение: Обработка http запроса завершилась с ошибкой	Событие
HTTP_REQUEST_FAIL_DURATION	Длительность http запроса (результат - error)	Длительность неуспешно выполненного http запроса в миллисекундах	Метрика
HTTP_REQUEST_RECEIVED	Получен http запрос	Факт получение запроса сервером	Событие
HTTP_REQUEST_SUCCESS	Http запрос исполнен успешно	Успешное выполнение: Обработка http запроса завершилась без ошибок	Событие
HTTP_REQUEST_SUCCESS_DURATION	Длительность http запроса	Длительность успешно выполненного http запроса в миллисекундах	Метрика
INSTANCE_START	Сервис стартовал	Факт старта сервиса	Событие
INSTANCE_STOP	Сервис остановлен	Сервис успешно остановлен	Событие
UFS_INDEX_SEARCH_SEARCH_FAILED_SHARDS	Shard неуспешно обработал запрос поиска	Shard неуспешно обработал запрос поиска	Событие

Требования к мониторингу Indexer-компонента#

Следующие метрики и события являются общими для всех операций:

Название	Значение	Описание	Метрика/Событие
HTTP_REQUEST_RECEIVED	Получен http запрос	Факт получение запроса сервером	Событие
HTTP_REQUEST_SUCCESS	Http запрос исполнен успешно	Успешное выполнение: Обработка http запроса завершилась без ошибок	Событие
HTTP_REQUEST_SUCCESS_DURATION	Длительность http запроса	Длительность успешно выполненного http запроса в миллисекундах	Метрика
HTTP_REQUEST_FAIL	Не удалось выполнить http запрос	Неуспешное выполнение: Обработка http запроса завершилась с ошибкой	Событие
HTTP_REQUEST_FAIL_DURATION	Длительность http запроса (результат - error)	Длительность неуспешно выполненного http запроса в миллисекундах	Метрика

Метрики и события по операциям, переданным через Kafka#

Название	Значение	Описание	Метрика/Событие
KAFKA_REQUEST_RECEIVED	Получен Kafka запрос	Факт получения запроса сервером	Событие
KAFKA_REQUEST_SUCCESS	Получен Kafka запрос	Успешное выполнение: Обработка Kafka запроса завершилась без ошибок	Событие
KAFKA_DURATION_SUCCESS	Длительность Kafka запроса	Длительность успешно выполненного Kafka запроса в миллисекундах	Метрика
KAFKA_REQUEST_FAIL	Не удалось выполнить Kafka запрос	Неуспешное выполнение: Обработка Kafka запроса завершилась с ошибкой	Событие
KAFKA_DURATION_FAIL	Длительность Kafka запроса (результат - error)	Длительность неуспешно выполненного Kafka запроса в миллисекундах	Метрика
KAFKA_OFFSET_TOPIC	Порядковый номер offset сообщения	Порядковый номер offset сообщения, считанный из Topic Kafka	Метрика
KAFKA_REGISTERED_CONSUMER	Наименование Topic Kafka	Наименование успешно подключенного Topic Kafka	Метрика
KAFKA_REGISTERED_CONSUMER_FAIL	Наименование Topic Kafka (error)	Неуспешное выполнение: наименование Topic Kafka	Метрика
KAFKA_REQUEST_ERROR_TOPIC_FAIL	Неуспешная отправка сообщения в Topic с ошибками	Неуспешная отправка сообщения об ошибке в Topic Kafka	Метрика

Метрики и события по операциям#

Наименование операции	Название	Значение	Описание	Метрика/Событие	Атрибуты	Описание атрибутов
batch	LOAD_DOCUMENT_FAIL_COUNT	Количество неуспешно загруженных записей	Количество неуспешно загруженных записей	Метрика	SCHEMA DOMAIN	Название схемы Название домена данных
batch	LOAD_DOCUMENT_SUCCESS_COUNT	Количество успешно загруженных записей	Количество успешно загруженных записей	Метрика	SCHEMA DOMAIN	Название схемы Название домена данных

Также со всеми вышеописанными метриками и событиями прикреплены следующие атрибуты:

Название	Описание	Обязательный
URI	URI запроса операции	Да

Мониторинг ETL-компонента#

Описание метрик/событий:

Название метрики/события	Наименование бизнес-операции и ее описание (title)	Тип метрики
UFS_INDEX_SEARCH_ETL_INDEX_UPDATE_FAIL_TIME	Длительность обновления индекса (результат − "FAIL")	Metric
UFS_INDEX_SEARCH_ETL_INDEX_UPDATE_SUCCESS_TIME	Длительность обновления индекса (результат − "SUCCESS")	Metric
UFS_INDEX_SEARCH_ETL_INDEX_DELETION_SUCCESS_TIME	Длительность этапа очистки индекса	Metric
UFS_INDEX_SEARCH_ETL_DATA_EXTRACTION_SUCCESS_TIME	Длительность этапа получения данных из источника	Metric
UFS_INDEX_SEARCH_ETL_DATA_TRANSFORMATION_SUCCESS_TIME	Длительность этапа преобразования данных	Metric
UFS_INDEX_SEARCH_ETL_INDEX_SAVE_PROCEDURE_SUCCESS_TIME	Длительность процедуры SAVE	Metric
UFS_INDEX_SEARCH_ETL_INDEX_UPDATE_PROCEDURE_SUCCESS_TIME	Длительность процедуры UPDATE	Metric
UFS_INDEX_SEARCH_ETL_INDEX_UPDATE_ITERATION_SUCCESS_TIME	Длительность итерации обновления индекса	Metric
UFS_INDEX_SEARCH_ETL_INDEX_UPDATE_START	Запуск обновления индекса	Event
UFS_INDEX_SEARCH_ETL_INDEX_UPDATE_START_FAIL	Не удалось запустить обновление индекса	Event
UFS_INDEX_SEARCH_ETL_DATA_EXTRACTION_FAIL	Не удалось загрузить данные для обновления индекса	Event
UFS_INDEX_SEARCH_ETL_INDEX_DELETION_FAIL	Не удалось очистить индекс	Event
UFS_INDEX_SEARCH_ETL_SUSPENDED_PROCEDURE_STATUS_UPDATE_FAIL	Не удалось зарегистрировать в индексе .etl_sync неуспешную попытку обновления домена данных	Event
UFS_INDEX_SEARCH_ETL_COMPLETED_PROCEDURE_SUCCESS_UPDATE_FAIL	Не удалось зарегистрировать в индексе .etl_sync успешное обновление домена данных	Event
UFS_INDEX_SEARCH_ETL_INDEX_UPDATE_SUCCESS	Индекс успешно обновлен	Event
HTTP_REQUEST_RECEIVED	Получен http-запрос	Event
HTTP_REQUEST_SUCCESS	Http-запрос выполнен успешно	Event
HTTP_REQUEST_SUCCESS_DURATION	Длительность http-запроса	Metric
HTTP_REQUEST_FAIL	Не удалось выполнить http-запрос	Event
HTTP_REQUEST_FAIL_DURATION	Длительность http-запроса (результат − error)	Metric
LOAD_DOCUMENT_FAIL_COUNT	Количество неуспешно загруженных записей	Metric

Мониторинг Proxy-компонента#

Описание метрик/событий:

Название метрики/события	Наименование бизнес-операции и ее описание (title)	Тип метрики
UFS_INDEX_SEARCH_PROXY_SEARCH_FAIL_TIME	Длительность обработки поискового запроса (результат − "ERROR")	Metric
UFS_INDEX_SEARCH_PROXY_SEARCH_SUCCESS_TIME	Длительность обработки поискового запроса	Metric
UFS_INDEX_SEARCH_PROXY_SEARCH_REQ_RECEIVED	Получен поисковый запрос	Event
UFS_INDEX_SEARCH_PROXY_SEARCH_FAIL	Не удалось выполнить поиск	Event
UFS_INDEX_SEARCH_PROXY_SEARCH_SUCCESS	Поиск выполнен успешно	Event

Мониторинг кластера SRHX на стороне Proxy-компонента#

Описание метрик/событий:

Наименование бизнес-операции и ее описание (title)	Тип метрики	Название метрики/события
Ошибка мониторинга состояния кластера SRHX	Event	UFS_INDEX_SEARCH_ES_MONITORING_FAIL
Количество документов (по всем Shards)	Metric	UFS_INDEX_SEARCH_ES_DOCS_COUNT
Количество удаленных документов (по всем Shards)	Metric	UFS_INDEX_SEARCH_ES_DOCS_DELETED
Количество документов всего (по всем Shards)	Metric	UFS_INDEX_SEARCH_ES_DOCS_ALL
Общие метрики состояния кластера SRH (запрос _cluster /health )
Показатель "здоровья" кластера	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_HEALTH_STATUS
Количество узлов в кластере	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_HEALTH_NUMBER_OF_NODES
Количество узлов данных	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_HEALTH_NUMBER_OF_DATA_NODES
Количество Shards, находящихся в процессе ребаланса	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_HEALTH_RELOCATING_SHARDS
Количество Shards, находящихся в процессе инициализации	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_HEALTH_INITIALIZING_SHARDS
Количество Shards, не размещенных на узлах кластера	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_HEALTH_UNASSIGNED_SHARDS
Количество задач уровня кластера в очереди на исполнение	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_HEALTH_NUMBER_OF_PENDING_TASKS
Максимальная длительность ожидания (в мс) в очереди на выполнение	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_HEALTH_TASK_MAX_WAITING_IN_QUEUE_MILLIS
Доля (в процентах) активных Shards в кластере	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_HEALTH_ACTIVE_SHARDS_PERCENT_AS_NUMBER
Расширенная статистика по кластеру SRHX (_cluster /stats )
Количество проиндексированных записей в кластере по состоянию на текущий момент времени	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_STATS_INDICES_DOCS_COUNT
Общее количество индексов	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_STATS_INDICES_COUNT
Общий объем дискового пространства (в байтах). Статистика по кластеру	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_STATS_FS_TOTAL_IN_BYTES
Объем доступного дискового пространства (в байтах). Статистика по кластеру	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_STATS_FS_AVAILABLE_IN_BYTES
Объем свободного дискового пространства (в байтах). Статистика по кластеру	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_STATS_FS_FREE_IN_BYTES
Общее количество сегментов	Metric	UFS_INDEX_SEARCH_ES_CLUSTER_STATS_INDICES_SEGMENTS_COUNT
Статистика по node (_nodes /stats )
Объем памяти, выделенной для кучи (heap), в байтах. Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_JVM_MEM_HEAP_MAX_IN_BYTES
Объем используемой памяти (heap), в байтах. Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_JVM_MEM_HEAP_USED_IN_BYTES
Доля используемой памяти в процентах от общего объема памяти, выделенного для кучи (heap). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_JVM_MEM_HEAP_USED_PERCENT
Общий объем дискового пространства (в байтах). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_FS_TOTAL_TOTAL_IN_BYTES
Объем доступного дискового пространства (в байтах). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_FS_TOTAL_FREE_IN_BYTES
Объем свободного дискового пространства (в байтах). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_FS_TOTAL_AVAILABLE_IN_BYTES
Количество открытых http-подключений к node на момент опроса	Metric	UFS_INDEX_SEARCH_ES_NODE_HTTP_CURRENT_OPEN
Общее количество открытых http-подключений к node	Metric	UFS_INDEX_SEARCH_ES_NODE_HTTP_TOTAL_OPENED
Время, которое кластер потратил на ожидание при индексации новых данных	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_INDEXING_THROTTLE_TIME_IN_MILLIS
Включает в себя не только время ожидания при восстановлении Shards (например, после сбоев), но и время ожидания при перемещении Shards с node на node (например, при ребалансе или миграции Shards между зонами hot/warm)	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_RECOVERY_THROTTLE_TIME_IN_MILLIS
Общее время, затраченное кластером на ожидание объединения сегментов на данной node. Накопительный счетчик	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_MERGES_TOTAL_THROTTLED_TIME_IN_MILLIS
Счетчик опросов (1-ая фаза поиска). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_SEARCH_QUERY_TOTAL
Общая длительность всех опросов (1-ая фаза поиска). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_SEARCH_QUERY_TIME_IN_MILLIS
Счетчик выполненных задач в Pool потоков "write". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_WRITE_COMPLETED
Количество задач в очереди Pool потоков "write". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_WRITE_QUEUE
Счетчик количества отказов по задачам в Pool потоков "write". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_WRITE_REJECTED
Счетчик выполненных задач в Pool потоков "refresh". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_REFRESH_COMPLETED
Количество задач в очереди Pool потоков "refresh". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_REFRESH_QUEUE
Счетчик количества отказов по задачам в Pool потоков "refresh". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_REFRESH_REJECTED
Счетчик выполненных задач в Pool потоков "search". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_SEARCH_COMPLETED
Количество задач в очереди Pool потоков "search". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_SEARCH_QUEUE
Счетчик количества отказов по задачам в Pool потоков "search". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_SEARCH_REJECTED
Счетчик выполненных задач в Pool потоков "get". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_GET_COMPLETED
Количество задач в очереди Pool потоков "get". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_GET_QUEUE
Счетчик количества отказов по задачам в Pool потоков "get". Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_THREAD_POOL_GET_REJECTED
Количество опросов (1-ая фаза поиска), выполняемых в настоящий момент. Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_SEARCH_QUERY_CURRENT
Счетчик извлечений (2-ая фаза поиска). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_SEARCH_FETCH_TOTAL
Общая длительность извлечения данных (2-ая фаза поиска). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_SEARCH_FETCH_TIME_IN_MILLIS
Количество извлечений (2-ая фаза поиска), выполняемых в настоящий момент. Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_NDICES_SEARCH_FETCH_CURRENT
Счетчик операций индексирования. Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_INDEX_TOTAL
Суммарная длительность операций индексирования. Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_INDEX_TIME_IN_MILLIS
Количество операций, индексирования, выполняемых в настоящий момент	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_INDEX_CURRENT
Счетчик обновлений (refreshes). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_REFRESH_TOTAL
Общая длительность обновлений (refreshes). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_REFRESH_TOTAL_TIME_IN_MILLIS
Счетчик сбросов (flushes). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_FLUSH_TOTAL
Общая длительность сбросов (flushes). Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_FLUSH_TOTAL_TIME_IN_MILLIS
Total count of young-generation garbage collections	Metric	UFS_INDEX_SEARCH_ES_NODE_JVM_GC_COLLECTORS_YOUNG_COLLECTION_COUNT
Total time spent on young-generation garbage collections	Metric	UFS_INDEX_SEARCH_ES_NODE_JVM_GC_COLLECTORS_YOUNG_COLLECTION_TIME_IN_MILLIS
Total count of old-generation garbage collections	Metric	UFS_INDEX_SEARCH_ES_NODE_JVM_GC_COLLECTORS_OLD_COLLECTION_COUNT
Total time spent on old-generation garbage collections	Metric	UFS_INDEX_SEARCH_ES_NODE_JVM_GC_COLLECTORS_OLD_COLLECTION_TIME_IN_MILLIS
Size of fielddata cache (bytes)	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_FIELDDATA_MEMORY_SIZE_IN_BYTES
Number of evictions from fielddata cache	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_FIELDDATA_EVICTIONS
How many times the circuit breaker has been tripped	Metric	UFS_INDEX_SEARCH_ES_NODE_BREAKERS_FIELDDATA_TRIPPED
Количество сегментов. Статистика по узлу кластера	Metric	UFS_INDEX_SEARCH_ES_NODE_INDICES_SEGMENTS_COUNT
Open_file_descriptors	Metric	UFS_INDEX_SEARCH_ES_NODE_PROCESS_OPEN_FILE_DESCRIPTORS
Max_file_descriptors	Metric	UFS_INDEX_SEARCH_ES_NODE_PROCESS_MAX_FILE_DESCRIPTORS
Показатели состояния индексов (_stats)
Счетчик запросов (1-ая фаза поиска). Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_SEARCH_QUERY_TOTAL
Общая длительность всех запросов (1-ая фаза поиска). Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_SEARCH_QUERY_TIME_IN_MILLIS
Количество запросов (1-ая фаза поиска), выполняемых в настоящий момент. Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_SEARCH_QUERY_CURRENT
Счетчик извлечений (2-ая фаза поиска). Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_SEARCH_FETCH_TOTAL
Общая длительность всех извлечений (2-ая фаза поиска). Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_SEARCH_FETCH_TIME_IN_MILLIS
Количество извлечений (2-ая фаза поиска), выполняемых в настоящий момент. Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_SEARCH_FETCH_CURRENT
Счетчик операций индексирования. Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_TOTAL
Суммарная длительность операций индексирования. Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_INDEXING_TIME_IN_MILLIS
Количество операций, индексирования, выполняемых в настоящий момент. Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_INDEXING_CURRENT
Счетчик обновлений (refresh). Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_REFRESH_TOTAL
Общая длительность обновлений (refresh). Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_REFRESH_TOTAL_TIME_IN_MILLIS
Счетчик сбросов (flush). Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_FLUSH_TOTAL
Общая длительность сбросов (flushes). Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_FLUSH_TOTAL_TIME_IN_MILLIS
Size of fielddata cache (bytes) (по всем Shards)	Metric	UFS_INDEX_SEARCH_ES_INDEX_FIELDDATA_MEMORY_SIZE_IN_BYTES
Number of evictions from fielddata cache (по всем Shards)	Metric	UFS_INDEX_SEARCH_ES_INDEX_FIELDDATA_EVICTIONS
Количество сегментов. Статистика по всем Shards индекса	Metric	UFS_INDEX_SEARCH_ES_INDEX_SEGMENTS_COUNT

Настройки#

Параметры для настройки компонента Индексированный поиск (IDXS) хранятся в платформенном компоненте Управление параметрами ЕФС (CFGE).

Параметры ETL-компонента:

Имя параметра	Тип	Группа атрибутов	Описание
ufs.baseurl.elastic.etl	Строка [STRING]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	URL Поисковой движок
Настройки IDXS
bfs.index.etl.domain.cron	Строка [STRING]	TASK_DOMAIN_ID	Расписание обновления индекса в виде cron expression. Первое поле записи − секунды
bfs.index.etl.domain.bulk.batch	Число [LONG]	TASK_DOMAIN_ID	Максимальное количество документов (размер пачки), индексируемых в рамках одной операции
bfs.index.etl.domain.timeout	Число [LONG]	TASK_DOMAIN_ID	Разрешенное время (мс) на обновление индекса. Значение по умолчанию − 3600000 (1 час)
bfs.index.etl.task.domain.enable	Логическое [BOOLEAN]	TASK_DOMAIN_ID	Включение/выключение задачи обновления данных: true − задача включена, false − задача отключена. Значение параметра применяется, если разрешено обновление домена данных (параметр bfs.index.etl.domain.enable с учетом разреза имеет значение true). Иначе (параметр bfs.index.etl.domain.enable с учетом разреза имеет значение false) все задачи обновления данных в этом домене отключены независимо от значений bfs.index.etl.task.domain.enable
bfs.index.etl.domain.purify.attempts	Число [LONG]	DOMAIN_CODE	Максимальное количество попыток очищения домена данных (по умолчанию − 1, максимальное количество − 127, минимальное количество − 1)
bfs.index.etl.elastic.rest.https.enable	Логическое [BOOLEAN]	SUBSYSTEM	Схема (протокол) взаимодействия между etl-компонентом и кластером Поисковой движок (true − HTTPS, false − HTTP)
bfs.index.etl.domain.enable	Логическое [BOOLEAN]	DOMAIN_CODE	Включение/выключение обновления индекса (true − обновление разрешено, false − обновление запрещено)
bfs.index.etl.source.enable	Логическое [BOOLEAN]	SOURCE_TYPE_CODE	Можно ли использовать источник для обновления индекса (true − обновление разрешено, false − обновление запрещено)
bfs.index.etl.elastic.rest.autobalancing.enable	Логическое [BOOLEAN]	SUBSYSTEM	Включение/выключение автоматической балансировки
bfs.index.etl.elastic.header.name.force	Строка [STRING]	SUBSYSTEM	Имя header-а для маршрутизации к требуемому контуру
Настройки http-клиента
ufs.httpclient.time-out.request.milliseconds.elastic.etl	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Таймаут запроса в миллисекундах (значение по умолчанию − 3000, 0 − бесконечный таймаут)
ufs.httpclient.time-out.connection.milliseconds.elastic.etl	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Таймаут на установку соединения в миллисекундах (значение по умолчанию − 500, 0 − бесконечный таймаут)
ufs.httpclient.connections.max.total.elastic.etl	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Максимальное число соединений в Pool (значение по умолчанию − 40)
ufs.httpclient.connections.max.per-route.elastic.etl	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Максимальное число соединений на URL (значение по умолчанию − 10)
ufs.httpclient.headers.name.server-ip.elastic.etl	Строка [STRING]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Имя http-заголовка для передачи ip-адреса клиента (значение по умолчанию − ufs-client-ip)

Параметры proxy-компонента:

Имя параметра	Тип	Группа атрибутов	Описание
ufs.baseurl.elastic.proxy	Строка [STRING]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	URL Поисковой движок
Настройки IDXS
bfs.index.proxy.elastic.rest.https.enable	Логическое [BOOLEAN]	SUBSYSTEM	Схема (протокол) взаимодействия между proxy-компонентом и кластером Поисковой движок (true − HTTPS, false − HTTP)
bfs.index.proxy.elastic.rest.autobalancing.enable	Логическое [BOOLEAN]	SUBSYSTEM	Включение/выключение автоматической балансировки
bfs.index.proxy.elastic.monitoring.period	Число [LONG]	SUBSYSTEM	Длительность временного окна (мс) для получения метрик состояния кластера Поисковой движок (максимальное значение − 600000 (10 минут))
bfs.index.proxy.elastic.header.name.force	Строка [STRING]	SUBSYSTEM	Имя header-а для маршрутизации к требуемому контуру
Настройки http-клиента
ufs.httpclient.time-out.request.milliseconds.elastic.proxy	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Таймаут запроса в миллисекундах (значение по умолчанию − 3000, 0 − бесконечный таймаут)
ufs.httpclient.time-out.connection.milliseconds.elastic.proxy	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Таймаут на установку соединения в миллисекундах значение по (умолчанию − 500, 0 − бесконечный таймаут)
ufs.httpclient.time-out.request.connection.milliseconds.elastic.proxy	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Таймаут запроса соединения из Pool в миллисекундах (значение по умолчанию − 500, 0 − бесконечный таймаут)
ufs.httpclient.time-out.socket.milliseconds.elastic.proxy	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Таймаут ожидания данных после установки соединения, таймаут между двумя пакетами данных (значение по умолчанию − 3000, где 0 − бесконечный таймаут)
ufs.httpclient.connections.max.total.elastic.proxy	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Максимальное число соединений в Pool (значение по умолчанию − 40)
ufs.httpclient.connections.max.per-route.elastic.proxy	Число [LONG]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Максимальное число соединений на URL (значение по умолчанию − 10)
ufs.httpclient.headers.name.server-ip.elastic.proxy	Строка [STRING]	PLATFORM_RUNTIME_ENVIRONMENT/SUBSYSTEM	Имя http-заголовка для передачи ip-адреса клиента (значение по умолчанию − ufs-client-ip)