Diagnostic Archives: Configuration
Configuration Options Advanced Configuration Options Related Tasks Related Topics
Use this page to configure how and where the current server archives its monitoring and diagnostics data.
Configuration Options
Name Description Server The name of the server.
MBean Attribute:
WLDFServerDiagnosticMBean.Name
Changes take effect after you redeploy the module or restart the server.
Type 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.
MBean Attribute:
WLDFServerDiagnosticMBean.DiagnosticDataArchiveType
Changes take effect after you redeploy the module or restart the server.
Directory The directory in which the current server maintains its diagnostic store.
MBean Attribute:
WLDFServerDiagnosticMBean.DiagnosticStoreDir
Changes take effect after you redeploy the module or restart the server.
Diagnostics Store File Locking Enabled 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.
MBean Attribute:
WLDFServerDiagnosticMBean.DiagnosticStoreFileLockingEnabled
Changes take effect after you redeploy the module or restart the server.
Data Source The JDBC data source that the server uses to archive its harvested metrics and event data.
Preferred Store Size Return the preferred limit on the size of diagnostic store file in MB.
MBean Attribute:
WLDFServerDiagnosticMBean.PreferredStoreSizeLimit
Minimum value:
10
Store Size Check Period Return the period in hours at which diagnostic store file size check will be performed
MBean Attribute:
WLDFServerDiagnosticMBean.StoreSizeCheckPeriod
Minimum value:
1
Store Size Check Period Return the period in hours at which diagnostic store file size check will be performed
MBean Attribute:
WLDFServerDiagnosticMBean.StoreSizeCheckPeriod
Minimum value:
1
Data Retirement Enabled This attribute controls if configuration based data retirement functionality is enabled on the server. If disabled, all retirement policies will be disabled.
MBean Attribute:
WLDFServerDiagnosticMBean.DataRetirementEnabled
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
MBean Attribute:
WLDFDataRetirementMBean.Name
Changes take effect after you redeploy the module or restart the server.
Type Returns the type of the MBean.
MBean Attribute:
WLDFDataRetirementMBean.Type
Changes take effect after you redeploy the module or restart the server.
Archive Name Name of the archive for which data retirement is configured
MBean Attribute:
WLDFDataRetirementMBean.ArchiveName
Enabled Enable data retirement
MBean Attribute:
WLDFDataRetirementMBean.Enabled
Retirement Age Retirement age for records in hours. Older records will be eligible for deletion.
MBean Attribute:
WLDFDataRetirementByAgeMBean.RetirementAge
Minimum value:
1
Retirement Time This attribute specifies the hour of day at which the data retirement task will first run during the day.
MBean Attribute:
WLDFDataRetirementMBean.RetirementTime
Retirement Period This attribute specifies the period in hours at which the data retirement task will be periodically performed for the archive during the day after it is first executed. The value of this attribute must be positive
MBean Attribute:
WLDFDataRetirementMBean.RetirementPeriod
Minimum value:
1
Advanced Configuration Options
Name Description Diagnostics Store Min Window Buffer Size 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
andDisabled
, but only when a nativewlfileio
library is loaded. See Maximum Window Buffer Size.MBean Attribute:
WLDFServerDiagnosticMBean.DiagnosticStoreMinWindowBufferSize
Minimum value:
-1
Maximum value:
1073741824
Changes take effect after you redeploy the module or restart the server.
Diagnostics Store Max Window Buffer Size 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
andDisabled
but only when the nativewlfileio
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 honorMinWindowBufferSize
.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.
MBean Attribute:
WLDFServerDiagnosticMBean.DiagnosticStoreMaxWindowBufferSize
Minimum value:
-1
Maximum value:
1073741824
Changes take effect after you redeploy the module or restart the server.
Diagnostics Store IO Buffer Size 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 nativewlfileio
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
andCache-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 (includingDisabled
).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 ofIOBufferSize
for theDirect-Write
andCache-Flush
policies, or zero.
MBean Attribute:
WLDFServerDiagnosticMBean.DiagnosticStoreIoBufferSize
Minimum value:
-1
Maximum value:
67108864
Changes take effect after you redeploy the module or restart the server.
Diagnostics Store Max File Size 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
, thenMaxFileSize
is ignored, and the value becomes 2^24 *BlockSize
. The defaultBlockSize
is 512, and 2^24 * 512 is 8 GB.
MBean Attribute:
WLDFServerDiagnosticMBean.DiagnosticStoreMaxFileSize
Minimum value:
1048576
Changes take effect after you redeploy the module or restart the server.
Diagnostics Store Block Size 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.
MBean Attribute:
WLDFServerDiagnosticMBean.DiagnosticStoreBlockSize
Minimum value:
-1
Maximum value:
8192
Changes take effect after you redeploy the module or restart the server.