FabricClient.HealthClient.GetApplicationHealthAsync Method

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (System.Fabric.Description.ApplicationHealthQueryDescription queryDescription);

member this.GetApplicationHealthAsync : System.Fabric.Description.ApplicationHealthQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>

Public Function GetApplicationHealthAsync (queryDescription As ApplicationHealthQueryDescription) As Task(Of ApplicationHealth)

Parameters

Returns

The health of the specified Service Fabric application.

Exceptions

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (Uri applicationName);

member this.GetApplicationHealthAsync : Uri -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>

Public Function GetApplicationHealthAsync (applicationName As Uri) As Task(Of ApplicationHealth)

Parameters

Returns

The health of the specified Service Fabric application.

Exceptions

Remarks

The following example gets the health of an application.

public static bool GetApplicationHealth(string clusterConnection)
            {
                ApplicationHealth applicationHealth;
                Uri applicationName = new Uri("fabric:/myapp/todo");

                // Connect to the cluster.
                FabricClient fabricClient = new FabricClient(clusterConnection);

                // Get the application health.
                try
                {
                    applicationHealth = fabricClient.HealthManager.GetApplicationHealthAsync(applicationName).Result;
                }
                catch (Exception e)
                {
                    Console.WriteLine("Error: " + e.Message);

                    if (e.InnerException != null)
            Console.WriteLine("  Inner Exception: " + e.InnerException.Message);

                    return false;
                }

                // Display the application health information.
                Console.WriteLine("Get Application Health:");
                Console.WriteLine("  Application {0}: {1}", applicationHealth.ApplicationName, applicationHealth.AggregatedHealthState);

                // List the deployed application health states.
                Console.WriteLine("    Deployed applications:");
                IList<DeployedApplicationHealthState> deployedAppHealthStateList = applicationHealth.DeployedApplicationHealthStates;
                foreach (DeployedApplicationHealthState deployedAppHealthState in deployedAppHealthStateList)
                {
                    Console.WriteLine("      Application: " + deployedAppHealthState.ApplicationName);
                    Console.WriteLine("        Aggregated Health State: " + deployedAppHealthState.AggregatedHealthState);
                    Console.WriteLine("        Node Name: " + deployedAppHealthState.NodeName);
                }

                // List the deployed services health states.
                Console.WriteLine("    Service Health States:");
                IList<ServiceHealthState> deployedSvcsHealthStateList = applicationHealth.ServiceHealthStates;
                foreach (ServiceHealthState serviceHealthState in deployedSvcsHealthStateList)
                {
                    Console.WriteLine("      Service {0}: {1}", serviceHealthState.ServiceName, serviceHealthState.AggregatedHealthState);
                }

                // List the health events.
                Console.WriteLine("    Health Events:");
                IList<HealthEvent> healthEvents = applicationHealth.HealthEvents;
                foreach (HealthEvent healthEvent in healthEvents)
                {
                    Console.WriteLine("      Health Event:");
                    Console.WriteLine("        Last Modified: " + healthEvent.LastModifiedUtcTimestamp);
                    Console.WriteLine("        Source UTC Timestamp: " + healthEvent.SourceUtcTimestamp);
                    Console.WriteLine("        Is Expired: " + healthEvent.IsExpired);
                    Console.WriteLine("        Health Information:");
                    Console.WriteLine("          Description: " + healthEvent.HealthInformation.Description);
                    Console.WriteLine("          Source ID: " + healthEvent.HealthInformation.SourceId);
                    Console.WriteLine("          Health State: " + healthEvent.HealthInformation.HealthState);
                    Console.WriteLine("          Property: " + healthEvent.HealthInformation.Property);
                    Console.WriteLine("          Remove When Expired: " + healthEvent.HealthInformation.RemoveWhenExpired);
                    Console.WriteLine("          Sequence Number: " + healthEvent.HealthInformation.SequenceNumber);
                    Console.WriteLine("          Time to Live: " + healthEvent.HealthInformation.TimeToLive);
                }

                Console.WriteLine();
                return true;
            }

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (Uri applicationName, System.Fabric.Health.ApplicationHealthPolicy healthPolicy);

member this.GetApplicationHealthAsync : Uri * System.Fabric.Health.ApplicationHealthPolicy -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>

Public Function GetApplicationHealthAsync (applicationName As Uri, healthPolicy As ApplicationHealthPolicy) As Task(Of ApplicationHealth)

Parameters

Returns

The health reports of the specified Service Fabric application.

Exceptions

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (System.Fabric.Description.ApplicationHealthQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetApplicationHealthAsync : System.Fabric.Description.ApplicationHealthQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>

Public Function GetApplicationHealthAsync (queryDescription As ApplicationHealthQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ApplicationHealth)

Parameters

Returns

The health reports of the specified Service Fabric application.

Exceptions

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (Uri applicationName, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetApplicationHealthAsync : Uri * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>

Public Function GetApplicationHealthAsync (applicationName As Uri, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ApplicationHealth)

Parameters

Returns

The health reports of the specified Service Fabric application.

Exceptions

public System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth> GetApplicationHealthAsync (Uri applicationName, System.Fabric.Health.ApplicationHealthPolicy healthPolicy, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetApplicationHealthAsync : Uri * System.Fabric.Health.ApplicationHealthPolicy * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.ApplicationHealth>

Public Function GetApplicationHealthAsync (applicationName As Uri, healthPolicy As ApplicationHealthPolicy, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ApplicationHealth)

Parameters

Returns

The health reports of the specified Service Fabric application.

Exceptions