Send-ServiceFabricServiceHealthReport
Service Fabric サービスの正常性レポートを送信します。
構文
Send-ServiceFabricServiceHealthReport
[-ServiceName] <Uri>
-HealthState <HealthState>
-SourceId <String>
-HealthProperty <String>
[-Description <String>]
[-TimeToLiveSec <Int32>]
[-RemoveWhenExpired]
[-SequenceNumber <Int64>]
[-Immediate]
[-TimeoutSec <Int32>]
[<CommonParameters>] 説明
Send-ServiceFabricServiceHealthReport コマンドレットは、Service Fabric サービスの正常性レポートを送信します。
サービスは、正常性ストアに既に存在している必要があります。 存在するかどうかを確認するには、Get-ServiceFabricServiceHealth コマンドレットを使用し、ServiceName パラメーターを指定します。 または、Get-ServiceFabricApplicationHealth コマンドレットを使用してアプリケーション情報を取得し、サービスの正常性状態セクションを確認して目的のサービスを見つけることができます。
レポートは、Connect-ServiceFabricCluster コマンドレットの HealthReportSendIntervalInSec パラメーターで指定された秒数後に送信されます。 この間、クラスター接続を維持する必要があります。
コマンドレットは成功を返す可能性がありますが、レポートは非同期的に送信されるため、その処理が失敗する可能性があります。 レポートが正常性ストアに適用されたかどうかを確認するには、Get-ServiceFabricServiceHealth コマンドレットを使用し、レポートが HealthEvents セクションに表示されることを確認します。
Service Fabric クラスターで操作を実行する前に、Connect-ServiceFabricCluster コマンドレットを使用してクラスターへの接続を確立します。
例
例 1: 無限 TTL を使用してエラー正常性レポートを報告する
PS C:\> Send-ServiceFabricServiceHealthReport -ServiceName fabric:/MyApplication/MyService -SourceId "MyWatchdog" -HealthProperty "Availability" -HealthState Error -Description "The service is not available."このコマンドは、ソース MyWatchDog から fabric:/MyApplication/MyService という名前のサービスの正常性レポートを送信します。 正常性レポートには、正常性プロパティ エラー正常性状態の可用性 に関する情報が含まれています。TTL は無限です。 このコマンドでは、エラーの説明も表示されます。
例 2: 指定された TTL に対して有効なレポート警告
PS C:\> Send-ServiceFabricServiceHealthReport -ServiceName fabric:/MyApplication/MyService -SourceId "MyWatchdog" -HealthProperty "PrivateData" -HealthState Warning -TimeToLiveSec 10 -RemoveWhenExpired -Description "Accessing private data in database MyServicePrivateData is slow."このコマンドは、ソース MyWatchdog から fabric:/MyApplication/MyService という名前のサービスに正常性レポートを送信します。
正常性レポートには、10 秒の TTL で警告正常性状態の PrivateData
パラメーター
-Description
レポートをトリガーした条件に関する人間が判読できる情報を指定します。
説明の最大文字列長は 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 |
-RemoveWhenExpired
レポートの有効期限が切れると、正常性ストアから削除されることを示します。 このパラメーターを指定しない場合、レポートの有効期限が切れると、エンティティはエラー状態と見なされます。 有効期限が切れたときに削除されるレポートは、一定期間だけ有効な条件や、ヘルス ストアからのレポートのクリアに使用できます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SequenceNumber
正常性レポートに関連付けられているシーケンス番号を指定します。 このパラメーターの値を指定しないと、シーケンス番号が自動的に設定されます。 シーケンス番号を指定する場合、その値は、同じ SourceId および HealthPropertyに設定されている以前のシーケンス番号よりも大きくする必要があります。そうしないと、古さのためにレポートが拒否されます。
| 型: | Int64 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ServiceName
Service Fabric サービスの URI (Uniform Resource Identifier) を指定します。
| 型: | Uri |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | 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.Uri
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