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

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

Overview

Cloud Trace API

Sends application trace data to Cloud 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 Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry.

Examples:

require 'google/apis/cloudtrace_v1'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://cloudtrace.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudTraceService

Returns a new instance of CloudTraceService.



51
52
53
54
55
56
 
# File 'lib/google/apis/cloudtrace_v1/service.rb', line 51

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-cloudtrace_v1',
        client_version: Google::Apis::CloudtraceV1::GEM_VERSION)
  @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.



44
45
46
 
# File 'lib/google/apis/cloudtrace_v1/service.rb', line 44

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.



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

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.

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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/apis/cloudtrace_v1/service.rb', line 114

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 a list of traces that match the specified filter conditions.

Parameters:

  • project_id (String) —

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

  • end_time (String) (defaults to: nil) —

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

  • filter (String) (defaults to: nil) —

    Optional. A filter against properties of the trace. See filter syntax documentation for details.

  • order_by (String) (defaults to: nil) —

    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.
  • page_size (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

    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 (String) (defaults to: nil) —

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

  • view (String) (defaults to: nil) —

    Optional. Type of data returned for traces in the list. Default is MINIMAL.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/google/apis/cloudtrace_v1/service.rb', line 170

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 trace spans to Cloud Trace. Spans cannot be updated. If the trace ID and span ID already exist, an additional copy of the span will be stored.

Parameters:

  • project_id (String) —

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

  • traces_object (Google::Apis::CloudtraceV1::Traces) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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