Настройки Span

Версия ЕдиногоАгента 1.215+ Ключ-АСТРОМ версия 1.216+

Ключ-АСТРОМ автоматически захватывает все трассировки OpenTracing и OpenTelemetry, но вы можете контролировать и адаптировать способ объединения данных OpenTelemetry и OpenTracing с данными ЕдиногоАгента для создания распределенных трассировок PurePath®.

Настройки трассировки доступны в разделе Настройки > Мониторинг служб на стороне сервера. Вы можете определить правила для:

• Хранить и маскировать только определенные атрибуты — Захват атрибутов
• Исключить определенные span — Захват Span
• Определите span, которые следует рассматривать как точки входа — Точки входа Span
• Включить распространение контекста для определенных span — Распространение контекста Span

Атрибуты

Модуль кода ЕдиногоАгента, использующий OpenTelemetry Span Sensor, автоматически собирает все атрибуты OpenTelemetry. Чтобы предотвратить случайное сохранение персональных данных, можно исключить определенные ключи атрибутов, значения которых не должны сохраняться. Исключив атрибуты, содержащие персональные данные, вы можете выполнить требования вашей организации по обеспечению конфиденциальности и контролировать объем сохраняемых данных мониторинга.

Чтобы настроить параметры хранения атрибутов и маскирования для вашей среды

1. Перейдите на соответствующую страницу настроек:
   • В последней версии Ключ-АСТРОМ перейдите в Настройки > Сбор и захват данных > Общие параметры мониторинга > Функции ЕдиногоАгента.
   • В Ключ-АСТРОМ Classic перейдите в Настройки > Предпочтения > Сетевые модули и интеграции ЕдиногоАгента.
2. Выберите Мониторинг серверных служб > Сбор атрибутов.
3. необязательно Чтобы изменить параметр сохранения атрибутов OpenTelemetry по умолчанию, перейдите в Настройки.
   • Чтобы сохранить все атрибуты, кроме тех, что указаны в списке Заблокированные атрибуты, выберите Разрешить все атрибуты.
   • Чтобы заблокировать все атрибуты, кроме тех, которые указаны в списке разрешенных атрибутов , выберите Заблокировать все атрибуты. Возможен только один предпочтительный вариант настройки.
4. Добавьте имя атрибута в список атрибутов.
   1. На странице захвата атрибутов выберите Заблокированные атрибуты или Разрешенные атрибуты.
      Список разрешенных атрибутов Ключ-АСТРОМ рекомендует включать несколько основных атрибутов, таких как service.name или service.version. Для удобства использования Ключ-АСТРОМ поставляется с конфигурацией по умолчанию, которую можно изменить.
   2. Выберите Добавить элемент, чтобы добавить новый ключ в список атрибутов, и введите этот ключ.
   3. Выберите Сохранить изменения.
5. Выполните следующие действия, чтобы скрыть сохраненное значение атрибута.
   1. На странице захвата атрибутов выберите Маскирование данных атрибутов .
   2. Выберите Добавить элемент, чтобы добавить новый ключ в список атрибутов с маскировкой.
   3. Введите ключ сохраненного значения и выберите параметр из раскрывающегося списка Маскировка. Для получения дополнительной информации о параметрах маскирования см. трассировки OpenTelemetry.
   4. Выберите Сохранить изменения.

Затем вы сможете найти ключ атрибута на странице Распределенные трассировки.

Захват Span

По умолчанию захватываются все обнаруженные трассировки OpenTelemetry и OpenTracing. Это означает, что каждая обнаруженная трассировка добавляется к распределенным трассировкам. Это обеспечивает видимость на уровне кода вместе с атрибутами трассировки, даже для технологий, не поддерживаемых ЕдинымАгентом по умолчанию.

Вы можете создавать атрибуты запросов на основе Span для сегментации распределенных трассировок.

Мы рекомендуем исключить из списка поддерживаемые технологии, которые изначально поддерживаются ЕдинымАгентом для Java и Go.

Для управления захватом Span

1. Перейдите в Настройки > Мониторинг серверных служб > Захват Span.
2. Выберите Добавить элемент.
3. Введите название правила .
4. В списке действий правила выберите, хотите ли вы игнорировать или захватывать участки, соответствующие критериям, которые вы собираетесь определить.
5. Выберите Добавить элемент.
6. Вы можете управлять захватом Span на основе значений следующих источников:
   • Атрибут
   • Название области применения инструментария, OpenTelemetry
   • Версия инструментария
   • Тип Span — например, server
   • Название Span
7. Выберите тип сравнения — например, «Содержит» или «Равно» .
8. Введите значение для источника, указанного вами ранее.
9. По умолчанию поиск по ключу и значению не чувствителен к регистру. Включите параметр Чувствительность к регистру, если хотите, чтобы правило учитывало регистр ключа и значения.
10. Выберите Сохранить изменения.

Точки входа Span

По умолчанию:

• OpenTelemetry/OpenTracing автоматически охватывает различные типы данных server и consumer запускает новые распределенные трассировки. Это означает, что все ЕдиныеАгенты вносят свой вклад в эту распределенную трассировку, и для распределенной трассировки создается служба по умолчанию.
• OpenTelemetry/OpenTracing поддерживают различные типы трассировки и client не запускают автоматически новую распределенную трассировку internalproducer

• .Вы можете выбрать запуск распределенной трассировки на основе типов трассировки client, internal и producer, а также отказаться от использования типов трассировки server и consumer, в зависимости от различных параметров трассировки.

Для контроля точек ввода Span

1. Перейдите в Настройки > Мониторинг серверных служб > Точки входа Span.
2. Выберите Добавить элемент.
3. Введите название правила.
4. В списке действий правила укажите Создать точку входа или Не создавать точку входа для участков, соответствующих критериям, которые вы собираетесь определить.
5. Выберите Добавить элемент.
6. Вы можете управлять точками входа Span на основе значений следующих источников:
   • Атрибут
   • Название области применения инструментария, OpenTelemetry
   • Версия инструментария
   • Тип Span — например, server
   • Название Span
7. Выберите тип сравнения — например, «Содержит» или «Равно».
8. Введите значение для источника, указанного вами ранее.
9. По умолчанию поиск по ключу и значению не чувствителен к регистру. Включите параметр Чувствительность к регистру, если хотите, чтобы правило учитывало регистр ключа и значения.
10. Выберите Сохранить изменения.

Распространение контекста Span

Распространение контекста позволяет подключать распределенные трассировки через OpenTelemetry/OpenTracing. Вы можете подключать распределенные трассировки по любому протоколу и передавать информацию об использовании функций inject и extract в контекст распределенных трассировок Ключ-АСТРОМ PurePath®.

Чтобы снизить риск конфликтов распространения контекста со встроенными датчиками, распространение контекста по умолчанию отключено и ограничено диапазонами, соответствующими выбранным вами критериям.

Определить правила, позволяющие распространять контекст для конкретных участков текста.

1. Перейдите в Настройки > Мониторинг серверных служб > Распространение контекста Span.
2. Выберите Добавить элемент.
3. Введите название правила.
4. В списке действий правила укажите Распространять или Не распространять контекст трассы для трассировок, соответствующих критериям, которые вы собираетесь определить.
5. Выберите Добавить элемент.
6. Вы можете управлять распространением контекста сегмента на основе значений следующих источников.
   • Атрибут
   • Название области применения инструментария, OpenTelemetry
   • Версия инструментария
   • Тип Span — например, server
   • Название Span
7. Выберите тип сравнения — например, «Содержит» или «Равно».
8. Добавьте значение для источника, указанного вами ранее.
9. По умолчанию поиск по ключу и значению не чувствителен к регистру. Включите параметр Чувствительность к регистру, если хотите, чтобы правило учитывало регистр ключа и значения.
10. Выберите Сохранить изменения.