Service Load Metric Description

  • Article

Specifies a metric to load balance a service during runtime.

Properties

Name Type Required
Name string Yes
Weight string (enum) No
PrimaryDefaultLoad integer No
SecondaryDefaultLoad integer No
AuxiliaryDefaultLoad integer No
DefaultLoad integer No

Name

Type: string
Required: Yes

The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive.

Weight

Type: string (enum)
Required: No

The service load metric relative weight, compared to other metrics configured for this service, as a number.

Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.

Possible values are:

  • Zero - Disables resource balancing for this metric. This value is zero.
  • Low - Specifies the metric weight of the service load as Low. The value is 1.
  • Medium - Specifies the metric weight of the service load as Medium. The value is 2.
  • High - Specifies the metric weight of the service load as High. The value is 3.

PrimaryDefaultLoad

Type: integer
Required: No

Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.

SecondaryDefaultLoad

Type: integer
Required: No

Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.

AuxiliaryDefaultLoad

Type: integer
Required: No

Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is an Auxiliary replica.

DefaultLoad

Type: integer
Required: No

Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.