package cloudtrace

Import Path
	google.golang.org/genproto/googleapis/devtools/cloudtrace/v2 (on go.dev)

Dependency Relation
	imports 14 packages, and imported by 2 packages

Involved Source Files trace.pb.go tracing.pb.go
Package-Level Type Names (total 29, in which 26 are exported)
/* sort exporteds by: | */
The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute. The type of the value. Types that are assignable to Value: *AttributeValue_StringValue *AttributeValue_IntValue *AttributeValue_BoolValue Deprecated: Use AttributeValue.ProtoReflect.Descriptor instead. (*T) GetBoolValue() bool (*T) GetIntValue() int64 (*T) GetStringValue() *TruncatableString (*T) GetValue() isAttributeValue_Value (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*Span_Attributes).GetAttributeMap() map[string]*AttributeValue
A Boolean value represented by `true` or `false`.
A 64-bit signed integer.
A string up to 256 bytes long.
The request message for the `BatchWriteSpans` method. Required. The name of the project where the spans belong. The format is `projects/[PROJECT_ID]`. Required. A list of new spans. The span names must not match existing spans, or the results are undefined. Deprecated: Use BatchWriteSpansRequest.ProtoReflect.Descriptor instead. (*T) GetName() string (*T) GetSpans() []*Span (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func TraceServiceClient.BatchWriteSpans(ctx context.Context, in *BatchWriteSpansRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) func TraceServiceServer.BatchWriteSpans(context.Context, *BatchWriteSpansRequest) (*emptypb.Empty, error) func (*UnimplementedTraceServiceServer).BatchWriteSpans(context.Context, *BatchWriteSpansRequest) (*emptypb.Empty, error) func cloud.google.com/go/trace/apiv2.(*Client).BatchWriteSpans(ctx context.Context, req *BatchWriteSpansRequest, opts ...gax.CallOption) error
Binary module. A unique identifier for the module, usually a hash of its contents (up to 128 bytes). For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes). Deprecated: Use Module.ProtoReflect.Descriptor instead. (*T) GetBuildId() *TruncatableString (*T) GetModule() *TruncatableString (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*StackTrace_StackFrame).GetLoadModule() *Module
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. A set of attributes on the span. You can have up to 32 attributes per span. Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. Required. 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. 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. Links associated with the span. You can have up to 128 links per Span. 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. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty. 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. Required. The [SPAN_ID] portion of the span's resource name. 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. Stack trace captured at the start of the span. 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. Optional. The final status for this span. A set of time events. You can have up to 32 annotations and 128 message events per span. Deprecated: Use Span.ProtoReflect.Descriptor instead. (*T) GetAttributes() *Span_Attributes (*T) GetChildSpanCount() *wrapperspb.Int32Value (*T) GetDisplayName() *TruncatableString (*T) GetEndTime() *timestamppb.Timestamp (*T) GetLinks() *Span_Links (*T) GetName() string (*T) GetParentSpanId() string (*T) GetSameProcessAsParentSpan() *wrapperspb.BoolValue (*T) GetSpanId() string (*T) GetSpanKind() Span_SpanKind (*T) GetStackTrace() *StackTrace (*T) GetStartTime() *timestamppb.Timestamp (*T) GetStatus() *status.Status (*T) GetTimeEvents() *Span_TimeEvents (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*BatchWriteSpansRequest).GetSpans() []*Span func TraceServiceClient.CreateSpan(ctx context.Context, in *Span, opts ...grpc.CallOption) (*Span, error) func TraceServiceServer.CreateSpan(context.Context, *Span) (*Span, error) func (*UnimplementedTraceServiceServer).CreateSpan(context.Context, *Span) (*Span, error) func cloud.google.com/go/trace/apiv2.(*Client).CreateSpan(ctx context.Context, req *Span, opts ...gax.CallOption) (*Span, error) func TraceServiceClient.CreateSpan(ctx context.Context, in *Span, opts ...grpc.CallOption) (*Span, error) func TraceServiceServer.CreateSpan(context.Context, *Span) (*Span, error) func (*UnimplementedTraceServiceServer).CreateSpan(context.Context, *Span) (*Span, error) func cloud.google.com/go/trace/apiv2.(*Client).CreateSpan(ctx context.Context, req *Span, opts ...gax.CallOption) (*Span, error)
A set of attributes, each in the format `[KEY]:[VALUE]`. The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "abc.com/myattribute": { "bool_value": false } The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. Deprecated: Use Span_Attributes.ProtoReflect.Descriptor instead. (*T) GetAttributeMap() map[string]*AttributeValue (*T) GetDroppedAttributesCount() int32 (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*Span).GetAttributes() *Span_Attributes func (*Span_Link).GetAttributes() *Span_Attributes func (*Span_TimeEvent_Annotation).GetAttributes() *Span_Attributes
Type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship. ( T) Descriptor() protoreflect.EnumDescriptor ( T) Enum() *Span_SpanKind Deprecated: Use Span_SpanKind.Descriptor instead. ( T) Number() protoreflect.EnumNumber ( T) String() string ( T) Type() protoreflect.EnumType T : google.golang.org/protobuf/reflect/protoreflect.Enum T : expvar.Var T : fmt.Stringer func (*Span).GetSpanKind() Span_SpanKind func Span_SpanKind.Enum() *Span_SpanKind const Span_CLIENT const Span_CONSUMER const Span_INTERNAL const Span_PRODUCER const Span_SERVER const Span_SPAN_KIND_UNSPECIFIED
A time-stamped annotation or message event in the Span. The timestamp indicating the time the event occurred. A `TimeEvent` can contain either an `Annotation` object or a `MessageEvent` object, but not both. Types that are assignable to Value: *Span_TimeEvent_Annotation_ *Span_TimeEvent_MessageEvent_ Deprecated: Use Span_TimeEvent.ProtoReflect.Descriptor instead. (*T) GetAnnotation() *Span_TimeEvent_Annotation (*T) GetMessageEvent() *Span_TimeEvent_MessageEvent (*T) GetTime() *timestamppb.Timestamp (*T) GetValue() isSpan_TimeEvent_Value (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*Span_TimeEvents).GetTimeEvent() []*Span_TimeEvent
Text annotation with a set of attributes. A set of attributes on the annotation. You can have up to 4 attributes per Annotation. A user-supplied message describing the event. The maximum length for the description is 256 bytes. Deprecated: Use Span_TimeEvent_Annotation.ProtoReflect.Descriptor instead. (*T) GetAttributes() *Span_Attributes (*T) GetDescription() *TruncatableString (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*Span_TimeEvent).GetAnnotation() *Span_TimeEvent_Annotation
Text annotation with a set of attributes.
An event describing a message sent/received between Spans. The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed. An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span. Type of MessageEvent. Indicates whether the message was sent or received. The number of uncompressed bytes sent or received. Deprecated: Use Span_TimeEvent_MessageEvent.ProtoReflect.Descriptor instead. (*T) GetCompressedSizeBytes() int64 (*T) GetId() int64 (*T) GetType() Span_TimeEvent_MessageEvent_Type (*T) GetUncompressedSizeBytes() int64 (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*Span_TimeEvent).GetMessageEvent() *Span_TimeEvent_MessageEvent
An event describing a message sent/received between Spans.
Indicates whether the message was sent or received. ( T) Descriptor() protoreflect.EnumDescriptor ( T) Enum() *Span_TimeEvent_MessageEvent_Type Deprecated: Use Span_TimeEvent_MessageEvent_Type.Descriptor instead. ( T) Number() protoreflect.EnumNumber ( T) String() string ( T) Type() protoreflect.EnumType T : google.golang.org/protobuf/reflect/protoreflect.Enum T : expvar.Var T : fmt.Stringer func (*Span_TimeEvent_MessageEvent).GetType() Span_TimeEvent_MessageEvent_Type func Span_TimeEvent_MessageEvent_Type.Enum() *Span_TimeEvent_MessageEvent_Type const Span_TimeEvent_MessageEvent_RECEIVED const Span_TimeEvent_MessageEvent_SENT const Span_TimeEvent_MessageEvent_TYPE_UNSPECIFIED
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. The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped. The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped. A collection of `TimeEvent`s. Deprecated: Use Span_TimeEvents.ProtoReflect.Descriptor instead. (*T) GetDroppedAnnotationsCount() int32 (*T) GetDroppedMessageEventsCount() int32 (*T) GetTimeEvent() []*Span_TimeEvent (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*Span).GetTimeEvents() *Span_TimeEvents
A call stack appearing in a trace. Stack frames in this stack trace. A maximum of 128 frames are allowed. The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`. Deprecated: Use StackTrace.ProtoReflect.Descriptor instead. (*T) GetStackFrames() *StackTrace_StackFrames (*T) GetStackTraceHashId() int64 (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*Span).GetStackTrace() *StackTrace
Represents a single stack frame in a stack trace. The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions. The name of the source file where the function call appears (up to 256 bytes). The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes). The line number in `file_name` where the function call appears. The binary module from where the code was loaded. An un-mangled function name, if `function_name` is [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can be fully-qualified (up to 1024 bytes). The version of the deployed source code (up to 128 bytes). Deprecated: Use StackTrace_StackFrame.ProtoReflect.Descriptor instead. (*T) GetColumnNumber() int64 (*T) GetFileName() *TruncatableString (*T) GetFunctionName() *TruncatableString (*T) GetLineNumber() int64 (*T) GetLoadModule() *Module (*T) GetOriginalFunctionName() *TruncatableString (*T) GetSourceVersion() *TruncatableString (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*StackTrace_StackFrames).GetFrame() []*StackTrace_StackFrame
A collection of stack frames, which can be truncated. The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped. Stack frames in this call stack. Deprecated: Use StackTrace_StackFrames.ProtoReflect.Descriptor instead. (*T) GetDroppedFramesCount() int32 (*T) GetFrame() []*StackTrace_StackFrame (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*StackTrace).GetStackFrames() *StackTrace_StackFrames
TraceServiceClient is the client API for TraceService service. For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. Sends new spans to new or existing traces. You cannot update existing spans. Creates a new span. func NewTraceServiceClient(cc grpc.ClientConnInterface) TraceServiceClient
TraceServiceServer is the server API for TraceService service. Sends new spans to new or existing traces. You cannot update existing spans. Creates a new span. *UnimplementedTraceServiceServer func RegisterTraceServiceServer(s *grpc.Server, srv TraceServiceServer)
Represents a string that might be shortened to a specified length. The number of bytes removed from the original string. If this value is 0, then the string was not shortened. The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. Deprecated: Use TruncatableString.ProtoReflect.Descriptor instead. (*T) GetTruncatedByteCount() int32 (*T) GetValue() string (*T) ProtoMessage() (*T) ProtoReflect() protoreflect.Message (*T) Reset() (*T) String() string *T : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage *T : google.golang.org/protobuf/runtime/protoiface.MessageV1 *T : expvar.Var *T : fmt.Stringer func (*AttributeValue).GetStringValue() *TruncatableString func (*Module).GetBuildId() *TruncatableString func (*Module).GetModule() *TruncatableString func (*Span).GetDisplayName() *TruncatableString func (*Span_TimeEvent_Annotation).GetDescription() *TruncatableString func (*StackTrace_StackFrame).GetFileName() *TruncatableString func (*StackTrace_StackFrame).GetFunctionName() *TruncatableString func (*StackTrace_StackFrame).GetOriginalFunctionName() *TruncatableString func (*StackTrace_StackFrame).GetSourceVersion() *TruncatableString
UnimplementedTraceServiceServer can be embedded to have forward compatible implementations. (*T) BatchWriteSpans(context.Context, *BatchWriteSpansRequest) (*emptypb.Empty, error) (*T) CreateSpan(context.Context, *Span) (*Span, error) *T : TraceServiceServer
Package-Level Variables (total 22, in which 8 are exported)
Enum value maps for Span_SpanKind.
Enum value maps for Span_SpanKind.
Enum value maps for Span_TimeEvent_MessageEvent_Type.
Enum value maps for Span_TimeEvent_MessageEvent_Type.
Package-Level Constants (total 12, all are exported)
Indicates that the span covers the client-side wrapper around an RPC or other remote request.
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).
Indicates that the span is used internally. Default value.
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).
Indicates that the span covers server-side handling of an RPC or other remote network request.
Unspecified. Do NOT use as default. Implementations MAY assume SpanKind.INTERNAL to be default.