Selecting source code automatically

Stackdriver Debugger uses source context information to display the correct version of your source code on the Debug page. The source context information is captured in a source-context.json file, which is generated from a Git repository and deployed with your application.

Before you begin

• Make sure your source code is in a Git repository.

• Make sure the Debugger API is enabled and your environment is configured.

Setup on Google Cloud Platform

Note: If your app is written in Python 2 or Java 8 and runs on App Engine standard environment, see the section on this page for setting up Debugger on App Engine standard environment: Python 2 and Java 8.

Follow the steps below to select your source code automatically:

Java

Note: When you use the maven-git-commit-id-plugin Maven plugin, you don't need to generate the source-context.json file. The plugin generates a git.properties file that contains source context information. The git.properties file is automatically injected into your application, so there is no need to generate the source-context.json file.

1. Commit your latest changes.
2. Run the following in the root directory of your local Git repository:
gcloud debug source gen-repo-info-file --output-directory="WEB-INF/classes/"
3. Deploy (or redeploy) your app from the Git repository, including the source-context.json file.

The correct version of your source code now appears automatically on the Debugger page.

Python

1. Commit your latest changes.
2. Run the following in the root directory of your local Git repository:
gcloud debug source gen-repo-info-file --output-directory=[MODULE_PACKAGE_DIR]

[MODULE_PACKAGE_DIR] is the top level of your app directory.

3. Deploy (or redeploy) your app from the Git repository, including the source-context.json file.

The correct version of your source code now appears automatically on the Debugger page.

Node.js

1. Commit your latest changes.
2. Run the following in the root directory of your local Git repository:
gcloud debug source gen-repo-info-file --output-directory=[MODULE_PACKAGE_DIR]

[MODULE_PACKAGE_DIR] is the top level of your app directory.

3. Deploy (or redeploy) your app from the Git repository, including the source-context.json file.

The correct version of your source code now appears automatically on the Debugger page.

.Net Core

1. Commit your latest changes.
2. Run the following in the root directory of your local Git repository:
gcloud debug source gen-repo-info-file --output-directory=[MODULE_PACKAGE_DIR]

[MODULE_PACKAGE_DIR] is the top level of your app directory.

3. Deploy (or redeploy) your app from the Git repository, including the source-context.json file.

The correct version of your source code now appears automatically on the Debugger page.

App Engine standard environment: Python 2 and Java 8

When you deploy your app, a WEB-INF/classes/source-context.json file is automatically generated and uploaded with your application.