WebSphere:*,type=TraceService
MBean TraceService
Management interface for the live TraceService function running in a server.
Attribute Summary | |
int | ringBufferSize the size of the trace output Ring Buffer. |
java.lang.String | traceSpecification A Trace specification which allows enabling/disabling tracing for components. |
java.lang.String | effectiveTraceSpecification A Trace specification like traceSpecification only with external factors such as PCI-DSS applied. |
java.lang.String | traceFileName the name of the file to which trace output will be written. |
java.lang.String | traceRuntimeConfig The current runtime configuration of the trace logger. |
boolean | rawTraceFilterEnabled Raw Trace Filter Enablement for legacy. |
Operation Summary | |
void | appendTraceString( Add the specified trace string to the trace state already active in the process runtime, without first clearing the current state. |
void | dumpRingBuffer( Write the contents of the Ras services Ring Buffer to the specified file. |
void | clearRingBuffer() Discard the current contents of the Ring Buffer. |
java.lang.String[] | listAllRegisteredComponents() Return an array of Strings containing the fully qualified names of all individual components currently registered with Ras services. |
java.lang.String[] | listAllRegisteredGroups() Return an array of Strings containing the names of all Groups currently registered with Ras services. |
java.util.HashMap | listComponentsInGroup( For each specified group, return an array of Strings containing the fully qualified names of all components who have registered as members of the specified group. |
java.lang.String[] | listComponentsInGroup( Return an array of Strings containing the fully qualified names of all components who have registered as members of the specified group. |
com.ibm.websphere.ras.TraceElementState[] | getTracedComponents() Return an array of TraceElementState objects containing information about the currently registered individual components for which some type of trace is currently enabled. |
com.ibm.websphere.ras.TraceElementState[] | getTracedGroups() Return an array of TraceElementState objects containing information about the currently registered Groups for which some type of trace is currently enabled. |
java.lang.String | getTraceSpecification( Return the current trace specification for the specified component or group. |
void | processDumpString( Instruct dumpable components to write their current state. |
void | checkTraceString( Check the specified trace string to see if it conforms to the TraceString grammar. |
void | setTraceOutputToFile( Make the specified file the active trace destination to which trace is routed. |
void | setTraceOutputToRingBuffer( Make the ring buffer the active trace destination to which trace is routed. |
java.lang.String | rolloverLogFileImmediate( Immediately roll the log file for the specified stream and return the name of the archive file. |
Attribute Detail |
public int ringBufferSize
public java.lang.String traceSpecification
public java.lang.String effectiveTraceSpecification
public java.lang.String traceFileName
public java.lang.String traceRuntimeConfig
public boolean rawTraceFilterEnabled
Operation Detail |
public void appendTraceString(java.lang.String traceString
)
traceString
-
a String that complies to the TraceString grammar and passes the checkTraceString() method.
public void dumpRingBuffer(java.lang.String fileToWriteTo
)
fileToWriteTo
-
the name of the file to write to.
public void clearRingBuffer()
public java.lang.String[] listAllRegisteredComponents()
public java.lang.String[] listAllRegisteredGroups()
public java.util.HashMap listComponentsInGroup(java.lang.String[] groups
)
groups
-
the complete names of the groups.
public java.lang.String[] listComponentsInGroup(java.lang.String group
)
group
-
the complete name of the group.
public com.ibm.websphere.ras.TraceElementState[] getTracedComponents()
public com.ibm.websphere.ras.TraceElementState[] getTracedGroups()
public java.lang.String getTraceSpecification(java.lang.String component
)
component
-
the String containing the name of the component or group.
public void processDumpString(java.lang.String dumpString
)
dumpString
-
a String in the specified format to process or null.
public void checkTraceString(java.lang.String traceString
)
traceString
-
a String that complies to the TraceString grammar.
public void setTraceOutputToFile(java.lang.String fileName,
int rolloverSize,
int numberBackups,
java.lang.String traceFormat
)
fileName
-
a non-null String containing the fully-qualified name of a file. Ras must be able to create the directory if it does not exist and must have write access to the file.rolloverSize
-
an int indicating the number of Megabytes at which the trace file should roll over to a new file. Caller must guarantee this is positive.numberBackups
-
an integer indicating the number of backup files to maintain. The caller must guarantee this is positive.traceFormat
-
a String indicating the trace format desired by the user. The String must be 'basic', 'advanced' or 'loganalyzer'. If an invalid value is specified, basic will be used.
public void setTraceOutputToRingBuffer(int ringBufferSize,
java.lang.String traceFormat
)
ringBufferSize
-
an integer indicating the number of backup files to maintain. The caller must guarantee this is positive.traceFormat
-
a String indicating the trace format desired by the user. The String must be 'basic', 'advanced' or 'loganalyzer'. If an invalid value is specified, basic will be used.
public java.lang.String rolloverLogFileImmediate(java.lang.String streamName,
java.lang.String fileName
)
streamName
-
token that indicates which log file is to be rolled over. The caller must guarantee it is 'SystemOut' or 'SystemErr'.fileName
-
the name of the file used to archive the contents of the current stream. May be null. If null is specified, the system will generate a file name.