Health Policy (healthPolicy)
Defines a condition for a server to be considered healthy and actions to take when the condition is not met.
- action
- cluster
- excessiveMemoryUsage
- excessiveRequestTimeout
- excessiveResponseTime
- host
- memoryLeak
- server
| Attribute name | Data type | Default value | Description |
|---|---|---|---|
| enabled | boolean | true | Indicates whether the health policy is enabled. |
| id | string | A unique configuration ID. |
- action
Description: An action to take when the health condition breaches.Required: falseData type: Attribute name Data type Default value Description action - generateThreadDump
- restartServer
- exitMaintenanceMode
- enterMaintenanceMode
- generateHeapDump
An action to take when the health condition breaches. - generateThreadDump
- Generate a thread dump of the server.
- restartServer
- Restart the server.
- exitMaintenanceMode
- Remove the server from maintenance mode
- enterMaintenanceMode
- Put the server into maintenance mode
- generateHeapDump
- Generate a heap dump of the server.
- cluster
Description: Applies the health policy to servers that belong to a cluster.Required: falseData type: Attribute name Data type Default value Description clusterName string The name of a cluster of servers to be monitored.
- excessiveMemoryUsage
Description: Detects if a JVM's heap size has grown over a configured percentage of the maximum heap size for a configured period of time.Required: falseData type: Attribute name Data type Default value Description heapSizePercentage int Minimum: 1
Maximum: 99
85 The threshold value for the percentage of the max heap size used by the server. timePeriod A period of time with millisecond precision 5m The time period over which the heap size must be over threshold before action is taken. The value can be from 1 millisecond to 1 day. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
- excessiveRequestTimeout
Description: Detects when the request timeout of a server, as measured by a web server that is enabled for Intelligent Management, exceeds the configured threshold value.Required: falseData type: Attribute name Data type Default value Description timeoutPercentage int Minimum: 1
Maximum: 99
85 The threshold value for the percentage of the request timeout by the server.
- excessiveResponseTime
Description: Detects when the average response time of requests to a server, as measured by a web server that is enabled for Intelligent Management, exceeds the configured threshold value.Required: falseData type: Attribute name Data type Default value Description responseTime A period of time with millisecond precision 10s The average time that requests can take prior to corrective action. The value can be from 1 millisecond to 1 hour. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
- host
Description: Applies the health policy to servers that reside on a host.Required: falseData type: Attribute name Data type Default value Description hostName string The name of a host whose servers are to be monitored.
- memoryLeak
Description: Detects if a JVMs heap size after the GC keeps growing.Required: falseData type:
- server
Description: Applies the health policy to a specific server.Required: falseData type: Attribute name Data type Default value Description hostName string The host name of the server to be monitored. serverName string The name of the server to be monitored. wlpUsrDirectory Path to a directory The absolute WLP usr directory of the server to be monitored.
Reference topic