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


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


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

Имя функцииОписаниеПараметры
CreateContextСоздать TraceContext
Подробнее... 
Создает runtime-объект TraceContext с новым или явно переданным trace id, источником операции, principal, HTTP-контекстом и безопасными metadata.
ТипПараметрПо умолчаниюОписание
array$options'array()'Параметры контекста: traceId, parentTraceId, source, principal, host, requestMethod, requestUri, externalCorrelationId, metadata.
FromCarrierПринять TraceContext из carrier
Подробнее... 
Создает TraceContext из массива carrier. Входящий trace id принимается только при trusted=true; иначе создается новый trace id, а входящее значение сохраняется как внешний correlation id.
ТипПараметрПо умолчаниюОписание
array$carrier'array()'Массив заголовков или metadata, содержащий traceId, parentTraceId или externalCorrelationId.
array$options'array()'Параметры обработки carrier: trusted, source, principal, host, requestMethod, requestUri, metadata.
GetCurrentПолучить текущий TraceContext
Подробнее... 
Возвращает текущий runtime-объект TraceContext для запроса. Если контекст еще не создан, он создается из текущего HTTP-запроса и сохраняется в модуле до конца выполнения.
ТипПараметрПо умолчаниюОписание
array$options'array()'Параметры создания контекста при первом обращении.
GetDiagnosticReportПолучить диагностический отчет по trace id
Подробнее... 
Запрашивает зарегистрированные TraceDiagnosticProvider и возвращает агрегированный диагностический отчет по trace id. Ошибка одного provider-а не скрывает срезы остальных provider-ов.
ТипПараметрПо умолчаниюОписание
ObjectDataTraceContext|string$traceContextОбязательныйTraceContext или строковый trace id, по которому нужно собрать диагностику.
array$options'array()'Ограничения и параметры диагностики: principal, visibility, limit, since, until.
InitHttpRequestContextИнициализировать TraceContext HTTP-запроса
Подробнее... 
Создает текущий TraceContext на входной границе HTTP-запроса, сохраняет его до конца выполнения и при необходимости отправляет trace id в HTTP-заголовке ответа.
ТипПараметрПо умолчаниюОписание
array$server'array()'Массив server-параметров. Если пустой, используется $_SERVER.
array$options'array()'Параметры инициализации: trusted, source, principal, emitHeader.
NewTraceIdСоздать trace id
Подробнее... 
Создает новый безопасный строковый trace id ИРБИС 128 для связывания пользовательского или системного действия с диагностикой.
Отсутствуют
StartScopeСоздать область трассировки
Подробнее... 
Создает вложенную область трассировки внутри текущего trace id. Scope используется для workflow-переходов, фоновых попыток, доставки событий и других участков одной операции.
ТипПараметрПо умолчаниюОписание
string$source'system'Источник или участок операции, для которого создается scope.
array$metadata'array()'Безопасные metadata области трассировки.
ObjectDataTraceContext|null$parent'null'Родительский TraceContext. Если не указан, используется текущий контекст запроса.