Class: Google::Cloud::Trace::V2::TraceService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/trace/v2/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. A single trace may contain span(s) from multiple services.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#project_path, #span_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new TraceService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Trace::V2::TraceService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Trace::V2::TraceService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the TraceService client.

Yield Parameters:


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
# File 'lib/google/cloud/trace/v2/trace_service/client.rb', line 120

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/v2/tracing_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::V2::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.

Examples:


# Modify the configuration for all TraceService clients
::Google::Cloud::Trace::V2::TraceService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/google/cloud/trace/v2/trace_service/client.rb', line 60

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

Sends new spans to new or existing traces. You cannot update existing spans.

Overloads:

  • #batch_write_spans(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to batch_write_spans via a request object, either of type BatchWriteSpansRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Trace::V2::BatchWriteSpansRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

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

  • #batch_write_spans(name: nil, spans: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to batch_write_spans via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil)

      Required. The name of the project where the spans belong. The format is projects/[PROJECT_ID].

    • spans (::Array<::Google::Cloud::Trace::V2::Span, ::Hash>) (defaults to: nil)

      Required. A list of new spans. The span names must not match existing spans, or the results are undefined.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.


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
# File 'lib/google/cloud/trace/v2/trace_service/client.rb', line 192

def batch_write_spans request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.batch_write_spans..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::V2::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_write_spans.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.batch_write_spans.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @trace_service_stub.call_rpc :batch_write_spans, request, options: 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

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

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:


99
100
101
102
# File 'lib/google/cloud/trace/v2/trace_service/client.rb', line 99

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.

Overloads:

  • #create_span(request, options = nil) ⇒ ::Google::Cloud::Trace::V2::Span

    Pass arguments to create_span via a request object, either of type Span or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Trace::V2::Span, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

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

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

    Pass arguments to create_span via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil)

      Required. The resource name of the span in the following format:

      projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
      

      [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.

      [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.

    • span_id (::String) (defaults to: nil)

      Required. The [SPAN_ID] portion of the span's resource name.

    • parent_span_id (::String) (defaults to: nil)

      The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.

    • display_name (::Google::Cloud::Trace::V2::TruncatableString, ::Hash) (defaults to: nil)

      Required. A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.

    • start_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil)

      Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.

    • end_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil)

      Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.

    • attributes (::Google::Cloud::Trace::V2::Span::Attributes, ::Hash) (defaults to: nil)

      A set of attributes on the span. You can have up to 32 attributes per span.

    • stack_trace (::Google::Cloud::Trace::V2::StackTrace, ::Hash) (defaults to: nil)

      Stack trace captured at the start of the span.

    • time_events (::Google::Cloud::Trace::V2::Span::TimeEvents, ::Hash) (defaults to: nil)

      A set of time events. You can have up to 32 annotations and 128 message events per span.

    • links (::Google::Cloud::Trace::V2::Span::Links, ::Hash) (defaults to: nil)

      Links associated with the span. You can have up to 128 links per Span.

    • status (::Google::Rpc::Status, ::Hash) (defaults to: nil)

      Optional. The final status for this span.

    • same_process_as_parent_span (::Google::Protobuf::BoolValue, ::Hash) (defaults to: nil)

      Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information.

    • child_span_count (::Google::Protobuf::Int32Value, ::Hash) (defaults to: nil)

      Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.

    • span_kind (::Google::Cloud::Trace::V2::Span::SpanKind) (defaults to: nil)

      Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using CLIENT (caller) and SERVER (callee) to identify an RPC call.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.


313
314
315
316
317
318
319
320
321
322
323
324
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
# File 'lib/google/cloud/trace/v2/trace_service/client.rb', line 313

def create_span request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.create_span..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::V2::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_span.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.create_span.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @trace_service_stub.call_rpc :create_span, request, options: 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