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>]
Description
Send-ServiceFabricServiceHealthReport Cmdlet 會在 Service Fabric 服務上傳送健康情況報告。
服務應該已存在於健康狀態存放區中。 若要檢查它是否存在,請使用 Get-ServiceFabricServiceHealth Cmdlet 並指定 ServiceName 參數。 或者,您可以使用 Get-ServiceFabricApplicationHealth Cmdlet 來取得應用程式資訊,然後檢查服務健康情況狀態欄段以尋找您想要的服務。
報告會在Connect-ServiceFabricCluster Cmdlet 的HealthReportSendIntervalInSec參數中指定的秒數之後傳送。 叢集連線必須在這段期間保持運作。
Cmdlet 可能會傳回成功,但報表會以非同步方式傳送,因此其處理可能會失敗。 若要查看是否已在健康狀態存放區中套用報表,請使用 Get-ServiceFabricServiceHealth Cmdlet,並檢查報告是否出現在 HealthEvents 區段中。
在 Service Fabric 叢集上執行任何作業之前,請先使用 Connect-ServiceFabricCluster Cmdlet 建立叢集的連線。
範例
範例 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 的服務健康情況報告。 健康狀態報表包含 Health 屬性 PrivateData 的相關資訊,其狀態為 10 秒 TTL,並標示報告在到期時移除。
參數
-Description
指定有關觸發報表之條件的人類可讀資訊。 SourceId、HealthProperty和HealthState參數會完整描述報告。
描述的字串長度上限為 4096 個字元。 如果提供的字串較長,則會自動截斷。 截斷時,描述會以標記 「[Truncated]」 結尾,以向使用者指出發生截斷。 字串大小總計為 4096 個字元,因此會保留原始字串中的少於 4096 個字元。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-HealthProperty
指定報表的 屬性。 此屬性與 SourceId 參數一起唯一識別報表。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-HealthState
指定代表報告健全狀況狀態的 HealthState 物件。
類型: | HealthState |
接受的值: | Invalid, Ok, Warning, Error, Unknown |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-Immediate
指定是否應該立即將報告傳送至健康狀態存放區。 這對於應該儘快傳送的重要報告來說,相當有用。 如果未指定,則會根據健康情況用戶端設定傳送報告。 因此,會根據 HealthReportSendInterval 設定進行批次處理。 這是建議的設定,因為這除了可讓健康情況用戶端將健康情況報告處理最佳化之外,也可將傳送給健康狀態資料存放區的健康情況報告訊息最佳化。 根據預設,Powershell 網狀架構用戶端會將 HealthReportSentInterval 設定為 0,因此會立即傳送報告。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-RemoveWhenExpired
指出報表在過期時會從健康狀態存放區中移除。 如果您未指定此參數,當報表存留時間到期時,實體會被視為處於錯誤狀態。 過期時移除的報告可用於僅有效一段時間的條件,或從 Health Store 清除報告。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-SequenceNumber
指定與健康情況報告相關聯的序號。 如果您未指定此參數的值,則會自動設定序號。 如果您指定序號,該值必須高於相同 SourceId 和 HealthProperty上設定的任何先前序號,或報表因為過期而遭到拒絕。
類型: | Int64 |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-ServiceName
指定 Service Fabric 服務的統一資源識別項 (URI) 。
類型: | Uri |
Position: | 0 |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-SourceId
指定觸發報表的來源識別碼。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-TimeoutSec
指定作業的逾時期間,以秒為單位。
類型: | Int32 |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-TimeToLiveSec
指定報表的存留時間 (TTL) ,以秒為單位。 當 TTL 到期時,如果指定 RemoveWhenExpired 參數,則會從健康狀態存放區中移除報告。 否則,實體會在錯誤時評估,因為報告已過期。 預設值為 Infinite。
類型: | Int32 |
Position: | 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