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

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/cloudtrace_v2/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 OpenCensus.

Examples:

require 'google/apis/cloudtrace_v2'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudTraceService

Returns a new instance of CloudTraceService.



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

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.



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

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.



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

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 new or existing traces. You cannot update existing spans.

Parameters:

  • name (String) —

    Required. The 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) (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



76
77
78
79
80
81
82
83
84
85
86
 
# File 'generated/google/apis/cloudtrace_v2/service.rb', line 76

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_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) —

    Required. 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; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16- character hexadecimal encoding of an 8-byte array. It should not be zero.

  • span_object (Google::Apis::CloudtraceV2::Span) (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



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

def create_project_trace_span_span(name, span_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, '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