org.apache.skywalking.apm.network.language.agent.v3

Class SegmentObject

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.skywalking.apm.network.language.agent.v3.SegmentObject

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SegmentObjectOrBuilder

public final class SegmentObject
extends com.google.protobuf.GeneratedMessageV3
implements SegmentObjectOrBuilder

 The segment is a collection of spans. It includes all collected spans in a simple one request context, such as a HTTP request process.
 We recommend the agent/SDK report all tracked data of one request once for all, such as,
 typically, such as in Java, one segment represent all tracked operations(spans) of one request context in the same thread.
 At the same time, in some language there is not a clear concept like golang, it could represent all tracked operations of one request context.
 

Protobuf type skywalking.v3.SegmentObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SegmentObject.Builder The segment is a collection of spans.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ISSIZELIMITED_FIELD_NUMBER
static int	SERVICE_FIELD_NUMBER
static int	SERVICEINSTANCE_FIELD_NUMBER
static int	SPANS_FIELD_NUMBER
static int	TRACEID_FIELD_NUMBER
static int	TRACESEGMENTID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SegmentObject	getDefaultInstance()
SegmentObject	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getIsSizeLimited() Whether the segment includes all tracked spans.
com.google.protobuf.Parser<SegmentObject>	getParserForType()
int	getSerializedSize()
String	getService() **Service**.
com.google.protobuf.ByteString	getServiceBytes() **Service**.
String	getServiceInstance() **Service Instance**.
com.google.protobuf.ByteString	getServiceInstanceBytes() **Service Instance**.
SpanObject	getSpans(int index) Span collections included in this segment.
int	getSpansCount() Span collections included in this segment.
List<SpanObject>	getSpansList() Span collections included in this segment.
SpanObjectOrBuilder	getSpansOrBuilder(int index) Span collections included in this segment.
List<? extends SpanObjectOrBuilder>	getSpansOrBuilderList() Span collections included in this segment.
String	getTraceId() A string id represents the whole trace.
com.google.protobuf.ByteString	getTraceIdBytes() A string id represents the whole trace.
String	getTraceSegmentId() A unique id represents this segment.
com.google.protobuf.ByteString	getTraceSegmentIdBytes() A unique id represents this segment.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SegmentObject.Builder	newBuilder()
static SegmentObject.Builder	newBuilder(SegmentObject prototype)
SegmentObject.Builder	newBuilderForType()
protected SegmentObject.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SegmentObject	parseDelimitedFrom(InputStream input)
static SegmentObject	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentObject	parseFrom(byte[] data)
static SegmentObject	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentObject	parseFrom(ByteBuffer data)
static SegmentObject	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentObject	parseFrom(com.google.protobuf.ByteString data)
static SegmentObject	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentObject	parseFrom(com.google.protobuf.CodedInputStream input)
static SegmentObject	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentObject	parseFrom(InputStream input)
static SegmentObject	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SegmentObject>	parser()
SegmentObject.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TRACEID_FIELD_NUMBER

public static final int TRACEID_FIELD_NUMBER

See Also:

Constant Field Values

TRACESEGMENTID_FIELD_NUMBER

public static final int TRACESEGMENTID_FIELD_NUMBER

See Also:

Constant Field Values

SPANS_FIELD_NUMBER

public static final int SPANS_FIELD_NUMBER

See Also:

Constant Field Values

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER

See Also:

Constant Field Values

SERVICEINSTANCE_FIELD_NUMBER

public static final int SERVICEINSTANCE_FIELD_NUMBER

See Also:

Constant Field Values

ISSIZELIMITED_FIELD_NUMBER

public static final int ISSIZELIMITED_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTraceId

public String getTraceId()

 A string id represents the whole trace.
 

string traceId = 1;

Specified by:

getTraceId in interface SegmentObjectOrBuilder

Returns:

The traceId.

getTraceIdBytes

public com.google.protobuf.ByteString getTraceIdBytes()

 A string id represents the whole trace.
 

string traceId = 1;

Specified by:

getTraceIdBytes in interface SegmentObjectOrBuilder

Returns:

The bytes for traceId.

getTraceSegmentId

public String getTraceSegmentId()

 A unique id represents this segment. Other segments could use this id to reference as a child segment.
 

string traceSegmentId = 2;

Specified by:

getTraceSegmentId in interface SegmentObjectOrBuilder

Returns:

The traceSegmentId.

getTraceSegmentIdBytes

public com.google.protobuf.ByteString getTraceSegmentIdBytes()

 A unique id represents this segment. Other segments could use this id to reference as a child segment.
 

string traceSegmentId = 2;

Specified by:

getTraceSegmentIdBytes in interface SegmentObjectOrBuilder

Returns:

The bytes for traceSegmentId.

getSpansList

public List<SpanObject> getSpansList()

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

Specified by:

getSpansList in interface SegmentObjectOrBuilder

getSpansOrBuilderList

public List<? extends SpanObjectOrBuilder> getSpansOrBuilderList()

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

Specified by:

getSpansOrBuilderList in interface SegmentObjectOrBuilder

getSpansCount

public int getSpansCount()

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

Specified by:

getSpansCount in interface SegmentObjectOrBuilder

getSpans

public SpanObject getSpans(int index)

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

Specified by:

getSpans in interface SegmentObjectOrBuilder

getSpansOrBuilder

public SpanObjectOrBuilder getSpansOrBuilder(int index)

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

Specified by:

getSpansOrBuilder in interface SegmentObjectOrBuilder

getService

public String getService()

 **Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests.
 The logic name represents the service. This would show as a separate node in the topology.
 The metrics analyzed from the spans, would be aggregated for this entity as the service level.
 

string service = 4;

Specified by:

getService in interface SegmentObjectOrBuilder

Returns:

The service.

getServiceBytes

public com.google.protobuf.ByteString getServiceBytes()

 **Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests.
 The logic name represents the service. This would show as a separate node in the topology.
 The metrics analyzed from the spans, would be aggregated for this entity as the service level.
 

string service = 4;

Specified by:

getServiceBytes in interface SegmentObjectOrBuilder

Returns:

The bytes for service.

getServiceInstance

public String getServiceInstance()

 **Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it
 doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process.
 The logic name represents the service instance. This would show as a separate node in the instance relationship.
 The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
 

string serviceInstance = 5;

Specified by:

getServiceInstance in interface SegmentObjectOrBuilder

Returns:

The serviceInstance.

getServiceInstanceBytes

public com.google.protobuf.ByteString getServiceInstanceBytes()

 **Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it
 doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process.
 The logic name represents the service instance. This would show as a separate node in the instance relationship.
 The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
 

string serviceInstance = 5;

Specified by:

getServiceInstanceBytes in interface SegmentObjectOrBuilder

Returns:

The bytes for serviceInstance.

getIsSizeLimited

public boolean getIsSizeLimited()

 Whether the segment includes all tracked spans.
 In the production environment tracked, some tasks could include too many spans for one request context, such as a batch update for a cache, or an async job.
 The agent/SDK could optimize or ignore some tracked spans for better performance.
 In this case, the value should be flagged as TRUE.
 

bool isSizeLimited = 6;

Specified by:

getIsSizeLimited in interface SegmentObjectOrBuilder

Returns:

The isSizeLimited.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SegmentObject parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentObject parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentObject parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentObject parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentObject parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentObject parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentObject parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static SegmentObject parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static SegmentObject parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static SegmentObject parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static SegmentObject parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static SegmentObject parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public SegmentObject.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SegmentObject.Builder newBuilder()

newBuilder

public static SegmentObject.Builder newBuilder(SegmentObject prototype)

toBuilder

public SegmentObject.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SegmentObject.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SegmentObject getDefaultInstance()

parser

public static com.google.protobuf.Parser<SegmentObject> parser()

getParserForType

public com.google.protobuf.Parser<SegmentObject> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SegmentObject getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder