HealthInformation interface

Пакет:

@azure/servicefabric

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

Свойства

description	Описание сведений о работоспособности. Он представляет бесплатный текст, используемый для добавления сведений о отчете, доступных для чтения. Максимальная длина строки описания — 4096 символов. Если указанная строка длиннее, она будет автоматически усечена. При усечении последние символы описания содержат маркер "[Усечено], а общий размер строки — 4096 символов. Наличие маркера указывает пользователям, что усечение произошло. Обратите внимание, что при усечении описание имеет менее 4096 символов из исходной строки.
healthReportId	Идентификатор отчета о работоспособности, который определяет отчет о работоспособности и может использоваться для получения более подробных сведений о конкретном событии работоспособности в aka.ms/sfhealthid
healthState	Состояние работоспособности сущности Service Fabric, например Cluster, Node, Application, Service, Partition, Replica и т. д. Возможные значения: "Invalid", "Ok", "Warning", "Error", "Unknown"
property	Свойство сведений о работоспособности. Сущность может иметь отчеты о работоспособности для различных свойств. Это свойство является строкой, а не фиксированным перечислением, чтобы разрешить гибкость репортера классифицировать условие состояния, которое активирует отчет. Например, репортер с SourceId "LocalWatchdog" может отслеживать состояние доступного диска на узле, чтобы он мог сообщать о свойстве AvailableDisk на этом узле. Тот же репортер может отслеживать подключение узла, поэтому он может сообщить о свойстве "Подключение" на том же узле. В хранилище работоспособности эти отчеты рассматриваются как отдельные события работоспособности для указанного узла. Вместе с SourceId свойство однозначно идентифицирует сведения о работоспособности.
removeWhenExpired	Значение, указывающее, удаляется ли отчет из хранилища работоспособности при истечении срока действия. Если задано значение true, отчет удаляется из хранилища работоспособности после истечения срока его действия. Если задано значение false, отчет обрабатывается как ошибка при истечении срока действия. Значение этого свойства по умолчанию равно false. Когда клиенты периодически сообщают, они должны задать значение False RemoveWhenExpired (по умолчанию). Таким образом, если репортер имеет проблемы (например, взаимоблокировка) и не может сообщать, сущность оценивается по ошибке при истечении срока действия отчета о работоспособности. Это помечает сущность как состояние работоспособности ошибки.
sequenceNumber	Порядковый номер для этого отчета о работоспособности в виде числовой строки. Порядковый номер отчета используется хранилищем работоспособности для обнаружения устаревших отчетов. Если оно не указано, при добавлении отчета автоматически создается клиентом работоспособности.
sourceId	Имя источника, определяющее компонент клиента/watchdog/system, создающий сведения о работоспособности.
timeToLiveInMilliSeconds	Длительность, для которой действителен этот отчет о работоспособности. Это поле использует формат ISO8601 для указания длительности. Когда клиенты периодически сообщают, они должны отправлять отчеты с более высокой частотой, чем время жизни. Если клиенты сообщают о переходе, они могут задать время, чтобы жить бесконечно. Когда срок жизни истекает, событие работоспособности, содержащее сведения о работоспособности, удаляется из хранилища работоспособности, если RemoveWhenExpired имеет значение true или вычисляется по ошибке, если RemoveWhenExpired false. Если значение не указано, время жизни по умолчанию имеет бесконечное значение.

Сведения о свойстве

description

Описание сведений о работоспособности. Он представляет бесплатный текст, используемый для добавления сведений о отчете, доступных для чтения. Максимальная длина строки описания — 4096 символов. Если указанная строка длиннее, она будет автоматически усечена. При усечении последние символы описания содержат маркер "[Усечено], а общий размер строки — 4096 символов. Наличие маркера указывает пользователям, что усечение произошло. Обратите внимание, что при усечении описание имеет менее 4096 символов из исходной строки.

description?: string

Значение свойства

string

healthReportId

Идентификатор отчета о работоспособности, который определяет отчет о работоспособности и может использоваться для получения более подробных сведений о конкретном событии работоспособности в aka.ms/sfhealthid

healthReportId?: string

Значение свойства

string

healthState

Состояние работоспособности сущности Service Fabric, например Cluster, Node, Application, Service, Partition, Replica и т. д. Возможные значения: "Invalid", "Ok", "Warning", "Error", "Unknown"

healthState: HealthState

Значение свойства

HealthState

property

Свойство сведений о работоспособности. Сущность может иметь отчеты о работоспособности для различных свойств. Это свойство является строкой, а не фиксированным перечислением, чтобы разрешить гибкость репортера классифицировать условие состояния, которое активирует отчет. Например, репортер с SourceId "LocalWatchdog" может отслеживать состояние доступного диска на узле, чтобы он мог сообщать о свойстве AvailableDisk на этом узле. Тот же репортер может отслеживать подключение узла, поэтому он может сообщить о свойстве "Подключение" на том же узле. В хранилище работоспособности эти отчеты рассматриваются как отдельные события работоспособности для указанного узла.

Вместе с SourceId свойство однозначно идентифицирует сведения о работоспособности.

property: string

Значение свойства

string

removeWhenExpired

Значение, указывающее, удаляется ли отчет из хранилища работоспособности при истечении срока действия. Если задано значение true, отчет удаляется из хранилища работоспособности после истечения срока его действия. Если задано значение false, отчет обрабатывается как ошибка при истечении срока действия. Значение этого свойства по умолчанию равно false. Когда клиенты периодически сообщают, они должны задать значение False RemoveWhenExpired (по умолчанию). Таким образом, если репортер имеет проблемы (например, взаимоблокировка) и не может сообщать, сущность оценивается по ошибке при истечении срока действия отчета о работоспособности. Это помечает сущность как состояние работоспособности ошибки.

removeWhenExpired?: boolean

Значение свойства

boolean

sequenceNumber

Порядковый номер для этого отчета о работоспособности в виде числовой строки. Порядковый номер отчета используется хранилищем работоспособности для обнаружения устаревших отчетов. Если оно не указано, при добавлении отчета автоматически создается клиентом работоспособности.

sequenceNumber?: string

Значение свойства

string

sourceId

Имя источника, определяющее компонент клиента/watchdog/system, создающий сведения о работоспособности.

sourceId: string

Значение свойства

string

timeToLiveInMilliSeconds

Длительность, для которой действителен этот отчет о работоспособности. Это поле использует формат ISO8601 для указания длительности. Когда клиенты периодически сообщают, они должны отправлять отчеты с более высокой частотой, чем время жизни. Если клиенты сообщают о переходе, они могут задать время, чтобы жить бесконечно. Когда срок жизни истекает, событие работоспособности, содержащее сведения о работоспособности, удаляется из хранилища работоспособности, если RemoveWhenExpired имеет значение true или вычисляется по ошибке, если RemoveWhenExpired false.

Если значение не указано, время жизни по умолчанию имеет бесконечное значение.

timeToLiveInMilliSeconds?: string

Значение свойства

string