Функции могут быть вызваны как UseModule("Observability")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| ApplyRecordIndexes | Индексирование записи Observability
Подробнее...
Проставляет тип записи OBSERVABILITY, нормализует ключ, название, тип настройки и служебные индексы 1288 для поиска profiles, routing policies, retention policies, dashboards и sinks. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataRecord | $record | Обязательный | Запись настройки Observability перед сохранением. |
|
| ApplyRetentionPolicy | Dry-run применения retention policy Observability
Подробнее...
Разделяет элементы Observability на сохраняемые и просроченные по retention policy без физического удаления данных. Используется для диагностики и TestA. | | Тип | Параметр | По умолчанию | Описание | | Array | $items | array (
) | Список сигналов, snapshots или диагностических пакетов с timestamp или createdAt. | | Array | $policy | array (
) | Retention policy с ttlDays или rawTtlDays. | | Array | $options | array (
) | Параметры dry-run: now и includeItems. |
|
| BuildDiagnosticPackage | Формирование диагностического пакета Observability
Подробнее...
Формирует безопасный диагностический пакет по trace id или набору сигналов: summary, маскированные сигналы и ссылки на внешние diagnostics без включения доменного текста, вложений и секретов. | | Тип | Параметр | По умолчанию | Описание | | Array | $signals | array (
) | Список эксплуатационных сигналов, из которых формируется пакет. | | Array | $options | array (
) | Параметры пакета: traceId, maxSignals, retentionPolicyKey и maskPolicy. |
|
| BuildMetricSnapshot | Построение среза метрик Observability
Подробнее...
Строит агрегированный metric snapshot по безопасным нормализованным сигналам: count, errors, warnings, статистику duration, группировку по kind и severity в рамках dimensions профиля. | | Тип | Параметр | По умолчанию | Описание | | Array | $signals | array (
) | Список эксплуатационных сигналов для агрегации. | | Array | $profile | array (
) | Профиль метрик. Если не указан, используется профиль по умолчанию. | | Array | $options | array (
) | Параметры построения snapshot: profileKey, dimensions, from, to, maskPolicy. |
|
| ExplainRouting | Объяснение маршрутизации Observability
Подробнее...
Возвращает человекочитаемое объяснение, почему сигнал Observability был отправлен или не отправлен в каждый sink согласно routing policies. | | Тип | Параметр | По умолчанию | Описание | | Array | $signal | array (
) | Исходный эксплуатационный сигнал. | | Array | $profile | array (
) | Профиль метрик. Если не указан, выбирается автоматически. | | Array | $options | array (
) | Параметры routing, включая profileKey и maskPolicy. |
|
| GetSystemDefinitions | Чтение системных описаний Observability
Подробнее...
Загружает системные JSON-описания Observability: типы сигналов, уровни важности, profiles, routing policies, retention policies, dashboards и sinks. | Отсутствуют |
| HealthCheckDefinition | Диагностика Observability
Подробнее...
Проверяет системные JSON-описания Observability: наличие типов сигналов, severity, metric profiles, routing policies, retention policies, dashboards, sinks, дубли ключей и ссылки между profiles и policies. | | Тип | Параметр | По умолчанию | Описание | | Array | $definition | array (
) | Definition для проверки. Если не указан, проверяются системные JSON-описания модуля. | | Array | $options | array (
) | Дополнительные параметры диагностики. |
|
| MaskSignalPayload | Маскирование payload сигнала Observability
Подробнее...
Приводит payload эксплуатационного сигнала к безопасному виду: удаляет текст записей, комментарии, вложения, персональные данные, токены, секреты и неизвестные поля, если они не разрешены policy. | | Тип | Параметр | По умолчанию | Описание | | Array | $payload | array (
) | Исходный payload сигнала Observability. | | Array | $policy | array (
) | Политика маскирования: allowedPayloadKeys, allowUnknownScalarPayload и maxStringLength. |
|
| NormalizeMetricProfile | Нормализация профиля метрик Observability
Подробнее...
Проверяет и приводит описание ObservabilityMetricProfile к единому виду: ключ, название, область применения, группы сигналов, dimensions, sampling, aggregation, thresholds, routing policies и retention policy. | | Тип | Параметр | По умолчанию | Описание | | Array | $definition | array (
) | Описание профиля метрик Observability из JSON или записи настройки. |
|
| NormalizeRoutingPolicy | Нормализация routing policy Observability
Подробнее...
Проверяет и приводит описание ObservabilityRoutingPolicy к единому виду: ключ, название, активность и список маршрутов в sinks с фильтрами по типам сигналов, группам, результатам и уровню важности. | | Тип | Параметр | По умолчанию | Описание | | Array | $definition | array (
) | Описание routing policy Observability из JSON или записи настройки. |
|
| NormalizeSignal | Нормализация сигнала Observability
Подробнее...
Проверяет эксплуатационный сигнал, добавляет стандартный envelope, нормализует sourceModule, operation, тип, результат, severity, timestamp, trace id, object keys и применяет safe payload masking. | | Тип | Параметр | По умолчанию | Описание | | Array | $signal | array (
) | Исходный эксплуатационный сигнал доменного или системного модуля. | | Array | $options | array (
) | Дополнительные параметры нормализации, включая maskPolicy. |
|
| PublishSignal | Публикация сигнала Observability
Подробнее...
Принимает эксплуатационный сигнал от модуля, нормализует его, применяет routing policy и при необходимости сохраняет безопасный краткоживущий сигнал в runtime buffer или пишет log-signal в Log. | | Тип | Параметр | По умолчанию | Описание | | Array | $signal | array (
) | Исходный эксплуатационный сигнал доменного или системного модуля. | | Array | $options | array (
) | Параметры публикации: dryRun, profileKey, maskPolicy. |
|
| RecordToProfileDefinition | Преобразование записи Observability в definition
Подробнее...
Читает запись настройки Observability и собирает из ее полей JSON-definition профиля метрик, routing policy, retention policy, dashboard или sink. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataRecord | $record | Обязательный | Запись настройки Observability. |
|
| ResolveMetricProfile | Выбор профиля метрик Observability
Подробнее...
Выбирает ObservabilityMetricProfile по явному ключу, owner module из контекста или системному профилю по умолчанию. | | Тип | Параметр | По умолчанию | Описание | | Array | $context | array (
) | Контекст публикации сигнала: sourceModule, проект, workflow, тип записи или операция. | | String | $profileKey | '' | Явный ключ профиля метрик Observability. |
|
| RouteSignal | Маршрутизация сигнала Observability
Подробнее...
Применяет ObservabilityMetricProfile и связанные routing policies к нормализованному сигналу, возвращая список выбранных sinks и explainable decisions без прямой реализации чужих sink-модулей. | | Тип | Параметр | По умолчанию | Описание | | Array | $signal | array (
) | Исходный эксплуатационный сигнал. | | Array | $profile | array (
) | Профиль метрик. Если не указан, выбирается автоматически. | | Array | $options | array (
) | Параметры routing, включая profileKey и maskPolicy. |
|