Cloud Trace V1 API - Class Google::Cloud::Trace::V1::ListTracesRequest (v0.3.5)

Reference documentation and code samples for the Cloud Trace V1 API class Google::Cloud::Trace::V1::ListTracesRequest.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#end_time

def end_time() -> ::Google::Protobuf::Timestamp
Returns

#end_time=

def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#filter

def filter() -> ::String
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.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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.
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.

#order_by

def order_by() -> ::String
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.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::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.

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.

#page_size

def page_size() -> ::Integer
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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::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.

#page_token

def page_token() -> ::String
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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.

#project_id

def project_id() -> ::String
Returns
  • (::String) — Required. ID of the Cloud project where the trace data is stored.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — 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.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Start of the time interval (inclusive) during which the trace data was collected from the application.
Returns

#view

def view() -> ::Google::Cloud::Trace::V1::ListTracesRequest::ViewType
Returns

#view=

def view=(value) -> ::Google::Cloud::Trace::V1::ListTracesRequest::ViewType
Parameter
Returns