Management API Reference for load-provider=dynamic

Configuration and runtime operations for mod_cluster subsystem.

Children (2)

Attributes (3)

decay - The factor by which a historic load values should degrade in significance.

Type	DOUBLE
Default Value	2.0
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "DOUBLE" }, "description" : "The factor by which a historic load values should degrade in significance.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 2.0, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

history - The number of historic (previous) load values to consider in the load balance factor computation.

Type	INT
Default Value	9
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of historic (previous) load values to consider in the load balance factor computation.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 9, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

initial-load - Initial load within the range [0..100] with which to prepopulate historical values. Used to gradually drive load to the node. Value of 0 prepopulates with full load and value of -1 disables this behavior.

Type	INT
Default Value	0
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	-1
Max	100
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Initial load within the range [0..100] with which to prepopulate historical values. Used to gradually drive load to the node. Value of 0 prepopulates with full load and value of -1 disables this behavior.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "min" : -1, "max" : 100, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

add - Add a dynamic load provider with no load metrics.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
decay	DOUBLE	false	true	2.0	The factor by which a historic load values should degrade in significance.
history	INT	false	true	9	The number of historic (previous) load values to consider in the load balance factor computation.
initial-load	INT	false	true	0	Initial load within the range [0..100] with which to prepopulate historical values. Used to gradually drive load to the node. Value of 0 prepopulates with full load and value of -1 disables this behavior.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a dynamic load provider with no load metrics.",
    "request-properties" : {
        "decay" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "The factor by which a historic load values should degrade in significance.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2.0,
            "stability" : "default"
        },
        "history" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of historic (previous) load values to consider in the load balance factor computation.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 9,
            "stability" : "default"
        },
        "initial-load" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Initial load within the range [0..100] with which to prepopulate historical values. Used to gradually drive load to the node. Value of 0 prepopulates with full load and value of -1 disables this behavior.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "min" : -1,
            "max" : 100,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove a dynamic load provider defaulting to simple load provider.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a dynamic load provider defaulting to simple load provider.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.modcluster.proxy.load-provider.dynamic

        
<feature spec="subsystem.modcluster.proxy.load-provider.dynamic">
  <param name="proxy" value="{resource name}"/>
  <param name="decay" value="{value}"/>
  <param name="history" value="{value}"/>
  <param name="initial-load" value="{value}"/>
<feature/>