HealthInformation
一般的な正常性レポート情報を表します。 これは、正常性ストアに送信されるすべての正常性レポートと、正常性クエリによって返されるすべての正常性イベントに含まれます。
プロパティ
| 名前 | Type | 必須 |
|---|---|---|
SourceId |
string | はい |
Property |
string | はい |
HealthState |
string (enum) | はい |
TimeToLiveInMilliSeconds |
string (duration) | いいえ |
Description |
string | いいえ |
SequenceNumber |
string | いいえ |
RemoveWhenExpired |
boolean | いいえ |
HealthReportId |
string | いいえ |
SourceId
型: string
必須: はい
正常性に関する情報を生成したクライアント/ウォッチドッグ/システム コンポーネントを識別するソース名。
Property
型: string
必須: はい
正常性情報のプロパティ。 エンティティには、さまざまなプロパティの正常性レポートを含めることができます。
このプロパティは固定値列挙型ではなく文字列で、これにより、レポーターは、レポートをトリガーする状態の条件を柔軟に分類できます。
たとえば、SourceId が "LocalWatchdog" のレポーターは、ノード上で使用可能なディスクの状態を監視できるため、そのノードの "AvailableDisk" プロパティをレポートできます。
同じレポーターは、ノードの接続性を監視できるため、同じノードの "Connectivity" プロパティをレポートできます。
正常性ストアでは、これらのレポートは、指定されたノードの個々の正常性イベントとして扱われます。
このプロパティは SourceId と共に、正常性情報を一意に識別します。
HealthState
型: string (enum)
必須: はい
クラスター、ノード、アプリケーション、サービス、パーティション、レプリカなどの Service Fabric エンティティの正常性状態。
次のいずれかの値になります。
Invalid- 無効な正常性状態を示します。 すべての Service Fabric 列挙型の型が無効です。 値は 0 です。Ok- 正常性状態が問題ありません。 値は 1 です。Warning- 正常性状態が警告レベルであることを示します。 値は 2 です。Error- 正常性状態がエラー レベルであることを示します。 エラーの正常性状態は、クラスターの正しい機能に影響を与える可能性があるため、調査する必要があります。 値は 3 です。Unknown- 不明な正常性状態を示します。 値は 65535 です。
TimeToLiveInMilliSeconds
型: string (duration)
必須: いいえ
この正常性レポートの有効期間。 このフィールドでは、この期間の指定に ISO8601 形式が使用されます。
クライアントは、定期的にレポートする場合、レポートの送信頻度を有効期間よりも高くする必要があります。
クライアントは、遷移時にレポートする場合、有効期間を無限に設定できます。
有効期間が期限切れになると、正常性に関する情報を含む正常性イベントは、正常性ストアから削除される (RemoveWhenExpired が true の場合) か、エラーと評価されます (RemoveWhenExpired が false の場合)。
指定しない場合、有効期間の既定値は無限になります。
Description
型: string
必須: いいえ
正常性情報の説明。 レポートについて人間が判読できる情報を追加するために使用するフリー テキストを表します。
この説明の文字列の最大長は 4,096 文字です。
指定された文字列が長い場合は、自動的に切り捨てられます。
切り捨てられると、説明の末尾の文字には "[切り捨て]" というマーカーが含まれ、文字列の合計サイズが 4,096 文字になります。
このマーカーの存在は、切り捨てが発生したことをユーザーに示します。
切り捨てられた場合、説明に含まれるのは元の文字列のうち 4,096 文字未満であることに注意してください。
SequenceNumber
型: string
必須: いいえ
数値文字列で表された、この正常性レポートのシーケンス番号。
レポートのシーケンス番号は、古いレポートを検出するために正常性ストアによって使用されます。
指定しない場合、シーケンス番号は、レポートが追加されたときに正常性クライアントによって自動的に生成されます。
RemoveWhenExpired
型: ブール値
必須: いいえ
有効期限が切れたときにレポートを正常性ストアから削除するかどうかを示す値。
true に設定した場合、レポートは、有効期限が切れると正常性ストアから削除されます。
false に設定した場合、レポートは、有効期限が切れるとエラーとして処理されます。 既定では、このプロパティの値は false です。
クライアントは、定期的にレポートする場合、RemoveWhenExpired を false (既定値) に設定する必要があります。
このようにして、レポーターに問題 (デッドロックなど) があり、報告できない場合、正常性レポートの有効期限が切れると、エンティティはエラーで評価されます。
これにより、このエンティティの正常性はエラー状態と見なされます。
HealthReportId
型: string
必須: いいえ
正常性レポートを識別し、特定の正常性イベントに関する詳細情報を検索するために使用できる正常性レポート ID aka.ms/sfhealthid