HealthEvent interface
正常性マネージャーによって追加されたメタデータを使用して、クラスター、アプリケーション、ノードなどの正常性エンティティで報告される正常性情報を表します。
- Extends
プロパティ
| is |
ヘルスイベントの有効期限が切れている場合はtrueを返し、それ以外の場合はfalseを返します。 |
| last |
現在の正常性状態が 'Error' の場合、このプロパティは、正常性レポートが最初に 'Error' で報告された時刻を返します。 定期的なレポートの場合、同じ状態のレポートが多数生成されている可能性がありますが、このプロパティは、最初の "エラー" 正常性レポートを受信した日時のみを返します。 現在の正常性状態が "OK" または "Warning" の場合、別の状態に移行する前に、正常性状態が最後に "Error" になった日時を返します。 正常性状態が 'Error' でなかった場合、値は 0 の日時になります。 |
| last |
正常性レポートが正常性ストアによって最後に変更された日時。 |
| last |
現在の正常性状態が "Ok" の場合、このプロパティは、正常性レポートが最初に "Ok" で報告された時刻を返します。 定期レポートの場合、同じ状態のレポートが多数生成されている可能性があります。 このプロパティは、最初の "OK" 正常性レポートを受信した日時を返します。 現在の正常性状態が "エラー" または "警告" の場合、別の状態に移行する前に、正常性状態が最後に "OK" になった日時を返します。 正常性状態が "Ok" でなかった場合、値は 0 の日時になります。 |
| last |
現在の正常性状態が "Warning" の場合、このプロパティは、正常性レポートが最初に "Warning" で報告された時刻を返します。 定期的なレポートの場合、同じ状態のレポートが多数生成されている可能性がありますが、このプロパティは、最初の "警告" 正常性レポートを受信した日時のみを返します。 現在の正常性状態が 'OK' または 'Error' の場合、別の状態に移行する前に、正常性状態が最後に 'Warning' になった日時を返します。 正常性状態が "警告" でなかった場合、値は 0 の日付/時刻になります。 |
| source |
ソースによってヘルス レポートが送信された日時。 |
継承されたプロパティ
| description | 正常性情報の説明。 これは、レポートに関する人間が判読できる情報を追加するために使用されるフリー テキストを表します。 説明の最大文字列長は 4096 文字です。 指定された文字列が長い場合は、自動的に切り捨てられます。 切り捨てられると、説明の最後の文字にマーカー "[Truncated]" が含まれており、合計文字列サイズは 4096 文字です。 マーカーが存在すると、切り捨てが発生したことをユーザーに示します。 切り捨てられた場合、説明は元の文字列から 4096 文字未満であることに注意してください。 |
| health |
正常性レポートを識別し、特定の正常性イベントに関する詳細情報を検索するために使用できる正常性レポート ID aka.ms/sfhealthid |
| health |
クラスター、ノード、アプリケーション、サービス、パーティション、レプリカなどの Service Fabric エンティティの正常性状態。指定できる値は、'Invalid'、'Ok'、'Warning'、'Error'、'Unknown' です。 |
| property | 正常性情報のプロパティ。 エンティティは、さまざまなプロパティの正常性レポートを持つことができます。 このプロパティは文字列であり、レポートをトリガーする状態条件を柔軟に分類できるようにするための固定列挙ではありません。 たとえば、SourceId が "LocalWatchdog" のレポーターは、ノードで使用可能なディスクの状態を監視できるため、そのノードで "AvailableDisk" プロパティを報告できます。 同じレポーターはノードの接続を監視できるため、同じノード上のプロパティ "Connectivity" を報告できます。 正常性ストアでは、これらのレポートは、指定されたノードの個別の正常性イベントとして扱われます。 SourceId と共に、プロパティは正常性情報を一意に識別します。 |
| remove |
レポートの有効期限が切れたときに正常性ストアから削除されるかどうかを示す値。 true に設定すると、レポートは有効期限が切れると正常性ストアから削除されます。 false に設定すると、レポートは有効期限が切れるとエラーとして扱われます。 既定では、このプロパティの値は false です。 クライアントが定期的に報告する場合は、RemoveWhenExpired false (既定値) を設定する必要があります。 これにより、レポーターに問題 (デッドロックなど) があり、報告できない場合、正常性レポートの有効期限が切れると、エンティティがエラーで評価されます。 これにより、エンティティにエラー正常性状態のフラグが設定されます。 |
| sequence |
この正常性レポートのシーケンス番号を数値文字列として指定します。 レポート シーケンス番号は、古いレポートを検出するために正常性ストアによって使用されます。 指定しない場合、レポートの追加時に正常性クライアントによってシーケンス番号が自動生成されます。 |
| source |
正常性情報を生成したクライアント/ウォッチドッグ/システム コンポーネントを識別するソース名。 |
| time |
この正常性レポートが有効な期間。 このフィールドではISO8601形式を使用して期間を指定します。 クライアントが定期的にレポートする場合は、有効期間よりも頻度の高いレポートを送信する必要があります。 クライアントが移行について報告する場合は、有効期間を無限に設定できます。 有効期限が切れると、正常性情報を含む正常性イベントは、RemoveWhenExpired が true の場合は正常性ストアから削除されるか、RemoveWhenExpired false の場合はエラー時に評価されます。 指定しない場合、Time to Live は既定で無限の値になります。 |
プロパティの詳細
isExpired
ヘルスイベントの有効期限が切れている場合はtrueを返し、それ以外の場合はfalseを返します。
isExpired?: booleanプロパティ値
boolean
lastErrorTransitionAt
現在の正常性状態が 'Error' の場合、このプロパティは、正常性レポートが最初に 'Error' で報告された時刻を返します。 定期的なレポートの場合、同じ状態のレポートが多数生成されている可能性がありますが、このプロパティは、最初の "エラー" 正常性レポートを受信した日時のみを返します。
現在の正常性状態が "OK" または "Warning" の場合、別の状態に移行する前に、正常性状態が最後に "Error" になった日時を返します。
正常性状態が 'Error' でなかった場合、値は 0 の日時になります。
lastErrorTransitionAt?: Dateプロパティ値
Date
lastModifiedUtcTimestamp
正常性レポートが正常性ストアによって最後に変更された日時。
lastModifiedUtcTimestamp?: Dateプロパティ値
Date
lastOkTransitionAt
現在の正常性状態が "Ok" の場合、このプロパティは、正常性レポートが最初に "Ok" で報告された時刻を返します。 定期レポートの場合、同じ状態のレポートが多数生成されている可能性があります。 このプロパティは、最初の "OK" 正常性レポートを受信した日時を返します。
現在の正常性状態が "エラー" または "警告" の場合、別の状態に移行する前に、正常性状態が最後に "OK" になった日時を返します。
正常性状態が "Ok" でなかった場合、値は 0 の日時になります。
lastOkTransitionAt?: Dateプロパティ値
Date
lastWarningTransitionAt
現在の正常性状態が "Warning" の場合、このプロパティは、正常性レポートが最初に "Warning" で報告された時刻を返します。 定期的なレポートの場合、同じ状態のレポートが多数生成されている可能性がありますが、このプロパティは、最初の "警告" 正常性レポートを受信した日時のみを返します。
現在の正常性状態が 'OK' または 'Error' の場合、別の状態に移行する前に、正常性状態が最後に 'Warning' になった日時を返します。
正常性状態が "警告" でなかった場合、値は 0 の日付/時刻になります。
lastWarningTransitionAt?: Dateプロパティ値
Date
sourceUtcTimestamp
ソースによってヘルス レポートが送信された日時。
sourceUtcTimestamp?: Dateプロパティ値
Date
継承されたプロパティの詳細
description
正常性情報の説明。 これは、レポートに関する人間が判読できる情報を追加するために使用されるフリー テキストを表します。 説明の最大文字列長は 4096 文字です。 指定された文字列が長い場合は、自動的に切り捨てられます。 切り捨てられると、説明の最後の文字にマーカー "[Truncated]" が含まれており、合計文字列サイズは 4096 文字です。 マーカーが存在すると、切り捨てが発生したことをユーザーに示します。 切り捨てられた場合、説明は元の文字列から 4096 文字未満であることに注意してください。
description?: stringプロパティ値
string
healthReportId
正常性レポートを識別し、特定の正常性イベントに関する詳細情報を検索するために使用できる正常性レポート ID aka.ms/sfhealthid
healthReportId?: stringプロパティ値
string
healthState
クラスター、ノード、アプリケーション、サービス、パーティション、レプリカなどの Service Fabric エンティティの正常性状態。指定できる値は、'Invalid'、'Ok'、'Warning'、'Error'、'Unknown' です。
healthState: HealthStateプロパティ値
property
正常性情報のプロパティ。 エンティティは、さまざまなプロパティの正常性レポートを持つことができます。 このプロパティは文字列であり、レポートをトリガーする状態条件を柔軟に分類できるようにするための固定列挙ではありません。 たとえば、SourceId が "LocalWatchdog" のレポーターは、ノードで使用可能なディスクの状態を監視できるため、そのノードで "AvailableDisk" プロパティを報告できます。 同じレポーターはノードの接続を監視できるため、同じノード上のプロパティ "Connectivity" を報告できます。 正常性ストアでは、これらのレポートは、指定されたノードの個別の正常性イベントとして扱われます。
SourceId と共に、プロパティは正常性情報を一意に識別します。
property: stringプロパティ値
string
removeWhenExpired
レポートの有効期限が切れたときに正常性ストアから削除されるかどうかを示す値。 true に設定すると、レポートは有効期限が切れると正常性ストアから削除されます。 false に設定すると、レポートは有効期限が切れるとエラーとして扱われます。 既定では、このプロパティの値は false です。 クライアントが定期的に報告する場合は、RemoveWhenExpired false (既定値) を設定する必要があります。 これにより、レポーターに問題 (デッドロックなど) があり、報告できない場合、正常性レポートの有効期限が切れると、エンティティがエラーで評価されます。 これにより、エンティティにエラー正常性状態のフラグが設定されます。
removeWhenExpired?: booleanプロパティ値
boolean
sequenceNumber
この正常性レポートのシーケンス番号を数値文字列として指定します。 レポート シーケンス番号は、古いレポートを検出するために正常性ストアによって使用されます。 指定しない場合、レポートの追加時に正常性クライアントによってシーケンス番号が自動生成されます。
sequenceNumber?: stringプロパティ値
string
sourceId
正常性情報を生成したクライアント/ウォッチドッグ/システム コンポーネントを識別するソース名。
sourceId: stringプロパティ値
string
timeToLiveInMilliSeconds
この正常性レポートが有効な期間。 このフィールドではISO8601形式を使用して期間を指定します。 クライアントが定期的にレポートする場合は、有効期間よりも頻度の高いレポートを送信する必要があります。 クライアントが移行について報告する場合は、有効期間を無限に設定できます。 有効期限が切れると、正常性情報を含む正常性イベントは、RemoveWhenExpired が true の場合は正常性ストアから削除されるか、RemoveWhenExpired false の場合はエラー時に評価されます。
指定しない場合、Time to Live は既定で無限の値になります。
timeToLiveInMilliSeconds?: stringプロパティ値
string