Class: Google::Cloud::Trace::V1::ListTracesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/devtools/cloudtrace/v1/trace.rb

Overview

The request message for the ListTraces method. All fields are required unless specified.

Defined Under Namespace

Modules: ViewType

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ ::Google::Protobuf::Timestamp

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

Returns:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'proto_docs/google/devtools/cloudtrace/v1/trace.rb', line 223

class ListTracesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of data returned for traces in the list.
  module ViewType
    # Default is `MINIMAL` if unspecified.
    VIEW_TYPE_UNSPECIFIED = 0

    # Minimal view of the trace record that contains only the project
    # and trace IDs.
    MINIMAL = 1

    # Root span view of the trace record that returns the root spans along
    # with the minimal trace data.
    ROOTSPAN = 2

    # Complete view of the trace record that contains the actual trace data.
    # This is equivalent to calling the REST `get` or RPC `GetTrace` method
    # using the ID of each listed trace.
    COMPLETE = 3
  end
end

#filter ⇒ ::String

Returns Optional. A filter against labels for the request.

By default, searches use prefix matching. To specify exact match, prepend a plus symbol (+) to the search term. Multiple terms are ANDed. Syntax:

  • root:NAME_PREFIX or NAME_PREFIX: Return traces where any root span starts with NAME_PREFIX.
  • +root:NAME or +NAME: Return traces where any root span's name is exactly NAME.
  • span:NAME_PREFIX: Return traces where any span starts with NAME_PREFIX.
  • +span:NAME: Return traces where any span's name is exactly NAME.
  • latency:DURATION: Return traces whose overall latency is greater or equal to than DURATION. Accepted units are nanoseconds (ns), milliseconds (ms), and seconds (s). Default is ms. For example, latency:24ms returns traces whose overall latency is greater than or equal to 24 milliseconds.
  • label:LABEL_KEY: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values).
  • LABEL_KEY:VALUE_PREFIX: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with VALUE_PREFIX. Both a key and a value must be specified.
  • +LABEL_KEY:VALUE: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified.
  • method:VALUE: Equivalent to /http/method:VALUE.
  • url:VALUE: Equivalent to /http/url:VALUE.

Returns:

  • (::String) —

    Optional. A filter against labels for the request.

    By default, searches use prefix matching. To specify exact match, prepend a plus symbol (+) to the search term. Multiple terms are ANDed. Syntax:

    • root:NAME_PREFIX or NAME_PREFIX: Return traces where any root span starts with NAME_PREFIX.
    • +root:NAME or +NAME: Return traces where any root span's name is exactly NAME.
    • span:NAME_PREFIX: Return traces where any span starts with NAME_PREFIX.
    • +span:NAME: Return traces where any span's name is exactly NAME.
    • latency:DURATION: Return traces whose overall latency is greater or equal to than DURATION. Accepted units are nanoseconds (ns), milliseconds (ms), and seconds (s). Default is ms. For example, latency:24ms returns traces whose overall latency is greater than or equal to 24 milliseconds.
    • label:LABEL_KEY: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values).
    • LABEL_KEY:VALUE_PREFIX: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with VALUE_PREFIX. Both a key and a value must be specified.
    • +LABEL_KEY:VALUE: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified.
    • method:VALUE: Equivalent to /http/method:VALUE.
    • url:VALUE: Equivalent to /http/url:VALUE.


223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'proto_docs/google/devtools/cloudtrace/v1/trace.rb', line 223

class ListTracesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of data returned for traces in the list.
  module ViewType
    # Default is `MINIMAL` if unspecified.
    VIEW_TYPE_UNSPECIFIED = 0

    # Minimal view of the trace record that contains only the project
    # and trace IDs.
    MINIMAL = 1

    # Root span view of the trace record that returns the root spans along
    # with the minimal trace data.
    ROOTSPAN = 2

    # Complete view of the trace record that contains the actual trace data.
    # This is equivalent to calling the REST `get` or RPC `GetTrace` method
    # using the ID of each listed trace.
    COMPLETE = 3
  end
end

#order_by ⇒ ::String

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

Returns:

  • (::String) —

    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.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'proto_docs/google/devtools/cloudtrace/v1/trace.rb', line 223

class ListTracesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of data returned for traces in the list.
  module ViewType
    # Default is `MINIMAL` if unspecified.
    VIEW_TYPE_UNSPECIFIED = 0

    # Minimal view of the trace record that contains only the project
    # and trace IDs.
    MINIMAL = 1

    # Root span view of the trace record that returns the root spans along
    # with the minimal trace data.
    ROOTSPAN = 2

    # Complete view of the trace record that contains the actual trace data.
    # This is equivalent to calling the REST `get` or RPC `GetTrace` method
    # using the ID of each listed trace.
    COMPLETE = 3
  end
end

#page_size ⇒ ::Integer

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.

Returns:

  • (::Integer) —

    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.



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'proto_docs/google/devtools/cloudtrace/v1/trace.rb', line 223

class ListTracesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of data returned for traces in the list.
  module ViewType
    # Default is `MINIMAL` if unspecified.
    VIEW_TYPE_UNSPECIFIED = 0

    # Minimal view of the trace record that contains only the project
    # and trace IDs.
    MINIMAL = 1

    # Root span view of the trace record that returns the root spans along
    # with the minimal trace data.
    ROOTSPAN = 2

    # Complete view of the trace record that contains the actual trace data.
    # This is equivalent to calling the REST `get` or RPC `GetTrace` method
    # using the ID of each listed trace.
    COMPLETE = 3
  end
end

#page_token ⇒ ::String

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

Returns:

  • (::String) —

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'proto_docs/google/devtools/cloudtrace/v1/trace.rb', line 223

class ListTracesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of data returned for traces in the list.
  module ViewType
    # Default is `MINIMAL` if unspecified.
    VIEW_TYPE_UNSPECIFIED = 0

    # Minimal view of the trace record that contains only the project
    # and trace IDs.
    MINIMAL = 1

    # Root span view of the trace record that returns the root spans along
    # with the minimal trace data.
    ROOTSPAN = 2

    # Complete view of the trace record that contains the actual trace data.
    # This is equivalent to calling the REST `get` or RPC `GetTrace` method
    # using the ID of each listed trace.
    COMPLETE = 3
  end
end

#project_id ⇒ ::String

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

Returns:

  • (::String) —

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'proto_docs/google/devtools/cloudtrace/v1/trace.rb', line 223

class ListTracesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of data returned for traces in the list.
  module ViewType
    # Default is `MINIMAL` if unspecified.
    VIEW_TYPE_UNSPECIFIED = 0

    # Minimal view of the trace record that contains only the project
    # and trace IDs.
    MINIMAL = 1

    # Root span view of the trace record that returns the root spans along
    # with the minimal trace data.
    ROOTSPAN = 2

    # Complete view of the trace record that contains the actual trace data.
    # This is equivalent to calling the REST `get` or RPC `GetTrace` method
    # using the ID of each listed trace.
    COMPLETE = 3
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

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

Returns:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'proto_docs/google/devtools/cloudtrace/v1/trace.rb', line 223

class ListTracesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of data returned for traces in the list.
  module ViewType
    # Default is `MINIMAL` if unspecified.
    VIEW_TYPE_UNSPECIFIED = 0

    # Minimal view of the trace record that contains only the project
    # and trace IDs.
    MINIMAL = 1

    # Root span view of the trace record that returns the root spans along
    # with the minimal trace data.
    ROOTSPAN = 2

    # Complete view of the trace record that contains the actual trace data.
    # This is equivalent to calling the REST `get` or RPC `GetTrace` method
    # using the ID of each listed trace.
    COMPLETE = 3
  end
end

#view ⇒ ::Google::Cloud::Trace::V1::ListTracesRequest::ViewType

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

Returns:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'proto_docs/google/devtools/cloudtrace/v1/trace.rb', line 223

class ListTracesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type of data returned for traces in the list.
  module ViewType
    # Default is `MINIMAL` if unspecified.
    VIEW_TYPE_UNSPECIFIED = 0

    # Minimal view of the trace record that contains only the project
    # and trace IDs.
    MINIMAL = 1

    # Root span view of the trace record that returns the root spans along
    # with the minimal trace data.
    ROOTSPAN = 2

    # Complete view of the trace record that contains the actual trace data.
    # This is equivalent to calling the REST `get` or RPC `GetTrace` method
    # using the ID of each listed trace.
    COMPLETE = 3
  end
end