Cloud Debugger is deprecated and will be shutdown May 31, 2023. See the deprecations page and release notes for more information.

Method: controller.debuggees.register

Registers the debuggee with the controller service.

All agents attached to the same application must call this method with exactly the same request content to get back the same stable debuggeeId. Agents should call this method again whenever google.rpc.Code.NOT_FOUND is returned from any controller method.

This protocol allows the controller service to disable debuggees, recover from data loss, or change the debuggeeId format. Agents must handle debuggeeId value changing upon re-registration.

HTTP request

POST https://clouddebugger.googleapis.com/v2/controller/debuggees/register

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "debuggee": {
    object (Debuggee)
  }
}
Fields
debuggee

object (Debuggee)

Required. Debuggee information to register. The fields project, uniquifier, description and agentVersion of the debuggee must be set.

Response body

If successful, the response body contains data with the following structure:

Response for registering a debuggee.

JSON representation 
{
  "debuggee": {
    object (Debuggee)
  },
  "agentId": string
}
Fields
debuggee

object (Debuggee)

Debuggee resource. The field id is guaranteed to be set (in addition to the echoed fields). If the field isDisabled is set to true, the agent should disable itself by removing all breakpoints and detaching from the application. It should however continue to poll debuggees.register until reenabled.
agentId

string

A unique ID generated for the agent. Each debuggees.register request will generate a new agent ID.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud_debugger
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.