HPELTextLogService MBean

Partial ObjectName:
WebSphere:*,type=HPELTextLogService


MBean HPELTextLogService

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


Attribute Summary
booleanenabled
           Enablement flag for the textLog
java.lang.StringdataDirectory
           The base directory to use for text 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 text log records
java.lang.StringoutOfSpaceAction
           The action to perform when an exception occurs during a text write.
booleantraceIncluded
           The indicator if trace should be included in text log (some performance impact)
booleanunimportantMessagesIncluded
           Not implemented yet
java.lang.StringoutputFormat
           The text output format to use.
booleanbufferingEnabled
           Buffering enablement indicator for text log
booleanfileSwitchEnabled
           Enabling of TextLog switch each day at a specified time
intfileSwitchTime
           The hour each day when to switch files (if enabled)

Operation Summary
voidsetTextLog(boolean enabled, java.lang.String dataDirectory, boolean purgeBySizeEnabled, boolean purgeByTimeEnabled, long purgeMaxSize, long purgeMinTime, java.lang.String outOfSpaceAction, java.lang.String outputFormat, boolean traceIncluded, java.lang.String outOfSpaceAction, boolean bufferingEnabled, boolean fileSwitchEnable, int fileSwitchTime)
           Initialization of the text log.
voiddisableTextLogging()
           Dynamically disable the textLog for performance improvements.

Attribute Detail

enabled

public boolean enabled
Enablement flag for the textLog
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

dataDirectory

public java.lang.String dataDirectory
The base directory to use for text 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 text log records
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 text write. Values: StopLogging PurgeOld StopServer
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

traceIncluded

public boolean traceIncluded
The indicator if trace should be included in text log (some performance impact)
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

unimportantMessagesIncluded

public boolean unimportantMessagesIncluded
Not implemented yet
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

outputFormat

public java.lang.String outputFormat
The text output format to use. Supported values 'Advanced' and 'Basic'. Value 'null' means to keep that value unchanged.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

bufferingEnabled

public boolean bufferingEnabled
Buffering enablement indicator for text log
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator

fileSwitchEnabled

public boolean fileSwitchEnabled
Enabling of TextLog 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

setTextLog

public void setTextLog(boolean enabled, java.lang.String dataDirectory, boolean purgeBySizeEnabled, boolean purgeByTimeEnabled, long purgeMaxSize, long purgeMinTime, java.lang.String outOfSpaceAction, java.lang.String outputFormat, boolean traceIncluded, java.lang.String outOfSpaceAction, boolean bufferingEnabled, boolean fileSwitchEnable, int fileSwitchTime)
Initialization of the text log.
Parameters:
enabled - Enable the TextLog or not.
dataDirectory - Location of Directory for the text Log.
purgeBySizeEnabled - Enable for size purge.
purgeByTimeEnabled - Enable for time purge.
purgeMaxSize - Size for the entire text log repository.
purgeMinTime - Min amount of time each logged entry should be maintained.
outOfSpaceAction - Action to take if unable to write to repository.
outputFormat - Format for text log.
traceIncluded - Include trace output in textLog.
outOfSpaceAction - Action to take if unable to write to repository.
bufferingEnabled - Indicator as to whether or not to buffer writes.
fileSwitchEnable - Enablement for switch log files at a specific time each day.
fileSwitchTime - Time each dsy to switch files if enabled.
Security Roles:
administrator
operator

disableTextLogging

public void disableTextLogging()
Dynamically disable the textLog for performance improvements.
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005