Send-ServiceFabricServiceHealthReport

  • Référence
Module:
ServiceFabric

Envoie un rapport d’intégrité sur un service Service Fabric.

Syntaxe

Send-ServiceFabricServiceHealthReport
    [-ServiceName] <Uri>
    -HealthState <HealthState>
    -SourceId <String>
    -HealthProperty <String>
    [-Description <String>]
    [-TimeToLiveSec <Int32>]
    [-RemoveWhenExpired]
    [-SequenceNumber <Int64>]
    [-Immediate]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Description

L’applet de commande Send-ServiceFabricServiceHealthReport envoie un rapport d’intégrité sur un service Service Fabric.

Le service doit déjà exister dans le magasin d’intégrité. Pour vérifier s’il existe, utilisez l’applet de commande Get-ServiceFabricServiceHealth et spécifiez le paramètre ServiceName. Vous pouvez également utiliser l’applet de commande Get-ServiceFabricApplicationHealth pour obtenir les informations de l’application, puis vérifier la section états d’intégrité du service pour trouver le service souhaité.

Le rapport est envoyé après le nombre de secondes spécifié dans le paramètre HealthReportSendIntervalInSec de l’applet de commande Connect-ServiceFabricCluster. La connexion de cluster doit être conservée active pendant cette période.

L’applet de commande peut retourner la réussite, mais le rapport est envoyé de façon asynchrone, de sorte que son traitement peut échouer. Pour déterminer si le rapport a été appliqué dans le magasin d’intégrité, utilisez l’applet de commande Get-ServiceFabricServiceHealth Get-ServiceFabricServiceHealth et vérifiez que le rapport apparaît dans la section HealthEvents.

Avant d’effectuer une opération sur un cluster Service Fabric, établissez une connexion au cluster à l’aide de l’applet de commande Connect-ServiceFabricCluster.

Exemples

Exemple 1 : Rapport d’intégrité des erreurs avec durée de vie infinie

PS C:\> Send-ServiceFabricServiceHealthReport -ServiceName fabric:/MyApplication/MyService -SourceId "MyWatchdog" -HealthProperty "Availability" -HealthState Error -Description "The service is not available."

Cette commande envoie un rapport d’intégrité pour le service nommé fabric :/MyApplication/MyService à partir de la source MyWatchDog. Le rapport d’intégrité contient des informations sur la propriété d’intégrité disponibilité dans un état d’intégrité d’erreur, avec durée de vie infinie. Cette commande fournit également une description de l’erreur.

Exemple 2 : Avertissement de rapport valide pour la durée de vie spécifiée

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."

Cette commande envoie un rapport d’intégrité sur le service nommé fabric :/MyApplication/MyService à partir de la source MyWatchdog. Le rapport d’intégrité contient des informations sur la propriété d’intégrité PrivateData dans un état d’intégrité d’avertissement avec une durée de vie de 10 secondes et marque le rapport pour suppression à l’expiration.

Paramètres

-Description

Spécifie des informations lisibles par l’homme sur la condition qui a déclenché le rapport. Les paramètres SourceId, HealthPropertyet HealthState décrivent entièrement le rapport.

La longueur maximale de la chaîne pour la description est de 4 096 caractères. Si la chaîne fournie est plus longue, elle est tronquée automatiquement. Lorsqu’elle est tronquée, la description se termine par un marqueur , « [Tronqué] », pour indiquer aux utilisateurs que la troncation s’est produite. La taille totale de la chaîne est de 4 096 caractères, donc moins de 4 096 caractères de la chaîne d’origine sont conservés.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-HealthProperty

Spécifie la propriété du rapport. Avec le paramètre SourceId, cette propriété identifie de manière unique le rapport.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-HealthState

Spécifie un objet HealthState qui représente l’état d’intégrité signalé.

Type:HealthState
Valeurs acceptées:Invalid, Ok, Warning, Error, Unknown
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Immediate

Spécifie si le rapport doit être envoyé immédiatement au magasin d’intégrité. Cela est utile pour les rapports critiques qui doivent être envoyés dès que possible. S’il n’est pas spécifié, le rapport est envoyé en fonction des paramètres du client d’intégrité. Par conséquent, il sera batché en fonction de la configuration HealthReportSendInterval. Il s’agit du paramètre recommandé, car il permet au client d’intégrité d’optimiser les messages de création de rapports d’intégrité dans le magasin d’intégrité, ainsi que le traitement du rapport d’intégrité. Par défaut, le client PowerShell Fabric définit HealthReportSentInterval sur 0. Par conséquent, les rapports sont envoyés immédiatement.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RemoveWhenExpired

Indique que le rapport est supprimé du magasin d’intégrité lorsqu’il expire. Si vous ne spécifiez pas ce paramètre, l’entité est considérée dans l’état d’erreur lorsque la durée de vie du rapport expire. Les rapports qui sont supprimés lorsqu’ils ont expiré peuvent être utilisés pour les conditions valides uniquement pendant une période donnée ou pour l’effacement des rapports du Magasin d’intégrité.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-SequenceNumber

Spécifie le numéro de séquence associé au rapport d’intégrité. Si vous ne spécifiez pas de valeur pour ce paramètre, le numéro de séquence est défini automatiquement. Si vous spécifiez un numéro de séquence, cette valeur doit être supérieure à n’importe quel numéro de séquence précédent défini sur le même SourceId et HealthProperty, ou le rapport est rejeté en raison d’une obsolescence.

Type:Int64
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ServiceName

Spécifie l’URI (Uniform Resource Identifier) d’un service Service Fabric.

Type:Uri
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-SourceId

Spécifie l’identificateur de la source qui a déclenché le rapport.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TimeoutSec

Spécifie le délai d’expiration, en secondes, pour l’opération.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-TimeToLiveSec

Spécifie la durée de vie (TTL) du rapport en secondes. Lorsque la durée de vie expire, le rapport est supprimé du magasin d’intégrité si le paramètre RemoveWhenExpired est spécifié. Sinon, l’entité est évaluée à l’erreur en raison du rapport expiré. La valeur par défaut est Infinite.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

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]]

Sorties

System.Object