class Google::Cloud::Trace::V2::TraceService::Client

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.

Attributes

trace_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the TraceService Client class.

See {::Google::Cloud::Trace::V2::TraceService::Client::Configuration} for a description of the configuration fields.

@example

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

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# 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
new() { |config| ... } click to toggle source

Create a new TraceService client object.

@example

# 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

@yield [config] Configure the TraceService client. @yieldparam config [Client::Configuration]

# 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

Public Instance Methods

batch_write_spans(request, options = nil) { |response, operation| ... } click to toggle source

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

@overload batch_write_spans(request, options = nil)

Pass arguments to `batch_write_spans` via a request object, either of type
{::Google::Cloud::Trace::V2::BatchWriteSpansRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload batch_write_spans(name: nil, spans: nil)

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

@param name [::String]
  Required. The name of the project where the spans belong. The format is
  `projects/[PROJECT_ID]`.
@param spans [::Array<::Google::Cloud::Trace::V2::Span, ::Hash>]
  Required. A list of new spans. The span names must not match existing
  spans, or the results are undefined.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Protobuf::Empty]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# 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
  metadata = @config.rpcs.batch_write_spans.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         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| ... } click to toggle source

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 {Client.configure}.

See {::Google::Cloud::Trace::V2::TraceService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# 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) { |response, operation| ... } click to toggle source

Creates a new span.

@overload create_span(request, options = nil)

Pass arguments to `create_span` via a request object, either of type
{::Google::Cloud::Trace::V2::Span} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload 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)

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

@param name [::String]
  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.
@param span_id [::String]
  Required. The [SPAN_ID] portion of the span's resource name.
@param parent_span_id [::String]
  The [SPAN_ID] of this span's parent span. If this is a root span,
  then this field must be empty.
@param display_name [::Google::Cloud::Trace::V2::TruncatableString, ::Hash]
  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.
@param start_time [::Google::Protobuf::Timestamp, ::Hash]
  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.
@param end_time [::Google::Protobuf::Timestamp, ::Hash]
  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.
@param attributes [::Google::Cloud::Trace::V2::Span::Attributes, ::Hash]
  A set of attributes on the span. You can have up to 32 attributes per
  span.
@param stack_trace [::Google::Cloud::Trace::V2::StackTrace, ::Hash]
  Stack trace captured at the start of the span.
@param time_events [::Google::Cloud::Trace::V2::Span::TimeEvents, ::Hash]
  A set of time events. You can have up to 32 annotations and 128 message
  events per span.
@param links [::Google::Cloud::Trace::V2::Span::Links, ::Hash]
  Links associated with the span. You can have up to 128 links per Span.
@param status [::Google::Rpc::Status, ::Hash]
  Optional. The final status for this span.
@param same_process_as_parent_span [::Google::Protobuf::BoolValue, ::Hash]
  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.
@param child_span_count [::Google::Protobuf::Int32Value, ::Hash]
  Optional. The number of child spans that were generated while this span
  was active. If set, allows implementation to detect missing child spans.
@param span_kind [::Google::Cloud::Trace::V2::Span::SpanKind]
  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.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Trace::V2::Span] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Trace::V2::Span]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# 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
  metadata = @config.rpcs.create_span.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"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("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         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