FabricClient.HealthClient.GetPartitionHealthAsync Method

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (Guid partitionId, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetPartitionHealthAsync : Guid * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>

Public Function GetPartitionHealthAsync (partitionId As Guid, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of PartitionHealth)

Parameters

Returns

The health of a Service Fabric partition.

Exceptions

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (System.Fabric.Description.PartitionHealthQueryDescription queryDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetPartitionHealthAsync : System.Fabric.Description.PartitionHealthQueryDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>

Public Function GetPartitionHealthAsync (queryDescription As PartitionHealthQueryDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of PartitionHealth)

Parameters

Returns

The health of a Service Fabric partition.

Exceptions

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (Guid partitionId, System.Fabric.Health.ApplicationHealthPolicy healthPolicy, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.GetPartitionHealthAsync : Guid * System.Fabric.Health.ApplicationHealthPolicy * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>

Public Function GetPartitionHealthAsync (partitionId As Guid, healthPolicy As ApplicationHealthPolicy, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of PartitionHealth)

Parameters

Returns

The health of a Service Fabric partition.

Exceptions

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (Guid partitionId);

member this.GetPartitionHealthAsync : Guid -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>

Public Function GetPartitionHealthAsync (partitionId As Guid) As Task(Of PartitionHealth)

Parameters

Returns

The health of a Service Fabric partition.

Exceptions

Remarks

The following example gets the health of a partition.

public static bool GetPartitionHealth(string clusterConnection)
            {
                PartitionHealth partitionHealth;

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

                // Get the partition health.
                try
                {
                    partitionHealth = fabricClient.HealthManager.GetPartitionHealthAsync(new Guid("a7206315-e53b-4d05-b59c-e210caa28893")).Result;
                }
                catch (Exception e)
                {
                    Console.WriteLine("Error: " + e.Message);

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

                    return false;
                }

                // Display the partition health information.
                Console.WriteLine("Partition Health:");
                Console.WriteLine("  Partition ID: " + partitionHealth.PartitionId);
                Console.WriteLine("    Aggregated Health State: " + partitionHealth.AggregatedHealthState);

                // List the health events.
                Console.WriteLine("    Health Events:");
                IList<HealthEvent> healthEvents = partitionHealth.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);
                }

                // List the replica health states.
                Console.WriteLine("    Replica Health States:");
                IList<ReplicaHealthState> replicaHealthStates = partitionHealth.ReplicaHealthStates;
                foreach (ReplicaHealthState replicaHealthState in replicaHealthStates)
                {
                    Console.WriteLine("      ID: " + replicaHealthState.Id);
                    Console.WriteLine("        Kind: " + replicaHealthState.Kind);
                    Console.WriteLine("        Aggregated Health State: " + replicaHealthState.AggregatedHealthState);
                    Console.WriteLine("        Partition ID: " + replicaHealthState.PartitionId);
                }

                // List the unhealthy evaluations.
                Console.WriteLine("    Unhealthy Evaluations:");
                IList<HealthEvaluation> healthEvaluationList = partitionHealth.UnhealthyEvaluations;
                foreach (HealthEvaluation healthEvaluation in healthEvaluationList)
                {
                    Console.WriteLine("      Kind: " + healthEvaluation.Kind);
                    Console.WriteLine("        Aggregated Health State: " + healthEvaluation.AggregatedHealthState);
                    Console.WriteLine("        Description: " + healthEvaluation.Description);
                }

                Console.WriteLine();
                return true;
            }

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (System.Fabric.Description.PartitionHealthQueryDescription queryDescription);

member this.GetPartitionHealthAsync : System.Fabric.Description.PartitionHealthQueryDescription -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>

Public Function GetPartitionHealthAsync (queryDescription As PartitionHealthQueryDescription) As Task(Of PartitionHealth)

Parameters

Returns

The health of a Service Fabric partition.

Exceptions

public System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth> GetPartitionHealthAsync (Guid partitionId, System.Fabric.Health.ApplicationHealthPolicy healthPolicy);

member this.GetPartitionHealthAsync : Guid * System.Fabric.Health.ApplicationHealthPolicy -> System.Threading.Tasks.Task<System.Fabric.Health.PartitionHealth>

Public Function GetPartitionHealthAsync (partitionId As Guid, healthPolicy As ApplicationHealthPolicy) As Task(Of PartitionHealth)

Parameters

Returns

The health of a Service Fabric partition.

Exceptions