Функции модуля (__call)


НАЧАЛО >> Оглавление >> Сервер приложений ИРБИС 64/128 >> Описание модулей системы >> Observability - Наблюдаемость >> Функции модуля (__call)📄 Скачать в DOCX


Функции могут быть вызваны как UseModule("Observability")->function(parameter1,parameter2,...);

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