Функции могут быть вызваны как UseModule("HealthCheck")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| EvaluateGate | Оценка publication gate HealthCheck
 Подробнее...
Оценивает, может ли операция публикации или применения конфигурации продолжаться по результатам HealthCheck: blocker запрещает, warning требует подтверждения, info не блокирует. | | Тип | Параметр | По умолчанию | Описание | | HealthCheckRun|string|array | $run | '' | Объект отчета, массив отчета или идентификатор ранее сохраненного запуска. | | array | $options | 'array()' | Параметры gate-оценки, включая confirmWarnings. |
|
| GetProviderDefinitions | Получение списка provider-ов HealthCheck
Подробнее...
Возвращает зарегистрированные provider-ы HealthCheck с учетом фильтров по scope, owner module и ключу provider-а. | | Тип | Параметр | По умолчанию | Описание | | array | $options | 'array()' | Фильтры provider-ов: scope, provider/providers, ownerModule/ownerModules. |
|
| GetRunReport | Получение отчета HealthCheck
Подробнее...
Возвращает ранее сохраненный структурированный отчет HealthCheck по идентификатору запуска. | | Тип | Параметр | По умолчанию | Описание | | string | $runid | '' | Идентификатор запуска HealthCheck. |
|
| HealthCheck_Self | Самопроверка HealthCheck
Подробнее...
Provider HealthCheck, проверяющий доступность самого модуля, registry provider-ов и базового технического хранилища отчетов. | | Тип | Параметр | По умолчанию | Описание | | HealthCheckContext | $context | '' | Контекст запуска HealthCheck. | | array | $definition | 'array()' | Описание provider-а из registry HealthCheck. |
|
| ListRunReports | Список отчетов HealthCheck
Подробнее...
Возвращает последние сохраненные отчеты HealthCheck из технического хранилища. | | Тип | Параметр | По умолчанию | Описание | | int | $limit | '20' | Максимальное количество отчетов в списке. |
|
| LoadSystemProviderDefinitions | Загрузка системных provider-ов HealthCheck
Подробнее...
Загружает декларативные provider definitions HealthCheck из JSON модуля-поставщика и проверяет наличие указанной __call-реализации. | | Тип | Параметр | По умолчанию | Описание | | string | $providerName | '' | Имя модуля-поставщика JSON definitions HealthCheck. | | array|null | $definition | 'null' | Готовое описание provider definitions. Если не указано, JSON читается из папки healthcheck модуля-поставщика. |
|
| RegisterProviderDefinition | Регистрация provider-а HealthCheck
Подробнее...
Регистрирует определение provider-а HealthCheck в runtime registry модуля. Исполняемая логика остается в модуле-владельце provider-а. | | Тип | Параметр | По умолчанию | Описание | | array | $definition | 'array()' | Описание provider-а: key, ownerModule, title, scopes, categories, module, method. |
|
| RunChecks | Запуск проверок HealthCheck
Подробнее...
Запускает зарегистрированные provider-ы HealthCheck, формирует структурированный отчет и сохраняет его в техническом хранилище отчетов. | | Тип | Параметр | По умолчанию | Описание | | array | $options | 'array()' | Параметры запуска: runid, scope, profileKey, ownerModule, projectKey, objectType, objectKey, traceId и фильтры provider-ов. |
|