次の方法で共有

Send-ServiceFabricDeployedServicePackageHealthReport

  • リファレンス
モジュール:
ServiceFabric

Service Fabric でデプロイされたサービス パッケージの正常性レポートを送信します。

構文

Send-ServiceFabricDeployedServicePackageHealthReport
    [-ApplicationName] <Uri>
    [-ServiceManifestName] <String>
    [-NodeName] <String>
    [[-ServicePackageActivationId] <String>]
    -HealthState <HealthState>
    -SourceId <String>
    -HealthProperty <String>
    [-Description <String>]
    [-TimeToLiveSec <Int32>]
    [-RemoveWhenExpired]
    [-SequenceNumber <Int64>]
    [-Immediate]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

説明

Send-ServiceFabricDeployedServicePackageHealthReport コマンドレットは、Service Fabric でデプロイされたサービス パッケージの正常性レポートを送信します。

デプロイされたサービス パッケージは、正常性ストアに既に存在している必要があります。 サービスが存在するかどうかを確認するには、 Get-ServiceFabricDeployedServicePackageHealth コマンドレットを使用します。 アプリケーション名、サービス パッケージ名、ノード名を指定します。 または、 Get-ServiceFabricDeployedApplicationHealth コマンドレットを使用することもできます。 アプリケーション名とノード名を指定し、デプロイされたサービス パッケージの正常性状態セクションを確認してサービス パッケージを見つけます。

コマンドレットは、Connect-ServiceFabricCluster コマンドレットの HealthReportSendIntervalInSec パラメーターで指定された間隔の後にレポートを送信します。 この間、クラスター接続を有効にしておく必要があります。 このコマンドは、正常性ストアで実行されている参照なしでクライアントで評価されます。 コマンドが成功を返しても、正常性ストアにレポートが適用されない場合があります。 たとえば、正常性ストアは、古いシーケンス番号などの無効なパラメーターが原因でレポートを拒否する場合があります。

レポートが正常性ストアに適用されたかどうかを確認するには、 Get-ServiceFabricDeployedServicePackageHealth コマンドレットを使用して、レポートが HealthEvents セクションに表示されることを確認します。

Service Fabric クラスターを管理するには、[管理者として実行] オプションを使用してWindows PowerShellを開始します。 Service Fabric クラスターで操作を実行する前に、Connect-ServiceFabricCluster コマンドレットと Get-ServiceFabricClusterConnection コマンドレットを使用してクラスターへの接続を確立します。

例

例 1: TTL が無限のエラー正常性レポートを報告する

PS C:\> Send-ServiceFabricDeployedServicePackageHealthReport -ApplicationName fabric:/MyApplication -NodeName "Node01" -ServiceManifestName "MyServiceManifest" -HealthProperty "Memory" -HealthState Error -SourceId "MyWatchdog"

このコマンドは、MyServiceManifest という名前のサービス マニフェストの Node01 という名前のノードで、fabric:/MyApplication という名前のアプリケーション用にデプロイされたサービス パッケージの正常性レポートを送信します。 正常性レポートには、ソース MyWatchdog からのエラー正常性状態の正常性プロパティ Memory に関する情報が、無限 TTL で含まれています。 説明は指定されず、シーケンス番号が自動的に設定されます。

例 2: 指定した TTL に対して有効な警告を報告し、有効期限が切れたときに削除する

PS C:\> Send-ServiceFabricDeployedServicePackageHealthReport -ApplicationName fabric:/MyApplication -ServiceManifestName MyServiceManifest -NodeName "Node01" -HealthProperty "CustomSetup" -HealthState Warning -SourceId MyWatchdog -RemoveWhenExpired -Description "The setup has completed with some warnings." -TimeToLiveSec 10

このコマンドは、Node01 という名前のノード上の MyServiceManifest という名前のサービス マニフェストの fabric:/MyApplication という名前のアプリケーションのデプロイ済みサービス パッケージの正常性レポートを送信します。 正常性レポートには、ソース MyWatchdog からの警告正常性状態の 正常性プロパティ CustomSetup に関する情報が含まれます。TTL は 10 秒です。 レポートの有効期限が切れると、正常性ストアから削除され、正常性評価には影響しなくなります。 このコマンドは、警告の説明も提供します。

パラメーター

-ApplicationName

Service Fabric アプリケーションの Uniform Resource Identifier (URI) を指定します。 コマンドレットは、指定した URI を持つアプリケーションの正常性レポートを送信します。

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

-Description

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

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

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

-HealthProperty

レポートのプロパティを指定します。 SourceId パラメーターと共に、このプロパティはレポートを一意に識別します。 このレポートは、同じエンティティの SourceId パラメーターと HealthProperty パラメーターと同じ値を持つ以前のレポートをオーバーライドします。

型: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

-NodeName

Service Fabric ノードの名前を指定します。 コマンドレットは、指定したノードにデプロイされたサービス パッケージの正常性レポートを送信します。

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

-RemoveWhenExpired

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

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

-SequenceNumber

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

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

-ServiceManifestName

Service Fabric サービス マニフェストの名前を指定します。 ApplicationName と NodeName と共に、この値はデプロイされたサービス パッケージの正常性エンティティを一意に識別します。

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

-ServicePackageActivationId

デプロイされた ServicePackage のアクティブ化 ID。 これは、 Get-ServiceFabricDeployedServicePackage クエリを使用して取得できます。

サービスの作成時に指定した ServicePackageActivationMode が New-ServiceFabricServiceSharedProcess (または指定されていない場合は既定で SharedProcess) の場合、ServicePackageActivationId の値は常に空の文字列であり、指定する必要はありません。 サービス パッケージのアクティブ化 ID の詳細については、[Service Fabric ホスティング モデル][1] を参照してください。

型:String
配置:3
規定値: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.Uri

System.String

System.Fabric.Health.HealthState

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