Package org.jenkinsci.plugins.workflow.log

Interface LogStorage

All Known Implementing Classes:

BrokenLogStorage, FileLogStorage

@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
public interface LogStorage

Means of replacing how logs are stored for a Pipeline build as a whole or for one step. UTF-8 encoding is assumed throughout.

See Also:

• JEP-210: Pluggable log storage

Method Summary

Modifier and Type	Method	Description
static String	endStep()	Closes an HTML step block.
default File	getLogFile(FlowExecutionOwner.Executable build, boolean complete)	Deprecated. Only used for compatibility with Run.getLogFile().
TaskListener	nodeListener(FlowNode node)	Provides an alternate way of emitting output from a node (such as a step).
static LogStorage	of(FlowExecutionOwner b)	Gets the available log storage method for a given build.
BuildListener	overallListener()	Provides an alternate way of emitting output from a build.
AnnotatedLargeText<FlowExecutionOwner.Executable>	overallLog(FlowExecutionOwner.Executable build, boolean complete)	Provides an alternate way of retrieving output from a build.
static String	startStep(String id)	Introduces an HTML block with a pipeline-node-<ID> CSS class based on FlowNode.getId().
AnnotatedLargeText<FlowNode>	stepLog(FlowNode node, boolean complete)	Provides an alternate way of retrieving output from a build.
static OutputStream	wrapWithAutoFlushingBuffer(OutputStream os)	Wraps the specified OutputStream with a buffer that flushes automatically as needed.
static BuildListener	wrapWithRemoteAutoFlushingListener(OutputStream os)	Wraps the specified OutputStream with a BuildListener that automatically buffers and flushes remote writes.

Method Details

overallListener

@NonNull
BuildListener overallListener()
                       throws IOException,
InterruptedException

Provides an alternate way of emitting output from a build.

May implement AutoCloseable to clean up at the end of a build; it may or may not be closed during Jenkins shutdown while a build is running.

The caller may wrap the result using TaskListenerDecorator.apply(hudson.model.TaskListener, org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner, org.jenkinsci.plugins.workflow.log.TaskListenerDecorator).

Returns:

a (remotable) build listener; do not bother overriding anything except TaskListener.getLogger()

Throws:

IOException

InterruptedException

See Also:

• FlowExecutionOwner.getListener()

nodeListener

@NonNull
TaskListener nodeListener(@NonNull
 FlowNode node)
                   throws IOException,
InterruptedException

Provides an alternate way of emitting output from a node (such as a step).

May implement AutoCloseable to clean up at the end of a node (FlowNode.isActive()); it may or may not be closed during Jenkins shutdown while a build is running.

The caller may wrap the result using TaskListenerDecorator.apply(hudson.model.TaskListener, org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner, org.jenkinsci.plugins.workflow.log.TaskListenerDecorator).

Parameters:

node - a running node

Returns:

a (remotable) task listener; do not bother overriding anything except TaskListener.getLogger()

Throws:

IOException

InterruptedException

See Also:

• StepContext.get(java.lang.Class<T>)

overallLog

@NonNull
AnnotatedLargeText<FlowExecutionOwner.Executable> overallLog(@NonNull
 FlowExecutionOwner.Executable build,
 boolean complete)

Provides an alternate way of retrieving output from a build.

In an AnnotatedLargeText.writeHtmlTo(long, java.io.Writer) override, ConsoleAnnotationOutputStream.eol(byte[], int) should apply startStep(java.lang.String) and endStep() to delineate blocks contributed by steps. (Also see ConsoleAnnotators.)

Parameters:

complete - if true, we claim to be serving the complete log for a build, so implementations should be sure to retrieve final log lines

Returns:

a log

startStep

@NonNull
static String startStep(@NonNull
 String id)

Introduces an HTML block with a pipeline-node-<ID> CSS class based on FlowNode.getId().

See Also:

• endStep()
• overallLog(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner.Executable, boolean)

endStep

@NonNull
static String endStep()

Closes an HTML step block.

See Also:

• startStep(java.lang.String)
• overallLog(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner.Executable, boolean)

stepLog

@NonNull
AnnotatedLargeText<FlowNode> stepLog(@NonNull
 FlowNode node,
 boolean complete)

Provides an alternate way of retrieving output from a build.

Parameters:

node - a running node

complete - if true, we claim to be serving the complete log for a node, so implementations should be sure to retrieve final log lines

Returns:

a log for this just this node

See Also:

• LogAction

getLogFile

@Deprecated
@NonNull
default File getLogFile(@NonNull
 FlowExecutionOwner.Executable build,
 boolean complete)

Deprecated.

Only used for compatibility with Run.getLogFile().

Provide a file containing the log text. The default implementation creates a temporary file based on the current contents of overallLog(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner.Executable, boolean).

Parameters:

build - as in overallLog(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner.Executable, boolean)

complete - as in overallLog(org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner.Executable, boolean)

Returns:

a possibly temporary file

of

@NonNull
static LogStorage of(@NonNull
 FlowExecutionOwner b)

Gets the available log storage method for a given build.

Parameters:

b - a build about to start

Returns:

the mechanism for handling this build, including any necessary fallback

See Also:

• LogStorageFactory

wrapWithRemoteAutoFlushingListener

@NonNull
static BuildListener wrapWithRemoteAutoFlushingListener(@NonNull
 OutputStream os)
                                                 throws IOException

Wraps the specified OutputStream with a BuildListener that automatically buffers and flushes remote writes.

Throws:

IOException

wrapWithAutoFlushingBuffer

@NonNull
static OutputStream wrapWithAutoFlushingBuffer(@NonNull
 OutputStream os)
                                        throws IOException

Wraps the specified OutputStream with a buffer that flushes automatically as needed.

Throws:

IOException