Skip to main content

Remote Runner Features

The following features are supported for both BuildBuddy Workflows and Remote Bazel. Check individual docs for more product-specific features.

Attaching artifacts to remote runs​

To provide easy access to artifacts generated during remote runs, BuildBuddy supports a special directory called the artifacts directory. If you write files to this directory, BuildBuddy will automatically upload those files and show them in the UI for the remote run. You can get the path to the artifacts directory using the environment variable $BUILDBUDDY_ARTIFACTS_DIRECTORY.

For example, Bazel supports several flags such as --remote_grpc_log that allow writing additional debug logs and metadata files associated with an invocation. To automatically upload these to our UI, you could run a command like bazel test //... --remote_grpc_log=$BUILDBUDDY_ARTIFACTS_DIRECTORY/grpc.log.

BuildBuddy creates a new artifacts directory for each step executed on the remote runner, and recursively uploads all files in the directory after the step exits.

Fetching artifacts programmatically​

If you'd like to fetch artifacts generated during a remote run programmatically, you can either:

  • Upload the artifacts to a hosted storage site (like S3), where you can later fetch the files
  • Upload the artifacts to BuildBuddy (using the approach described above)

If you upload the artifacts to BuildBuddy, you can fetch them by:

  1. Using the GetInvocation API with the include_artifacts field set to fetch the invocation for the remote run
  • In the response, the artifacts field will include bytestream URLs for artifacts that were uploaded to BuildBuddy
  1. Use the GetFile API to fetch the desired artifacts