WLDFServerDiagnosticMBean

Overview

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

Related MBeans

This section describes attributes that provide access to other MBeans.

DiagnosticJDBCResource

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

For more information, see:

• getDiagnosticDataArchiveType

WLDFDataRetirementByAges

Return the WLDFDataRetirementByAgeMBeans parented by this WLDFServerDiagnosticMBean.

WLDFDataRetirements

Return the WLDFDataRetirementMBeans parented by this WLDFServerDiagnosticMBean.

Attributes

This section describes the following attributes:

CachingDisabled

Private property that disables caching in proxies.

DataRetirementEnabled

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

DiagnosticContextEnabled

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.

DiagnosticDataArchiveType

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.

DiagnosticStoreBlockSize

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.

DiagnosticStoreDir

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

For more information, see:

• getDiagnosticDataArchiveType

DiagnosticStoreFileLockingEnabled

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.

DiagnosticStoreIoBufferSize

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

• For the Direct-Write-With-Cache policy when a native wlfileio driver is available, IOBufferSize describes the maximum portion of a cache view that is passed to a system call. This portion does not consume off-heap (native) or Java heap memory.

• For the Direct-Write and Cache-Flush policies, IOBufferSize is the size of a per store buffer which consumes off-heap (native) memory, where one buffer is allocated during run-time, but multiple buffers may be temporarily created during boot recovery.

• When a native wlfileio driver is not available, the setting applies to off-heap (native) memory for all policies (including Disabled).

• For the best runtime performance, Oracle recommends setting IOBufferSize so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).

• For the best boot recovery time performance of large stores, Oracle recommends setting IOBufferSize to at least 2 megabytes.

• See AllocatedIOBufferBytes to find out the actual allocated off-heap (native) memory amount. It is a multiple of IOBufferSize for the Direct-Write and Cache-Flush policies, or zero.

DiagnosticStoreMaxFileSize

The maximum file size, in bytes.

• The MaxFileSize value affects the number of files needed to accommodate a store of a particular size (number of files = store size/MaxFileSize rounded up).

• A file store automatically reuses space freed by deleted records and automatically expands individual files up to MaxFileSize if there is not enough space for a new record. If there is no space left in exiting files for a new record, a 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 MaxFileSize is larger than 2^24 * BlockSize, then MaxFileSize is ignored, and the value becomes 2^24 * BlockSize. The default BlockSize is 512, and 2^24 * 512 is 8 GB.

DiagnosticStoreMaxWindowBufferSize

The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per primary store file. Applies to synchronous write policies Direct-Write-With-Cache and Disabled but only when the 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 MinWindowBufferSize, and then fails if cannot honor MinWindowBufferSize.

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.

DiagnosticStoreMinWindowBufferSize

The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per primary store file. Applies to synchronous write policies Direct-Write-With-Cache and Disabled, but only when a native wlfileio library is loaded. See Maximum Window Buffer Size.

EventPersistenceInterval

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

EventsImageCaptureInterval

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.

ImageDir

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.

For more information, see:

• WLDFImageRuntimeMBean

ImageTimeout

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

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:
Name=user-specified-name

Notes

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

Parent

Return the immediate parent for this MBean

PreferredStoreSizeLimit

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

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

StoreSizeCheckPeriod

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

SynchronousEventPersistenceEnabled

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.

Type

Returns the type of the MBean.

WLDFDiagnosticVolume

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 JRockit 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.

Operations

This section describes the following operations:

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

unSet

Restore the given property to its default value.