HealthEvent interface

包:

@azure/servicefabric

表示在运行状况实体（如群集、应用程序或节点）上报告的运行状况信息，以及运行状况管理器添加的其他元数据。

扩展

HealthInformation

属性

isExpired	如果运行状况事件已过期，则返回 true，否则返回 false。
lastErrorTransitionAt	如果当前运行状况状态为“Error”，则此属性返回首次报告运行状况报告的时间，并显示“Error”。 对于定期报告，可能已生成具有相同状态的许多报告，但此属性仅返回收到第一个“错误”运行状况报告时的日期和时间。 如果当前运行状况状态为“正常”或“警告”，则返回运行状况状态在“错误”中最后一次的日期和时间，然后再转换为其他状态。 如果运行状况状态从不为“Error”，则该值将为零日期时间。
lastModifiedUtcTimestamp	运行状况报告上次由运行状况存储修改的日期和时间。
lastOkTransitionAt	如果当前运行状况状态为“Ok”，则此属性返回运行状况报告首次报告为“Ok”的时间。 对于定期报告，可能已生成具有相同状态的许多报告。 此属性返回收到第一个“确定”运行状况报告时的日期和时间。 如果当前运行状况为“Error”或“Warning”，则返回运行状况状态在“确定”中最后一次的日期和时间，然后再转换为其他状态。 如果运行状况状态从不为“确定”，则该值将为零日期时间。
lastWarningTransitionAt	如果当前运行状况状态为“Warning”，则此属性返回首次报告运行状况报告的时间，并显示“Warning”。 对于定期报告，可能已生成具有相同状态的许多报告，但此属性仅返回收到第一份“警告”运行状况报告时的日期和时间。 如果当前运行状况状态为“Ok”或“Error”，则返回运行状况状态在“警告”中最后一次的日期和时间，然后再转换为其他状态。 如果运行状况状态从不为“Warning”，则该值将为零日期时间。
sourceUtcTimestamp	源发送运行状况报告的日期和时间。

继承属性

description	运行状况信息的说明。 它表示用于添加有关报表的人工可读信息的自由文本。 说明的最大字符串长度为 4096 个字符。 如果提供的字符串较长，它将自动截断。 截断时，说明的最后一个字符包含标记“[Truncated]”，总字符串大小为 4096 个字符。 标记的存在表示用户发生了截断。 请注意，截断时，说明的原始字符串中少于 4096 个字符。
healthReportId	用于标识运行状况报告的运行状况报告 ID，可用于在 aka.ms/sfhealthid 查找有关特定运行状况事件的更多详细信息
healthState	Service Fabric 实体的运行状况状态，例如群集、节点、应用程序、服务、分区、副本等。可能的值包括：“Invalid”、“Ok”、“Warning”、“Error”、“Unknown”
property	运行状况信息的属性。 实体可以具有不同属性的运行状况报告。 该属性是一个字符串，而不是固定枚举，使记者能够灵活地对触发报表的状态条件进行分类。 例如，具有 SourceId“LocalWatchdog”的记者可以监视节点上可用磁盘的状态，以便它可以报告该节点上的“AvailableDisk”属性。 同一记者可以监视节点连接，因此它可以报告同一节点上的属性“Connectivity”。 在运行状况存储中，这些报告被视为指定节点的单独运行状况事件。 属性与 SourceId 一起唯一标识运行状况信息。
removeWhenExpired	指示报表在过期时是否从运行状况存储中删除的值。 如果设置为 true，则报告在过期后会从运行状况存储中删除。 如果设置为 false，则报告在过期时被视为错误。 此属性的值默认为 false。 客户端定期报告时，应设置 RemoveWhenExpired false （默认值）。 这样，如果记者出现问题（例如死锁）且无法报告，则运行状况报告过期时会以错误方式评估实体。 这会将实体标记为处于错误运行状况状态。
sequenceNumber	此运行状况报告的序列号作为数字字符串。 运行状况存储使用报表序列号来检测过时的报告。 如果未指定，则添加报表时运行状况客户端自动生成序列号。
sourceId	标识生成运行状况信息的客户端/监视器/系统组件的源名称。
timeToLiveInMilliSeconds	此运行状况报告有效的持续时间。 此字段使用ISO8601格式来指定持续时间。 客户端定期报告时，应发送频率高于生存时间的报告。 如果客户端报告转换情况，则可以将生存时间设置为无限。 生存时间过期时，如果 RemoveWhenExpired 为 true，则从运行状况存储中删除包含运行状况信息的运行状况事件;如果 RemoveWhenExpired 为 false，则以错误方式进行评估。 如果未指定，生存时间默认为无限值。

属性详细信息

isExpired

如果运行状况事件已过期，则返回 true，否则返回 false。

isExpired?: boolean

属性值

boolean

lastErrorTransitionAt

如果当前运行状况状态为“Error”，则此属性返回首次报告运行状况报告的时间，并显示“Error”。 对于定期报告，可能已生成具有相同状态的许多报告，但此属性仅返回收到第一个“错误”运行状况报告时的日期和时间。

如果当前运行状况状态为“正常”或“警告”，则返回运行状况状态在“错误”中最后一次的日期和时间，然后再转换为其他状态。

如果运行状况状态从不为“Error”，则该值将为零日期时间。

lastErrorTransitionAt?: Date

属性值

Date

lastModifiedUtcTimestamp

运行状况报告上次由运行状况存储修改的日期和时间。

lastModifiedUtcTimestamp?: Date

属性值

Date

lastOkTransitionAt

如果当前运行状况状态为“Ok”，则此属性返回运行状况报告首次报告为“Ok”的时间。 对于定期报告，可能已生成具有相同状态的许多报告。 此属性返回收到第一个“确定”运行状况报告时的日期和时间。

如果当前运行状况为“Error”或“Warning”，则返回运行状况状态在“确定”中最后一次的日期和时间，然后再转换为其他状态。

如果运行状况状态从不为“确定”，则该值将为零日期时间。

lastOkTransitionAt?: Date

属性值

Date

lastWarningTransitionAt

如果当前运行状况状态为“Warning”，则此属性返回首次报告运行状况报告的时间，并显示“Warning”。 对于定期报告，可能已生成具有相同状态的许多报告，但此属性仅返回收到第一份“警告”运行状况报告时的日期和时间。

如果当前运行状况状态为“Ok”或“Error”，则返回运行状况状态在“警告”中最后一次的日期和时间，然后再转换为其他状态。

如果运行状况状态从不为“Warning”，则该值将为零日期时间。

lastWarningTransitionAt?: Date

属性值

Date

sourceUtcTimestamp

源发送运行状况报告的日期和时间。

sourceUtcTimestamp?: Date

属性值

Date

继承属性详细信息

description

运行状况信息的说明。 它表示用于添加有关报表的人工可读信息的自由文本。 说明的最大字符串长度为 4096 个字符。 如果提供的字符串较长，它将自动截断。 截断时，说明的最后一个字符包含标记“[Truncated]”，总字符串大小为 4096 个字符。 标记的存在表示用户发生了截断。 请注意，截断时，说明的原始字符串中少于 4096 个字符。

description?: string

属性值

string

继承自HealthInformation.description

healthReportId

用于标识运行状况报告的运行状况报告 ID，可用于在 aka.ms/sfhealthid 查找有关特定运行状况事件的更多详细信息

healthReportId?: string

属性值

string

继承自 HealthInformation.healthReportId

healthState

Service Fabric 实体的运行状况状态，例如群集、节点、应用程序、服务、分区、副本等。可能的值包括：“Invalid”、“Ok”、“Warning”、“Error”、“Unknown”

healthState: HealthState

属性值

HealthState

继承自HealthInformation.healthState

property

运行状况信息的属性。 实体可以具有不同属性的运行状况报告。 该属性是一个字符串，而不是固定枚举，使记者能够灵活地对触发报表的状态条件进行分类。 例如，具有 SourceId“LocalWatchdog”的记者可以监视节点上可用磁盘的状态，以便它可以报告该节点上的“AvailableDisk”属性。 同一记者可以监视节点连接，因此它可以报告同一节点上的属性“Connectivity”。 在运行状况存储中，这些报告被视为指定节点的单独运行状况事件。

属性与 SourceId 一起唯一标识运行状况信息。

property: string

属性值

string

继承自HealthInformation.property

removeWhenExpired

指示报表在过期时是否从运行状况存储中删除的值。 如果设置为 true，则报告在过期后会从运行状况存储中删除。 如果设置为 false，则报告在过期时被视为错误。 此属性的值默认为 false。 客户端定期报告时，应设置 RemoveWhenExpired false （默认值）。 这样，如果记者出现问题（例如死锁）且无法报告，则运行状况报告过期时会以错误方式评估实体。 这会将实体标记为处于错误运行状况状态。

removeWhenExpired?: boolean

属性值

boolean

继承自HealthInformation.removeWhenExpired

sequenceNumber

此运行状况报告的序列号作为数字字符串。 运行状况存储使用报表序列号来检测过时的报告。 如果未指定，则添加报表时运行状况客户端自动生成序列号。

sequenceNumber?: string

属性值

string

继承自HealthInformation.sequenceNumber

sourceId

标识生成运行状况信息的客户端/监视器/系统组件的源名称。

sourceId: string

属性值

string

继承自HealthInformation.sourceId

timeToLiveInMilliSeconds

此运行状况报告有效的持续时间。 此字段使用ISO8601格式来指定持续时间。 客户端定期报告时，应发送频率高于生存时间的报告。 如果客户端报告转换情况，则可以将生存时间设置为无限。 生存时间过期时，如果 RemoveWhenExpired 为 true，则从运行状况存储中删除包含运行状况信息的运行状况事件;如果 RemoveWhenExpired 为 false，则以错误方式进行评估。

如果未指定，生存时间默认为无限值。

timeToLiveInMilliSeconds?: string

属性值

string

继承自 HealthInformation.timeToLiveInMilliSeconds