weblogic.management.configuration
Interface WLDFServerDiagnosticMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface WLDFServerDiagnosticMBean
extends ConfigurationMBean

Use this interface to configure the WebLogic Diagnostic Framework (WLDF) components that are defined for each WebLogic Server instance.

FILE_STORE_ARCHIVE_TYPE

static final String FILE_STORE_ARCHIVE_TYPE

The file store type of archive.

See Also:

Constant Field Values

JDBC_ARCHIVE_TYPE

static final String JDBC_ARCHIVE_TYPE

The JDBC type of archive.

See Also:

Constant Field Values

DEFAULT_EVENTS_IMAGE_CAPTURE_INTERVAL

static final long DEFAULT_EVENTS_IMAGE_CAPTURE_INTERVAL

The default time interval, 60 seconds, used when capturing recent diagnostic image events.

See Also:

Constant Field Values

OFF_VOLUME

static final String OFF_VOLUME

See Also:

Constant Field Values

LOW_VOLUME

static final String LOW_VOLUME

See Also:

Constant Field Values

MEDIUM_VOLUME

static final String MEDIUM_VOLUME

See Also:

Constant Field Values

HIGH_VOLUME

static final String HIGH_VOLUME

See Also:

Constant Field Values

getImageDir

String getImageDir()

The default directory where the server stores captured diagnostic images.

If you specify a relative pathname, the root of that path is the server's root directory.

If the directory does not exist, it will be created when the WebLogic Diagnostic Framework is initialized on the server. Note that each image capture request can override this default directory location.

Returns:

the relative or absolute directory where the diagnostic images captured are stored

See Also:

WLDFImageRuntimeMBean

Changes take effect after you redeploy the module or restart the server.

setImageDir

void setImageDir(String dirPath)

Sets the value of the ImageDir attribute.

Parameters:

dirPath - The path where the images will be stored.

See Also:

WLDFServerDiagnosticMBean.getImageDir()

getImageTimeout

int getImageTimeout()

The default timeout period, in minutes, that the server uses to delay future diagnostic image-capture requests.

Returns:

the timeout in minutes

Changes take effect after you redeploy the module or restart the server.

Default Value:

1

Maximum Value:

1440

Minimum Value:

0

setImageTimeout

void setImageTimeout(int timeout)

Sets the value of the ImageTimeout attribute.

Parameters:

timeout - in minutes

See Also:

WLDFServerDiagnosticMBean.getImageTimeout()

getEventsImageCaptureInterval

long getEventsImageCaptureInterval()

The time span, in milliseconds, for which recently archived events will be captured in the diagnostic image. All events archived on or after ( System.currentTimeMillis() - interval ) will be captured.

Returns:

the length of the interval in milliseconds

setEventsImageCaptureInterval

void setEventsImageCaptureInterval(long interval)

Sets the value of the EventsImageCaptureInterval attribute.

Parameters:

interval - The length of the interval in milliseconds

See Also:

WLDFServerDiagnosticMBean.getEventsImageCaptureInterval()

Default Value:

WLDFServerDiagnosticMBean.DEFAULT_EVENTS_IMAGE_CAPTURE_INTERVAL

getDiagnosticStoreDir

String getDiagnosticStoreDir()

The directory in which the current server maintains its diagnostic store.

Returns:

Directory path for diagnostic store

See Also:

WLDFServerDiagnosticMBean.getDiagnosticDataArchiveType()

Default Value:

weblogic.management.configuration.WLDFServerDiagnosticMBean.DEFAULT_STORE_DIR

setDiagnosticStoreDir

void setDiagnosticStoreDir(String diagnosticStoreDir)

Sets the value of the DiagnosticStoreDir attribute.

Parameters:

diagnosticStoreDir - Directory path for diagnostic store

See Also:

WLDFServerDiagnosticMBean.getDiagnosticStoreDir()

isDiagnosticStoreFileLockingEnabled

boolean isDiagnosticStoreFileLockingEnabled()

Determines whether OS file locking is used.

When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.

Returns:

DiagnosticStoreFileLockingEnabled value

setDiagnosticStoreFileLockingEnabled

void setDiagnosticStoreFileLockingEnabled(boolean diagnosticStoreFileLockingEnabled)

See GenericFileStoreMBean.setFileLockingEnabled.

Parameters:

diagnosticStoreFileLockingEnabled - The new FileLockingEnabled value

Default Value:

true

getDiagnosticStoreMinWindowBufferSize

int getDiagnosticStoreMinWindowBufferSize()

The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per diagnostic store file. Applies only when a native wlfileio library is loaded. See Diagnostic Store Maximum Window Buffer Size.

Returns:

The DiagnosticStoreMinWindowBufferSize value

setDiagnosticStoreMinWindowBufferSize

void setDiagnosticStoreMinWindowBufferSize(int diagnosticStoreMinWindowBufferSize)

See GenericFileStoreMBean.setMinWindowBufferSize.

Throws:

InvalidAttributeValueException

Default Value:

-1

Maximum Value:

1073741824

Minimum Value:

-1

getDiagnosticStoreMaxWindowBufferSize

int getDiagnosticStoreMaxWindowBufferSize()

The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per diagnostic store file. Applies only when a native wlfileio library is loaded.

A window buffer does not consume Java heap memory, but does consume off-heap (native) memory. If the store is unable to allocate the requested buffer size, it allocates smaller and smaller buffers until it reaches DiagnosticStoreMinWindowBufferSize, and then fails if it cannot honor DiagnosticStoreMinWindowBufferSize.

Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.

Returns:

The DiagnosticStoreMaxWindowBufferSize value

setDiagnosticStoreMaxWindowBufferSize

void setDiagnosticStoreMaxWindowBufferSize(int diagnosticStoreMaxWindowBufferSize)

See GenericFileStoreMBean.setMaxWindowBufferSize.

Parameters:

diagnosticStoreMaxWindowBufferSize - The new DiagnosticStoreMaxWindowBufferSize value

Throws:

InvalidAttributeValueException

Default Value:

4194304

Maximum Value:

1073741824

Minimum Value:

-1

getDiagnosticStoreIoBufferSize

int getDiagnosticStoreIoBufferSize()

The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2, controls the largest write size.

• When a native wlfileio driver is available, the setting applies to off-heap (native) memory.
• When a native wlfileio driver is not available, the setting applies to JAVA heap memory.
• For the best runtime performance, Oracle recommends setting DiagnosticStoreIOBufferSize so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).
• See AllocatedIOBufferBytes to find out the actual allocated off-heap (native) memory amount. It is a multiple of IOBufferSize

Returns:

The DiagnosticStoreIoBufferSize value

setDiagnosticStoreIoBufferSize

void setDiagnosticStoreIoBufferSize(int diagnosticStoreIoBufferSize)

See GenericFileStoreMBean.IoBufferSize.

Parameters:

diagnosticStoreIoBufferSize - The new DiagnosticStoreIOBufferSize value

Throws:

InvalidAttributeValueException

Default Value:

-1

Maximum Value:

67108864

Minimum Value:

-1

getDiagnosticStoreMaxFileSize

long getDiagnosticStoreMaxFileSize()

The maximum file size, in bytes.

• The DiagnosticStoreMaxFileSize value affects the number of files needed to accommodate a diagnostic store of a particular size (number of files = diagnostic store size/MaxFileSize rounded up).
• A diagnostic store automatically reuses space freed by deleted records and automatically expands individual files up to DiagnosticStoreMaxFileSize if there is not enough space for a new record. If there is no space left in exiting files for a new record, a diagnostic store creates an additional file.
• A small number of larger files is normally preferred over a large number of smaller files as each file allocates Window Buffer and file handles.
• If DiagnosticStoreMaxFileSize is larger than 2^24 * DiagnosticStoreBlockSize, then DiagnosticStoreMaxFileSize is ignored, and the value becomes 2^24 * DiagnosticStoreBlockSize. The default DiagnosticStoreBlockSize is 512, and 2^24 * 512 is 8 GB.

Oracle recommends not setting the Diagnostic Store Max File Size above the default value of 1,342,177,280.

Returns:

The DiagnosticStoreMaxFileSize value

setDiagnosticStoreMaxFileSize

void setDiagnosticStoreMaxFileSize(long diagnosticStoreMaxFileSize)

See GenericFileStoreMBean.setMaxFileSize.

Parameters:

diagnosticStoreMaxFileSize - The new DiagnosticStoreMaxFileSize value

Throws:

InvalidAttributeValueException

Default Value:

1342177280

Minimum Value:

10485760

getDiagnosticStoreBlockSize

int getDiagnosticStoreBlockSize()

The smallest addressable block, in bytes, of a file. When a native wlfileio driver is available and the block size has not been configured by the user, the store selects the minimum OS specific value for unbuffered (direct) I/O, if it is within the range [512, 8192].

A file store's block size does not change once the file store creates its files. Changes to block size only take effect for new file stores or after the current files have been deleted. See "Tuning the Persistent Store" in Performance and Tuning for Oracle WebLogic Server.

Returns:

The DiagnosticStoreBlockSize value

setDiagnosticStoreBlockSize

void setDiagnosticStoreBlockSize(int diagnosticStoreBlockSize)

See GenericFileStoreMBean.setBlockSize.

Parameters:

diagnosticStoreBlockSize - The new DiagnosticStoreBlockSize value

Throws:

InvalidAttributeValueException

Default Value:

-1

Maximum Value:

8192

Minimum Value:

-1

getDiagnosticDataArchiveType

String getDiagnosticDataArchiveType()

Determines whether the current server persists its harvested metrics and event data in a diagnostic store (file-based store) or a JDBC based archive. The default store is file-based.

Returns:

the diagnostic data archive type, file-based or JDBC based

setDiagnosticDataArchiveType

void setDiagnosticDataArchiveType(String archiveType)

Sets the value of the DiagnosticDataArchiveType attribute.

Parameters:

archiveType - the diagnostic data archive type

See Also:

WLDFServerDiagnosticMBean.getDiagnosticDataArchiveType()

Default Value:

WLDFServerDiagnosticMBean.FILE_STORE_ARCHIVE_TYPE

Valid Values:

WLDFServerDiagnosticMBean.FILE_STORE_ARCHIVE_TYPE, WLDFServerDiagnosticMBean.JDBC_ARCHIVE_TYPE

getDiagnosticJDBCResource

JDBCSystemResourceMBean getDiagnosticJDBCResource()

The JDBC data source that the server uses to archive its harvested metrics and event data.

Returns:

the JDBC data source

See Also:

WLDFServerDiagnosticMBean.getDiagnosticDataArchiveType()

setDiagnosticJDBCResource

void setDiagnosticJDBCResource(JDBCSystemResourceMBean diagnosticJDBCResource)

Sets the value of the DiagnosticJDBCResource attribute.

Parameters:

diagnosticJDBCResource - the JDBC data source

See Also:

WLDFServerDiagnosticMBean.getDiagnosticJDBCResource()

isSynchronousEventPersistenceEnabled

boolean isSynchronousEventPersistenceEnabled()

Specifies the instrumentation events persistence policy. If true, events will be persisted synchronously within the same thread. If false, events will be queued up to be persisted in a separate thread.

Returns:

True, if instrumentation events will be persisted synchronously

setSynchronousEventPersistenceEnabled

void setSynchronousEventPersistenceEnabled(boolean enable)

Sets the value of the SynchronousEventPersistenceEnabled attribute.

Parameters:

enable - If true, persist instrumentation events synchronously.

See Also:

WLDFServerDiagnosticMBean.isSynchronousEventPersistenceEnabled()

Default Value:

false

getEventPersistenceInterval

long getEventPersistenceInterval()

The interval, in milliseconds, at which queued up instrumentation events will be periodically dispatched to the archive.

Returns:

Event persistence interval in milliseconds

setEventPersistenceInterval

void setEventPersistenceInterval(long interval)

Sets the value of the EventPersistenceInterval attribute.

Parameters:

interval - Event persistence interval in milliseconds

See Also:

WLDFServerDiagnosticMBean.getEventPersistenceInterval()

Default Value:

5000

isDiagnosticContextEnabled

boolean isDiagnosticContextEnabled()

If true, diagnostic context creation is enabled. If false, the diagnostic context will not be created when requested. However, if the diagnostics context already exists because it was propagated from another VM or was created through the DyeInjection monitor, the context will be made available.

Returns:

If true, diagnostic context will be created when asked for.

setDiagnosticContextEnabled

void setDiagnosticContextEnabled(boolean enable)

Sets the value of the DiagnosticContextEnabled attribute.

Parameters:

enable - If true, diagnostic context will be created when asked for.

See Also:

WLDFServerDiagnosticMBean.isDiagnosticContextEnabled()

Default Value:

false

setDataRetirementTestModeEnabled

void setDataRetirementTestModeEnabled(boolean enabled)

Parameters:

enabled -

See Also:

WLDFServerDiagnosticMBean.isDataRetirementTestModeEnabled()

isDataRetirementEnabled

boolean isDataRetirementEnabled()

This attribute controls if configuration based data retirement functionality is enabled on the server. If disabled, all retirement policies will be disabled.

Returns:

True if data retirement functionality is enabled on this server

Default Value:

true

setDataRetirementEnabled

void setDataRetirementEnabled(boolean enabled)

Enables or disabled the data retirement functionality on this server. Actual data retirement will be performed as per configured policies.

Parameters:

enabled - If true, enable data retirement functionality on the server.

See Also:

WLDFServerDiagnosticMBean.isDataRetirementEnabled()

getPreferredStoreSizeLimit

int getPreferredStoreSizeLimit()

Return the preferred limit on the size of diagnostic store file in MB.

Returns:

Preferred limit on the size of diagnostic store file in MB.

Changes take effect after you redeploy the module or restart the server.

Default Value:

100

Minimum Value:

10

setPreferredStoreSizeLimit

void setPreferredStoreSizeLimit(int preferredStoreSizeLimit)

Sets preferredStoreSizeLimit attributes

Parameters:

preferredStoreSizeLimit - Preferred size limit of the diagnostic store file in MB.

See Also:

WLDFServerDiagnosticMBean.getPreferredStoreSizeLimit()

getStoreSizeCheckPeriod

int getStoreSizeCheckPeriod()

Return the period in hours at which diagnostic store file size check will be performed

Returns:

Period in hours at which diagnostic store file size check will be performed

Changes take effect after you redeploy the module or restart the server.

Default Value:

1

Minimum Value:

1

setStoreSizeCheckPeriod

void setStoreSizeCheckPeriod(int storeSizeCheckPeriod)

Sets storeSizeCheckPeriod attribute

Parameters:

storeSizeCheckPeriod - Period in hours at which diagnostic store file size check will be performed

See Also:

WLDFServerDiagnosticMBean.getStoreSizeCheckPeriod()

getWLDFDataRetirements

WLDFDataRetirementMBean[] getWLDFDataRetirements()

Return the WLDFDataRetirementMBeans parented by this WLDFServerDiagnosticMBean.

lookupWLDFDataRetirement

WLDFDataRetirementMBean lookupWLDFDataRetirement(String name)

Look up WLDFDataRetirement object with given name

Parameters:

name - Name of the data retirement

Returns:

WLDFDataRetirement object

getWLDFDataRetirementByAges

WLDFDataRetirementByAgeMBean[] getWLDFDataRetirementByAges()

Return the WLDFDataRetirementByAgeMBeans parented by this WLDFServerDiagnosticMBean.

Returns:

The WLDFDataRetirementByAges value

Changes take effect after you redeploy the module or restart the server.

createWLDFDataRetirementByAge

WLDFDataRetirementByAgeMBean createWLDFDataRetirementByAge(String name)

Factory to create WLDFDataRetirement instance corresponding to a WLDF archive

Parameters:

name -

Returns:

WLDFDataRetirementByAgeMBean object

destroyWLDFDataRetirementByAge

void destroyWLDFDataRetirementByAge(WLDFDataRetirementByAgeMBean wldfDataRetirement)

Deletes WLDFDataRetirementByAgeMBean object

Parameters:

wldfDataRetirement -

lookupWLDFDataRetirementByAge

WLDFDataRetirementByAgeMBean lookupWLDFDataRetirementByAge(String name)

Look up WLDFDataRetirementByAgeMBean object with given name

Parameters:

name -

Returns:

WLDFDataRetirementByAgeMBean object

getWLDFDiagnosticVolume

String getWLDFDiagnosticVolume()

Specifies the volume of diagnostic data that is automatically produced by WebLogic Server at run time. Note that the WLDF diagnostic volume setting does not affect explicitly configured diagnostic modules. For example, this controls the volume of events generated for Flight Recorder.

This attribute has the following settings:

• Off No diagnostic data is produced.
• Low Minimal amounts of automatic diagnostic data are produced. This is the default.
• Medium Additional diagnostic data is automatically generated beyond the amount generated for Low.
• High Additional diagnostic data is automatically generated beyond the amount generated for Medium.

Returns:

The diagnostic volume

Changes take effect after you redeploy the module or restart the server.

setWLDFDiagnosticVolume

void setWLDFDiagnosticVolume(String volume)

Specifies the volume of diagnostic data that is automatically produced by WebLogic Server at run time. Note that the WLDF diagnostic volume setting does not affect explicitly configured diagnostic modules. For example, this controls the volume of events generated for Flight Recorder.

This attribute has the following settings:

• Off No diagnostic data is produced.
• Low Minimal amounts of automatic diagnostic data are produced. This is the default.
• Medium Additional diagnostic data is automatically generated beyond the amount generated for Low.
• High Additional diagnostic data is automatically generated beyond the amount generated for Medium.

Parameters:

volume - Specifies the diagnostics volume

See Also:

WLDFServerDiagnosticMBean.getWLDFDiagnosticVolume()

Default Value:

WLDFServerDiagnosticMBean.LOW_VOLUME

Valid Values:

WLDFServerDiagnosticMBean.OFF_VOLUME, WLDFServerDiagnosticMBean.LOW_VOLUME, WLDFServerDiagnosticMBean.MEDIUM_VOLUME, WLDFServerDiagnosticMBean.HIGH_VOLUME

getWLDFBuiltinSystemResourceType

String getWLDFBuiltinSystemResourceType()

This attribute specifies the WLDF built-in system resource type in use for this server.

This attribute has the following settings:

• None No WLDF built-in system resource in use.
• Low The Low WLDF built-in system resource. This is the default.
• Medium The Medium built-in system resource.
• High The High built-in system resource.

Returns:

The WLDF built-in system resource type in use

Changes take effect after you redeploy the module or restart the server.

Default Value:

"None"

Valid Values:

"None", "Low", "Medium", "High"

Default value in production mode:

"Low"

setWLDFBuiltinSystemResourceType

void setWLDFBuiltinSystemResourceType(String profile)

Sets the built-in system resource type for this server

getWLDFBuiltinSystemResourceDescriptorBean

WLDFResourceBean getWLDFBuiltinSystemResourceDescriptorBean()

Returns:

WLDFResourceBean for the built-in system resource.