WildFly Full 20 Model Reference

  1. home
  2. subsystem=modcluster
  3. proxy
  4. load-provider=dynamic
  5. custom-load-metric

Built-in load metric contributing a value to the overall load factor of a node. The load factors from each metric are aggregated according to their weights.

Attributes (5)

  • capacity Maximum capacity of the metric used to normalize the load values from a metric which require explicit capacity.
    • Attribute Value
    Default Value 1.0
    Type DOUBLE
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • class Class name to use to construct a load metric from.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • module Module name from which to load the load metric class.
    • Attribute Value
    Default Value org.wildfly.extension.mod_cluster
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • property Properties to apply on a loaded metric instance.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • weight Number indicating the significance of a metric with respect to the other metrics. For example, a metric of weight 2 will have twice the impact on the overall load factor than a metric of weight 1.
    • Attribute Value
    Default Value 1
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (2)

  • add Add a load metric to the set of load metrics to calculate the load factor from.
    Request Parameter Type Required Expressions Allowed Default value Description
    weight INT false true 1 Number indicating the significance of a metric with respect to the other metrics. For example, a metric of weight 2 will have twice the impact on the overall load factor than a metric of weight 1.
    capacity DOUBLE false true 1.0 Maximum capacity of the metric used to normalize the load values from a metric which require explicit capacity.
    property OBJECT false true Properties to apply on a loaded metric instance.
    class STRING true true Class name to use to construct a load metric from.
    module STRING false true org.wildfly.extension.mod_cluster Module name from which to load the load metric class.
  • remove Remove a load metric from the set of load metrics to calculate the load factor from.