Cloud Trace V1 API - Class Google::Cloud::Trace::V1::TraceService::Client (v1.2.0)

Reference documentation and code samples for the Cloud Trace V1 API class Google::Cloud::Trace::V1::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. Spans for a single trace may span multiple services.

Inherits

Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the TraceService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#get_trace

def get_trace(request, options = nil) -> ::Google::Cloud::Trace::V1::Trace
def get_trace(project_id: nil, trace_id: nil) -> ::Google::Cloud::Trace::V1::Trace

Gets a single trace by its ID.

Overloads

def get_trace(request, options = nil) -> ::Google::Cloud::Trace::V1::Trace

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

Parameters

request (::Google::Cloud::Trace::V1::GetTraceRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_trace(project_id: nil, trace_id: nil) -> ::Google::Cloud::Trace::V1::Trace

Pass arguments to get_trace 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

project_id (::String) — Required. ID of the Cloud project where the trace data is stored.
trace_id (::String) — Required. ID of the trace to return.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Trace::V1::Trace)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Trace::V1::Trace)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/trace/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Trace::V1::TraceService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Trace::V1::GetTraceRequest.new

# Call the get_trace method.
result = client.get_trace request

# The returned object is of type Google::Cloud::Trace::V1::Trace.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new TraceService client object.

Yields

(config) — Configure the TraceService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

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

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

#list_traces

def list_traces(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Trace::V1::Trace>
def 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.

Overloads

def list_traces(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Trace::V1::Trace>

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

Parameters

request (::Google::Cloud::Trace::V1::ListTracesRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

Pass arguments to list_traces 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

project_id (::String) — Required. ID of the Cloud project where the trace data is stored.
view (::Google::Cloud::Trace::V1::ListTracesRequest::ViewType) — Optional. Type of data returned for traces in the list. Default is MINIMAL.
page_size (::Integer) — Optional. Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size.
page_token (::String) — Token identifying the page of results to return. If provided, use the value of the next_page_token field from a previous request.
start_time (::Google::Protobuf::Timestamp, ::Hash) — Start of the time interval (inclusive) during which the trace data was collected from the application.
end_time (::Google::Protobuf::Timestamp, ::Hash) — End of the time interval (inclusive) during which the trace data was collected from the application.
filter (::String) —
Optional. A filter against labels for the request.

By default, searches use prefix matching. To specify exact match, prepend a plus symbol (+) to the search term. Multiple terms are ANDed. Syntax:
- root:NAME_PREFIX or NAME_PREFIX: Return traces where any root span starts with NAME_PREFIX.
- +root:NAME or +NAME: Return traces where any root span's name is exactly NAME.
- span:NAME_PREFIX: Return traces where any span starts with NAME_PREFIX.
- +span:NAME: Return traces where any span's name is exactly NAME.
- latency:DURATION: Return traces whose overall latency is greater or equal to than DURATION. Accepted units are nanoseconds (ns), milliseconds (ms), and seconds (s). Default is ms. For example, latency:24ms returns traces whose overall latency is greater than or equal to 24 milliseconds.
- label:LABEL_KEY: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values).
- LABEL_KEY:VALUE_PREFIX: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with VALUE_PREFIX. Both a key and a value must be specified.
- +LABEL_KEY:VALUE: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified.
- method:VALUE: Equivalent to /http/method:VALUE.
- url:VALUE: Equivalent to /http/url:VALUE.
order_by (::String) — Optional. Field used to sort the returned traces. Can be one of the following:
- trace_id
- name (name field of root span in the trace)
- duration (difference between end_time and start_time fields of the root span)
- start (start_time field of the root span)
Descending order can be specified by appending desc to the sort field (for example, name desc).

Only one sort field is permitted.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Trace::V1::Trace>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Trace::V1::Trace>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/trace/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Trace::V1::TraceService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Trace::V1::ListTracesRequest.new

# Call the list_traces method.
result = client.list_traces request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Trace::V1::Trace.
  p item
end

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns

(Logger)

#patch_traces

def patch_traces(request, options = nil) -> ::Google::Protobuf::Empty
def 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.

Overloads

def patch_traces(request, options = nil) -> ::Google::Protobuf::Empty

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

Parameters

request (::Google::Cloud::Trace::V1::PatchTracesRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def patch_traces(project_id: nil, traces: nil) -> ::Google::Protobuf::Empty

Pass arguments to patch_traces 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

project_id (::String) — Required. ID of the Cloud project where the trace data is stored.
traces (::Google::Cloud::Trace::V1::Traces, ::Hash) — Required. The body of the message.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/trace/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Trace::V1::TraceService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Trace::V1::PatchTracesRequest.new

# Call the patch_traces method.
result = client.patch_traces request

# The returned object is of type Google::Protobuf::Empty.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)