AlertMonitorMXBean (org.openidentityplatform.commons.parent 2.2.3 Documentation)

All Known Implementing Classes:

AlertMonitor
```
@MXBean
public interface AlertMonitorMXBean
```
Management interface to the AlertMonitor which accumulates and logs abnormal events such as IOExceptions and measurements outside of expected thresholds.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLEANUP_CATEGORY`
`static String`	`EXTEND_VOLUME_CATEGORY`
`static String`	`FLUSH_STATISTICS_CATEGORY`
`static String`	`JOURNAL_CATEGORY`
`static String`	`MANY_JOURNAL_FILES`
`static String`	`MISSING_VOLUME_CATEGORY`
`static String`	`MXBEAN_NAME`
`static String`	`READ_PAGE_CATEGORY`
`static String`	`WRITE_PAGE_CATEGORY`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getAlertLevel()` Current maximum AlertLevel in this monitor as a String: one of NORMAL, WARN or ERROR
`String`	`getDetailedHistory(String category)` Return a detailed description, including first and recent occurrences of events within the History for the specified category.
`long`	`getErrorLogTimeInterval()`
`int`	`getHistoryLength()`
`String`	`getSummary()` Return a summary of this AlertMonitor's current state.
`long`	`getWarnLogTimeInterval()`
`void`	`poll(boolean force)` Called periodically to emit log messages
`void`	`reset()` Restore this alert monitor to its initial state at level `AlertMonitor.AlertLevel.NORMAL` with no history.
`void`	`setErrorLogTimeInterval(long errorLogTimeInterval)` Set the interval between successive notifications for this monitor when its `AlertMonitor.AlertLevel.ERROR`.
`void`	`setHistoryLength(int historyLength)` Set the number of events per category on which to keep a complete history.
`void`	`setWarnLogTimeInterval(long warnLogTimeInterval)` Set the interval between successive notifications for this monitor when its `AlertMonitor.AlertLevel.WARN`.

- Field Detail
  - MXBEAN_NAME
```
static final String MXBEAN_NAME
```
    See Also:
    
    Constant Field Values
  - MANY_JOURNAL_FILES
```
static final String MANY_JOURNAL_FILES
```
    See Also:
    
    Constant Field Values
  - JOURNAL_CATEGORY
```
static final String JOURNAL_CATEGORY
```
    See Also:
    
    Constant Field Values
  - WRITE_PAGE_CATEGORY
```
static final String WRITE_PAGE_CATEGORY
```
    See Also:
    
    Constant Field Values
  - READ_PAGE_CATEGORY
```
static final String READ_PAGE_CATEGORY
```
    See Also:
    
    Constant Field Values
  - EXTEND_VOLUME_CATEGORY
```
static final String EXTEND_VOLUME_CATEGORY
```
    See Also:
    
    Constant Field Values
  - FLUSH_STATISTICS_CATEGORY
```
static final String FLUSH_STATISTICS_CATEGORY
```
    See Also:
    
    Constant Field Values
  - CLEANUP_CATEGORY
```
static final String CLEANUP_CATEGORY
```
    See Also:
    
    Constant Field Values
  - MISSING_VOLUME_CATEGORY
```
static final String MISSING_VOLUME_CATEGORY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getAlertLevel
```
String getAlertLevel()
```
    Current maximum AlertLevel in this monitor as a String: one of NORMAL, WARN or ERROR
  - reset
```
void reset()
```
    Restore this alert monitor to its initial state at level AlertMonitor.AlertLevel.NORMAL with no history.
  - getWarnLogTimeInterval
```
long getWarnLogTimeInterval()
```
    Returns:
    
    the interval in milliseconds between successive notifications for this monitor when its level is AlertMonitor.AlertLevel.WARN.
  - setWarnLogTimeInterval
```
void setWarnLogTimeInterval(long warnLogTimeInterval)
```
    Set the interval between successive notifications for this monitor when its AlertMonitor.AlertLevel.WARN.
    
    Parameters:
    
    warnLogTimeInterval - the interval in milliseconds
  - getErrorLogTimeInterval
```
long getErrorLogTimeInterval()
```
    Returns:
    
    the interval in milliseconds between successive notifications for this monitor when its AlertMonitor.AlertLevel.ERROR.
  - setErrorLogTimeInterval
```
void setErrorLogTimeInterval(long errorLogTimeInterval)
```
    Set the interval between successive notifications for this monitor when its AlertMonitor.AlertLevel.ERROR.
    
    Parameters:
    
    errorLogTimeInterval - the interval in milliseconds
  - getHistoryLength
```
int getHistoryLength()
```
    Returns:
    
    The number of events per category for which to keep individual Events.
  - setHistoryLength
```
void setHistoryLength(int historyLength)
```
    Set the number of events per category on which to keep a complete history. Once the number of events exceeds this count, the events aggregated.
    
    Parameters:
    
    historyLength - the historyLength to set
  - getSummary
```
String getSummary()
```
    Return a summary of this AlertMonitor's current state.
    
    Returns:
    
    a summary report
  - getDetailedHistory
```
String getDetailedHistory(String category)
```
    Return a detailed description, including first and recent occurrences of events within the History for the specified category. If there is no history for the specified category, this method returns null .
    
    Parameters:
    
    category - the category name
    
    Returns:
    
    the detailed report
  - poll
```
void poll(boolean force)
```
    Called periodically to emit log messages
    
    Parameters:
    
    force - Whether to force notifications to be issued immediatel

Interface AlertMonitorMXBean

Field Summary

Method Summary

Field Detail

MXBEAN_NAME

MANY_JOURNAL_FILES

JOURNAL_CATEGORY

WRITE_PAGE_CATEGORY

READ_PAGE_CATEGORY

EXTEND_VOLUME_CATEGORY

FLUSH_STATISTICS_CATEGORY

CLEANUP_CATEGORY

MISSING_VOLUME_CATEGORY

Method Detail

getAlertLevel

reset

getWarnLogTimeInterval

setWarnLogTimeInterval

getErrorLogTimeInterval

setErrorLogTimeInterval

getHistoryLength

setHistoryLength

getSummary

getDetailedHistory

poll