Class: Google::Apis::CloudtraceV2::CloudTraceService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudtrace_v2/service.rb

Overview

Stackdriver Trace API

Send and retrieve trace data from Stackdriver Trace. Data is generated and available by default for all App Engine applications. Data from other applications can be written to Stackdriver Trace for display, reporting, and analysis.

Examples:

require 'google/apis/cloudtrace_v2'

Cloudtrace = Google::Apis::CloudtraceV2 # Alias the module
service = Cloudtrace::CloudTraceService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initialize ⇒ CloudTraceService

Returns a new instance of CloudTraceService



48
49
50
51
 
# File 'generated/google/apis/cloudtrace_v2/service.rb', line 48

def initialize
  super('https://cloudtrace.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.



41
42
43
 
# File 'generated/google/apis/cloudtrace_v2/service.rb', line 41

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.



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

def quota_user
  @quota_user
end

Instance Method Details

#batch_trace_write_spans(name, batch_write_spans_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2::Empty

Sends new spans to Stackdriver Trace or updates existing traces. If the name of a trace that you send matches that of an existing trace, new spans are added to the existing trace. Attempt to update existing spans results undefined behavior. If the name does not match, a new trace is created with given set of spans.

Parameters:

  • name (String) —

    Required. Name of the project where the spans belong. The format is projects/PROJECT_ID.

  • batch_write_spans_request_object (Google::Apis::CloudtraceV2::BatchWriteSpansRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



79
80
81
82
83
84
85
86
87
88
89
 
# File 'generated/google/apis/cloudtrace_v2/service.rb', line 79

def batch_trace_write_spans(name, batch_write_spans_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+name}/traces:batchWrite', options)
  command.request_representation = Google::Apis::CloudtraceV2::BatchWriteSpansRequest::Representation
  command.request_object = batch_write_spans_request_object
  command.response_representation = Google::Apis::CloudtraceV2::Empty::Representation
  command.response_class = Google::Apis::CloudtraceV2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_trace_span(name, span_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2::Span

Creates a new Span.

Parameters:

  • name (String) —

    The resource name of the span in the following format: projects/[PROJECT_ID]traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project. [SPAN_ID] is a unique identifier for a span within a trace, assigned when the span is created.

  • span_object (Google::Apis::CloudtraceV2::Span) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



217
218
219
220
221
222
223
224
225
226
227
 
# File 'generated/google/apis/cloudtrace_v2/service.rb', line 217

def create_project_trace_span(name, span_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v2/{+name}', options)
  command.request_representation = Google::Apis::CloudtraceV2::Span::Representation
  command.request_object = span_object
  command.response_representation = Google::Apis::CloudtraceV2::Span::Representation
  command.response_class = Google::Apis::CloudtraceV2::Span
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Returns a list of spans within a trace.

Parameters:

  • parent (String) —

    Required: The resource name of the trace containing the spans to list. The format is projects/PROJECT_ID/traces/TRACE_ID.

  • page_token (String) —

    Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



181
182
183
184
185
186
187
188
189
190
 
# File 'generated/google/apis/cloudtrace_v2/service.rb', line 181

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

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

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

Parameters:

  • parent (String) —

    Required. The project where the trace data is stored. The format is projects/PROJECT_ID.

  • end_time (String) —

    Optional. Do not return traces whose start time is later than this time.

  • filter (String) —

    Opional. Return only traces that match this trace filter. Example: "label:/http/url root:/_ah/background my_label:17"

  • order_by (String) —

    Optional. A single field used to sort the returned traces. Only the following field names can be used:

    • trace_id: the trace's ID field
    • name: the root span's resource name
    • duration: the difference between the root span's start time and end time
    • start: the start time of the root span Sorting is in ascending order unless desc is appended to the sort field name. Example: "name desc").
  • page_size (Fixnum) —

    Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available, even if fewer than the maximum number of results is returned by this request.

  • page_token (String) —

    Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.

  • start_time (String) —

    Optional. Do not return traces whose end time is earlier than this time.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'generated/google/apis/cloudtrace_v2/service.rb', line 139

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