image::build-scan-2.png[]

== Enable Build Scans

To enable build scans on a gradle command, add `--scan` to the command line option:

[source,text]
----
 ./gradlew build --scan
----

You may be prompted to agree to the terms to use Build Scans.

Vist the link:https://scans.gradle.com/[Build Scans page] to learn more.

[.text-right]

            |= Doctitle
            |
            |include::contribute[guide-name="creating-build-scans"]
            |""".stripMargin()

        when:
        String content = asciidoctor.convert(asciidocContent, [:])

        then:

        <span class="badge-text">How to Use Build Scans&nbsp;&nbsp;&nbsp;&gt;</span>
    </a>
</div>
++++

Gradle provides multiple ways to inspect your build:

- Profile with build scans
- Local profile reports
- Low level profiling

== What is a build scan?

https://scans.gradle.com/[Build scans] are a persistent, shareable record of what happened when running a build.

To do so, just run Gradle with the `--scan` flag.

[listing.terminal.sample-command]
----
\$ ./gradlew build --scan

BUILD SUCCESSFUL in 0s
${tasksExecuted.raw} actionable tasks: ${tasksExecuted.raw} executed

### Additional Links
These additional references should also help you:

link:https://scans.gradle.com[Build scans] will tell you information about the JVM that executed the build when you use the `--scan` option:

[caption= "Build Environment in build scans",link=https://scans.gradle.com/s/sample/cpp-parallel/infrastructure]
image::build-scan-infrastructure.png[Build Environment in Build Scan]

)

var (
	scannerBucketScansFinishedMD = NewCounterMD(scannerBucketScansFinished,
		"Total number of bucket scans finished since server start")
	scannerBucketScansStartedMD = NewCounterMD(scannerBucketScansStarted,
		"Total number of bucket scans started since server start")
	scannerDirectoriesScannedMD = NewCounterMD(scannerDirectoriesScanned,
		"Total number of directories scanned since server start")

plugins {
    id("gradlebuild.build-logic.kotlin-dsl-gradle-plugin")
}

description = "Provides plugins that configure profiling tools (jmh and build scans)"

dependencies {
    implementation("com.gradle:develocity-gradle-plugin")

    implementation("gradlebuild:basics")
    implementation("gradlebuild:module-identity")

    implementation(project(":documentation"))

    implementation("me.champeau.jmh:jmh-gradle-plugin")

         *
         * Not used by build scans but for TAPI events in {@code TransformOperationMapper}.
         */
        @NotUsedByScanPlugin
        String getTransformerName();

        /**
         * Returns the display name of the transform step subject.
         *
         * Not used by build scans but for TAPI events in {@code TransformOperationMapper}.
         */

* [Building Swift Libraries](https://docs.gradle.org/current/samples/sample_building_swift_libraries.html)
* [Creating Build Scans](https://scans.gradle.com/)

## Stay in Flow
Enjoy first-class Gradle support in your IDE of choice.

* [Android Studio](https://developer.android.com/studio/build/index.html)