framework-google_stackdriver_debugger.md

Google Stackdriver Debugger Framework

The Google Stackdriver Debugger Framework causes an application to be automatically configured to work with a bound Google Stackdriver Debugger Service.

Detection Criterion	Existence of a single bound Google Stackdriver Debugger service. Existence of a Google Stackdriver Debugger service is defined as the VCAP_SERVICES payload containing a service who's name, label or tag has google-stackdriver-debugger as a substring.
Tags	google-stackdriver-debugger=<version>

Tags are printed to standard output by the buildpack detect script

User-Provided Service (Optional)

Users may optionally provide their own Google Stackdriver Debugger service. A user-provided Google Stackdriver Debugger service must have a name or tag with google-stackdriver-debugger in it so that the Google Stackdriver Debugger Agent Framework will automatically configure the application to work with the service.

The credential payload of the service must contain the following entry:

Name	Description
PrivateKeyData	A Base64 encoded Service Account JSON payload

Configuration

For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to Configuration and Extension.

The framework can be configured by modifying the config/google_stackdriver_debugger.yml file in the buildpack fork. The framework uses the Repository utility support and so it supports the version syntax defined there.

Name	Description
repository_root	The URL of the Google Stackdriver Debugger repository index (details).
version	The version of Google Stackdriver Debugger to use. Candidate versions can be found in this listing.