CodePackageActivationContext.ReportApplicationHealth Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

ReportApplicationHealth(HealthInformation)	Reports health for current application.
ReportApplicationHealth(HealthInformation, HealthReportSendOptions)	Reports health for current application. Specifies options to control how the report is sent.

ReportApplicationHealth(HealthInformation)

Reports health for current application.

public void ReportApplicationHealth (System.Fabric.Health.HealthInformation healthInfo);

abstract member ReportApplicationHealth : System.Fabric.Health.HealthInformation -> unit
override this.ReportApplicationHealth : System.Fabric.Health.HealthInformation -> unit

Public Sub ReportApplicationHealth (healthInfo As HealthInformation)

Parameters

healthInfo

HealthInformation

The HealthInformation that describes the health report information, such as source, property, and health state.

Implements

ReportApplicationHealth(HealthInformation)

Exceptions

ArgumentNullException

Returned when a null reference is passed to a method that does not accept it as a valid argument.

FabricException

Caused by one of the following:

FabricHealthStaleReport.

FabricHealthMaxReportsReached.

Remarks

The health information describes the report details, like the source ID, the property, the health state and other relevant details. The code package activation context uses an internal health client to send the reports to the health store. The client optimizes messages to Health Manager by batching reports per a configured duration (Default: 30 seconds). If the report has high priority, you can specify send options to send it immediately by using ReportApplicationHealth(HealthInformation, HealthReportSendOptions).

Read more about health reporting.

ReportApplicationHealth(HealthInformation, HealthReportSendOptions)

Reports health for current application. Specifies options to control how the report is sent.

public void ReportApplicationHealth (System.Fabric.Health.HealthInformation healthInfo, System.Fabric.Health.HealthReportSendOptions sendOptions);

abstract member ReportApplicationHealth : System.Fabric.Health.HealthInformation * System.Fabric.Health.HealthReportSendOptions -> unit
override this.ReportApplicationHealth : System.Fabric.Health.HealthInformation * System.Fabric.Health.HealthReportSendOptions -> unit

Public Sub ReportApplicationHealth (healthInfo As HealthInformation, sendOptions As HealthReportSendOptions)

Parameters

healthInfo

HealthInformation

The HealthInformation that describes the health report information, such as source, property, and health state.

sendOptions

HealthReportSendOptions

The HealthReportSendOptions that controls how the report is sent.

Implements

ReportApplicationHealth(HealthInformation, HealthReportSendOptions)

Exceptions

ArgumentNullException

Returned when a null reference is passed to a method that does not accept it as a valid argument.

FabricException

Caused by one of the following:

FabricHealthStaleReport.

FabricHealthMaxReportsReached.

Remarks

The health information describes the report details, like the source ID, the property, the health state and other relevant details. The code package activation context uses an internal health client to send the reports to the health store. The client optimizes messages to Health Manager by batching reports per a configured duration (Default: 30 seconds). If the report has high priority, you can specify send options to send it immediately.

Read more about health reporting.