com.sonicsw.mf.mgmtapi.runtime
Interface ICollectionsMonitorProxy

public interface ICollectionsMonitorProxy

Remote interface to a runtime instance of a CollectionsMonitor.

Management attributes and operations are documented in this interface.

An implementation of this interface can be created using the MFProxyFactory class. Each implementation instance is valid for the life of the provided JMS/JMX Connector and MBean ObjectName. The implementation is built using remote JMX MBeanServer calls.

For each JMX MBean attribute, this interface provides an associated get method (for readable attributes) and/or a set method (for writable attributes).

For each JMX MBean operation, this interface provides an associated method with a signature as described by the MBean's operation meta-data. Each JMX MBean operation has an associated impact:

• ACTION - Indicates that the operation is a write-like, and would modify the MBean in some way, typically by writing some value or changing a configuration.
• INFO - Indicates that the operation is read-like, it basically returns information.
• ACTION/INFO - Indicates that the operation is both read-like and write-like.
• UNKNOWN - Indicates that the operation has an "unknown" nature.

All exceptions emitted by implementations are wrapped as a ProxyRuntimeException.

See Also:

CollectionsMonitor Notifications, CollectionsMonitor Metrics

Field Summary

static java.lang.String	APPLICATION_ALERT_STORAGE_METRICS_STOREDPERMINUTE_NOTIFICATION_ID Notification type constant for the notification application.alert.storage.metrics.StoredPerMinute.
static java.lang.String	APPLICATION_ALERT_STORAGE_NOTIFICATIONS_STOREDPERMINUTE_NOTIFICATION_ID Notification type constant for the notification application.alert.storage.notifications.StoredPerMinute.
static IMetricIdentity	STORAGE_METRICS_STOREDPERMINUTE_METRIC_ID Metric identity constant for the metric storage.metrics.StoredPerMinute.
static IMetricIdentity	STORAGE_NOTIFICATIONS_STOREDPERMINUTE_METRIC_ID Metric identity constant for the metric storage.notifications.StoredPerMinute.
static java.lang.String	SYSTEM_MONITOR_THRESHOLD_NOTIFICATION_ID Notification type constant for the notification system.monitor.Threshold.
static java.lang.String	SYSTEM_STATE_OFFLINE_NOTIFICATION_ID Notification type constant for the notification system.state.Offline.
static java.lang.String	SYSTEM_STATE_ONLINE_NOTIFICATION_ID Notification type constant for the notification system.state.Online.

Method Summary

void	addNotificationListener(NotificationListener listener, NotificationFilter filter, java.lang.Object handback) Adds a notification listener.
void	clearError() Invokes the clearError operation.
void	clearHistory() Invokes the clearHistory operation.
void	disableAlerts(IAlert[] alerts) Invokes the disableAlerts operation.
void	disableMetrics(IMetricIdentity[] ids) Invokes the disableMetrics operation.
void	enableAlerts(IAlert[] alerts) Invokes the enableAlerts operation.
void	enableMetrics(IMetricIdentity[] ids) Invokes the enableMetrics operation.
IMetricIdentity[]	getActiveMetrics(IMetricIdentity[] ids) Invokes the getActiveMetrics operation.
IAggregateMetricsData	getAggregateMetricsData(java.lang.String collectionID, IMetricIdentity[] metricIDs, java.lang.Long latestCurrency, java.lang.Long lookbackPeriod) Invokes the getAggregateMetricsData operation.
AttributeList	getAttributes(java.lang.String[] attributeNames) Gets the values of several attributes of a CollectionsMonitor component.
java.lang.String	getClassname() Gets the value of the Classname attribute.
java.lang.String	getClasspath() Gets the value of the Classpath attribute.
java.lang.String	getConfigID() Gets the value of the ConfigID attribute.
IAlert[]	getEnabledAlerts(IMetricIdentity[] ids) Invokes the getEnabledAlerts operation.
IMetricIdentity[]	getEnabledMetrics(IMetricIdentity[] ids) Invokes the getEnabledMetrics operation.
MBeanNotificationInfo[]	getForwardedNotificationsInfo(java.lang.String collectionID) Invokes the getForwardedNotificationsInfo operation.
java.lang.Integer	getHistoryDurationHours() Gets the value of the HistoryDurationHours attribute.
java.lang.String[]	getInstanceMetricNames(java.lang.String collectionID, IMetricIdentity id) Invokes the getInstanceMetricNames operation.
java.lang.String	getLastError() Gets the value of the LastError attribute.
java.lang.Integer	getLastErrorLevel() Gets the value of the LastErrorLevel attribute.
java.lang.String	getLastErrorLevelString() Gets the value of the LastErrorLevelString attribute.
IMetricsData	getMetricHistory(java.lang.String collectionID, IMetricIdentity[] metricIDs, java.lang.Long latest, java.lang.Long earliest) Invokes the getMetricHistory operation.
java.lang.Integer	getMetricsCollectionInterval() Gets the value of the MetricsCollectionInterval attribute.
IMetricsData	getMetricsData(IMetricIdentity[] ids, java.lang.Boolean returnTriggeredAlerts) Invokes the getMetricsData operation.
IMetricInfo[]	getMetricsInfo() Invokes the getMetricsInfo operation.
java.lang.Integer	getMetricsRefreshInterval() Gets the value of the MetricsRefreshInterval attribute.
java.lang.String[]	getMonitoredCollections() Invokes the getMonitoredCollections operation.
IMetricInfo[]	getMonitoredMetricsInfo(java.lang.String collectionID) Invokes the getMonitoredMetricsInfo operation.
INotification[]	getNotificationHistory(java.lang.String collectionID, java.lang.String[] notificationTypes, java.lang.Long latest, java.lang.Long earliest) Invokes the getNotificationHistory operation.
java.lang.String	getReleaseVersion() Gets the value of the ReleaseVersion attribute.
java.lang.Boolean	getRepeatMetricAlerts() Gets the value of the RepeatMetricAlerts attribute.
java.lang.Boolean	getSaveMonitoredNotifications() Gets the value of the SaveMonitoredNotifications attribute.
java.lang.Boolean	getSaveThresholdNotifications() Gets the value of the SaveThresholdNotifications attribute.
java.lang.Short	getState() Gets the value of the State attribute.
java.lang.String	getStateString() Gets the value of the StateString attribute.
IMonitoredMetrics	getStoredMetrics(java.lang.String[] collectionIDs, java.lang.Long lastReceivedTimestamp, java.lang.Long lookbackPeriod) Invokes the getStoredMetrics operation.
IMonitoredNotifications	getStoredNotifications(java.lang.String[] collectionIDs, java.lang.Long lastReceivedTimestamp, java.lang.Long lookbackPeriod) Invokes the getStoredNotifications operation.
INotification[]	getThresholdNotificationHistory(java.lang.Long latest, java.lang.Long earliest) Invokes the getThresholdNotificationHistory operation.
java.lang.Integer	getTraceMask() Gets the value of the TraceMask attribute.
java.lang.String	getTraceMaskValues() Gets the value of the TraceMaskValues attribute.
java.lang.Long	getUptime() Gets the value of the Uptime attribute.
void	reload() Invokes the reload operation.
void	removeNotificationListener(NotificationListener listener) Removes a notification listener.
void	resetMetrics() Invokes the resetMetrics operation.
AttributeList	setAttributes(AttributeList attributes) Sets the values of several attributes of a CollectionsMonitor component.
void	setHistoryDurationHours(java.lang.Integer value) Sets the value of the HistoryDurationHours attribute.
void	setMetricsCollectionInterval(java.lang.Integer value) Sets the value of the MetricsCollectionInterval attribute.
void	setMetricsRefreshInterval(java.lang.Integer value) Sets the value of the MetricsRefreshInterval attribute.
void	setRepeatMetricAlerts(java.lang.Boolean value) Sets the value of the RepeatMetricAlerts attribute.
void	setSaveMonitoredNotifications(java.lang.Boolean value) Sets the value of the SaveMonitoredNotifications attribute.
void	setSaveThresholdNotifications(java.lang.Boolean value) Sets the value of the SaveThresholdNotifications attribute.
void	setTraceMask(java.lang.Integer value) Sets the value of the TraceMask attribute.
void	start() Invokes the start operation.
void	stop() Invokes the stop operation.

Field Detail

APPLICATION_ALERT_STORAGE_METRICS_STOREDPERMINUTE_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_STORAGE_METRICS_STOREDPERMINUTE_NOTIFICATION_ID

Notification type constant for the notification application.alert.storage.metrics.StoredPerMinute.

Description: Alert for metric storage.metrics.StoredPerMinute

See Also:

application.alert.storage.metrics.StoredPerMinute

See Also:

Constant Field Values

APPLICATION_ALERT_STORAGE_NOTIFICATIONS_STOREDPERMINUTE_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_STORAGE_NOTIFICATIONS_STOREDPERMINUTE_NOTIFICATION_ID

Notification type constant for the notification application.alert.storage.notifications.StoredPerMinute.

Description: Alert for metric storage.notifications.StoredPerMinute

See Also:

application.alert.storage.notifications.StoredPerMinute

See Also:

Constant Field Values

STORAGE_METRICS_STOREDPERMINUTE_METRIC_ID

static final IMetricIdentity STORAGE_METRICS_STOREDPERMINUTE_METRIC_ID

Metric identity constant for the metric storage.metrics.StoredPerMinute.

Description: Number of monitored metric values stored per minute.

See Also:

storage.metrics.StoredPerMinute

STORAGE_NOTIFICATIONS_STOREDPERMINUTE_METRIC_ID

static final IMetricIdentity STORAGE_NOTIFICATIONS_STOREDPERMINUTE_METRIC_ID

Metric identity constant for the metric storage.notifications.StoredPerMinute.

Description: Number of monitored notifications stored per minute.

See Also:

storage.notifications.StoredPerMinute

SYSTEM_MONITOR_THRESHOLD_NOTIFICATION_ID

static final java.lang.String SYSTEM_MONITOR_THRESHOLD_NOTIFICATION_ID

Notification type constant for the notification system.monitor.Threshold.

Description: Sent when a notification monitoring threshold has been broken.

See Also:

system.monitor.Threshold

See Also:

Constant Field Values

SYSTEM_STATE_OFFLINE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_OFFLINE_NOTIFICATION_ID

Notification type constant for the notification system.state.Offline.

Description: Component stop complete.

See Also:

system.state.Offline

See Also:

Constant Field Values

SYSTEM_STATE_ONLINE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_ONLINE_NOTIFICATION_ID

Notification type constant for the notification system.state.Online.

Description: Component start complete.

See Also:

system.state.Online

See Also:

Constant Field Values

Method Detail

addNotificationListener

void addNotificationListener(NotificationListener listener,
                             NotificationFilter filter,
                             java.lang.Object handback)

Adds a notification listener.

A CollectionsMonitor component publishes the following notifications:

• application.alert.storage.metrics.StoredPerMinute
• application.alert.storage.notifications.StoredPerMinute
• system.monitor.Threshold
• system.state.Offline
• system.state.Online

Parameters:

listener - The listener object which will handle the notifications emitted component.

filter - The filter object. If filter is null, no filtering will be performed before handling notifications.

handback - The context to be sent to the listener when a notification is emitted.

See Also:

removeNotificationListener(javax.management.NotificationListener)

clearError

void clearError()

Invokes the clearError operation.

Clear existing error condition.

Impact: ACTION

See Also:

getLastErrorLevel()

clearHistory

void clearHistory()

Invokes the clearHistory operation.

Clears all notification/metric history maintained by this monitor.

Impact: ACTION

disableAlerts

void disableAlerts(IAlert[] alerts)

Invokes the disableAlerts operation.

Disable threshold alerts on a metric.

Impact: ACTION

Metrics that allow alert thresholds to be specified are:

• storage.metrics.StoredPerMinute
• storage.notifications.StoredPerMinute

Parameters:

alerts - A list of alerts to disable.

See Also:

enableAlerts(com.sonicsw.mf.common.metrics.IAlert[]), getEnabledAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity[])

disableMetrics

void disableMetrics(IMetricIdentity[] ids)

Invokes the disableMetrics operation.

Disable the given set of dynamic metrics.

Impact: ACTION

Dynamic metrics are:

• storage.metrics.StoredPerMinute
• storage.notifications.StoredPerMinute

Parameters:

ids - A list of metrics identity patterns.

See Also:

enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getAggregateMetricsData(java.lang.String, com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Long, java.lang.Long), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), getMonitoredMetricsInfo(java.lang.String), getStoredMetrics(java.lang.String[], java.lang.Long, java.lang.Long), resetMetrics()

enableAlerts

void enableAlerts(IAlert[] alerts)

Invokes the enableAlerts operation.

Enable threshold alerts on a metric.

Impact: ACTION

Metrics that allow alert thresholds to be specified are:

• storage.metrics.StoredPerMinute
• storage.notifications.StoredPerMinute

Parameters:

alerts - A list of alerts to enable.

See Also:

disableAlerts(com.sonicsw.mf.common.metrics.IAlert[]), getEnabledAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity[])

enableMetrics

void enableMetrics(IMetricIdentity[] ids)

Invokes the enableMetrics operation.

Enable the given set of dynamic metrics.

Impact: ACTION

Dynamic metrics are:

• storage.metrics.StoredPerMinute
• storage.notifications.StoredPerMinute

Parameters:

ids - A list of metrics identity patterns.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getAggregateMetricsData(java.lang.String, com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Long, java.lang.Long), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), getMonitoredMetricsInfo(java.lang.String), getStoredMetrics(java.lang.String[], java.lang.Long, java.lang.Long), resetMetrics()

getActiveMetrics

IMetricIdentity[] getActiveMetrics(IMetricIdentity[] ids)

Invokes the getActiveMetrics operation.

Gets the the list of metrics currently active in this component.

Impact: INFO

Parameters:

ids - A list of metrics identity patterns.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getAggregateMetricsData(java.lang.String, com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Long, java.lang.Long), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), getMonitoredMetricsInfo(java.lang.String), getStoredMetrics(java.lang.String[], java.lang.Long, java.lang.Long), resetMetrics()

getAggregateMetricsData

IAggregateMetricsData getAggregateMetricsData(java.lang.String collectionID,
                                              IMetricIdentity[] metricIDs,
                                              java.lang.Long latestCurrency,
                                              java.lang.Long lookbackPeriod)

Invokes the getAggregateMetricsData operation.

Gets aggregated metrics for a collection, based from recorded metrics of the given time window.

Impact: INFO

Parameters:

collectionID - The configuration ID to the monitored collection.

metricIDs - The metric identities for which aggregate data is sought.

latestCurrency - The time of the latest metric value to be used to compute the aggregate data..

lookbackPeriod - The period to lookback for metric values.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), getMonitoredMetricsInfo(java.lang.String), getStoredMetrics(java.lang.String[], java.lang.Long, java.lang.Long), resetMetrics()

getAttributes

AttributeList getAttributes(java.lang.String[] attributeNames)

Gets the values of several attributes of a CollectionsMonitor component.

Getting multiple attribute values at once is typically more efficient than getting individual attribute values.

Readable attributes (and their datatypes) exposed by a CollectionsMonitor are:

• Classname (java.lang.String)
• Classpath (java.lang.String)
• ConfigID (java.lang.String)
• HistoryDurationHours (java.lang.Integer)
• LastError (java.lang.String)
• LastErrorLevel (java.lang.Integer)
• LastErrorLevelString (java.lang.String)
• MetricsCollectionInterval (java.lang.Integer)
• MetricsRefreshInterval (java.lang.Integer)
• ReleaseVersion (java.lang.String)
• RepeatMetricAlerts (java.lang.Boolean)
• SaveMonitoredNotifications (java.lang.Boolean)
• SaveThresholdNotifications (java.lang.Boolean)
• State (java.lang.Short)
• StateString (java.lang.String)
• TraceMask (java.lang.Integer)
• TraceMaskValues (java.lang.String)
• Uptime (java.lang.Long)

Parameters:

attributeNames - A list of the attribute names of attributes to be retrieved.

Returns:

The list of the retrieved attributes.

See Also:

setAttributes(javax.management.AttributeList)

getClassname

java.lang.String getClassname()

Gets the value of the Classname attribute.

Returns:

Component classname.

getClasspath

java.lang.String getClasspath()

Gets the value of the Classpath attribute.

Returns:

Component classpath.

getConfigID

java.lang.String getConfigID()

Gets the value of the ConfigID attribute.

Returns:

Configuration identity.

getEnabledAlerts

IAlert[] getEnabledAlerts(IMetricIdentity[] ids)

Invokes the getEnabledAlerts operation.

Get all metric threshold alerts enabled by this component.

Impact: INFO

Parameters:

ids - A list of metrics identities for which to get the enabled alerts.

See Also:

disableAlerts(com.sonicsw.mf.common.metrics.IAlert[]), enableAlerts(com.sonicsw.mf.common.metrics.IAlert[])

getEnabledMetrics

IMetricIdentity[] getEnabledMetrics(IMetricIdentity[] ids)

Invokes the getEnabledMetrics operation.

Get the list of metric patterns that have been enabled for this component.

Impact: INFO

Parameters:

ids - A list of metrics identities for which to get the enabled alerts.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getAggregateMetricsData(java.lang.String, com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Long, java.lang.Long), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), getMonitoredMetricsInfo(java.lang.String), getStoredMetrics(java.lang.String[], java.lang.Long, java.lang.Long), resetMetrics()

getForwardedNotificationsInfo

MBeanNotificationInfo[] getForwardedNotificationsInfo(java.lang.String collectionID)

Invokes the getForwardedNotificationsInfo operation.

Gets the meta-data for the notifications being forwarded by this monitor.

Impact: INFO

Parameters:

collectionID - The configuration ID to the monitored collection.

getHistoryDurationHours

java.lang.Integer getHistoryDurationHours()

Gets the value of the HistoryDurationHours attribute.

Returns:

Duration (hours) for which historical monitoring data will be held.

See Also:

setHistoryDurationHours(java.lang.Integer)

getInstanceMetricNames

java.lang.String[] getInstanceMetricNames(java.lang.String collectionID,
                                          IMetricIdentity id)

Invokes the getInstanceMetricNames operation.

Gets the instance metric names for a monitored metric of a specified collection.

Impact: INFO

Parameters:

collectionID - The configuration ID to the monitored collection.

id - The metric identity for which instance names are sought.

getLastError

java.lang.String getLastError()

Gets the value of the LastError attribute.

Returns:

Last (uncleared) error condition.

getLastErrorLevel

java.lang.Integer getLastErrorLevel()

Gets the value of the LastErrorLevel attribute.

Returns:

Last (uncleared) error severity.

getLastErrorLevelString

java.lang.String getLastErrorLevelString()

Gets the value of the LastErrorLevelString attribute.

Returns:

Last (uncleared) error severity description.

getMetricHistory

IMetricsData getMetricHistory(java.lang.String collectionID,
                              IMetricIdentity[] metricIDs,
                              java.lang.Long latest,
                              java.lang.Long earliest)

Invokes the getMetricHistory operation.

Gets recorded metrics for the given collection and metrics, between the given dates. Metrics are returned in date order with most recent first.

Impact: INFO

Parameters:

collectionID - The configuration ID to the monitored collection.

metricIDs - The metric identities of interest.

latest - The time of the latest monitored metric value to be returned.

earliest - The time of the earliest monitored metric value to be returned.

getMetricsCollectionInterval

java.lang.Integer getMetricsCollectionInterval()

Gets the value of the MetricsCollectionInterval attribute.

Returns:

Metrics collection interval (in minutes)

See Also:

setMetricsCollectionInterval(java.lang.Integer)

getMetricsData

IMetricsData getMetricsData(IMetricIdentity[] ids,
                            java.lang.Boolean returnTriggeredAlerts)

Invokes the getMetricsData operation.

Gets metric values for a given set of metrics. If a requested metric was not enabled or is otherwise unknown, then no data for that metric will be included in the results.

Impact: INFO

Parameters:

ids - A list of active metrics, either individual metrics or instances.

returnTriggeredAlerts - If true, each metric returned should include a list of triggered (exceeded) alerts for these metrics.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getAggregateMetricsData(java.lang.String, com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Long, java.lang.Long), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsInfo(), getMonitoredMetricsInfo(java.lang.String), getStoredMetrics(java.lang.String[], java.lang.Long, java.lang.Long), resetMetrics()

getMetricsInfo

IMetricInfo[] getMetricsInfo()

Invokes the getMetricsInfo operation.

Gets the meta-data for all metrics supported by this component.

Impact: INFO

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getAggregateMetricsData(java.lang.String, com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Long, java.lang.Long), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMonitoredMetricsInfo(java.lang.String), getStoredMetrics(java.lang.String[], java.lang.Long, java.lang.Long), resetMetrics()

getMetricsRefreshInterval

java.lang.Integer getMetricsRefreshInterval()

Gets the value of the MetricsRefreshInterval attribute.

Returns:

Metrics refresh interval (in seconds)

See Also:

setMetricsRefreshInterval(java.lang.Integer)

getMonitoredCollections

java.lang.String[] getMonitoredCollections()

Invokes the getMonitoredCollections operation.

Gets the list of collections being monitored by this monitor.

Impact: INFO

getMonitoredMetricsInfo

IMetricInfo[] getMonitoredMetricsInfo(java.lang.String collectionID)

Invokes the getMonitoredMetricsInfo operation.

Gets the meta-data for the metrics being forwarded by this monitor.

Impact: INFO

Parameters:

collectionID - The configuration ID to the monitored collection.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getAggregateMetricsData(java.lang.String, com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Long, java.lang.Long), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), getStoredMetrics(java.lang.String[], java.lang.Long, java.lang.Long), resetMetrics()

getNotificationHistory

INotification[] getNotificationHistory(java.lang.String collectionID,
                                       java.lang.String[] notificationTypes,
                                       java.lang.Long latest,
                                       java.lang.Long earliest)

Invokes the getNotificationHistory operation.

Gets recorded notifications for the given collection and notification types, between the given dates. Notifications are returned in date order with most recent first.

Impact: INFO

Parameters:

collectionID - The configuration ID to the monitored collection.

notificationTypes - The (canonical) notification types of interest.

latest - The time of the latest monitored notification to be returned.

earliest - The time of the earliest monitored notification to be returned.

getReleaseVersion

java.lang.String getReleaseVersion()

Gets the value of the ReleaseVersion attribute.

Returns:

Component release version.

getRepeatMetricAlerts

java.lang.Boolean getRepeatMetricAlerts()

Gets the value of the RepeatMetricAlerts attribute.

Returns:

Repeat metric alert notifications

See Also:

setRepeatMetricAlerts(java.lang.Boolean)

getSaveMonitoredNotifications

java.lang.Boolean getSaveMonitoredNotifications()

Gets the value of the SaveMonitoredNotifications attribute.

Returns:

Flag indicating if a history of monitored notifications should be maintained.

See Also:

setSaveMonitoredNotifications(java.lang.Boolean)

getSaveThresholdNotifications

java.lang.Boolean getSaveThresholdNotifications()

Gets the value of the SaveThresholdNotifications attribute.

Returns:

Flag indicating if a history of threshold notifications should be maintained.

See Also:

setSaveThresholdNotifications(java.lang.Boolean)

getState

java.lang.Short getState()

Gets the value of the State attribute.

Returns:

Execution state of the component.

See Also:

getStateString(), IComponentState

getStateString

java.lang.String getStateString()

Gets the value of the StateString attribute.

Returns:

Description of the execution state of the component.

See Also:

getState(), IComponentState.STATE_TEXT

getStoredMetrics

IMonitoredMetrics getStoredMetrics(java.lang.String[] collectionIDs,
                                   java.lang.Long lastReceivedTimestamp,
                                   java.lang.Long lookbackPeriod)

Invokes the getStoredMetrics operation.

Returns an instance of IMonitoredMetrics containing copies of the stored metrics for the specified component collection(s), for the given time window, up to a total size of approximately 1Mb, and a flag to indicate if there are more metrics to be retrieved.

Impact: INFO

Parameters:

collectionIDs - The configuration ID(s) of the monitored collection(s).

lastReceivedTimestamp - The timestamp of the last retrieved metric, or the timr of the last retrieval attempt.

lookbackPeriod - The period to look back for metric values.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getAggregateMetricsData(java.lang.String, com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Long, java.lang.Long), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), getMonitoredMetricsInfo(java.lang.String), resetMetrics()

getStoredNotifications

IMonitoredNotifications getStoredNotifications(java.lang.String[] collectionIDs,
                                               java.lang.Long lastReceivedTimestamp,
                                               java.lang.Long lookbackPeriod)

Invokes the getStoredNotifications operation.

Returns an instance of IMonitoredNotifications containing copies of the stored notifications for a collection, for the given time window, up to a total size of approximately 1Mb, and a flag to indicate if there are more notifications to be retrieved.

Impact: INFO

Parameters:

collectionIDs - The configuration ID(s) of the monitored collection(s).

lastReceivedTimestamp - The timestamp of the last retrieved notification, or the time of the last retrieval attempt.

lookbackPeriod - The period to look back for notification values.

getThresholdNotificationHistory

INotification[] getThresholdNotificationHistory(java.lang.Long latest,
                                                java.lang.Long earliest)

Invokes the getThresholdNotificationHistory operation.

Gets recorded notifications for the given collection and notification types, between the given dates. Notifications are returned in date order with most recent first.

Impact: INFO

Parameters:

latest - The time of the latest threshold notification to be returned.

earliest - The time of the earliest threshold notification to be returned.

getTraceMask

java.lang.Integer getTraceMask()

Gets the value of the TraceMask attribute. The trace mask is a bit mask composed from the following possible values:

• 1 - verbose
• 2 - set attributes
• 4 - operation invoked
• 8 - notification sent
• 16 - received notifications
• 32 - forwarded notifications
• 64 - storage failure details
• 128 - metric poll timeouts
• 256 - metric enabling
• 512 - monitoring request failures
• 1024 - storage activity
• 2048 - metric polling

Returns:

Debug bit mask.

See Also:

setTraceMask(java.lang.Integer), getTraceMaskValues()

getTraceMaskValues

java.lang.String getTraceMaskValues()

Gets the value of the TraceMaskValues attribute.

Returns:

Possible TraceMask values.

See Also:

getTraceMask(), setTraceMask(java.lang.Integer)

getUptime

java.lang.Long getUptime()

Gets the value of the Uptime attribute.

Returns:

Execution time (milliseconds).

reload

void reload()

Invokes the reload operation.

Asynchronously reload the component and restart the component if it was previously online.

Impact: ACTION

removeNotificationListener

void removeNotificationListener(NotificationListener listener)

Removes a notification listener.

This method will remove all the information related to the given listener.

Parameters:

listener - The listener object which will handle the notifications emitted by the registered MBean.

See Also:

addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, Object)

resetMetrics

void resetMetrics()

Invokes the resetMetrics operation.

Reset all metrics to their initial state.

Impact: ACTION

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getAggregateMetricsData(java.lang.String, com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Long, java.lang.Long), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), getMonitoredMetricsInfo(java.lang.String), getStoredMetrics(java.lang.String[], java.lang.Long, java.lang.Long)

setAttributes

AttributeList setAttributes(AttributeList attributes)

Sets the values of several attributes of a CollectionsMonitor component.

Setting multiple attribute values at once is typically more efficient than setting individual attribute values.

Settable attributes (and their datatypes) exposed by a CollectionsMonitor are:

• HistoryDurationHours (java.lang.Integer)
• MetricsCollectionInterval (java.lang.Integer)
• MetricsRefreshInterval (java.lang.Integer)
• RepeatMetricAlerts (java.lang.Boolean)
• SaveMonitoredNotifications (java.lang.Boolean)
• SaveThresholdNotifications (java.lang.Boolean)
• TraceMask (java.lang.Integer)

Parameters:

attributes - A list of attributes: The identification of the attributes to be set and the values they are to be set to.

Returns:

The list of attributes that were set, with their new values.

See Also:

getAttributes(java.lang.String[])

setHistoryDurationHours

void setHistoryDurationHours(java.lang.Integer value)

Sets the value of the HistoryDurationHours attribute.

Parameters:

value - Duration (hours) for which historical monitoring data will be held.

See Also:

getHistoryDurationHours()

setMetricsCollectionInterval

void setMetricsCollectionInterval(java.lang.Integer value)

Sets the value of the MetricsCollectionInterval attribute.

Parameters:

value - Metrics collection interval (in minutes)

See Also:

getMetricsCollectionInterval()

setMetricsRefreshInterval

void setMetricsRefreshInterval(java.lang.Integer value)

Sets the value of the MetricsRefreshInterval attribute.

Parameters:

value - Metrics refresh interval (in seconds)

See Also:

getMetricsRefreshInterval()

setRepeatMetricAlerts

void setRepeatMetricAlerts(java.lang.Boolean value)

Sets the value of the RepeatMetricAlerts attribute.

Parameters:

value - Repeat metric alert notifications

See Also:

getRepeatMetricAlerts()

setSaveMonitoredNotifications

void setSaveMonitoredNotifications(java.lang.Boolean value)

Sets the value of the SaveMonitoredNotifications attribute.

Parameters:

value - Flag indicating if a history of monitored notifications should be maintained.

See Also:

getSaveMonitoredNotifications()

setSaveThresholdNotifications

void setSaveThresholdNotifications(java.lang.Boolean value)

Sets the value of the SaveThresholdNotifications attribute.

Parameters:

value - Flag indicating if a history of threshold notifications should be maintained.

See Also:

getSaveThresholdNotifications()

setTraceMask

void setTraceMask(java.lang.Integer value)

Sets the value of the TraceMask attribute. The trace mask is a bit mask composed from the following possible values:

• 1 - verbose
• 2 - set attributes
• 4 - operation invoked
• 8 - notification sent
• 16 - received notifications
• 32 - forwarded notifications
• 64 - storage failure details
• 128 - metric poll timeouts
• 256 - metric enabling
• 512 - monitoring request failures
• 1024 - storage activity
• 2048 - metric polling

Parameters:

value - Debug bit mask.

See Also:

getTraceMask(), getTraceMaskValues()

start

void start()

Invokes the start operation.

Start providing service.

Impact: ACTION

See Also:

stop()

stop

void stop()

Invokes the stop operation.

Stop providing service.

Impact: ACTION

See Also:

start()