Console
    Contact Us Start free

    Package google.devtools.cloudtrace.v1

    Index

    TraceService

    Service for collecting and viewing traces and spans within a trace.

    A trace is a collection of spans. A trace can correspond to a single operation or a set of operations in an application.

    A span is an individual timed event which forms a node of the trace tree. A single trace can contain spans from multiple services.

    GetTrace

    rpc GetTrace( GetTraceRequest ) returns ( Trace )

    Gets a single trace by its ID.

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/trace.readonly
    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    ListTraces

    rpc ListTraces( ListTracesRequest ) returns ( ListTracesResponse )

    Returns a list of traces that match the specified filter conditions.

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/trace.readonly
    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    PatchTraces

    rpc PatchTraces( PatchTracesRequest ) returns ( 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.

    Authorization scopes

    Requires one of the following OAuth scopes:

    • https://www.googleapis.com/auth/trace.append
    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    GetTraceRequest

    The request message for the GetTrace method.

    Fields
    project_id

    string

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

    Authorization requires the following IAM permission on the specified resource projectId :

    • cloudtrace.traces.get
    trace_id

    string

    Required. ID of the trace to return.

    ListTracesRequest

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

    Fields
    project_id

    string

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

    Authorization requires the following IAM permission on the specified resource projectId :

    • cloudtrace.traces.list
    view

    ViewType

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

    page_size

    int32

    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

    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

    Timestamp

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

    end_time

    Timestamp

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

    filter

    string

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

    order_by

    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.

    ViewType

    Type of data returned for traces in the list.

    Enums
    VIEW_TYPE_UNSPECIFIED Default is MINIMAL if unspecified.
    MINIMAL Minimal view of the trace record that contains only the project and trace IDs.
    ROOTSPAN Root span view of the trace record that returns the root spans along with the minimal trace data.
    COMPLETE 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.

    ListTracesResponse

    The response message for the ListTraces method.

    Fields
    traces[]

    Trace

    List of trace records as specified by the view parameter.
    next_page_token

    string

    If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces.

    PatchTracesRequest

    The request message for the PatchTraces method.

    Fields
    project_id

    string

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

    Authorization requires the following IAM permission on the specified resource projectId :

    • cloudtrace.traces.patch
    traces

    Traces

    Required. The body of the message.

    Trace

    A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.

    Fields
    project_id

    string

    Project ID of the Cloud project where the trace data is stored.
    trace_id

    string

    Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string. For example, 382d4f4c6b7bb2f4a972559d9085001d . The numeric value should not be zero.
    spans[]

    TraceSpan

    Collection of spans in the trace.

    TraceSpan

    A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.

    Fields
    span_id

    fixed64

    Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, 2205310701640571284 .
    kind

    SpanKind

    Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using RPC_CLIENT and RPC_SERVER to identify queueing latency associated with the span.
    name

    string

    Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Trace tool in the Google Cloud Platform Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.
    start_time

    Timestamp

    Start time of the span in seconds and nanoseconds from the UNIX epoch.
    end_time

    Timestamp

    End time of the span in seconds and nanoseconds from the UNIX epoch.
    parent_span_id

    fixed64

    Optional. ID of the parent span, if any.
    labels

    map<string, string>

    Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 KiB. Some keys might have predefined meaning, and you can also create your own.

    For more information, see Cloud Trace labels .

    SpanKind

    Type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship.

    Enums
    SPAN_KIND_UNSPECIFIED Unspecified.
    RPC_SERVER Indicates that the span covers server-side handling of an RPC or other remote network request.
    RPC_CLIENT Indicates that the span covers the client-side wrapper around an RPC or other remote request.

    Traces

    List of new or updated traces.

    Fields
    traces[]

    Trace

    List of traces.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: