Конфигурация трейсинга в сервисах#
Трассировка вызовов HTTP и обращений к базе данных в сервисах предоставляет диагностическую информацию, которая может быть использована для локализации и последующего решения проблем и инцидентов. В случае, если запрос пользователя затрагивает работу нескольких сервисов, трассировка будет составной и будет включать информацию обо всех вызванных сервисах.
Трейсинг доступен для следующих сервисов:
Archive service;
Client api service;
Flow service;
Full text index service;
Kafka service;
Monitoring service;
PVM Base service;
Для настройки используется следующий набор парметров:
Имя параметра |
Описание |
Тип |
Значение по умолчанию |
Обязательность |
|---|---|---|---|---|
common.tracing.enabled |
Включение/отключение функциональности трейсинга |
boolean |
false |
нет |
common.tracing.backend-url |
URL сервера выполняющего сбор трейсов. Формат: scheme://host:port/api/v2/spans. |
string |
- |
нет |
common.tracing.sampling-percent |
Количество трейсов в процентном отношении, которые будут отправлены на сервер сбора трейсов. Если был создан составной трейс, то он отправляется на сервер целиком. Возможные значения: 1-100. |
integer |
100 |
нет |
При необходимости настройки TLS подключения для публикации трейсов будут использоваться глобальные настройки TLS для всего модуля, а именно:
Имя параметра |
Описание |
Тип |
Значение по умолчанию |
Обязательность |
|---|---|---|---|---|
common.global.client.ssl.truststore-location |
Путь к хранилищу доверенных сертификатов (глобальный для всего модуля) |
string |
- |
нет |
common.global.client.ssl.keystore-location |
Путь к хранилищу клиентских сертификатов (глобальный для всего модуля) |
string |
- |
нет |
common.global.client.ssl.truststore-password |
Пароль от хранилища доверенных сертификатов (глобальный для всего модуля) |
password |
- |
нет |
common.global.client.ssl.keystore-password |
Пароль от хранилища клиентских сертификатов (глобальный для всего модуля) |
password |
- |
нет |
common.global.client.ssl.key-password |
Пароль от приватного ключа (глобальный для всего модуля) |
password |
- |
нет |
common.global.client.ssl.store-type |
Тип хранилища сертификатов (глобальный для всего модуля). Допустимые значения: |
string_enum |
JKS |
нет |
- JKS, |
||||
- PKCS12. |
||||
common.global.client.ssl.verify-hosts |
Параметр включающий проверку сертификата хоста при установлении TLS соединения (глобальный для всего модуля) |
boolean |
false |
нет |
Для работы с трейсами необходимо:
Переложить их в топик Kafka (для этого можно использовать функциональность Trace Collector сервиса). В качестве параметра common.tracing.backend-url использовать endpoint выделенного Trace Collector сервиса.
Создать задачу аналитического индекса на основе данных из исходного топика.
Сконфигурировать источник трейсов с помощью функциональности Trace Query сервиса.
Просматривать и анализировать полученные трейсы можно будет на вкладке «Трейсинг» в UI Coordinator.