25.4. Build

25.4.1. Overview

The Build sensor data type is designed to represent the occurrence of an invocation of a build tool (such as Ant or Make) and the results of this invocation.

[Note]Note

The only build tool for which we have implemented a sensor is Ant.

Table 25.3, “Build SDT attributes” documents its attributes.

Table 25.3. Build SDT attributes

AttributeDescription
tstampThe UTC time at which this data was collected.
toolA string indicating the tool that collected this data, such as "Ant".
resultThe result of the build (either "Success" or "Failure").
pathA fully qualified directory path indicating the location of the system that invoked this build.
targetThe 'top-level' target associated with this build data.
pMapOptional information about this build event.

25.4.2. Applications of the Build SDT

Ant is a widely used tool for building Java-based systems. The Hackystat sensor for Ant records information about each invocation of Ant, whether it passed or failed, and why. This information can be useful for tracking when builds are being done, what the results are, and whether this the occurrences and success rate is changing over time.

The pMap field in the build SDT sent by ANT sensor contains the following information: failureType (present only if build fails), failureMessage (present only if build fails), runTime, startTimeMillis, endTimeMillis, configuration, startType, checkstyleRan, compilationRan, unittestRan, failureModuleName.