Class: Google::Cloud::Debugger::V2::Controller2Client

Inherits:
Object
  • Object
show all
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
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
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 Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ Controller2Client

Returns a new instance of Controller2Client

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • 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.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



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
 
# File 'lib/google/cloud/debugger/v2/controller2_client.rb', line 110

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: 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"

  credentials ||= Google::Cloud::Debugger::V2::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Debugger::V2::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-debugger'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  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,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @controller2_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Devtools::Clouddebugger::V2::Controller2::Stub.method(:new)
  )

  @register_debuggee = Google::Gax.create_api_call(
    @controller2_stub.method(:register_debuggee),
    defaults["register_debuggee"],
    exception_transformer: exception_transformer
  )
  @list_active_breakpoints = Google::Gax.create_api_call(
    @controller2_stub.method(:list_active_breakpoints),
    defaults["list_active_breakpoints"],
    exception_transformer: exception_transformer
  )
  @update_active_breakpoint = Google::Gax.create_api_call(
    @controller2_stub.method(:update_active_breakpoint),
    defaults["update_active_breakpoint"],
    exception_transformer: exception_transformer
  )
end

Instance Method Details

#list_active_breakpoints(debuggee_id, wait_token: nil, success_on_timeout: nil, options: nil) {|result, operation| ... } ⇒ Google::Devtools::Clouddebugger::V2::ListActiveBreakpointsResponse

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.

Examples:

require "google/cloud/debugger/v2"

controller2_client = Google::Cloud::Debugger::V2::Controller2.new

# TODO: Initialize +debuggee_id+:
debuggee_id = ''
response = controller2_client.list_active_breakpoints(debuggee_id)

Parameters:

  • debuggee_id (String) —

    Identifies the debuggee.

  • wait_token (String) —

    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"+.

  • success_on_timeout (true, false) —

    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.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/google/cloud/debugger/v2/controller2_client.rb', line 292

def list_active_breakpoints \
    debuggee_id,
    wait_token: nil,
    success_on_timeout: nil,
    options: nil,
    &block
  req = {
    debuggee_id: debuggee_id,
    wait_token: wait_token,
    success_on_timeout: success_on_timeout
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Devtools::Clouddebugger::V2::ListActiveBreakpointsRequest)
  @list_active_breakpoints.call(req, options, &block)
end

#register_debuggee(debuggee, options: nil) {|result, operation| ... } ⇒ Google::Devtools::Clouddebugger::V2::RegisterDebuggeeResponse

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 +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.

Examples:

require "google/cloud/debugger/v2"

controller2_client = Google::Cloud::Debugger::V2::Controller2.new

# TODO: Initialize +debuggee+:
debuggee = {}
response = controller2_client.register_debuggee(debuggee)

Parameters:

  • debuggee (Google::Devtools::Clouddebugger::V2::Debuggee | Hash) —

    Debuggee information to register. The fields +project+, +uniquifier+, +description+ and +agent_version+ of the debuggee must be set. A hash of the same form as Google::Devtools::Clouddebugger::V2::Debuggee can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/google/cloud/debugger/v2/controller2_client.rb', line 236

def register_debuggee \
    debuggee,
    options: nil,
    &block
  req = {
    debuggee: debuggee
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Devtools::Clouddebugger::V2::RegisterDebuggeeRequest)
  @register_debuggee.call(req, options, &block)
end

#update_active_breakpoint(debuggee_id, breakpoint, options: nil) {|result, operation| ... } ⇒ 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 +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.

Examples:

require "google/cloud/debugger/v2"

controller2_client = Google::Cloud::Debugger::V2::Controller2.new

# TODO: Initialize +debuggee_id+:
debuggee_id = ''

# TODO: Initialize +breakpoint+:
breakpoint = {}
response = controller2_client.update_active_breakpoint(debuggee_id, breakpoint)

Parameters:

  • debuggee_id (String) —

    Identifies the debuggee being debugged.

  • breakpoint (Google::Devtools::Clouddebugger::V2::Breakpoint | Hash) —

    Updated breakpoint information. The field +id+ must be set. The agent must echo all Breakpoint specification fields in the update. A hash of the same form as Google::Devtools::Clouddebugger::V2::Breakpoint can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/google/cloud/debugger/v2/controller2_client.rb', line 344

def update_active_breakpoint \
    debuggee_id,
    breakpoint,
    options: nil,
    &block
  req = {
    debuggee_id: debuggee_id,
    breakpoint: breakpoint
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Devtools::Clouddebugger::V2::UpdateActiveBreakpointRequest)
  @update_active_breakpoint.call(req, options, &block)
end