1. RESTful Edit Management Interface for Oracle WebLogic Server
  2. Tasks
  3. WLDF Server Diagnostic
  4. Servers
  5. Server Diagnostic Config

View This WLDF Server Diagnostic

get

/management/weblogic/{version}/edit/servers/{name}/serverDiagnosticConfig

View this WLDF server diagnostic.

Request

Path Parameters
Query Parameters
  • The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
  • The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
Security
Back to Top

Response

Supported Media Types

200 Response

Returns this WLDF server diagnostic.

This method can return the following links:

  • rel=WLDFBuiltinSystemResourceDescriptorBean uri=/management/weblogic/{version}/edit/servers/{name}/serverDiagnosticConfig/WLDFBuiltinSystemResourceDescriptorBean

    This resource's WLDFBuiltinSystemResourceDescriptorBean singleton resource.

  • rel=WLDFDataRetirementByAgeCreateForm uri=/management/weblogic/{version}/edit/servers/{name}/serverDiagnosticConfig/WLDFDataRetirementByAgeCreateForm

    The create form resource for this resource's WLDFDataRetirementByAges collection resource.

  • rel=WLDFDataRetirementByAges uri=/management/weblogic/{version}/edit/servers/{name}/serverDiagnosticConfig/WLDFDataRetirementByAges

    This resource's WLDFDataRetirementByAges collection resource.

  • rel=action title=lookupWLDFDataRetirement uri=/management/weblogic/{version}/edit/servers/{name}/serverDiagnosticConfig/lookupWLDFDataRetirement

    This resource's lookupWLDFDataRetirement action resource.

  • rel=diagnosticJDBCResource

    This resource's diagnosticJDBCResource reference to a JDBC system resource resource.

Body ()
Root Schema : WLDF Server Diagnostic
Type: object
Show Source
  • Default Value: true

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

  • Default Value: FileStoreArchive
    Allowed Values: [ "FileStoreArchive", "JDBCArchive" ]

    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.

  • Default Value: logs/diagnostic_dumps

    Directory where heap and thread dumps will be generated by actions. This directory is a relative path with respect to the server directory

  • JDBC System Resource Reference
    Title: JDBC System Resource Reference
    Contains the JDBC system resource reference.

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

    Constraints

    • restart required

  • The schema name to use for accessing JDBC-based archive tables.

    If multiple WLDF JDBC archive schemas exist in the same database, this value specifies the correct schema to use for accessing JDBC-based archive tables in that database.

    There is no default value. If a schema name is not specified, no schema name is applied when WLDF validates the run-time table or is used for the SQL statements.

  • Minimum Value: -1
    Maximum Value: 8192
    Default Value: -1

    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

  • Default Value: data/store/diagnostics

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

  • Default Value: false

    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.

  • Minimum Value: -1
    Maximum Value: 67108864
    Default Value: -1

    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

  • Minimum Value: 10485760
    Default Value: 1342177280

    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.

  • Minimum Value: -1
    Maximum Value: 1073741824
    Default Value: 4194304

    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.

  • Minimum Value: -1
    Maximum Value: 1073741824
    Default Value: -1

    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

  • Read Only: true
    Default Value: false

    Return whether the MBean was created dynamically or is persisted to config.xml

  • Default Value: 5000

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

  • Default Value: 60000

    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.

  • Read Only: true

    Return the unique id of this MBean instance

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

  • Minimum Value: 0
    Maximum Value: 1440
    Default Value: 1

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

  • Minimum Value: 1
    Maximum Value: 50
    Default Value: 8

    Returns the maximum number of heap dump files to be retained which are generated by heap dump actions. If this limit is reached, oldest heap dumps will be deleted while creating new heap dump so that this limit is not exceeded.

  • Minimum Value: 1
    Maximum Value: 1000
    Default Value: 100

    Returns the maximum number of thread dump files to be retained which are generated by thread dump actions. If this limit is reached, oldest thread dump files will be deleted while creating new thread dump file so that this limit is not exceeded.

  • Read Only: true

    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

    Constraints

    • legal null

  • Optional information that you can include to describe this configuration.

    WebLogic Server 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.

  • Minimum Value: 10
    Default Value: 100

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

  • Minimum Value: 1
    Default Value: 1

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

  • Default Value: false

    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.

  • Items
    Title: Items

    Return all tags on this Configuration MBean

  • Read Only: true

    Returns the type of the MBean.

    Constraints

    • unharvestable
  • Default Value: None
    Allowed Values: [ "None", "Low", "Medium", "High" ]

    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.

    Constraints

    • production mode default : "Low"
  • WLDF Data Retirement References
    Title: WLDF Data Retirement References
    Read Only: true
    Contains the array of WLDF data retirement references.

    Return the WLDFDataRetirementMBeans parented by this WLDFServerDiagnosticMBean.

  • Default Value: Low
    Allowed Values: [ "Off", "Low", "Medium", "High" ]

    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

Nested Schema : JDBC System Resource Reference
Type: array
Title: JDBC System Resource Reference
Contains the JDBC system resource reference.

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

Constraints

  • restart required
Show Source
Nested Schema : Items
Type: array
Title: Items

Return all tags on this Configuration MBean

Show Source
Nested Schema : WLDF Data Retirement References
Type: array
Title: WLDF Data Retirement References
Read Only: true
Contains the array of WLDF data retirement references.

Return the WLDFDataRetirementMBeans parented by this WLDFServerDiagnosticMBean.

Show Source
Nested Schema : WLDF Data Retirement Reference
Type: object
Title: WLDF Data Retirement Reference
Contains the WLDF data retirement reference.
Show Source
Nested Schema : Identity
Type: array
Title: Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
Show Source
Back to Top