weblogic.management.runtime
Interface WLDFHarvesterRuntimeMBean

All Superinterfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface WLDFHarvesterRuntimeMBean
extends RuntimeMBean

Provides aggregated information about all active Harvester configurations, as well as metadata about harvestable and harvested attributes, types, and instances. Harvestable means potentially available for harvesting; harvested means explicitly designated for harvesting. These terms apply to types, instances, and the attributes within those types. In addition, the interface provides access to sampling and snapshot statistics. All statistics are base on data collected during the current server session.

getHarvestableAttributes

String[][] getHarvestableAttributes(String type)
                                    throws HarvesterException.HarvestableTypesNotFoundException,
                                           HarvesterException.AmbiguousTypeName,
                                           HarvesterException.TypeNotHarvestable

Deprecated. 

The set of attributes that are eligible for harvesting for the specified type. The specified type does not need to be currently configured for harvesting. For MBeans other than WebLogic Server MBeans, returns null until at least one instance has been created.

The returned array represents a list of pairs. The first element in each pair is the attribute name and the second element is the class name of the attribute's type.

Parameters:

type - the name of the type to get the attributes for

Returns:

the set of attributes that are eligible for harvesting for the specified type

Throws:

HarvesterException.HarvestableTypesNotFoundException - if the type name is valid but could not be located

HarvesterException.AmbiguousTypeName - if the type name requires qualification to resolve

HarvesterException.TypeNotHarvestableException - if the type could never be harvested

HarvesterException.TypeNotHarvestable

getHarvestableAttributesForInstance

String[][] getHarvestableAttributesForInstance(String instancePattern)
                                               throws HarvesterException.HarvestableTypesNotFoundException,
                                                      HarvesterException.AmbiguousTypeName,
                                                      HarvesterException.TypeNotHarvestable

Deprecated. 

The set of attributes that are eligible for harvesting for the specified instance name. The type of the specified instance does not need to be currently configured for harvesting. For MBeans other than WebLogic Server MBeans, returns null until at least one instance has been created.

Note that in the case where an ObjectName pattern is specified for a WebLogic Server MBean, the ObjectName's property list must contain the "Type" property (e.g., "com.bea:Type=ServerRuntime,*"). Otherwise, as is the case for any non-WebLogic Server MBean, an instance must exist in order for the set of harvestable attributes to be known.

The returned array represents a list of pairs. The first element in each pair is the attribute name and the second element is the class name of the attribute's type.

Parameters:

instancePattern - the ObjectName or ObjectName pattern of the type to get the attributes for

Returns:

the set of attributes that are eligible for harvesting for the specified type

Throws:

HarvesterException.HarvestableTypesNotFoundException - if the type name is valid but could not be located

HarvesterException.AmbiguousTypeName - if the type name requires qualification to resolve

HarvesterException.TypeNotHarvestableException - if the type could never be harvested

HarvesterException.TypeNotHarvestable

getCurrentlyHarvestedAttributes

String[] getCurrentlyHarvestedAttributes(String type)
                                         throws HarvesterException.MissingConfigurationType,
                                                HarvesterException.HarvestingNotEnabled,
                                                HarvesterException.AmbiguousTypeName

Deprecated. 

The set of attributes that are currently being harvested for the specified type. The specified type must be explicitly configured for harvesting.

The returned set of attributes usually matches the corresponding set of attributes configured for harvesting; but if an error occurs when harvesting an attribute, that attribute will be omitted from the returned set.

Parameters:

type - the name of the type to get the attributes for

Returns:

the set of attributes currently being harvested for the provided type

Throws:

HarvesterException.MissingConfigurationType - if the provided type is not configured for harvesting

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

HarvesterException.HarvesterException.AmbiguousTypeName - if the type name requires qualification to resolve

HarvesterException.AmbiguousTypeName

getKnownHarvestableTypes

String[] getKnownHarvestableTypes()

The set of all known types, regardless of whether the types are currently configured for harvesting. The set includes the WebLogic Server MBeans, which are always present, plus any other types that can be discovered. MBeans that are not WebLogic Server MBeans will require instances to exist in order to discover the type.

Returns:

the set of known types

getKnownHarvestableInstances

String[] getKnownHarvestableInstances(String type)
                                      throws HarvesterException.HarvestableTypesNotFoundException,
                                             HarvesterException.AmbiguousTypeName,
                                             HarvesterException.TypeNotHarvestable

Deprecated. 

The set of instances that are eligible for harvesting for the specified type at the time of the call. The type does not need to be currently configured for harvesting.

The caller should be aware that instances come and go. This method returns only those instances that exist at the time of the call.

Note

For MBeans that are not WebLogic Server MBeans, returns null until at least one instance has been created.

Parameters:

type - the name of the type to get the attributes for

Returns:

the set of instances that are eligible for harvesting for the provided type at the time of the call

Throws:

HarvesterException.HarvestableTypesNotFoundException - if the type name is valid but could not be located

HarvesterException.AmbiguousTypeName - if the type name requires qualification to resolve

HarvesterException.TypeNotHarvestableException - if the type could never be harvested

HarvesterException.TypeNotHarvestable

getCurrentlyHarvestedInstances

String[] getCurrentlyHarvestedInstances(String type)
                                        throws HarvesterException.MissingConfigurationType,
                                               HarvesterException.HarvestingNotEnabled,
                                               HarvesterException.AmbiguousTypeName

Deprecated. 

The set of instances that are currently being harvested for the specified type. The type must be configured for harvesting.

The returned set of instances usually matches the corresponding set of instances configured for harvesting; but if an error occurs when harvesting an instance, that instance will be omitted from the returned set.

Parameters:

type - the name of the type to get the instances for

Returns:

the set of instances currently being harvested for the provided type

Throws:

HarvesterException.MissingConfigurationType - if the provided type is not configured for harvesting

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

HarvesterException.AmbiguousTypeName - if the type name requires qualification to resolve

getHarvestableType

String getHarvestableType(String instanceName)
                          throws HarvesterException.HarvestableInstancesNotFoundException,
                                 HarvesterException.AmbiguousInstanceName

Deprecated. 

The type associated with a particular harvestable instance.

Parameters:

instanceName - the name of the instance to get the type for

Returns:

the name of the associated type, or null if the instance does not exist

Throws:

HarvesterException.HarvestableInstancesNotFoundException - if the provided instance does not currently exist

HarvesterException.AmbiguousInstanceName - if the instance name requires qualification to resolve

getSamplePeriod

long getSamplePeriod()
                     throws HarvesterException.HarvestingNotEnabled

Deprecated. 

The current global sample period, in nanoseconds.

Returns:

the current global sample period in milliseconds

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getTotalSamplingCycles

long getTotalSamplingCycles()

The total number of sampling cycles taken thus far.

Returns:

the number of sampling cycles taken

getMinimumSamplingTime

long getMinimumSamplingTime()

The minimum sampling time, in nanoseconds.

Returns:

the minimum sampling time in nanoseconds

getMaximumSamplingTime

long getMaximumSamplingTime()

The maximum sampling time, in nanoseconds.

Returns:

the maximum sampling time in nanoseconds

getTotalSamplingTime

long getTotalSamplingTime()

The total amount of time, in nanoseconds, spent in sampling cycles.

Returns:

the total amount of time spent (in nanoseconds) in all sampling cycles

getAverageSamplingTime

long getAverageSamplingTime()

The average amount of time, in nanoseconds, spent in sampling cycles.

Returns:

the average amount of time spent (in nanoseconds) in sampling cycles

getTotalDataSampleCount

long getTotalDataSampleCount()
                             throws HarvesterException.HarvestingNotEnabled

Deprecated. 

The number of configured data samples that have been collected so far in this server session.

Returns:

the number of configured data samples collected in this server session

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getAttributeInfoForAllTypes

Map<String,MBeanAttributeInfo[]> getAttributeInfoForAllTypes()

This method returns all Harvester types and their MBeanAttributeInfos.

Returns:

Map of Harvestable type as key and MBeanAttributeInfo array as value

getInstancesForAllTypes

Map<String,ObjectName[]> getInstancesForAllTypes()

This method returns all Harvester types and their instances

Returns:

Map of Harvestable type as key and ObjectName array as instance values

getCurrentDataSampleCount

long getCurrentDataSampleCount()
                               throws HarvesterException.HarvestingNotEnabled

Deprecated. 

The number of collected data samples in the current snapshot.

Returns:

the number of data samples collected in the current snapshot

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getCurrentSnapshotStartTime

long getCurrentSnapshotStartTime()
                                 throws HarvesterException.HarvestingNotEnabled

Deprecated. 

The start time, in nanoseconds, of a snapshot.

Returns:

the start time in nanoseconds

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getCurrentSnapshotElapsedTime

long getCurrentSnapshotElapsedTime()
                                   throws HarvesterException.HarvestingNotEnabled

Deprecated. 

The elapsed time, in nanoseconds, of a snapshot.

Returns:

the elapsed time (in nanoseconds) of the most recent snapshot

Throws:

HarvesterException.HarvestingNotEnabled - if the Harvester is not deployed

getTotalSamplingTimeOutlierCount

long getTotalSamplingTimeOutlierCount()

Deprecated. 

The number of times within this server session that the sampling time differed significantly enough from the average to be considered a statistical outlier. The Harvester removes these values form the ongoing averages.

Returns:

the count of statistical outliers since the start of the session

isCurrentSampleTimeAnOutlier

boolean isCurrentSampleTimeAnOutlier()

Deprecated. 

Whether or not the sampling time for the most recent data sample differed significantly enough from the average to be considered a statistical outlier.

Returns:

Whether the most recent sampling time was an outlier

getOutlierDetectionFactor

float getOutlierDetectionFactor()

Deprecated. 

The multiplicative factor used to determine a statistical outlier. If the actual sampling time exceeds this the session average multiplied by the outlier detection factor, then the sampling time is considered to be a statistical outlier.

Returns:

the multiplicative factor used to identify outliers