package google.devtools.clouddebugger.v2
Get desktop application:
View/edit binary Protocol Buffers messages
service Controller2
controller.proto:53The Controller service provides the API for orchestrating a collection of debugger agents to perform debugging tasks. These agents are each attached to a process of an application which may include one or more replicas. The debugger agents register with the Controller to identify the application being debugged, the Debuggee. All agents that register with the same data, represent the same Debuggee, and are assigned the same `debuggee_id`. The debugger agents call the Controller to retrieve the list of active Breakpoints. Agents with the same `debuggee_id` get the same breakpoints list. An agent that can fulfill the breakpoint request updates the Controller with the breakpoint result. The controller selects the first result received and discards the rest of the results. Agents that poll again for active breakpoints will no longer have the completed breakpoint in the list and should remove that breakpoint from their attached process. The Controller service does not provide a way to retrieve the results of a completed breakpoint. This functionality is available using the Debugger service.
rpc RegisterDebuggee (, )
controller.proto:69Registers 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 `debuggee_id`. 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 `debuggee_id` format. Agents must handle `debuggee_id` value changing upon re-registration.
message
controller.proto:115Request to register a debuggee.
optional debuggee = 1
Required. Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set.
message
controller.proto:123Response for registering a debuggee.
optional debuggee = 1
Debuggee resource. The field `id` is guaranteed to be set (in addition to the echoed fields). If the field `is_disabled` is set to `true`, the agent should disable itself by removing all breakpoints and detaching from the application. It should however continue to poll `RegisterDebuggee` until reenabled.
Returns the list of all active breakpoints for the debuggee. The breakpoint specification (`location`, `condition`, and `expressions` fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics. This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.
message
controller.proto:133Request to list active breakpoints.
string debuggee_id = 1
Required. Identifies the debuggee.
string wait_token = 2
A token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server-selected timeout has expired. The value should be set from the `next_wait_token` field in the last response. The initial value should be set to `"init"`.
bool success_on_timeout = 3
If set to `true` (recommended), returns `google.rpc.Code.OK` status and sets the `wait_expired` response field to `true` when the server-selected timeout has expired. If set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status when the server-selected timeout has expired.
message
controller.proto:153Response for listing active breakpoints.
repeated breakpoints = 1
List of all active breakpoints. The fields `id` and `location` are guaranteed to be set on each breakpoint.
string next_wait_token = 2
A token that can be used in the next method call to block until the list of breakpoints changes.
bool wait_expired = 3
If set to `true`, indicates that there is no change to the list of active breakpoints and the server-selected timeout has expired. The `breakpoints` field would be empty and should be ignored.
Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the `location`, `condition` and `expressions` fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.
message
controller.proto:169Request to update an active breakpoint.
string debuggee_id = 1
Required. Identifies the debuggee being debugged.
optional breakpoint = 2
Required. Updated breakpoint information. The field `id` must be set. The agent must echo all Breakpoint specification fields in the update.
message
controller.proto:181Response for updating an active breakpoint. The message is defined to allow future extensions.
(message has no fields)
service Debugger2
debugger.proto:45The Debugger service provides the API that allows users to collect run-time information from a running application, without stopping or slowing it down and without modifying its state. An application may include one or more replicated processes performing the same work. A debugged application is represented using the Debuggee concept. The Debugger service provides a way to query for available debuggees, but does not provide a way to create one. A debuggee is created using the Controller service, usually by running a debugger agent with the application. The Debugger service enables the client to set one or more Breakpoints on a Debuggee and collect the results of the set Breakpoints.
rpc SetBreakpoint (, )
debugger.proto:52Sets the breakpoint to the debuggee.
message
debugger.proto:94Request to set a breakpoint
string debuggee_id = 1
Required. ID of the debuggee where the breakpoint is to be set.
optional breakpoint = 2
Required. Breakpoint specification to set. The field `location` of the breakpoint must be set.
string client_version = 4
Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
message
debugger.proto:108Response for setting a breakpoint.
optional breakpoint = 1
Breakpoint resource. The field `id` is guaranteed to be set (in addition to the echoed fileds).
rpc GetBreakpoint (, )
debugger.proto:61Gets breakpoint information.
message
debugger.proto:115Request to get breakpoint information.
string debuggee_id = 1
Required. ID of the debuggee whose breakpoint to get.
string breakpoint_id = 2
Required. ID of the breakpoint to get.
string client_version = 4
Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
message
debugger.proto:128Response for getting breakpoint information.
optional breakpoint = 1
Complete breakpoint state. The fields `id` and `location` are guaranteed to be set.
rpc DeleteBreakpoint (, )
debugger.proto:69Deletes the breakpoint from the debuggee.
message
debugger.proto:135Request to delete a breakpoint.
string debuggee_id = 1
Required. ID of the debuggee whose breakpoint to delete.
string breakpoint_id = 2
Required. ID of the breakpoint to delete.
string client_version = 3
Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
rpc ListBreakpoints (, )
debugger.proto:77Lists all breakpoints for the debuggee.
message
debugger.proto:148Request to list breakpoints.
string debuggee_id = 1
Required. ID of the debuggee whose breakpoints to list.
bool include_all_users = 2
When set to `true`, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller.
bool include_inactive = 3
When set to `true`, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints.
optional action = 4
When set, the response includes only breakpoints with the specified action.
bool strip_results = 5
This field is deprecated. The following fields are always stripped out of the result: `stack_frames`, `evaluated_expressions` and `variable_table`.
string wait_token = 6
A wait token that, if specified, blocks the call until the breakpoints list has changed, or a server selected timeout has expired. The value should be set from the last response. The error code `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which should be called again with the same `wait_token`.
string client_version = 8
Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
message
debugger.proto:187Response for listing breakpoints.
repeated breakpoints = 1
List of breakpoints matching the request. The fields `id` and `location` are guaranteed to be set on each breakpoint. The fields: `stack_frames`, `evaluated_expressions` and `variable_table` are cleared on each breakpoint regardless of its status.
string next_wait_token = 2
A wait token that can be used in the next call to `list` (REST) or `ListBreakpoints` (RPC) to block until the list of breakpoints has changes.
rpc ListDebuggees (, )
debugger.proto:85Lists all the debuggees that the user has access to.
message
debugger.proto:200Request to list debuggees.
string project = 2
Required. Project number of a Google Cloud project whose debuggees to list.
bool include_inactive = 3
When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.
string client_version = 4
Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
message
debugger.proto:214Response for listing debuggees.
repeated debuggees = 1
List of debuggees accessible to the calling user. The fields `debuggee.id` and `description` are guaranteed to be set. The `description` field is a human readable field provided by agents and can be displayed to users.
message
data.proto:274Represents the breakpoint specification, status and results.
Used in: , , , , ,
string id = 1
Breakpoint identifier, unique in the scope of the debuggee.
Breakpoint.Action action = 13
Action that the agent should perform when the code at the breakpoint location is hit.
optional location = 2
Breakpoint source location.
string condition = 3
Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
repeated string expressions = 4
List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
string log_message_format = 14
Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
Breakpoint.LogLevel log_level = 15
Indicates the severity of the log. Only relevant when action is `LOG`.
bool is_final_state = 5
When true, indicates that this is a final result and the breakpoint state will not change from here on.
optional create_time = 11
Time this breakpoint was created by the server in seconds resolution.
optional final_time = 12
Time this breakpoint was finalized as seen by the server in seconds resolution.
string user_email = 16
E-mail address of the user that created this breakpoint
optional status = 10
Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
repeated stack_frames = 7
The stack at breakpoint time, where stack_frames[0] represents the most recently entered function.
repeated evaluated_expressions = 8
Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
repeated variable_table = 9
The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable.
map<string, string> labels = 17
A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
Actions that can be taken when a breakpoint hits. Agents should reject breakpoints with unsupported or unknown action values.
Used in: ,
CAPTURE = 0
Capture stack frame and variables and update the breakpoint. The data is only captured once. After that the breakpoint is set in a final state.
LOG = 1
Log each breakpoint hit. The breakpoint remains active until deleted or expired.
Log severity levels.
Used in:
INFO = 0
Information log message.
WARNING = 1
Warning log message.
ERROR = 2
Error log message.
message
data.proto:402Represents the debugged application. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. Agents attached to the same debuggee identify themselves as such by using exactly the same Debuggee message value when registering.
Used in: , ,
string id = 1
Unique identifier for the debuggee generated by the controller service.
string project = 2
Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project.
string uniquifier = 3
Uniquifier to further distinguish the application. It is possible that different applications might have identical values in the debuggee message, thus, incorrectly identified as a single application by the Controller service. This field adds salt to further distinguish the application. Agents should consider seeding this field with value that identifies the code, binary, configuration and environment.
string description = 4
Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
bool is_inactive = 5
If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped.
string agent_version = 6
Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`).
bool is_disabled = 7
If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
optional status = 8
Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status.
repeated source_contexts = 9
References to the locations and revisions of the source code used in the deployed application.
repeated ext_source_contexts = 13
References to the locations and revisions of the source code used in the deployed application.
map<string, string> labels = 11
A set of custom debuggee properties, populated by the agent, to be displayed to the user.
message
data.proto:34Represents a message with parameters.
Used in:
string format = 1
Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
repeated string parameters = 2
Optional parameters to be embedded into the message.
message
debugger.proto:151Wrapper message for `Breakpoint.Action`. Defines a filter on the action field of breakpoints.
Used in:
Breakpoint.Action value = 1
Only breakpoints with the specified action will pass the filter.
message
data.proto:91Represents a location in the source code.
Used in: ,
string path = 1
Path to the source file within the source context of the target binary.
int32 line = 2
Line inside the file. The first line in the file has the value `1`.
int32 column = 3
Column within a line. The first column in a line as the value `1`. Agents that do not support setting breakpoints on specific columns ignore this field.
message
data.proto:257Represents a stack frame context.
Used in:
string function = 1
Demangled function name at the call site.
optional location = 2
Source location of the call site.
repeated arguments = 3
Set of arguments passed to this function. Note that this might not be populated for all stack frames.
repeated locals = 4
Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
message
data.proto:55Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
Used in: , ,
bool is_error = 1
Distinguishes errors from informational messages.
StatusMessage.Reference refers_to = 2
Reference to which the message applies.
optional description = 3
Status message text.
Enumerates references to which the message applies.
Used in:
UNSPECIFIED = 0
Status doesn't refer to any particular input.
BREAKPOINT_SOURCE_LOCATION = 3
Status applies to the breakpoint and is related to its location.
BREAKPOINT_CONDITION = 4
Status applies to the breakpoint and is related to its condition.
BREAKPOINT_EXPRESSION = 7
Status applies to the breakpoint and is related to its expressions.
BREAKPOINT_AGE = 8
Status applies to the breakpoint and is related to its age.
VARIABLE_NAME = 5
Status applies to the entire variable.
VARIABLE_VALUE = 6
Status applies to variable value (variable name is valid).
message
data.proto:213Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
Used in: ,
string name = 1
Name of the variable, if any.
string value = 2
Simple value of the variable.
string type = 6
Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
repeated members = 3
Members contained or pointed to by the variable.
optional var_table_index = 4
Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
optional status = 5
Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`