ServiceLoadMetricDescription interface
Specifies a metric to load balance a service during runtime.
Properties
default |
Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. |
name | 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. |
primary |
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. |
secondary |
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. |
weight | The service load metric relative weight, compared to other metrics configured for this service, as a number. |
Property Details
defaultLoad
Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
defaultLoad?: number
Property Value
number
name
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.
name: string
Property Value
string
primaryDefaultLoad
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.
primaryDefaultLoad?: number
Property Value
number
secondaryDefaultLoad
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.
secondaryDefaultLoad?: number
Property Value
number
weight
The service load metric relative weight, compared to other metrics configured for this service, as a number.
weight?: string
Property Value
string