Class: Google::Cloud::Trace::V2::TraceService::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Trace::V2::TraceService::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/trace/v2/trace_service/rest/client.rb
Overview
REST client for the TraceService service.
Service for collecting and viewing traces and spans within a trace.
A trace is a collection of spans corresponding to a single operation or a set of operations in an application.
A span is an individual timed event which forms a node of the trace tree. A single trace can contain spans from multiple services.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the TraceService Client class.
Instance Method Summary collapse
-
#batch_write_spans(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Batch writes new spans to new or existing traces.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the TraceService Client instance.
-
#create_span(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Trace::V2::Span
Creates a new span.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new TraceService REST client object.
-
#universe_domain ⇒ String
The effective universe domain.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new TraceService REST client object.
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 |
# File 'lib/google/cloud/trace/v2/trace_service/rest/client.rb', line 142 def initialize # 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.nil? || (@config.endpoint == Configuration::DEFAULT_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 = ::Google::Cloud::Trace::V2::TraceService::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the TraceService Client class.
See Configuration for a description of the configuration fields.
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 |
# File 'lib/google/cloud/trace/v2/trace_service/rest/client.rb', line 70 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Trace", "V2"] 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.batch_write_spans.timeout = 120.0 default_config.rpcs.batch_write_spans.retry_policy = { initial_delay: 0.1, max_delay: 30.0, multiplier: 2, retry_codes: [14, 4] } default_config.rpcs.create_span.timeout = 120.0 default_config.rpcs.create_span.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
#batch_write_spans(request, options = nil) ⇒ ::Google::Protobuf::Empty #batch_write_spans(name: nil, spans: nil) ⇒ ::Google::Protobuf::Empty
Batch writes new spans to new or existing traces. You cannot update existing spans.
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 |
# File 'lib/google/cloud/trace/v2/trace_service/rest/client.rb', line 223 def batch_write_spans request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Trace::V2::BatchWriteSpansRequest # 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.batch_write_spans..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V2::VERSION, transports_version_send: [:rest] [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.batch_write_spans.timeout, metadata: , retry_policy: @config.rpcs.batch_write_spans.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trace_service_stub.batch_write_spans request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#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.
112 113 114 115 |
# File 'lib/google/cloud/trace/v2/trace_service/rest/client.rb', line 112 def configure yield @config if block_given? @config end |
#create_span(request, options = nil) ⇒ ::Google::Cloud::Trace::V2::Span #create_span(name: nil, span_id: nil, parent_span_id: nil, display_name: nil, start_time: nil, end_time: nil, attributes: nil, stack_trace: nil, time_events: nil, links: nil, status: nil, same_process_as_parent_span: nil, child_span_count: nil, span_kind: nil) ⇒ ::Google::Cloud::Trace::V2::Span
Creates a new span.
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/google/cloud/trace/v2/trace_service/rest/client.rb', line 358 def create_span request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Trace::V2::Span # 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.create_span..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V2::VERSION, transports_version_send: [:rest] [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_span.timeout, metadata: , retry_policy: @config.rpcs.create_span.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trace_service_stub.create_span request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
122 123 124 |
# File 'lib/google/cloud/trace/v2/trace_service/rest/client.rb', line 122 def universe_domain @trace_service_stub.universe_domain end |