次の方法で共有

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 パラメーター レポートを完全に記述します。

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-HealthProperty

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

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-HealthState

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

型:HealthState
指定可能な値:Invalid, Ok, Warning, Error, Unknown
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Immediate

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InstanceId

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

型:Int64
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-PartitionId

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

型:Guid
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-RemoveWhenExpired

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ReplicaId

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

型:Int64
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-SequenceNumber

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

型:Int64
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-SourceId

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

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-TimeoutSec

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

型:Int32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-TimeToLiveSec

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

型:Int32
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る: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