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, Andrey Shlykov, Rafael Ceccone
See Also:

  • Method Details

    • start

      void start(BuildRequest request)
      Log that a build is starting.
      Parameters:
      request - the build request

    • pullingImage

      Consumer<TotalProgressEvent> pullingImage(ImageReference imageReference, @Nullable ImagePlatform platform, org.springframework.boot.buildpack.platform.build.ImageType imageType)
      Log that an image is being pulled.
      Parameters:
      imageReference - the image reference
      platform - the platform of the image
      imageType - the image type
      Returns:
      a consumer for progress update events

    • pulledImage

      void pulledImage(Image image, org.springframework.boot.buildpack.platform.build.ImageType imageType)
      Log that an image has been pulled.
      Parameters:
      image - the image that was pulled
      imageType - the image type that was pulled

    • pushingImage

      Consumer<TotalProgressEvent> pushingImage(ImageReference imageReference)
      Log that an image is being pushed.
      Parameters:
      imageReference - the image reference
      Returns:
      a consumer for progress update events

    • pushedImage

      void pushedImage(ImageReference imageReference)
      Log that an image has been pushed.
      Parameters:
      imageReference - the image reference

    • 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

    • executingLifecycle

      void executingLifecycle(BuildRequest request, org.springframework.boot.buildpack.platform.build.LifecycleVersion version, Cache buildCache)
      Log that the lifecycle is executing.
      Parameters:
      request - the build request
      version - the lifecycle version
      buildCache - the build cache 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

    • taggedImage

      void taggedImage(ImageReference tag)
      Log that a tag has been created.
      Parameters:
      tag - the tag reference

    • failedCleaningWorkDir

      void failedCleaningWorkDir(Cache cache, @Nullable Exception exception)
      Log that a cache cleanup step was not completed successfully.
      Parameters:
      cache - the cache
      exception - any exception that caused the failure
      Since:
      3.2.6

    • sensitiveTargetBindingDetected

      void sensitiveTargetBindingDetected(Binding binding)
      Log that a binding with a sensitive target has been detected.
      Parameters:
      binding - the binding
      Since:
      3.4.0

    • stackIdsDoNotMatch

      default void stackIdsDoNotMatch(String runImageStackId, String builderImageStackId)
      Log that the stack ID of the run image does not match the stack ID of the builder image.
      Parameters:
      runImageStackId - the stack ID of the run image
      builderImageStackId - the stack ID of the builder image
      Since:
      4.0.9

    • 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