Send-ServiceFabricReplicaHealthReport

リファレンス

モジュール:: ServiceFabric

Service Fabric レプリカの正常性レポートを送信します。

構文

Send-ServiceFabricReplicaHealthReport
    [-PartitionId] <Guid>
    -ReplicaId <Int64>
    -HealthState <HealthState>
    -SourceId <String>
    -HealthProperty <String>
    [-Description <String>]
    [-TimeToLiveSec <Int32>]
    [-RemoveWhenExpired]
    [-SequenceNumber <Int64>]
    [-Immediate]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Send-ServiceFabricReplicaHealthReport
    [-PartitionId] <Guid>
    -InstanceId <Int64>
    -HealthState <HealthState>
    -SourceId <String>
    -HealthProperty <String>
    [-Description <String>]
    [-TimeToLiveSec <Int32>]
    [-RemoveWhenExpired]
    [-SequenceNumber <Int64>]
    [-Immediate]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

説明

Send-ServiceFabricReplicaHealthReport コマンドレットは、Service Fabric ステートレスサービスインスタンスまたはステートフルサービスレプリカに正常性レポートを送信します。

ステートレスサービスインスタンスまたはステートフルサービスレプリカは、正常性ストアに既に存在している必要があります。存在するかどうかを確認するには、 Get-ServiceFabricReplicaHealth コマンドレットを使用し、 PartitionId パラメーターと ReplicaOrInstanceId パラメーターを指定します。または、PartitionId パラメーターを指定して Get-ServiceFabricPartitionHealth コマンドレットを使用し、ReplicaHealthStates セクションを確認してレプリカを検索することもできます。

コマンドレットは、Connect-ServiceFabricCluster コマンドレットの HealthReportSendIntervalInSec パラメーターで指定された間隔の後にレポートを送信します。この間、クラスター接続を有効にしておく必要があります。

コマンドレットは成功を返す可能性がありますが、レポートは非同期的に送信されるため、処理が失敗する可能性があります。レポートが正常性ストアに適用されたかどうかを確認するには、 Get-ServiceFabricReplicaHealth コマンドレットを使用して、正常性イベントセクションにレポートが表示されることを確認します。

Service Fabric クラスターで操作を実行する前に、 Connect-ServiceFabricCluster コマンドレットを使用してクラスターへの接続を確立します。

例

例 1: TTL が無限のステートフルサービスレプリカのエラー正常性レポートを報告する

PS C:\> Send-ServiceFabricReplicaHealthReport -PartitionId 869dd2e9-fdda-42a5-ad96-4b71c795dfd3 -ReplicaId 130464806670632402 -SourceId "MyWatchdog" -HealthProperty "DiskUsage" -HealthState Error -Description "Disk is full"

このコマンドは、指定されたステートフルサービスレプリカの指定されたパーティションの正常性レポートをソース MyWatchDog から送信します。正常性レポートには、エラー正常性状態の正常性プロパティ DiskUsage に関する情報が含まれます。TTL は無限です。このコマンドは、エラーの説明も提供します。

例 2: 指定した TTL に対して有効なステートレスサービスインスタンスの警告正常性レポートを報告し、有効期限が切れたときに削除する

PS C:\> Send-ServiceFabricReplicaHealthReport -PartitionId 1a151ac7-9c25-4528-81fc-4c6bb9909394 -InstanceId 130464806670632403 -SourceId "MyWatchdog" -HealthProperty "Resources" -HealthState Warning -Description "Access to resources is temporarily disabled" -TimeToLiveSec 10 -RemoveWhenExpired

このコマンドは、指定されたステートレスサービスインスタンスの正常性レポートをソース MyWatchDog から送信します。正常性レポートには、ソース MyWatchdog からの警告正常性状態の正常性プロパティ リソース に関する情報が含まれます。TTL は 10 秒です。期限切れ時に削除のマークが付いたレポート。

パラメーター

-Description

レポートをトリガーした条件に関する人間が判読できる情報を指定します。 SourceId、HealthProperty、および HealthState パラメーターは、レポートを完全に記述します。

この説明の文字列の最大長は 4,096 文字です。指定された文字列が長い場合は、自動的に切り捨てられます。切り捨てられると、説明はマーカー "[Truncated]" で終わり、切り捨てが発生したことをユーザーに示します。合計文字列サイズは 4096 文字であるため、元の文字列から 4096 文字未満が保持されます。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-HealthProperty

レポートのプロパティを指定します。 SourceId パラメーターと共に、このプロパティはレポートを一意に識別します。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-HealthState

報告される正常性状態を表す HealthState オブジェクトを指定します。

Type:	HealthState
Accepted values:	Invalid, Ok, Warning, Error, Unknown
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Immediate

レポートをすぐに正常性ストアに送信するかどうかを指定します。これは、できるだけ早く送信する必要がある重要なレポートに役立ちます。指定しない場合、正常性クライアント設定に基づいてレポートが送信されます。その結果、HealthReportSendInterval の構成に従ってバッチ処理されます。この設定が推奨されているのは、正常性クライアントが正常性ストアへの正常性レポートメッセージに加えて正常性レポート処理を最適化できるようになるためです。既定では、Powershell ファブリッククライアントは HealthReportSentInterval を 0 に設定するため、レポートはすぐに送信されます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InstanceId

ステートレスサービスインスタンス ID を指定します。インスタンス ID はステートレスサービスに対してのみ有効です。 ReplicaId ではなく InstanceId を使用するステートフルレプリカのレポートは、正常性クライアントによって受け入れられますが、正常性ストアによって拒否されます。

Type:	Int64
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PartitionId

Service Fabric パーティションの ID を指定します。

Type:	Guid
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-RemoveWhenExpired

レポートの有効期限が切れると、正常性ストアからレポートが削除されることを示します。このパラメーターを指定しない場合、レポートの有効期限が切れると、エンティティはエラー状態と見なされます。有効期限が切れたときに削除されるレポートは、一定期間だけ有効な条件や、正常性ストアからレポートをクリアするために使用できます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ReplicaId

ステートフルサービスレプリカ ID を指定します。レプリカ ID はステートフルサービスに対してのみ有効です。 InstaceId の代わりに ReplicaId を使用するステートレスインスタンスのレポートは、正常性クライアントによって受け入れられますが、正常性ストアによって拒否されます。

Type:	Int64
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SequenceNumber

正常性レポートに関連付けられているシーケンス番号を指定します。このパラメーターの値を指定しない場合、シーケンス番号は自動的に設定されます。シーケンス番号を指定する場合、その値は、同じ SourceId と HealthProperty に対して同じエンティティに設定された以前のシーケンス番号よりも大きくする必要があります。または、古さが原因でレポートが拒否されます。

Type:	Int64
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SourceId

レポートをトリガーしたソースの識別子を指定します。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TimeoutSec

操作のタイムアウト期間を秒単位で指定します。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeToLiveSec

レポートの Time to Live (TTL) を秒単位で指定します。 TTL の有効期限が切れると、 RemoveWhenExpired パラメーターが指定されている場合、レポートは正常性ストアから削除されます。それ以外の場合、有効期限が切れたレポートのため、エンティティは Error で評価されます。既定値は Infinite です。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

入力

System.Guid

System.Fabric.Health.HealthState

System.String

System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

System.Management.Automation.SwitchParameter

System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

出力

System.Object