org.springframework.boot.buildpack.platform.build

Interface BuildLog

All Known Implementing Classes:

AbstractBuildLog

public interface BuildLog

Callback interface used to provide Builder output logging.

Since:

2.3.0

Author:

Phillip Webb, Scott Frederick

See Also:

toSystemOut()

Method Summary

Modifier and Type	Method and Description
void	executedLifecycle(BuildRequest request) Log that the lifecycle has executed.
void	executingLifecycle(BuildRequest request, org.springframework.boot.buildpack.platform.build.LifecycleVersion version, VolumeName buildCacheVolume) Log that the lifecycle is executing.
void	pulledBuilder(BuildRequest request, Image image) Log that the builder image has been pulled.
void	pulledRunImage(BuildRequest request, Image image) Log that a run image has been pulled.
Consumer<TotalProgressEvent>	pullingBuilder(BuildRequest request, ImageReference imageReference) Log that the builder image is being pulled.
Consumer<TotalProgressEvent>	pullingRunImage(BuildRequest request, ImageReference imageReference) Log that a run image is being pulled.
Consumer<LogUpdateEvent>	runningPhase(BuildRequest request, String name) Log that a specific phase is running.
void	skippingPhase(String name, String reason) Log that a specific phase is being skipped.
void	start(BuildRequest request) Log that a build is starting.
static BuildLog	to(PrintStream out) Factory method that returns a BuildLog the outputs to a given PrintStream.
static BuildLog	toSystemOut() Factory method that returns a BuildLog the outputs to System.out.

Method Detail

start

void start(BuildRequest request)

Log that a build is starting.

Parameters:

request - the build request

pullingBuilder

Consumer<TotalProgressEvent> pullingBuilder(BuildRequest request,
                                            ImageReference imageReference)

Log that the builder image is being pulled.

Parameters:

request - the build request

imageReference - the builder image reference

Returns:

a consumer for progress update events

pulledBuilder

void pulledBuilder(BuildRequest request,
                   Image image)

Log that the builder image has been pulled.

Parameters:

request - the build request

image - the builder image that was pulled

pullingRunImage

Consumer<TotalProgressEvent> pullingRunImage(BuildRequest request,
                                             ImageReference imageReference)

Log that a run image is being pulled.

Parameters:

request - the build request

imageReference - the run image reference

Returns:

a consumer for progress update events

pulledRunImage

void pulledRunImage(BuildRequest request,
                    Image image)

Log that a run image has been pulled.

Parameters:

request - the build request

image - the run image that was pulled

executingLifecycle

void executingLifecycle(BuildRequest request,
                        org.springframework.boot.buildpack.platform.build.LifecycleVersion version,
                        VolumeName buildCacheVolume)

Log that the lifecycle is executing.

Parameters:

request - the build request

version - the lifecycle version

buildCacheVolume - the name of the build cache volume in use

runningPhase

Consumer<LogUpdateEvent> runningPhase(BuildRequest request,
                                      String name)

Log that a specific phase is running.

Parameters:

request - the build request

name - the name of the phase

Returns:

a consumer for log updates

skippingPhase

void skippingPhase(String name,
                   String reason)

Log that a specific phase is being skipped.

Parameters:

name - the name of the phase

reason - the reason the phase is skipped

executedLifecycle

void executedLifecycle(BuildRequest request)

Log that the lifecycle has executed.

Parameters:

request - the build request

toSystemOut

static BuildLog toSystemOut()

Factory method that returns a BuildLog the outputs to System.out.

Returns:

a build log instance that logs to system out

to

static BuildLog to(PrintStream out)

Factory method that returns a BuildLog the outputs to a given PrintStream.

Parameters:

out - the print stream used to output the log

Returns:

a build log instance that logs to the given print stream