Class: Google::Cloud::Debugger::V2::Controller2Client
- Inherits:
-
Object
- Object
- Google::Cloud::Debugger::V2::Controller2Client
- Defined in:
- lib/google/cloud/debugger/v2/controller2_client.rb
Overview
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.
Constant Summary collapse
- SERVICE_ADDRESS =
The default address of the service.
"clouddebugger.googleapis.com".freeze
- DEFAULT_SERVICE_PORT =
The default port of the service.
443
- DEFAULT_TIMEOUT =
30
- ALL_SCOPES =
The scopes needed to make gRPC calls to all of the methods defined in this service.
[ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud_debugger" ].freeze
Instance Attribute Summary collapse
Instance Method Summary collapse
-
#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ Controller2Client
constructor
A new instance of Controller2Client.
-
#list_active_breakpoints(debuggee_id, wait_token: nil, success_on_timeout: nil, options: nil) ⇒ Google::Devtools::Clouddebugger::V2::ListActiveBreakpointsResponse
Returns the list of all active breakpoints for the debuggee.
-
#register_debuggee(debuggee, options: nil) ⇒ Google::Devtools::Clouddebugger::V2::RegisterDebuggeeResponse
Registers the debuggee with the controller service.
-
#update_active_breakpoint(debuggee_id, breakpoint, options: nil) ⇒ Google::Devtools::Clouddebugger::V2::UpdateActiveBreakpointResponse
Updates the breakpoint state or mutable fields.
Constructor Details
#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ Controller2Client
Returns a new instance of Controller2Client
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/google/cloud/debugger/v2/controller2_client.rb', line 98 def initialize \ service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "" # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "google/gax/grpc" require "google/devtools/clouddebugger/v2/controller_services_pb" if app_name || app_version warn "`app_name` and `app_version` are no longer being used in the request headers." end google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } client_config_file = Pathname.new(__dir__).join( "controller2_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.devtools.clouddebugger.v2.Controller2", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, errors: Google::Gax::Grpc::API_ERRORS, kwargs: headers ) end @controller2_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, &Google::Devtools::Clouddebugger::V2::Controller2::Stub.method(:new) ) @register_debuggee = Google::Gax.create_api_call( @controller2_stub.method(:register_debuggee), defaults["register_debuggee"] ) @list_active_breakpoints = Google::Gax.create_api_call( @controller2_stub.method(:list_active_breakpoints), defaults["list_active_breakpoints"] ) @update_active_breakpoint = Google::Gax.create_api_call( @controller2_stub.method(:update_active_breakpoint), defaults["update_active_breakpoint"] ) end |
Instance Attribute Details
#controller2_stub ⇒ Google::Devtools::Clouddebugger::V2::Controller2::Stub (readonly)
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/google/cloud/debugger/v2/controller2_client.rb', line 59 class Controller2Client attr_reader :controller2_stub # The default address of the service. SERVICE_ADDRESS = "clouddebugger.googleapis.com".freeze # The default port of the service. DEFAULT_SERVICE_PORT = 443 DEFAULT_TIMEOUT = 30 # The scopes needed to make gRPC calls to all of the methods defined in # this service. ALL_SCOPES = [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud_debugger" ].freeze # @param service_path [String] # The domain name of the API remote host. # @param port [Integer] # The port on which to connect to the remote host. # @param channel [Channel] # A Channel object through which to make calls. # @param chan_creds [Grpc::ChannelCredentials] # A ChannelCredentials for the setting up the RPC client. # @param updater_proc [Proc] # A function that transforms the metadata for requests, e.g., to give # OAuth credentials. # @param scopes [Array<String>] # The OAuth scopes for this service. This parameter is ignored if # an updater_proc is supplied. # @param client_config[Hash] # A Hash for call options for each method. See # Google::Gax#construct_settings for the structure of # this data. Falls back to the default config if not specified # or the specified config is missing data points. # @param timeout [Numeric] # The default timeout, in seconds, for calls made through this client. def initialize \ service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "" # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "google/gax/grpc" require "google/devtools/clouddebugger/v2/controller_services_pb" if app_name || app_version warn "`app_name` and `app_version` are no longer being used in the request headers." end google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } client_config_file = Pathname.new(__dir__).join( "controller2_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.devtools.clouddebugger.v2.Controller2", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, errors: Google::Gax::Grpc::API_ERRORS, kwargs: headers ) end @controller2_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, &Google::Devtools::Clouddebugger::V2::Controller2::Stub.method(:new) ) @register_debuggee = Google::Gax.create_api_call( @controller2_stub.method(:register_debuggee), defaults["register_debuggee"] ) @list_active_breakpoints = Google::Gax.create_api_call( @controller2_stub.method(:list_active_breakpoints), defaults["list_active_breakpoints"] ) @update_active_breakpoint = Google::Gax.create_api_call( @controller2_stub.method(:update_active_breakpoint), defaults["update_active_breakpoint"] ) end # Service calls # Registers the debuggee with the controller service. # # All agents attached to the same application should call this method with # 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 allows the controller service to disable the agent or recover from any # data loss. If the debuggee is disabled by the server, the response will # have +is_disabled+ set to +true+. # # @param debuggee [Google::Devtools::Clouddebugger::V2::Debuggee] # Debuggee information to register. # The fields +project+, +uniquifier+, +description+ and +agent_version+ # of the debuggee must be set. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Devtools::Clouddebugger::V2::RegisterDebuggeeResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/debugger/v2" # # Controller2Client = Google::Cloud::Debugger::V2::Controller2Client # Debuggee = Google::Devtools::Clouddebugger::V2::Debuggee # # controller2_client = Controller2Client.new # debuggee = Debuggee.new # response = controller2_client.register_debuggee(debuggee) def register_debuggee \ debuggee, options: nil req = Google::Devtools::Clouddebugger::V2::RegisterDebuggeeRequest.new({ debuggee: debuggee }.delete_if { |_, v| v.nil? }) @register_debuggee.call(req, ) end # Returns the list of all active breakpoints for the debuggee. # # The breakpoint specification (location, condition, and expression # 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. # # @param debuggee_id [String] # Identifies the debuggee. # @param wait_token [String] # A wait 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 last returned response. # @param success_on_timeout [true, false] # If set to +true+, returns +google.rpc.Code.OK+ status and sets the # +wait_expired+ response field to +true+ when the server-selected timeout # has expired (recommended). # # If set to +false+, returns +google.rpc.Code.ABORTED+ status when the # server-selected timeout has expired (deprecated). # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Devtools::Clouddebugger::V2::ListActiveBreakpointsResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/debugger/v2" # # Controller2Client = Google::Cloud::Debugger::V2::Controller2Client # # controller2_client = Controller2Client.new # debuggee_id = '' # response = controller2_client.list_active_breakpoints(debuggee_id) def list_active_breakpoints \ debuggee_id, wait_token: nil, success_on_timeout: nil, options: nil req = Google::Devtools::Clouddebugger::V2::ListActiveBreakpointsRequest.new({ debuggee_id: debuggee_id, wait_token: wait_token, success_on_timeout: success_on_timeout }.delete_if { |_, v| v.nil? }) @list_active_breakpoints.call(req, ) end # 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 +expression+ 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. # # @param debuggee_id [String] # Identifies the debuggee being debugged. # @param breakpoint [Google::Devtools::Clouddebugger::V2::Breakpoint] # Updated breakpoint information. # The field 'id' must be set. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Devtools::Clouddebugger::V2::UpdateActiveBreakpointResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/debugger/v2" # # Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint # Controller2Client = Google::Cloud::Debugger::V2::Controller2Client # # controller2_client = Controller2Client.new # debuggee_id = '' # breakpoint = Breakpoint.new # response = controller2_client.update_active_breakpoint(debuggee_id, breakpoint) def update_active_breakpoint \ debuggee_id, breakpoint, options: nil req = Google::Devtools::Clouddebugger::V2::UpdateActiveBreakpointRequest.new({ debuggee_id: debuggee_id, breakpoint: breakpoint }.delete_if { |_, v| v.nil? }) @update_active_breakpoint.call(req, ) end end |
Instance Method Details
#list_active_breakpoints(debuggee_id, wait_token: nil, success_on_timeout: nil, options: nil) ⇒ Google::Devtools::Clouddebugger::V2::ListActiveBreakpointsResponse
Returns the list of all active breakpoints for the debuggee.
The breakpoint specification (location, condition, and expression 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.
249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/google/cloud/debugger/v2/controller2_client.rb', line 249 def list_active_breakpoints \ debuggee_id, wait_token: nil, success_on_timeout: nil, options: nil req = Google::Devtools::Clouddebugger::V2::ListActiveBreakpointsRequest.new({ debuggee_id: debuggee_id, wait_token: wait_token, success_on_timeout: success_on_timeout }.delete_if { |_, v| v.nil? }) @list_active_breakpoints.call(req, ) end |
#register_debuggee(debuggee, options: nil) ⇒ Google::Devtools::Clouddebugger::V2::RegisterDebuggeeResponse
Registers the debuggee with the controller service.
All agents attached to the same application should call this method with 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 allows the controller service to disable the agent or recover from any data loss. If the debuggee is disabled by the server, the response will have +is_disabled+ set to +true+.
199 200 201 202 203 204 205 206 |
# File 'lib/google/cloud/debugger/v2/controller2_client.rb', line 199 def register_debuggee \ debuggee, options: nil req = Google::Devtools::Clouddebugger::V2::RegisterDebuggeeRequest.new({ debuggee: debuggee }.delete_if { |_, v| v.nil? }) @register_debuggee.call(req, ) end |
#update_active_breakpoint(debuggee_id, breakpoint, options: nil) ⇒ Google::Devtools::Clouddebugger::V2::UpdateActiveBreakpointResponse
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 +expression+ 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.
293 294 295 296 297 298 299 300 301 302 |
# File 'lib/google/cloud/debugger/v2/controller2_client.rb', line 293 def update_active_breakpoint \ debuggee_id, breakpoint, options: nil req = Google::Devtools::Clouddebugger::V2::UpdateActiveBreakpointRequest.new({ debuggee_id: debuggee_id, breakpoint: breakpoint }.delete_if { |_, v| v.nil? }) @update_active_breakpoint.call(req, ) end |