Package com.gradle.develocity.agent.gradle.scan

Interface BuildScanCaptureConfiguration

public interface BuildScanCaptureConfiguration
Allows configuring what data will be captured as part of the build scan.
Since:
3.17
See Also:

  • Method Details

    • getFileFingerprints

      Property<Boolean> getFileFingerprints()
      Specifies whether to capture information about each file used as an input to a unit of work.

      Defaults to true.

      Capturing file fingerprints may increase the size of the build scan data. This requires more time to transmit to the server, and more storage space at the server. Most builds will not incur a noticeable difference when this feature is enabled. Large builds may increase the build scan data by a handful of megabytes. For most builds, the increase will be negligible.

      If using Develocity with a good connection to the server this capture should stay enabled, as it allows comparing inputs at a file level when comparing builds.

      This property may also be set by the "scan.capture-file-fingerprints" system property. If this is set to any value other than "false", the capture will be enabled. If this is set to "false", the capture will be disabled. If the capture is enabled or disabled via system property, calling this method has no effect. That is, the system property takes precedence over the value set via this method.

      This method cannot be called after the root project has finished configuring. Doing so will produce a build time error.

    • getBuildLogging

      Property<Boolean> getBuildLogging()
      Specifies whether to capture build logging output.

      Defaults to true.

      This method cannot be called after the root project has finished configuring. Doing so will produce a build time error.

    • getTestLogging

      Property<Boolean> getTestLogging()
      Specifies whether to capture test logging output.

      Defaults to true.

      This method cannot be called after the root project has finished configuring. Doing so will produce a build time error.

    • getResourceUsage

      Property<Boolean> getResourceUsage()
      Specifies whether to capture information about the resources used by the build.

      Defaults to true.

      This property may also be set by the "scan.capture-resource-usage" system property. If this is set to any value other than "false", the capture will be enabled. If this is set to "false", the capture will be disabled. If the capture is enabled or disabled via system property, calling this method has no effect. That is, the system property takes precedence over the value set via this method.

      This method cannot be called after the root project has finished configuring. Doing so will produce a build time error.

      Since:
      3.18