Class: Google::Cloud::Trace::V1::TraceService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Trace::V1::TraceService::Client
- Defined in:
- lib/google/cloud/trace/v1/trace_service/client.rb
Overview
Client for the TraceService service.
This file describes an API for collecting and viewing traces and spans within a trace. A Trace is a collection of spans corresponding to a single operation or set of operations for an application. A span is an individual timed event which forms a node of the trace tree. Spans for a single trace may span multiple services.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the TraceService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the TraceService Client instance.
-
#get_trace(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Trace::V1::Trace
Gets a single trace by its ID.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new TraceService client object.
-
#list_traces(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Trace::V1::Trace>
Returns of a list of traces that match the specified filter conditions.
-
#patch_traces(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Sends new traces to Stackdriver Trace or updates existing traces.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new TraceService client object.
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 |
# File 'lib/google/cloud/trace/v1/trace_service/client.rb', line 126 def initialize # 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 "gapic/grpc" require "google/devtools/cloudtrace/v1/trace_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @trace_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Trace::V1::TraceService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the TraceService Client class.
See Configuration for a description of the configuration fields.
58 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 |
# File 'lib/google/cloud/trace/v1/trace_service/client.rb', line 58 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Trace", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.list_traces.timeout = 45.0 default_config.rpcs.list_traces.retry_policy = { initial_delay: 0.1, max_delay: 1.0, multiplier: 1.2, retry_codes: [14, 4] } default_config.rpcs.get_trace.timeout = 45.0 default_config.rpcs.get_trace.retry_policy = { initial_delay: 0.1, max_delay: 1.0, multiplier: 1.2, retry_codes: [14, 4] } default_config.rpcs.patch_traces.timeout = 45.0 default_config.rpcs.patch_traces.retry_policy = { initial_delay: 0.1, max_delay: 1.0, multiplier: 1.2, retry_codes: [14, 4] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the TraceService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
105 106 107 108 |
# File 'lib/google/cloud/trace/v1/trace_service/client.rb', line 105 def configure yield @config if block_given? @config end |
#get_trace(request, options = nil) ⇒ ::Google::Cloud::Trace::V1::Trace #get_trace(project_id: nil, trace_id: nil) ⇒ ::Google::Cloud::Trace::V1::Trace
Gets a single trace by its ID.
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 |
# File 'lib/google/cloud/trace/v1/trace_service/client.rb', line 325 def get_trace request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Trace::V1::GetTraceRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_trace..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Trace::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id, "trace_id" => request.trace_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_trace.timeout, metadata: , retry_policy: @config.rpcs.get_trace.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trace_service_stub.call_rpc :get_trace, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_traces(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Trace::V1::Trace> #list_traces(project_id: nil, view: nil, page_size: nil, page_token: nil, start_time: nil, end_time: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Trace::V1::Trace>
Returns of a list of traces that match the specified filter conditions.
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 |
# File 'lib/google/cloud/trace/v1/trace_service/client.rb', line 254 def list_traces request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Trace::V1::ListTracesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_traces..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Trace::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_traces.timeout, metadata: , retry_policy: @config.rpcs.list_traces.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trace_service_stub.call_rpc :list_traces, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @trace_service_stub, :list_traces, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#patch_traces(request, options = nil) ⇒ ::Google::Protobuf::Empty #patch_traces(project_id: nil, traces: nil) ⇒ ::Google::Protobuf::Empty
Sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 |
# File 'lib/google/cloud/trace/v1/trace_service/client.rb', line 400 def patch_traces request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Trace::V1::PatchTracesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.patch_traces..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Trace::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.patch_traces.timeout, metadata: , retry_policy: @config.rpcs.patch_traces.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trace_service_stub.call_rpc :patch_traces, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |