com.atlassian.bamboo.build.logger

Interface BuildLogger

All Known Implementing Classes:

AbstractBuildLogger, BuildLoggerImpl, DisconnectedBuildLogger, NullBuildLogger, RemoteBuildLogger, SimpleBuildLogger

@PublicApi
public interface BuildLogger

This interface represents a logger for a given build

Method Summary

Modifier and Type	Method and Description
String	addBuildLogEntry(LogEntry logEntry) Add a new build log entry.
String	addBuildLogEntry(String logString) Create a new build log entry from text to append to logs
String	addBuildLogHeader(String logString, boolean showBothBanner) Deprecated. since 6.1 use other log methods
String	addErrorLogEntry(LogEntry logEntry) Add a new build error log entry.
String	addErrorLogEntry(String logString) Add a new build error log entry from text.
void	addErrorLogEntry(String logString, Throwable e) Adds an error log entry and each frame of the stack trace as a new error log entry
void	clearBuildLog() Deprecated. since 6.1
void	close()
List<LogEntry>	getBuildLog() Deprecated. since 5.5 use log interceptors to get this information
List<LogEntry>	getErrorLog() Deprecated. since 5.5 use log interceptors to get this information
LogInterceptorStack	getInterceptorStack()
List<LogEntry>	getLastNLogEntries(int n) Provide the latest build details (last n lines of logs).
LogMutatorStack	getMutatorStack()
List<String>	getStringErrorLogs() Deprecated. since 5.0
long	getTimeOfLastLog() last time a log entry was added.
void	stopStreamingBuildLogs() Stop streaming any logs to the build logs file

Method Detail

getBuildLog

@NotNull
 @Deprecated
List<LogEntry> getBuildLog()

Deprecated. since 5.5 use log interceptors to get this information

Provide the latest build details (last 100 lines of logs). This is not persisted.

Returns:

The list of LogEntrys.

getErrorLog

@NotNull
 @Deprecated
List<LogEntry> getErrorLog()

Deprecated. since 5.5 use log interceptors to get this information

Provide the latest error logs. This is not persisted

Returns:

The list of LogEntrys.

getLastNLogEntries

@NotNull
List<LogEntry> getLastNLogEntries(int n)

Provide the latest build details (last n lines of logs). This is not persisted.

Returns:

The list of LogEntrys.

getStringErrorLogs

@Deprecated
List<String> getStringErrorLogs()

Deprecated. since 5.0

addBuildLogEntry

@NotNull
String addBuildLogEntry(@NotNull
                                 LogEntry logEntry)

Add a new build log entry. This will get appended to the end of the log.

Parameters:

logEntry - The data being logged

Returns:

The line of text being logged. From LogEntry.getUnstyledLog().

addBuildLogEntry

String addBuildLogEntry(@NotNull
                        String logString)

Create a new build log entry from text to append to logs

Parameters:

logString - text to create log entry from

Returns:

The line of text being logged. From LogEntry.getUnstyledLog().

addBuildLogHeader

@Deprecated
String addBuildLogHeader(String logString,
                                     boolean showBothBanner)

Deprecated. since 6.1 use other log methods

addErrorLogEntry

@NotNull
String addErrorLogEntry(@NotNull
                                 LogEntry logEntry)

Add a new build error log entry. This will get appended to the end of the log and to the end of the errors.

Parameters:

logEntry - The data being logged

Returns:

The line of text being logged. From LogEntry.getUnstyledLog().

addErrorLogEntry

String addErrorLogEntry(String logString)

Add a new build error log entry from text. This will get appended to the end of the log and to the end of the errors.

Parameters:

logString - The text to create log entry from

Returns:

The line of text being logged. From LogEntry.getUnstyledLog().

addErrorLogEntry

void addErrorLogEntry(String logString,
                      @Nullable
                      Throwable e)

Adds an error log entry and each frame of the stack trace as a new error log entry

Parameters:

logString -

e -

stopStreamingBuildLogs

void stopStreamingBuildLogs()

Stop streaming any logs to the build logs file

clearBuildLog

@Deprecated
void clearBuildLog()

Deprecated. since 6.1

Reset the build log, ready for the next build

getTimeOfLastLog

long getTimeOfLastLog()

last time a log entry was added. If no logs, returns 0

Returns:

getInterceptorStack

@NotNull
LogInterceptorStack getInterceptorStack()

Returns:

stack of log interceptors attached to this build logger

getMutatorStack

@NotNull
LogMutatorStack getMutatorStack()

Returns:

stack of log mutators attached to this build logger

close

void close()