Method: projects.traces.batchWrite

Sends new spans to new or existing traces. You cannot update existing spans.

HTTP request

POST https://cloudtrace.googleapis.com/v2/{name=projects/*}/traces:batchWrite

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the project where the spans belong. The format is projects/[PROJECT_ID].

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudtrace.traces.patch

Request body

The request body contains data with the following structure:

JSON representation
{
  "spans": [
    {
      object(Span)
    }
  ]
}
Fields
spans[]

object(Span)

A list of new spans. The span names must not match existing spans, or the results are undefined.

Response body

If successful, the response body will be empty.

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.

Span

A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous—there may be gaps or overlaps between spans in a trace.

JSON representation
{
  "name": string,
  "spanId": string,
  "parentSpanId": string,
  "displayName": {
    object(TruncatableString)
  },
  "startTime": string,
  "endTime": string,
  "attributes": {
    object(Attributes)
  },
  "stackTrace": {
    object(StackTrace)
  },
  "timeEvents": {
    object(TimeEvents)
  },
  "links": {
    object(Links)
  },
  "status": {
    object(Status)
  },
  "sameProcessAsParentSpan": boolean,
  "childSpanCount": number
}
Fields
name

string

The resource name of the span in the following format:

projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]

[TRACE_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.

spanId

string

The [SPAN_ID] portion of the span's resource name.

parentSpanId

string

The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.

displayName

object(TruncatableString)

A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.

startTime

string (Timestamp format)

The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

attributes

object(Attributes)

A set of attributes on the span. You can have up to 32 attributes per span.

stackTrace

object(StackTrace)

Stack trace captured at the start of the span.

timeEvents

object(TimeEvents)

A set of time events. You can have up to 32 annotations and 128 message events per span.

status

object(Status)

An optional final status for this span.

sameProcessAsParentSpan

boolean

(Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information.

childSpanCount

number

An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.

Was this page helpful? Let us know how we did:

Send feedback about...

Stackdriver Trace