Class: Google::Cloud::Debugger::V2::Debugger2Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/debugger/v2/debugger2_client.rb

Overview

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.

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: "") ⇒ Debugger2Client

Returns a new instance of Debugger2Client

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.



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

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/debugger_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(
    "debugger2_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.devtools.clouddebugger.v2.Debugger2",
      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
  @debugger2_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::Debugger2::Stub.method(:new)
  )

  @set_breakpoint = Google::Gax.create_api_call(
    @debugger2_stub.method(:set_breakpoint),
    defaults["set_breakpoint"],
    exception_transformer: exception_transformer
  )
  @get_breakpoint = Google::Gax.create_api_call(
    @debugger2_stub.method(:get_breakpoint),
    defaults["get_breakpoint"],
    exception_transformer: exception_transformer
  )
  @delete_breakpoint = Google::Gax.create_api_call(
    @debugger2_stub.method(:delete_breakpoint),
    defaults["delete_breakpoint"],
    exception_transformer: exception_transformer
  )
  @list_breakpoints = Google::Gax.create_api_call(
    @debugger2_stub.method(:list_breakpoints),
    defaults["list_breakpoints"],
    exception_transformer: exception_transformer
  )
  @list_debuggees = Google::Gax.create_api_call(
    @debugger2_stub.method(:list_debuggees),
    defaults["list_debuggees"],
    exception_transformer: exception_transformer
  )
end

Instance Method Details

#delete_breakpoint(debuggee_id, breakpoint_id, client_version, options: nil) {|result, operation| ... } ⇒ Object

Deletes the breakpoint from the debuggee.

Examples:

require "google/cloud/debugger/v2"

debugger2_client = Google::Cloud::Debugger::V2::Debugger2.new

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

# TODO: Initialize +breakpoint_id+:
breakpoint_id = ''

# TODO: Initialize +client_version+:
client_version = ''
debugger2_client.delete_breakpoint(debuggee_id, breakpoint_id, client_version)

Parameters:

  • debuggee_id (String) —

    ID of the debuggee whose breakpoint to delete.

  • breakpoint_id (String) —

    ID of the breakpoint to delete.

  • client_version (String) —

    The client version making the call. Schema: +domain/type/version+ (e.g., +google.com/intellij/v1+).

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

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/google/cloud/debugger/v2/debugger2_client.rb', line 331

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

#get_breakpoint(debuggee_id, breakpoint_id, client_version, options: nil) {|result, operation| ... } ⇒ Google::Devtools::Clouddebugger::V2::GetBreakpointResponse

Gets breakpoint information.

Examples:

require "google/cloud/debugger/v2"

debugger2_client = Google::Cloud::Debugger::V2::Debugger2.new

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

# TODO: Initialize +breakpoint_id+:
breakpoint_id = ''

# TODO: Initialize +client_version+:
client_version = ''
response = debugger2_client.get_breakpoint(debuggee_id, breakpoint_id, client_version)

Parameters:

  • debuggee_id (String) —

    ID of the debuggee whose breakpoint to get.

  • breakpoint_id (String) —

    ID of the breakpoint to get.

  • client_version (String) —

    The client version making the call. Schema: +domain/type/version+ (e.g., +google.com/intellij/v1+).

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/google/cloud/debugger/v2/debugger2_client.rb', line 285

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

#list_breakpoints(debuggee_id, client_version, include_all_users: nil, include_inactive: nil, action: nil, strip_results: nil, wait_token: nil, options: nil) {|result, operation| ... } ⇒ Google::Devtools::Clouddebugger::V2::ListBreakpointsResponse

Lists all breakpoints for the debuggee.

Examples:

require "google/cloud/debugger/v2"

debugger2_client = Google::Cloud::Debugger::V2::Debugger2.new

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

# TODO: Initialize +client_version+:
client_version = ''
response = debugger2_client.list_breakpoints(debuggee_id, client_version)

Parameters:

  • debuggee_id (String) —

    ID of the debuggee whose breakpoints to list.

  • client_version (String) —

    The client version making the call. Schema: +domain/type/version+ (e.g., +google.com/intellij/v1+).

  • include_all_users (true, false) —

    When set to +true+, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller.

  • include_inactive (true, false) —

    When set to +true+, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints.

  • action (Google::Devtools::Clouddebugger::V2::ListBreakpointsRequest::BreakpointActionValue | Hash) —

    When set, the response includes only breakpoints with the specified action. A hash of the same form as Google::Devtools::Clouddebugger::V2::ListBreakpointsRequest::BreakpointActionValue can also be provided.

  • strip_results (true, false) —

    This field is deprecated. The following fields are always stripped out of the result: +stack_frames+, +evaluated_expressions+ and +variable_table+.

  • wait_token (String) —

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

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



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/google/cloud/debugger/v2/debugger2_client.rb', line 393

def list_breakpoints \
    debuggee_id,
    client_version,
    include_all_users: nil,
    include_inactive: nil,
    action: nil,
    strip_results: nil,
    wait_token: nil,
    options: nil,
    &block
  req = {
    debuggee_id: debuggee_id,
    client_version: client_version,
    include_all_users: include_all_users,
    include_inactive: include_inactive,
    action: action,
    strip_results: strip_results,
    wait_token: wait_token
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Devtools::Clouddebugger::V2::ListBreakpointsRequest)
  @list_breakpoints.call(req, options, &block)
end

#list_debuggees(project, client_version, include_inactive: nil, options: nil) {|result, operation| ... } ⇒ Google::Devtools::Clouddebugger::V2::ListDebuggeesResponse

Lists all the debuggees that the user has access to.

Examples:

require "google/cloud/debugger/v2"

debugger2_client = Google::Cloud::Debugger::V2::Debugger2.new

# TODO: Initialize +project+:
project = ''

# TODO: Initialize +client_version+:
client_version = ''
response = debugger2_client.list_debuggees(project, client_version)

Parameters:

  • project (String) —

    Project number of a Google Cloud project whose debuggees to list.

  • client_version (String) —

    The client version making the call. Schema: +domain/type/version+ (e.g., +google.com/intellij/v1+).

  • include_inactive (true, false) —

    When set to +true+, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.

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



446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/google/cloud/debugger/v2/debugger2_client.rb', line 446

def list_debuggees \
    project,
    client_version,
    include_inactive: nil,
    options: nil,
    &block
  req = {
    project: project,
    client_version: client_version,
    include_inactive: include_inactive
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Devtools::Clouddebugger::V2::ListDebuggeesRequest)
  @list_debuggees.call(req, options, &block)
end

#set_breakpoint(debuggee_id, breakpoint, client_version, options: nil) {|result, operation| ... } ⇒ Google::Devtools::Clouddebugger::V2::SetBreakpointResponse

Sets the breakpoint to the debuggee.

Examples:

require "google/cloud/debugger/v2"

debugger2_client = Google::Cloud::Debugger::V2::Debugger2.new

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

# TODO: Initialize +breakpoint+:
breakpoint = {}

# TODO: Initialize +client_version+:
client_version = ''
response = debugger2_client.set_breakpoint(debuggee_id, breakpoint, client_version)

Parameters:

  • debuggee_id (String) —

    ID of the debuggee where the breakpoint is to be set.

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

    Breakpoint specification to set. The field +location+ of the breakpoint must be set. A hash of the same form as Google::Devtools::Clouddebugger::V2::Breakpoint can also be provided.

  • client_version (String) —

    The client version making the call. Schema: +domain/type/version+ (e.g., +google.com/intellij/v1+).

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/google/cloud/debugger/v2/debugger2_client.rb', line 238

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