HealthReportSendOptions.Immediate Property

Definition

Namespace:

System.Fabric.Health

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Gets or sets the flag which indicates whether the report should be sent immediately. Defaults to false, in which case the report is sent per the fabric client health report related settings.

public bool Immediate { get; set; }

member this.Immediate : bool with get, set

Public Property Immediate As Boolean

Property Value

Boolean

A flag which indicates whether the report should be sent immediately.

Remarks

If true, the report is sent immediately, regardless of the HealthReportSendInterval configuration set on the health client. This is useful for critical reports that should be sent as soon as possible. Another scenario where this may be useful is if the client needs to be closed, for example because the host process is going down, and you need to increase the chances of the report being sent. Depending on timing and other conditions, sending the report may still fail, either because the client doesn't have time to send it before shutdown, or because the message is lost and the health client went down before it can retry.

If false, the report is sent based on the health client settings, especially the HealthReportSendInterval configuration.

By default, reports are not sent immediately. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.