A client to Stackdriver Debugger API
The interfaces provided are listed below, along with usage samples.
Controller2Client
Service Description: The 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.
Sample for Controller2Client:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (Controller2Client controller2Client = Controller2Client.create()) {
Debuggee debuggee = Debuggee.newBuilder().build();
RegisterDebuggeeResponse response = controller2Client.registerDebuggee(debuggee);
}
Debugger2Client
Service Description: The 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.
Sample for Debugger2Client:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (Debugger2Client debugger2Client = Debugger2Client.create()) {
String debuggeeId = "debuggeeId-1833285553";
Breakpoint breakpoint = Breakpoint.newBuilder().build();
String clientVersion = "clientVersion771880589";
SetBreakpointResponse response =
debugger2Client.setBreakpoint(debuggeeId, breakpoint, clientVersion);
}
Classes
Controller2Client
Service Description: The 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.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (Controller2Client controller2Client = Controller2Client.create()) {
Debuggee debuggee = Debuggee.newBuilder().build();
RegisterDebuggeeResponse response = controller2Client.registerDebuggee(debuggee);
}
Note: close() needs to be called on the Controller2Client object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of Controller2Settings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
Controller2Settings controller2Settings =
Controller2Settings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
Controller2Client controller2Client = Controller2Client.create(controller2Settings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
Controller2Settings controller2Settings =
Controller2Settings.newBuilder().setEndpoint(myEndpoint).build();
Controller2Client controller2Client = Controller2Client.create(controller2Settings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
Controller2Settings controller2Settings = Controller2Settings.newHttpJsonBuilder().build();
Controller2Client controller2Client = Controller2Client.create(controller2Settings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Controller2Settings
Settings class to configure an instance of Controller2Client.
The default instance has everything set to sensible defaults:
- The default service address (clouddebugger.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of registerDebuggee to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
Controller2Settings.Builder controller2SettingsBuilder = Controller2Settings.newBuilder();
controller2SettingsBuilder
.registerDebuggeeSettings()
.setRetrySettings(
controller2SettingsBuilder
.registerDebuggeeSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
Controller2Settings controller2Settings = controller2SettingsBuilder.build();
Controller2Settings.Builder
Builder for Controller2Settings.
Debugger2Client
Service Description: The 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.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (Debugger2Client debugger2Client = Debugger2Client.create()) {
String debuggeeId = "debuggeeId-1833285553";
Breakpoint breakpoint = Breakpoint.newBuilder().build();
String clientVersion = "clientVersion771880589";
SetBreakpointResponse response =
debugger2Client.setBreakpoint(debuggeeId, breakpoint, clientVersion);
}
Note: close() needs to be called on the Debugger2Client object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of Debugger2Settings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
Debugger2Settings debugger2Settings =
Debugger2Settings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
Debugger2Client debugger2Client = Debugger2Client.create(debugger2Settings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
Debugger2Settings debugger2Settings =
Debugger2Settings.newBuilder().setEndpoint(myEndpoint).build();
Debugger2Client debugger2Client = Debugger2Client.create(debugger2Settings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
Debugger2Settings debugger2Settings = Debugger2Settings.newHttpJsonBuilder().build();
Debugger2Client debugger2Client = Debugger2Client.create(debugger2Settings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Debugger2Settings
Settings class to configure an instance of Debugger2Client.
The default instance has everything set to sensible defaults:
- The default service address (clouddebugger.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of setBreakpoint to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
Debugger2Settings.Builder debugger2SettingsBuilder = Debugger2Settings.newBuilder();
debugger2SettingsBuilder
.setBreakpointSettings()
.setRetrySettings(
debugger2SettingsBuilder
.setBreakpointSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
Debugger2Settings debugger2Settings = debugger2SettingsBuilder.build();
Debugger2Settings.Builder
Builder for Debugger2Settings.