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

Interface SegmentObjectOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SegmentObject, SegmentObject.Builder

public interface SegmentObjectOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getIsSizeLimited() Whether the segment includes all tracked spans.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTraceId

String getTraceId()

 A string id represents the whole trace.
 

string traceId = 1;

Returns:

The traceId.

getTraceIdBytes

com.google.protobuf.ByteString getTraceIdBytes()

 A string id represents the whole trace.
 

string traceId = 1;

Returns:

The bytes for traceId.

getTraceSegmentId

String getTraceSegmentId()

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

string traceSegmentId = 2;

Returns:

The traceSegmentId.

getTraceSegmentIdBytes

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;

Returns:

The bytes for traceSegmentId.

getSpansList

List<SpanObject> getSpansList()

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

getSpans

SpanObject getSpans(int index)

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

getSpansCount

int getSpansCount()

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

getSpansOrBuilderList

List<? extends SpanObjectOrBuilder> getSpansOrBuilderList()

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

getSpansOrBuilder

SpanObjectOrBuilder getSpansOrBuilder(int index)

 Span collections included in this segment.
 

repeated .skywalking.v3.SpanObject spans = 3;

getService

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;

Returns:

The service.

getServiceBytes

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;

Returns:

The bytes for service.

getServiceInstance

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;

Returns:

The serviceInstance.

getServiceInstanceBytes

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;

Returns:

The bytes for serviceInstance.

getIsSizeLimited

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;

Returns:

The isSizeLimited.