com.ibm.websphere.logging.hpel.reader
Interface RepositoryReader
- public interface RepositoryReader
The getLogLists() methods return lists of log record lists in which the log record (inner) list represents log records generated by one process.
For example, If your repository contains log records from two separate
process lifespans, you'll have the following results:
All getLogList* queries have the ability to start from a particular
RepositoryLogRecord. This is done by passing to the query method the
RepositoryPointer information from that record. Here is an example:
for (
ServerInstanceLogRecordList
oneProcessList: getLogLists()
) {
// this loop will be executed twice - once for each process lifespan
// The header contains information about the server
Properties
header = oneProcessList.getHeader();
for ( RepositoryLogRecord
record: oneProcessList) {
// This loop iterates over the list of RepositoryLogRecords from one process lifespan.
}
}
A simple sample of using the reader to report on all logs currently in a server repository:
RepositoryPointer pointer;
for (
RepositoryLogRecord
record: getLogListForCurrentServerInstance()
) {
// process the record
if (<this is the record we want to start from next time>) {
pointer = record.getRepositoryPointer();
}
}
// after the break
for ( RepositoryLogRecord
record: getLogListForServerInstance(last)) {
// finish what was started.
}
Note that any records added to the repository after the repository reader
instance has been created will not be included in the record list.
public static void main(String[] args) {
// Create a repository reader (requires base directory of repository
RepositoryReader logRepository = new RepositoryReaderImpl(args[0]) ;
// Get iterator of server instances (start/stop of the server) extracting all log messages with
// severity between INFO and SEVERE. Lots of different filtering options, this is just one sample
Iterable<ServerInstanceLogRecordList> repResults = logRepository.getLogLists(Level.INFO, Level.SEVERE) ;
// Go through each server instance
for (ServerInstanceLogRecordList pidRecords: repResults) { // For each list (server lifeCycle)
// For each server instance, go through the records
for (RepositoryLogRecord repositoryLogRecord : pidRecords) {
// Just printing some key information here. Note that the repositoryRecord exposes all fields
// with simple get methods
System.out.println(" "+repositoryLogRecord.getFormattedMessage());
}
}
}
Method Summary
Modifier and Type | Method and Description |
---|---|
getLogListForCurrentServerInstance()
returns log records from the repository that were created since the last
server startup.
|
|
getLogListForServerInstance(java.util.Date time)
returns log records from the repository of a server instance running
at the time specified.
|
|
getLogListForServerInstance(java.util.Date time,int threadID)
returns log records from the repository of a server instance running
at a specified time created by the given thread.
|
|
getLogListForServerInstance(java.util.Date time,java.util.logging.Level minLevel,java.util.logging.Level maxLevel)
returns log records from the repository of a server instance running
at a specified time, within the level range as specified.
|
|
getLogListForServerInstance(java.util.Date time,LogQueryBean query)
returns log records from the repository of a server instance running
at a specified time, according to the criteria specified by the log query
bean.
|
|
getLogListForServerInstance(RepositoryPointer after)
returns log records from the repository that are beyond a given
repository location as specified.
|
|
getLogListForServerInstance(RepositoryPointer after,int threadID)
returns log records from the repository that are beyond a given
repository location and created by a given thread as specified.
|
|
getLogListForServerInstance(RepositoryPointer after,java.util.logging.Level minLevel,java.util.logging.Level maxLevel)
returns log records from the repository that are beyond a given
repository location and within the level range as specified.
|
|
getLogListForServerInstance(RepositoryPointer after,LogQueryBean query)
returns log records from the repository for one server instance that are
beyond a given repository location, according to the criteria specified by the log query
bean.
|
|
|
getLogLists()
returns all log records from the repository.
|
|
getLogLists(java.util.Date minTime,java.util.Date maxTime)
returns log records from the repository that are within the date range
as specified.
|
|
getLogLists(java.util.logging.Level minLevel,java.util.logging.Level maxLevel)
returns log records from the repository that are within the level range as
specified.
|
|
getLogLists(LogQueryBean query)
returns log records from the repository according to the criteria specified
by the log query bean.
|
|
getLogLists(RepositoryPointer after)
returns all log records from the repository beyond a given repository
location as specified.
|
|
getLogLists(RepositoryPointer after,java.util.Date maxTime)
returns log records from the repository that are beyond a given
repository location and occurred before a given time as specified.
|
|
getLogLists(RepositoryPointer after,java.util.logging.Level minLevel,java.util.logging.Level maxLevel)
returns log records from the repository that are beyond a given
repository location and within the level range as specified.
|
|
getLogLists(RepositoryPointer after,LogQueryBean query)
returns log records from the repository that are beyond a given
repository location, according to the criteria specified by the log query
bean.
|
Method Detail
getLogLists
- java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( )
- throws LogRepositoryException
LogRepositoryException
- indicating that an error occurred while reading list of instances from the server. getLogLists
- java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( RepositoryPointer after)
- throws LogRepositoryException
RepositoryLogRecordHeader.getRepositoryPointer()
to obtain the
RepositoryPointer for a particular log record.
after
- pointer to a record the list will start after LogRepositoryException
- indicating that an error occurred while reading list of instances from the server. getLogLists
- java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( java.util.logging.Level minLevel,
- java.util.logging.Level maxLevel)
- throws LogRepositoryException
minLevel
- minimum Level
that will be included in the
returned list maxLevel
- maximum Level
that will be included in the
returned list LogRepositoryException
- indicating that an error occurred while reading list of instances from the server. getLogLists
- java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( RepositoryPointer after,
- java.util.logging.Level minLevel,
- java.util.logging.Level maxLevel)
- throws LogRepositoryException
RepositoryLogRecordHeader.getRepositoryPointer()
to obtain the
RepositoryPointer for a particular log record.
after
- pointer to a record the list will start after minLevel
- minimum Level
that will be included in the
returned list maxLevel
- maximum Level
that will be included in the
returned list LogRepositoryException
- indicating that an error occurred while reading list of instances from the server. getLogLists
- java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( java.util.Date minTime,
- java.util.Date maxTime)
- throws LogRepositoryException
null
as the maxTime to indicate that the returned log records do not have
to meet a maxTime criteria.
minTime
- minimum Date
value that will be included in
the returned list maxTime
- maximum Date
value that will be included in
the returned list LogRepositoryException
- indicating that an error occurred while reading list of instances from the server. getLogLists
- java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( RepositoryPointer after,
- java.util.Date maxTime)
- throws LogRepositoryException
RepositoryLogRecordHeader.getRepositoryPointer()
to obtain the
RepositoryPointer for a particular log record.
after
- pointer to a record the list will start after maxTime
- maximum Date
value that will be included in
the returned list LogRepositoryException
- indicating that an error occurred while reading list of instances from the server. getLogLists
- java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( LogQueryBean query)
- throws LogRepositoryException
query
- LogQueryBean
instance representing set of criteria
each of which need to be met by the return records. LogRepositoryException
- indicating that an error occurred while reading list of instances from the server. getLogLists
- java.lang.Iterable<ServerInstanceLogRecordList> getLogLists( RepositoryPointer after,
- LogQueryBean query)
- throws LogRepositoryException
after
- pointer to a record the list will start after query
- LogQueryBean
instance representing set of criteria
each of which need to be met by the return records. LogRepositoryException
- indicating that an error occurred while reading list of instances from the server. getLogListForCurrentServerInstance
- ServerInstanceLogRecordList getLogListForCurrentServerInstance( )
- throws LogRepositoryException
LogRepositoryException
- indicating that an error occurred while reading records from the server. getLogListForServerInstance
- ServerInstanceLogRecordList getLogListForServerInstance( java.util.Date time)
- throws LogRepositoryException
time
- Date
value used to determine the
server instance where the server start time occurs
before this value and the server stop time occurs
after this value LogRepositoryException
- indicating that an error occurred while reading records from the server. getLogListForServerInstance
- ServerInstanceLogRecordList getLogListForServerInstance( RepositoryPointer after)
- throws LogRepositoryException
RepositoryLogRecordHeader.getRepositoryPointer()
to obtain the
RepositoryPointer for a particular log record. The returned logs will
be from one server instance.
after
- pointer to a record the list will start after LogRepositoryException
- indicating that an error occurred while reading records from the server. getLogListForServerInstance
- ServerInstanceLogRecordList getLogListForServerInstance( java.util.Date time,
- java.util.logging.Level minLevel,
- java.util.logging.Level maxLevel)
- throws LogRepositoryException
time
- Date
value used to determine the
server instance where the server start time occurs
before this value and the server stop time occurs
after this value minLevel
- minimum Level
that will be included in the
returned list maxLevel
- maximum Level
that will be included in the
returned list LogRepositoryException
- indicating that an error occurred while reading records from the server. getLogListForServerInstance
- ServerInstanceLogRecordList getLogListForServerInstance( RepositoryPointer after,
- java.util.logging.Level minLevel,
- java.util.logging.Level maxLevel)
- throws LogRepositoryException
RepositoryLogRecordHeader.getRepositoryPointer()
to obtain the
RepositoryPointer for a particular log record. The returned logs will
be from one server instance.
after
- pointer to a record the list will start after minLevel
- minimum Level
that will be included in the
returned list maxLevel
- maximum Level
that will be included in the
returned list LogRepositoryException
- indicating that an error occurred while reading records from the server. getLogListForServerInstance
- ServerInstanceLogRecordList getLogListForServerInstance( java.util.Date time,
- int threadID)
- throws LogRepositoryException
time
- Date
value used to determine the
server instance where the server start time occurs
before this value and the server stop time occurs
after this value threadID
- ID of the thread that the returned records will match LogRepositoryException
- indicating that an error occurred while reading records from the server. getLogListForServerInstance
- ServerInstanceLogRecordList getLogListForServerInstance( RepositoryPointer after,
- int threadID)
- throws LogRepositoryException
RepositoryLogRecordHeader.getRepositoryPointer()
to obtain the
RepositoryPointer for a particular log record. The returned logs will
be from one server instance.
after
- pointer to a record the list will start after threadID
- ID of the thread that the returned records will match LogRepositoryException
- indicating that an error occurred while reading records from the server. getLogListForServerInstance
- ServerInstanceLogRecordList getLogListForServerInstance( java.util.Date time,
- LogQueryBean query)
- throws LogRepositoryException
time
- Date
value used to determine the
server instance where the server start time occurs
before this value and the server stop time occurs
after this value query
- LogQueryBean
instance representing set of criteria
each of which need to be met by the return records. LogRepositoryException
- indicating that an error occurred while reading records from the server. getLogListForServerInstance
- ServerInstanceLogRecordList getLogListForServerInstance( RepositoryPointer after,
- LogQueryBean query)
- throws LogRepositoryException
after
- pointer to a record the list will start after query
- LogQueryBean
instance representing set of criteria
each of which need to be met by the return records. LogRepositoryException
- indicating that an error occurred while reading records from the server.