Send-ServiceFabricDeployedServicePackageHealthReport
Wysyła raport kondycji dla wdrożonego pakietu usługi Service Fabric.
Składnia
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>]
Opis
Polecenie cmdlet Send-ServiceFabricDeployedServicePackageHealthReport wysyła raport kondycji dla wdrożonego pakietu usługi Service Fabric.
Wdrożony pakiet usługi musi już istnieć w magazynie kondycji. Aby sprawdzić, czy usługa istnieje, użyj polecenia cmdlet Get-ServiceFabricDeployedServicePackageHealth. Określ nazwę aplikacji, nazwę pakietu usługi i nazwę węzła. Alternatywnie możesz użyć polecenia cmdlet Get-ServiceFabricDeployedApplicationHealth. Określ nazwę aplikacji i nazwę węzła, a następnie sprawdź sekcję Stany kondycji wdrożonego pakietu usługi, aby znaleźć pakiet usługi.
Polecenie cmdlet wysyła raport po interwale określonym przez polecenie cmdlet HealthReportSendIntervalInSec parametru Connect-ServiceFabricCluster. W tym czasie połączenie klastra musi być nadal aktywne. Polecenie jest oceniane na kliencie bez odwołania do uruchamiania w magazynie kondycji. Raport może nie być stosowany w magazynie kondycji, nawet jeśli polecenie zwróci powodzenie. Na przykład magazyn kondycji może odrzucić raport z powodu nieprawidłowego parametru, takiego jak nieaktualny numer sekwencji.
Aby sprawdzić, czy raport został zastosowany w magazynie kondycji, użyj polecenia cmdlet Get-ServiceFabricDeployedServicePackageHealth i sprawdź, czy raport jest wyświetlany w sekcji HealthEvents.
Aby zarządzać klastrami usługi Service Fabric, uruchom program Windows PowerShell przy użyciu opcji Uruchom jako administrator. Przed wykonaniem dowolnej operacji w klastrze usługi Service Fabric ustanów połączenie z klastrem przy użyciu polecenia cmdlet Connect-ServiceFabricCluster, a następnie polecenia cmdlet Get-ServiceFabricClusterConnection.
Przykłady
Przykład 1. Raport dotyczący kondycji błędu z nieskończonym czasem wygaśnięcia
PS C:\> Send-ServiceFabricDeployedServicePackageHealthReport -ApplicationName fabric:/MyApplication -NodeName "Node01" -ServiceManifestName "MyServiceManifest" -HealthProperty "Memory" -HealthState Error -SourceId "MyWatchdog"
To polecenie wysyła raport kondycji dla wdrożonego pakietu usługi dla aplikacji o nazwie fabric:/MyApplication w węźle o nazwie Node01 dla manifestu usługi o nazwie MyServiceManifest. Raport kondycji zawiera informacje o właściwości kondycji pamięci w stanie kondycji błędu ze źródła MyWatchdog z nieskończonym TTL. Opis nie jest podany, a numer sekwencji jest ustawiany automatycznie.
Przykład 2: Ostrzeżenie raportu prawidłowe dla określonego czasu wygaśnięcia i usunięcie go po wygaśnięciu
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
To polecenie wysyła raport kondycji dla wdrożonego pakietu usługi dla aplikacji o nazwie fabric:/MyApplication dla manifestu usługi o nazwie MyServiceManifest w węźle o nazwie Node01. Raport kondycji zawiera informacje o właściwości kondycji CustomSetup w stanie kondycji Ostrzeżenie ze źródła MyWatchdog z 10 sekund czasu wygaśnięcia. Po wygaśnięciu raportu zostanie on usunięty z magazynu kondycji i nie będzie już mieć wpływu na ocenę kondycji. To polecenie zawiera również opis ostrzeżenia.
Parametry
-ApplicationName
Określa identyfikator URI (Uniform Resource Identifier) aplikacji usługi Service Fabric. Polecenie cmdlet wysyła raport kondycji dla aplikacji, która ma określony identyfikator URI.
Typ: | Uri |
Position: | 0 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Description
Określa czytelne informacje o stanie, który wyzwolił raport. Parametry SourceId, HealthPropertyi HealthState w pełni opisują raport.
Maksymalna długość ciągu opisu wynosi 4096 znaków. Jeśli podany ciąg jest dłuższy, zostanie on automatycznie obcięty. Po obcięciu opis kończy się znacznikiem "[Obcięty]", aby wskazać użytkownikom, że wystąpił obcinanie. Łączny rozmiar ciągu to 4096 znaków, więc przechowywane są mniej niż 4096 znaków z oryginalnego ciągu.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-HealthProperty
Określa właściwość raportu. Wraz z parametrem SourceId ta właściwość jednoznacznie identyfikuje raport. Raport zastępuje wszystkie poprzednie raporty o tych samych wartościach dla parametrów SourceId i HealthProperty w tej samej jednostce.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-HealthState
Określa obiekt HealthState reprezentujący zgłoszony stan kondycji.
Typ: | HealthState |
Dopuszczalne wartości: | Invalid, Ok, Warning, Error, Unknown |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Immediate
Określa, czy raport ma być wysyłany do magazynu kondycji natychmiast. Jest to przydatne w przypadku raportów krytycznych, które powinny być wysyłane tak szybko, jak to możliwe. Jeśli nie zostanie określony, raport zostanie wysłany na podstawie ustawień klienta kondycji. W związku z tym zostanie ona wsadowa zgodnie z konfiguracją HealthReportSendInterval. Jest to zalecane ustawienie, ponieważ umożliwia klientowi kondycji optymalizowanie komunikatów raportowania kondycji do magazynu kondycji oraz przetwarzania raportów o kondycji. Domyślnie klient sieci szkieletowej programu PowerShell ustawia wartość HealthReportSentInterval na wartość 0, więc raporty są wysyłane natychmiast.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-NodeName
Określa nazwę węzła usługi Service Fabric. Polecenie cmdlet wysyła raport o kondycji pakietu usługi wdrożonego w określonym węźle.
Typ: | String |
Position: | 2 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-RemoveWhenExpired
Wskazuje, że raport jest usuwany z magazynu kondycji po wygaśnięciu. Jeśli nie określisz tego parametru, jednostka jest uznawana za w stanie Błąd, gdy czas wygaśnięcia raportu wygaśnie. Raporty, które są usuwane, gdy wygasły, mogą być używane w przypadku warunków, które są ważne tylko przez pewien czas lub do czyszczenia raportów z magazynu kondycji.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-SequenceNumber
Określa numer sekwencji skojarzony z raportem kondycji. Jeśli nie określisz wartości dla tego parametru, numer sekwencji zostanie ustawiony automatycznie. Jeśli określisz numer sekwencji, ta wartość musi być wyższa niż poprzedni numer sekwencji ustawiony na tej samej sourceId i HealthPropertylub raport zostanie odrzucony z powodu nieaktualności.
Typ: | Int64 |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-ServiceManifestName
Określa nazwę manifestu usługi Service Fabric. Wraz z ApplicationName i NodeNameta wartość jednoznacznie identyfikuje wdrożona jednostka kondycji pakietu usługi.
Typ: | String |
Position: | 1 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-ServicePackageActivationId
Identyfikator aktywacji wdrożonej ServicePackage. Można to uzyskać za pomocą zapytania Get-ServiceFabricDeployedServicePackage.
Jeśli ServicePackageActivationMode określona podczas tworzenia usługi (przy użyciu New-ServiceFabricService
) jest SharedProcess (lub jeśli nie jest określona, w tym przypadku domyślnie SharedProcess), wartość ServicePackageActivation Id jest zawsze pustym ciągiem i nie trzeba go określać. Aby dowiedzieć się więcej na temat identyfikatora aktywacji pakietu usługi, zobacz [Model hostingu usługi Service Fabric][1].
Typ: | String |
Position: | 3 |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-SourceId
Określa identyfikator źródła, które wyzwoliło raport.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-TimeoutSec
Określa limit czasu dla operacji w sekundach.
Typ: | Int32 |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-TimeToLiveSec
Określa czas wygaśnięcia (TTL) raportu w sekundach. Po wygaśnięciu czasu wygaśnięcia raport zostanie usunięty z magazynu kondycji, jeśli zostanie określony parametr RemoveWhenExpired. W przeciwnym razie jednostka jest oceniana na stronie Błąd z powodu wygasłego raportu. Wartość domyślna to Nieskończona.
Typ: | Int32 |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
Dane wejściowe
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]]
Dane wyjściowe
System.Object