IServicePartition.ReportLoad(IEnumerable<LoadMetric>) Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Reports the load for a set of load balancing metrics. The load can be reported at any time via the ReportLoad(IEnumerable<LoadMetric>) method and provides one or more properties of the LoadMetric method.

public void ReportLoad (System.Collections.Generic.IEnumerable<System.Fabric.LoadMetric> metrics);

abstract member ReportLoad : seq<System.Fabric.LoadMetric> -> unit

Public Sub ReportLoad (metrics As IEnumerable(Of LoadMetric))

Parameters

metrics

IEnumerable<LoadMetric>

A collection of LoadMetric to report the load for.

Exceptions

FabricObjectClosedException

This indicates that the partition object is closed. The replica/replicator/instance has either been closed or is about to be closed.

Remarks

The reported metrics should correspond to those that are provided in the ServiceLoadMetricDescription as a part of the ServiceDescription that is used to create the service. Load metrics that are not present in the description are ignored. Reporting custom metrics allows Service Fabric to balance services that are based on additional custom information.