Send-ServiceFabricServiceHealthReport
Wysyła raport kondycji usługi Service Fabric.
Składnia
Send-ServiceFabricServiceHealthReport
[-ServiceName] <Uri>
-HealthState <HealthState>
-SourceId <String>
-HealthProperty <String>
[-Description <String>]
[-TimeToLiveSec <Int32>]
[-RemoveWhenExpired]
[-SequenceNumber <Int64>]
[-Immediate]
[-TimeoutSec <Int32>]
[<CommonParameters>]
Opis
Polecenie cmdlet Send-ServiceFabricServiceHealthReport wysyła raport kondycji usługi Service Fabric.
Usługa powinna już istnieć w magazynie kondycji. Aby sprawdzić, czy istnieje, użyj polecenia cmdlet Get-ServiceFabricServiceHealth i określ parametr ServiceName. Alternatywnie możesz użyć polecenia cmdlet Get-ServiceFabricApplicationHealth, aby uzyskać informacje o aplikacji, a następnie sprawdzić sekcję stanów kondycji usługi, aby znaleźć odpowiednią usługę.
Raport jest wysyłany po liczbie sekund określonych w HealthReportSendIntervalInSec parametru Connect-ServiceFabricCluster. W tym czasie połączenie klastra musi być nadal aktywne.
Polecenie cmdlet może zwrócić powodzenie, ale raport jest wysyłany asynchronicznie, więc jego przetwarzanie może zakończyć się niepowodzeniem. Aby sprawdzić, czy raport został zastosowany w magazynie kondycji, użyj polecenia cmdlet Get-ServiceFabricServiceHealth i sprawdź, czy raport jest wyświetlany w sekcji HealthEvents.
Przed wykonaniem dowolnej operacji w klastrze usługi Service Fabric ustanów połączenie z klastrem przy użyciu polecenia cmdlet Connect-ServiceFabricCluster.
Przykłady
Przykład 1. Raport dotyczący kondycji błędu z nieskończonym czasem wygaśnięcia
PS C:\> Send-ServiceFabricServiceHealthReport -ServiceName fabric:/MyApplication/MyService -SourceId "MyWatchdog" -HealthProperty "Availability" -HealthState Error -Description "The service is not available."
To polecenie wysyła raport kondycji usługi o nazwie fabric:/MyApplication/MyService ze źródła MyWatchDog. Raport kondycji zawiera informacje o właściwości kondycji dostępności w stanie Kondycja błędu z nieskończonym czasem wygaśnięcia. To polecenie zawiera również opis błędu.
Przykład 2: Ostrzeżenie raportu prawidłowe dla określonego czasu wygaśnięcia
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."
To polecenie wysyła raport kondycji usługi o nazwie fabric:/MyApplication/MyService ze źródła MyWatchdog. Raport kondycji zawiera informacje o właściwości kondycji PrivateData w stanie kondycji Ostrzeżenie o 10 sekundach czasu wygaśnięcia i oznacza raport do usunięcia po wygaśnięciu.
Parametry
-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.
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 |
-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 |
-ServiceName
Określa identyfikator URI (Uniform Resource Identifier) usługi Service Fabric.
Typ: | Uri |
Position: | 0 |
Domyślna wartość: | None |
Wymagane: | True |
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.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]]
Dane wyjściowe
System.Object