com.github.triceo.splitlog.api

Interface TailSplitter

All Known Implementing Classes:

JBossServerLogTailSplitter, SimpleTailSplitter

public interface TailSplitter

The purpose of classes implementing this interface is to interpret the log files. Each implementation should be familiar with one type of log file (i.e. JBoss logging or Logback) and be able to interpret the messages and their lines.

Method Summary

Modifier and Type	Method and Description
Date	determineDate(List<String> raw) Read the message and find the date when the message was submitted.
ExceptionDescriptor	determineException(List<String> raw) Read the message and try to identify an exception stack trace within.
String	determineLogger(List<String> raw) Messages in the log can contain information as to what logged them.
MessageSeverity	determineSeverity(List<String> raw) Read the message and try to find its severity.
MessageType	determineType(List<String> raw) Read the message and try to find its type.
boolean	isStartingLine(String line) Whether or not this particular line from the log starts a new log message.
String	stripOfMetadata(String line) Take a line from the log and attempt to strip it of metadata, such as severity, type and date.

Method Detail

determineDate

Date determineDate(List<String> raw)

Read the message and find the date when the message was submitted.

Parameters:

raw - Raw, untreated lines of the message.

Returns:

Date from the message, or null if not found.

determineException

ExceptionDescriptor determineException(List<String> raw)

Read the message and try to identify an exception stack trace within.

Parameters:

raw - Raw, untreated lines of the message.

Returns:

Exception data if found, null otherwise.

determineLogger

String determineLogger(List<String> raw)

Messages in the log can contain information as to what logged them. This would typically be a Java package name. This method will try to return that.

Parameters:

raw - Raw, untreated lines of the message.

Returns:

Null if not found.

determineSeverity

MessageSeverity determineSeverity(List<String> raw)

Read the message and try to find its severity.

Parameters:

raw - Raw, untreated lines of the message.

Returns:

Severity included in the message, MessageSeverity.UNKNOWN otherwise.

determineType

MessageType determineType(List<String> raw)

Read the message and try to find its type.

Parameters:

raw - Raw, untreated lines of the message.

Returns:

Type guessed from the message, MessageType.LOG if undetermined.

isStartingLine

boolean isStartingLine(String line)

Whether or not this particular line from the log starts a new log message. If so, it will be used to trigger a Message being produced and possibly stored.

Parameters:

line - Line from the log.

Returns:

True if this is the first line of a new log message.

stripOfMetadata

String stripOfMetadata(String line)

Take a line from the log and attempt to strip it of metadata, such as severity, type and date.

Parameters:

line - Line from the log.

Returns:

The same line, stripped of metadata. Usually just the actual information being logged.