HPELTraceDataService MBean

Partial ObjectName:
WebSphere:*,type=HPELTraceDataService


MBean HPELTraceDataService

Trace Information for the RAS High Performance Extensible Logging (HPEL).


Attribute Summary

java.lang.StringstorageType
           The trace storage type
java.lang.StringdataDirectory
           The base directory to use for trace file directory
booleanpurgeBySizeEnabled
           Is purging by size enabled
longpurgeMaxSize
           The maximum MB size of the repository
booleanpurgeByTimeEnabled
           Is purging by time enabled
longpurgeMinTime
           The minimum time (hours) to store trace records
longmemoryBufferSize
           The trace memory buffer
java.lang.StringoutOfSpaceAction
           The action to perform when an exception occurs during a trace write.
booleanbufferingEnabled
           Buffering enablement indicator for binary trace
booleanfileSwitchEnabled
           Enabling of trace switch each day at a specified time
intfileSwitchTime
           The hour each day when to switch files (if enabled)

Operation Summary

voidsetTraceRepository(java.lang.String dataDirectory, boolean purgeBySizeEnabled, boolean purgeByTimeEnabled, long purgeMaxSize, long purgeMinTime, java.lang.String outOfSpaceAction, boolean bufferingEnabled, boolean fileSwitchEnabled, int fileSwitchTime)
           Initialization of much of the binary trace repository config.
voidsetTraceMemory(java.lang.String dataDirectory, long memoryBufferSize)
           Initialization of the in-memory trace config.
voiddumpTraceMemory()
           Dump in-memory trace to disk.

Attribute Detail

storageType

public java.lang.String storageType

     The trace storage type

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


dataDirectory

public java.lang.String dataDirectory

     The base directory to use for trace file directory

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


purgeBySizeEnabled

public boolean purgeBySizeEnabled

     Is purging by size enabled

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


purgeMaxSize

public long purgeMaxSize

     The maximum MB size of the repository

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


purgeByTimeEnabled

public boolean purgeByTimeEnabled

     Is purging by time enabled

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


purgeMinTime

public long purgeMinTime

     The minimum time (hours) to store trace records

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


memoryBufferSize

public long memoryBufferSize

     The trace memory buffer

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


outOfSpaceAction

public java.lang.String outOfSpaceAction

     The action to perform when an exception occurs during a trace write. Values: StopLogging PurgeOld StopServer

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


bufferingEnabled

public boolean bufferingEnabled

     Buffering enablement indicator for binary trace

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


fileSwitchEnabled

public boolean fileSwitchEnabled

     Enabling of trace switch each day at a specified time

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


fileSwitchTime

public int fileSwitchTime

     The hour each day when to switch files (if enabled)

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


Operation Detail

setTraceRepository

public void setTraceRepository(java.lang.String dataDirectory, boolean purgeBySizeEnabled, boolean purgeByTimeEnabled, long purgeMaxSize, long purgeMinTime, java.lang.String outOfSpaceAction, boolean bufferingEnabled, boolean fileSwitchEnabled, int fileSwitchTime)

     Initialization of much of the binary trace repository config.

Parameters:

     dataDirectory - Directory into which the binary trace repository will be placed.
     purgeBySizeEnabled - Is purge based on size enabled.
     purgeByTimeEnabled - Is purge based on time enabled.
     purgeMaxSize - Size for the entire binary repository.
     purgeMinTime - Min amount of time each logged entry should be maintained.
     outOfSpaceAction - Action to take if unable to write to repository.
     bufferingEnabled - Indicator as to whether or not to do buffer writes.
     fileSwitchEnabled - Enablement for daily file switch.
     fileSwitchTime - Hour of day to switch files if enabled.

Security Roles:

     administrator
     operator


setTraceMemory

public void setTraceMemory(java.lang.String dataDirectory, long memoryBufferSize)

     Initialization of the in-memory trace config.

Parameters:

     dataDirectory - Directory into which the in-memory trace dump will be placed.
     memoryBufferSize - Size in MB for the entire in-memory buffer.

Security Roles:

     administrator
     operator


dumpTraceMemory

public void dumpTraceMemory()

     Dump in-memory trace to disk.

Security Roles:

     administrator
     operator


Copyright IBM Corporation 2002, 2012