Gradle build insights
- The Tuist Gradle plugin installed and configured
Tuist's Gradle plugin can send build analytics to Tuist, giving you visibility into task execution and build performance.
Configure upload behavior#
By default:
- Build analytics are uploaded in the background for local builds.
- Build analytics are uploaded in the foreground for CI runs to avoid losing telemetry on short-lived agents.
You can control this behavior using uploadInBackground inside the tuist extension:
tuist {
uploadInBackground = false // always upload in the foreground
}
Configuration reference#
The uploadInBackground option is available in the tuist extension block in settings.gradle.kts:
| Option | Type | Default | Description |
|---|---|---|---|
uploadInBackground | Boolean? | null (background locally, foreground on CI) | Whether to upload build insights in the background for local builds. |
This setting does not affect remote cache settings in the buildCache block.
Custom metadata#
Attach tags and key-value data to Gradle builds to compare runs from different teams, hardware, or workflows. Tags are available as dashboard filters, and values appear on each build's detail page and in the application programming interface and Model Context Protocol tools.
Set metadata with environment variables:
export TUIST_BUILD_TAGS="nightly,android"
export TUIST_BUILD_VALUE_TICKET="TUIST-123"
export TUIST_BUILD_VALUE_RUNNER="macos-14"
You can also configure metadata in settings.gradle.kts:
tuist {
buildInsights {
tag("nightly")
tag("android")
value("ticket", "TUIST-123")
value("runner", "macos-14")
}
}
When the same value is configured in both places, the value in settings.gradle.kts takes precedence.
Tags must contain only letters, numbers, hyphens, and underscores. A build can have up to 50 tags, and each tag can contain up to 50 characters. A build can have up to 20 key-value entries, each key can contain up to 50 characters, and each value can contain up to 500 characters. These are the same server-side limits used for Xcode build metadata. The plugin skips invalid tags and oversized or empty metadata entries before it sends the report, so invalid configuration cannot prevent the rest of the build insights report from being stored. Use key-value metadata for values that do not meet the tag constraint.
Custom metadata is visible to project members in the dashboard and through the application programming interface and Model Context Protocol tools. Do not use it for credentials, access tokens, or other sensitive data. Tuist retains Gradle build data, including this metadata, for 90 days. See the data retention policy for details.