HealthMBean

All Known Implementing Classes:

Health
```
public interface HealthMBean
```
Managed bean interface that exposes health indicators.

Since:

11.2.0

Version:

$Revision: 23905 $ $Date: 2020-06-16 15:29:26 +0000 (Tue, 16 Jun 2020) $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getAvgWebResourceRenderDurationOfLastFiveMinutes()` Health indicator of the average render time of the web resources, in the last five minutes.
`int`	`getBigDataRepositoryErrorLevel()` Health indicator of the big data cluster status.
`long`	`getDatabaseLatency()` Health indicator of the latency of the used database.
`double`	`getLoadAveragePerProc()` Returns the System Load Average per Available Core Processors.
`long`	`getNumberOfCachedPagesExpiredSince5m()` Returns the number of cached pages expired under five minutes ago.
`int`	`getNumberOfCachedPagesWithError()` Health indicator for the number of page cache with error.
`int`	`getNumberOfClocksExecutingMoreThanTwoMinutes()` Health indicator of the number of clocks running more than two minutes.
`int`	`getNumberOfLocks15SecondsOld()` Health indicator of the number of locks creates in more than fifty seconds.
`long`	`getNumberOfMonitoredUsers()` Returns the number o monitored users.
`int`	`getNumberOfPortalCachesFull()` Health indicator of the number of portal cache with full capacity.
`long`	`getNumberOfRegisteredUsers()` Returns the number o registered users.
`long`	`getNumberOfStandardGroupMembers()` Returns the number of standard group members.
`long`	`getNumberOfWebResources()` Returns the number of web resources.
`int`	`getProcessQueueFailedItems()` Health indicator of the process queue statistics, this is for retrieve the number of failed items in queue.
`int`	`getProcessQueueQueuedItems()` Health indicator of the process queue statistics, this is for retrieve the number of waiting items in queue.
`int`	`getProcessQueueRunningItems()` Health indicator of the process queue statistics, this is for retrieve the number of running items in queue.
`int`	`getProcessQueueScheduleItems()` Health indicator of the process queue statistics, this is for retrieve the number of schedule items in queue.
`int`	`getProcessQueueTotalProcess()` Health indicator of the process queue statistics, this is for retrieve the total number of items in queue.

- Method Detail
  - getDatabaseLatency
```
long getDatabaseLatency()
                 throws Exception
```
    Health indicator of the latency of the used database.
    
    Returns:
    
    The latency of the database(in milliseconds).
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getNumberOfCachedPagesWithError
```
int getNumberOfCachedPagesWithError()
                             throws Exception
```
    Health indicator for the number of page cache with error.
    
    Returns:
    
    The count of page cache with error.
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getNumberOfClocksExecutingMoreThanTwoMinutes
```
int getNumberOfClocksExecutingMoreThanTwoMinutes()
                                          throws Exception
```
    Health indicator of the number of clocks running more than two minutes.
    
    Returns:
    
    The count of clock running more than two minutes.
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getNumberOfLocks15SecondsOld
```
int getNumberOfLocks15SecondsOld()
                          throws Exception
```
    Health indicator of the number of locks creates in more than fifty seconds.
    
    Returns:
    
    The count of lock with lifetime higher than fifty seconds
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getAvgWebResourceRenderDurationOfLastFiveMinutes
```
long getAvgWebResourceRenderDurationOfLastFiveMinutes()
                                               throws Exception
```
    Health indicator of the average render time of the web resources, in the last five minutes.
    
    Returns:
    
    the average render time of the web resources.
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getNumberOfPortalCachesFull
```
int getNumberOfPortalCachesFull()
                         throws Exception
```
    Health indicator of the number of portal cache with full capacity.
    
    Returns:
    
    The count of full capacity portal cache.
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getProcessQueueTotalProcess
```
int getProcessQueueTotalProcess()
                         throws Exception
```
    Health indicator of the process queue statistics, this is for retrieve the total number of items in queue.
    
    Returns:
    
    The total of items in queue;
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getProcessQueueRunningItems
```
int getProcessQueueRunningItems()
                         throws Exception
```
    Health indicator of the process queue statistics, this is for retrieve the number of running items in queue.
    
    Returns:
    
    The number of running items in queue;
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getProcessQueueScheduleItems
```
int getProcessQueueScheduleItems()
                          throws Exception
```
    Health indicator of the process queue statistics, this is for retrieve the number of schedule items in queue.
    
    Returns:
    
    The number of schedule items in queue;
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getProcessQueueQueuedItems
```
int getProcessQueueQueuedItems()
                        throws Exception
```
    Health indicator of the process queue statistics, this is for retrieve the number of waiting items in queue.
    
    Returns:
    
    The number of waiting items in queue;
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getProcessQueueFailedItems
```
int getProcessQueueFailedItems()
                        throws Exception
```
    Health indicator of the process queue statistics, this is for retrieve the number of failed items in queue.
    
    Returns:
    
    The number of failed items in queue;
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getBigDataRepositoryErrorLevel
```
int getBigDataRepositoryErrorLevel()
                            throws Exception
```
    Health indicator of the big data cluster status.
    
    Returns:
    
    the error level of the repository: 0 if green, 1 if yellow, 2 if red and will return -1 if was unable to evaluate the repository status;
    
    Throws:
    
    Exception
    
    Since:
    
    11.2.0
  - getLoadAveragePerProc
```
double getLoadAveragePerProc()
                      throws Exception
```
    Returns the System Load Average per Available Core Processors.
    
    Returns:
    
    the System Load Average per Available Core Processors.
    
    Throws:
    
    Exception
    
    Since:
    
    12.4.0
  - getNumberOfRegisteredUsers
```
long getNumberOfRegisteredUsers()
                         throws Exception
```
    Returns the number o registered users.
    
    Returns:
    
    the number o registered users.
    
    Throws:
    
    Exception
    
    Since:
    
    12.4.0
  - getNumberOfMonitoredUsers
```
long getNumberOfMonitoredUsers()
                        throws Exception
```
    Returns the number o monitored users.
    
    Returns:
    
    the number o monitored users.
    
    Throws:
    
    Exception
    
    Since:
    
    12.4.0
  - getNumberOfStandardGroupMembers
```
long getNumberOfStandardGroupMembers()
                              throws Exception
```
    Returns the number of standard group members.
    
    Returns:
    
    the number of standard group members.
    
    Throws:
    
    Exception
    
    Since:
    
    12.4.0
  - getNumberOfWebResources
```
long getNumberOfWebResources()
                      throws Exception
```
    Returns the number of web resources.
    
    Returns:
    
    the number of web resources.
    
    Throws:
    
    Exception
    
    Since:
    
    12.4.0
  - getNumberOfCachedPagesExpiredSince5m
```
long getNumberOfCachedPagesExpiredSince5m()
                                   throws Exception
```
    Returns the number of cached pages expired under five minutes ago.
    
    Returns:
    
    the number of cached pages expired under five minutes ago.
    
    Throws:
    
    Exception
    
    Since:
    
    12.4.0

Interface HealthMBean

Method Summary

Method Detail

getDatabaseLatency

getNumberOfCachedPagesWithError

getNumberOfClocksExecutingMoreThanTwoMinutes

getNumberOfLocks15SecondsOld

getAvgWebResourceRenderDurationOfLastFiveMinutes

getNumberOfPortalCachesFull

getProcessQueueTotalProcess

getProcessQueueRunningItems

getProcessQueueScheduleItems

getProcessQueueQueuedItems

getProcessQueueFailedItems

getBigDataRepositoryErrorLevel

getLoadAveragePerProc

getNumberOfRegisteredUsers

getNumberOfMonitoredUsers

getNumberOfStandardGroupMembers

getNumberOfWebResources

getNumberOfCachedPagesExpiredSince5m