Class: Google::Apis::CloudtraceV1::CloudTraceService

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

Overview

Stackdriver Trace API

Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.

Examples:

require 'google/apis/cloudtrace_v1'

Cloudtrace = Google::Apis::CloudtraceV1 # 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

#initializeCloudTraceService


49
50
51
52
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 49

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

Instance Attribute Details

#keyString


42
43
44
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 42

def key
  @key
end

#quota_userString


47
48
49
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

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

Gets a single trace by its ID. In this case, getting for traces is considered an active developer method, even though it is technically a read-only method.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


117
118
119
120
121
122
123
124
125
126
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 117

def get_project_trace(project_id, trace_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectId}/traces/{traceId}', options)
  command.response_representation = Google::Apis::CloudtraceV1::Trace::Representation
  command.response_class = Google::Apis::CloudtraceV1::Trace
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['traceId'] = trace_id unless trace_id.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(project_id, end_time: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, start_time: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV1::ListTracesResponse

Returns of a list of traces that match the specified filter conditions. In this case, listing for traces is considered an active developer method, even though it is technically a read-only method.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 206

def list_project_traces(project_id, end_time: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, start_time: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectId}/traces', options)
  command.response_representation = Google::Apis::CloudtraceV1::ListTracesResponse::Representation
  command.response_class = Google::Apis::CloudtraceV1::ListTracesResponse
  command.params['projectId'] = project_id unless project_id.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['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_traces(project_id, traces_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV1::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. In this case, writing traces is not considered an active developer method since traces are machine generated.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


81
82
83
84
85
86
87
88
89
90
91
# File 'generated/google/apis/cloudtrace_v1/service.rb', line 81

def patch_project_traces(project_id, traces_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/projects/{projectId}/traces', options)
  command.request_representation = Google::Apis::CloudtraceV1::Traces::Representation
  command.request_object = traces_object
  command.response_representation = Google::Apis::CloudtraceV1::Empty::Representation
  command.response_class = Google::Apis::CloudtraceV1::Empty
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end