Class Span (1.11.3)

Version 1.11.3

• 1.15.0 (latest)
• 1.14.1
• 1.13.5
• 1.12.0
• 1.11.3
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.3
• 1.6.2
• 1.5.1
• 1.4.0
• 1.3.4
• 1.2.0
• 1.1.0
• 1.0.0
• 0.24.2
• 0.23.0
• 0.22.1

Span(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 might be gaps or overlaps between spans in a trace.

Attributes
Name	Description
name	str Required. 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. It should not be zero. [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_id	str Required. The [SPAN_ID] portion of the span's resource name.
parent_span_id	str The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.
display_name	google.cloud.trace_v2.types.TruncatableString Required. A description of the span's operation (up to 128 bytes). Cloud Trace displays the description in the Cloud 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.
start_time	google.protobuf.timestamp_pb2.Timestamp Required. 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.
end_time	google.protobuf.timestamp_pb2.Timestamp Required. 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.
attributes	google.cloud.trace_v2.types.Span.Attributes A set of attributes on the span. You can have up to 32 attributes per span.
stack_trace	google.cloud.trace_v2.types.StackTrace Stack trace captured at the start of the span.
time_events	google.cloud.trace_v2.types.Span.TimeEvents A set of time events. You can have up to 32 annotations and 128 message events per span.
links	google.cloud.trace_v2.types.Span.Links Links associated with the span. You can have up to 128 links per Span.
status	google.rpc.status_pb2.Status Optional. The final status for this span.
same_process_as_parent_span	google.protobuf.wrappers_pb2.BoolValue Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information.
child_span_count	google.protobuf.wrappers_pb2.Int32Value Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
span_kind	google.cloud.trace_v2.types.Span.SpanKind Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using CLIENT (caller) and SERVER (callee) to identify an RPC call.

Classes

Attributes

Attributes(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A set of attributes as key-value pairs.

Link

Link(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single batch handler processes multiple requests from different traces or when the handler receives a request from a different project.

Links

Links(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A collection of links, which are references from this span to a span in the same or different trace.

SpanKind

SpanKind(value)

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

Values: SPAN_KIND_UNSPECIFIED (0): Unspecified. Do NOT use as default. Implementations MAY assume SpanKind.INTERNAL to be default. INTERNAL (1): Indicates that the span is used internally. Default value. SERVER (2): Indicates that the span covers server-side handling of an RPC or other remote network request. CLIENT (3): Indicates that the span covers the client-side wrapper around an RPC or other remote request. PRODUCER (4): Indicates that the span describes producer sending a message to a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. publishing a message to a pubsub service). CONSUMER (5): Indicates that the span describes consumer receiving a message from a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. receiving a message from a pubsub service subscription).

TimeEvent

TimeEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A time-stamped annotation or message event in the Span.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TimeEvents

TimeEvents(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A collection of TimeEvent\ s. A TimeEvent is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans.