Class: Google::Apis::TracingV1::TracingService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/tracing_v1/service.rb

Overview

Google Tracing API

Send and retrieve trace data from Google Stackdriver Trace.

Examples:

require 'google/apis/tracing_v1'

Tracing = Google::Apis::TracingV1 # Alias the module
service = Tracing::TracingService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ TracingService

Returns a new instance of TracingService



45
46
47
48
 
# File 'generated/google/apis/tracing_v1/service.rb', line 45

def initialize
  super('https://tracing.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/tracing_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/tracing_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#batch_trace_update_spans(parent, batch_update_spans_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TracingV1::Empty

Sends new spans to Stackdriver Trace or updates existing spans. If the name 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 name does not match, a new trace is created with given set of spans.

Parameters:

  • parent (String) —

    ID of the Cloud project where the trace data is stored.

  • batch_update_spans_request_object (Google::Apis::TracingV1::BatchUpdateSpansRequest) (defaults to: nil)
  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



170
171
172
173
174
175
176
177
178
179
180
 
# File 'generated/google/apis/tracing_v1/service.rb', line 170

def batch_trace_update_spans(parent, batch_update_spans_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}/traces:batchUpdate', options)
  command.request_representation = Google::Apis::TracingV1::BatchUpdateSpansRequest::Representation
  command.request_object = batch_update_spans_request_object
  command.response_representation = Google::Apis::TracingV1::Empty::Representation
  command.response_class = Google::Apis::TracingV1::Empty
  command.params['parent'] = parent unless parent.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_project_trace(name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TracingV1::Trace

Returns a specific trace.

Parameters:

  • name (String) —

    ID of the trace. Format is projects/PROJECT_ID/traces/TRACE_ID.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



135
136
137
138
139
140
141
142
143
 
# File 'generated/google/apis/tracing_v1/service.rb', line 135

def get_project_trace(name, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::TracingV1::Trace::Representation
  command.response_class = Google::Apis::TracingV1::Trace
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_project_trace_spans(name, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TracingV1::ListSpansResponse

Returns a list of spans within a trace.

Parameters:

  • name (String) —

    ID of the trace for which to list child spans. Format is projects/PROJECT_ID/traces/TRACE_ID.

  • page_token (String) —

    Token identifying the page of results to return. If provided, use the value of the nextPageToken field from a previous request. Optional.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



206
207
208
209
210
211
212
213
214
215
 
# File 'generated/google/apis/tracing_v1/service.rb', line 206

def list_project_trace_spans(name, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}:listSpans', options)
  command.response_representation = Google::Apis::TracingV1::ListSpansResponse::Representation
  command.response_class = Google::Apis::TracingV1::ListSpansResponse
  command.params['name'] = name unless name.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_project_traces(parent, start_time: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, end_time: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TracingV1::ListTracesResponse

Returns of a list of traces that match the specified filter conditions.

Parameters:

  • parent (String) —

    ID of the Cloud project where the trace data is stored.

  • start_time (String) —

    Start of the time interval (inclusive) during which the trace data was collected from the application.

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

  • page_size (Fixnum) —

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

  • order_by (String) —

    Field used to sort the returned traces. Optional. 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.
  • filter (String) —

    An optional filter for the request. Example: version_label_key:a some_label:some_label_key returns traces from version a and has some_label with some_label_key.

  • end_time (String) —

    End of the time interval (inclusive) during which the trace data was collected from the application.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'generated/google/apis/tracing_v1/service.rb', line 99

def list_project_traces(parent, start_time: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, end_time: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/traces', options)
  command.response_representation = Google::Apis::TracingV1::ListTracesResponse::Representation
  command.response_class = Google::Apis::TracingV1::ListTracesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['startTime'] = start_time unless start_time.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end