HealthInformation interface

패키지:

@azure/servicefabric

일반적인 상태 보고서 정보를 나타냅니다. 상태 저장소로 전송된 모든 상태 보고서 및 상태 쿼리에서 반환된 모든 상태 이벤트에 포함됩니다.

속성

description	상태 정보에 대한 설명입니다. 보고서에 대한 사람이 읽을 수 있는 정보를 추가하는 데 사용되는 무료 텍스트를 나타냅니다. 설명의 최대 문자열 길이는 4096자입니다. 제공된 문자열이 더 길면 자동으로 잘립니다. 잘린 경우 설명의 마지막 문자에는 "[Truncated]" 표식이 포함되고 총 문자열 크기는 4096자입니다. 표식이 있으면 잘림이 발생했음을 사용자에게 나타냅니다. 잘린 경우 설명은 원래 문자열에서 4096자 미만입니다.
healthReportId	상태 보고서를 식별하고 aka.ms/sfhealthid 특정 상태 이벤트에 대한 자세한 정보를 찾는 데 사용할 수 있는 상태 보고서 ID입니다.
healthState	클러스터, 노드, 애플리케이션, 서비스, 파티션, 복제본 등과 같은 Service Fabric 엔터티의 상태입니다. 가능한 값으로는 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' 등이 있습니다.
property	상태 정보의 속성입니다. 엔터티는 다양한 속성에 대한 상태 보고서를 가질 수 있습니다. 이 속성은 보고서를 트리거하는 상태 조건을 보고자가 유연하게 분류할 수 있도록 하는 고정 열거형이 아닌 문자열입니다. 예를 들어 SourceId "LocalWatchdog"를 사용하는 기자는 노드에서 사용 가능한 디스크의 상태를 모니터링할 수 있으므로 해당 노드에서 "AvailableDisk" 속성을 보고할 수 있습니다. 동일한 기자가 노드 연결을 모니터링할 수 있으므로 동일한 노드에서 속성 "연결"을 보고할 수 있습니다. 상태 저장소에서 이러한 보고서는 지정된 노드에 대한 별도의 상태 이벤트로 처리됩니다. SourceId와 함께 이 속성은 상태 정보를 고유하게 식별합니다.
removeWhenExpired	보고서가 만료될 때 Health Store에서 제거되는지 여부를 나타내는 값입니다. true로 설정하면 보고서가 만료된 후 상태 저장소에서 제거됩니다. false로 설정하면 보고서가 만료될 때 오류로 처리됩니다. 이 속성의 값은 기본적으로 false입니다. 클라이언트가 주기적으로 보고하는 경우 RemoveWhenExpired false(기본값)를 설정해야 합니다. 이렇게 하면 보고자에게 문제가 있고(예: 교착 상태) 보고할 수 없는 경우 상태 보고서가 만료되면 엔터티가 오류로 평가됩니다. 이렇게 하면 엔터티가 오류 상태인 것으로 플래그가 지정됩니다.
sequenceNumber	이 상태 보고서의 시퀀스 번호(숫자 문자열)입니다. 보고서 시퀀스 번호는 상태 저장소에서 부실 보고서를 검색하는 데 사용됩니다. 지정하지 않으면 보고서가 추가될 때 상태 클라이언트에서 시퀀스 번호가 자동으로 생성됩니다.
sourceId	상태 정보를 생성한 클라이언트/watchdog/시스템 구성 요소를 식별하는 원본 이름입니다.
timeToLiveInMilliSeconds	이 상태 보고서가 유효한 기간입니다. 이 필드는 기간을 지정하기 위해 ISO8601 형식을 사용합니다. 클라이언트가 주기적으로 보고하는 경우 TL(Time to Live)보다 빈도가 높은 보고서를 보내야 합니다. 클라이언트가 전환에 대해 보고하는 경우 시간을 무한으로 설정할 수 있습니다. TTL(Time to Live)이 만료되면 상태 정보가 포함된 상태 이벤트가 Health 스토어에서 제거되거나 RemoveWhenExpired가 true인 경우 또는 RemoveWhenExpired false인 경우 오류로 평가됩니다. 지정하지 않으면 TL(Time to Live)은 기본적으로 무한값으로 설정됩니다.

속성 세부 정보

description

상태 정보에 대한 설명입니다. 보고서에 대한 사람이 읽을 수 있는 정보를 추가하는 데 사용되는 무료 텍스트를 나타냅니다. 설명의 최대 문자열 길이는 4096자입니다. 제공된 문자열이 더 길면 자동으로 잘립니다. 잘린 경우 설명의 마지막 문자에는 "[Truncated]" 표식이 포함되고 총 문자열 크기는 4096자입니다. 표식이 있으면 잘림이 발생했음을 사용자에게 나타냅니다. 잘린 경우 설명은 원래 문자열에서 4096자 미만입니다.

description?: string

속성 값

string

healthReportId

상태 보고서를 식별하고 aka.ms/sfhealthid 특정 상태 이벤트에 대한 자세한 정보를 찾는 데 사용할 수 있는 상태 보고서 ID입니다.

healthReportId?: string

속성 값

string

healthState

클러스터, 노드, 애플리케이션, 서비스, 파티션, 복제본 등과 같은 Service Fabric 엔터티의 상태입니다. 가능한 값으로는 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' 등이 있습니다.

healthState: HealthState

속성 값

HealthState

property

상태 정보의 속성입니다. 엔터티는 다양한 속성에 대한 상태 보고서를 가질 수 있습니다. 이 속성은 보고서를 트리거하는 상태 조건을 보고자가 유연하게 분류할 수 있도록 하는 고정 열거형이 아닌 문자열입니다. 예를 들어 SourceId "LocalWatchdog"를 사용하는 기자는 노드에서 사용 가능한 디스크의 상태를 모니터링할 수 있으므로 해당 노드에서 "AvailableDisk" 속성을 보고할 수 있습니다. 동일한 기자가 노드 연결을 모니터링할 수 있으므로 동일한 노드에서 속성 "연결"을 보고할 수 있습니다. 상태 저장소에서 이러한 보고서는 지정된 노드에 대한 별도의 상태 이벤트로 처리됩니다.

SourceId와 함께 이 속성은 상태 정보를 고유하게 식별합니다.

property: string

속성 값

string

removeWhenExpired

보고서가 만료될 때 Health Store에서 제거되는지 여부를 나타내는 값입니다. true로 설정하면 보고서가 만료된 후 상태 저장소에서 제거됩니다. false로 설정하면 보고서가 만료될 때 오류로 처리됩니다. 이 속성의 값은 기본적으로 false입니다. 클라이언트가 주기적으로 보고하는 경우 RemoveWhenExpired false(기본값)를 설정해야 합니다. 이렇게 하면 보고자에게 문제가 있고(예: 교착 상태) 보고할 수 없는 경우 상태 보고서가 만료되면 엔터티가 오류로 평가됩니다. 이렇게 하면 엔터티가 오류 상태인 것으로 플래그가 지정됩니다.

removeWhenExpired?: boolean

속성 값

boolean

sequenceNumber

이 상태 보고서의 시퀀스 번호(숫자 문자열)입니다. 보고서 시퀀스 번호는 상태 저장소에서 부실 보고서를 검색하는 데 사용됩니다. 지정하지 않으면 보고서가 추가될 때 상태 클라이언트에서 시퀀스 번호가 자동으로 생성됩니다.

sequenceNumber?: string

속성 값

string

sourceId

상태 정보를 생성한 클라이언트/watchdog/시스템 구성 요소를 식별하는 원본 이름입니다.

sourceId: string

속성 값

string

timeToLiveInMilliSeconds

이 상태 보고서가 유효한 기간입니다. 이 필드는 기간을 지정하기 위해 ISO8601 형식을 사용합니다. 클라이언트가 주기적으로 보고하는 경우 TL(Time to Live)보다 빈도가 높은 보고서를 보내야 합니다. 클라이언트가 전환에 대해 보고하는 경우 시간을 무한으로 설정할 수 있습니다. TTL(Time to Live)이 만료되면 상태 정보가 포함된 상태 이벤트가 Health 스토어에서 제거되거나 RemoveWhenExpired가 true인 경우 또는 RemoveWhenExpired false인 경우 오류로 평가됩니다.

지정하지 않으면 TL(Time to Live)은 기본적으로 무한값으로 설정됩니다.

timeToLiveInMilliSeconds?: string

속성 값

string