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

Interface SegmentReferenceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SegmentReference, SegmentReference.Builder
public interface SegmentReferenceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getNetworkAddressUsedAtPeer()
    The network address, including ip/hostname and port, which is used in the client side.
    com.google.protobuf.ByteString
    getNetworkAddressUsedAtPeerBytes()
    The network address, including ip/hostname and port, which is used in the client side.
    String
    getParentEndpoint()
    The endpoint name of the parent segment.
    com.google.protobuf.ByteString
    getParentEndpointBytes()
    The endpoint name of the parent segment.
    String
    getParentService()
    The service logic name of the parent segment.
    com.google.protobuf.ByteString
    getParentServiceBytes()
    The service logic name of the parent segment.
    String
    getParentServiceInstance()
    The service logic name instance of the parent segment.
    com.google.protobuf.ByteString
    getParentServiceInstanceBytes()
    The service logic name instance of the parent segment.
    int
    getParentSpanId()
    The span id in the parent trace segment.
    String
    getParentTraceSegmentId()
    Another segment id as the parent.
    com.google.protobuf.ByteString
    getParentTraceSegmentIdBytes()
    Another segment id as the parent.
    RefType
    getRefType()
    Represent the reference type.
    int
    getRefTypeValue()
    Represent the reference type.
    String
    getTraceId()
    A string id represents the whole trace.
    com.google.protobuf.ByteString
    getTraceIdBytes()
    A string id represents the whole trace.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getRefTypeValue

      int getRefTypeValue()
       Represent the reference type. It could be across thread or across process.
 Across process means there is a downstream RPC call for this.
 Typically, refType == CrossProcess means SpanObject#spanType = entry.
      .skywalking.v3.RefType refType = 1;
      Returns:
      The enum numeric value on the wire for refType.

    • getRefType

      RefType getRefType()
       Represent the reference type. It could be across thread or across process.
 Across process means there is a downstream RPC call for this.
 Typically, refType == CrossProcess means SpanObject#spanType = entry.
      .skywalking.v3.RefType refType = 1;
      Returns:
      The refType.

    • getTraceId

      String getTraceId()
       A string id represents the whole trace.
      string traceId = 2;
      Returns:
      The traceId.

    • getTraceIdBytes

      com.google.protobuf.ByteString getTraceIdBytes()
       A string id represents the whole trace.
      string traceId = 2;
      Returns:
      The bytes for traceId.

    • getParentTraceSegmentId

      String getParentTraceSegmentId()
       Another segment id as the parent.
      string parentTraceSegmentId = 3;
      Returns:
      The parentTraceSegmentId.

    • getParentTraceSegmentIdBytes

      com.google.protobuf.ByteString getParentTraceSegmentIdBytes()
       Another segment id as the parent.
      string parentTraceSegmentId = 3;
      Returns:
      The bytes for parentTraceSegmentId.

    • getParentSpanId

      int getParentSpanId()
       The span id in the parent trace segment.
      int32 parentSpanId = 4;
      Returns:
      The parentSpanId.

    • getParentService

      String getParentService()
       The service logic name of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.
      string parentService = 5;
      Returns:
      The parentService.

    • getParentServiceBytes

      com.google.protobuf.ByteString getParentServiceBytes()
       The service logic name of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.
      string parentService = 5;
      Returns:
      The bytes for parentService.

    • getParentServiceInstance

      String getParentServiceInstance()
       The service logic name instance of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.
      string parentServiceInstance = 6;
      Returns:
      The parentServiceInstance.

    • getParentServiceInstanceBytes

      com.google.protobuf.ByteString getParentServiceInstanceBytes()
       The service logic name instance of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.
      string parentServiceInstance = 6;
      Returns:
      The bytes for parentServiceInstance.

    • getParentEndpoint

      String getParentEndpoint()
       The endpoint name of the parent segment.
 **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
 In a trace segment, the endpoint name is the name of first entry span.
      string parentEndpoint = 7;
      Returns:
      The parentEndpoint.

    • getParentEndpointBytes

      com.google.protobuf.ByteString getParentEndpointBytes()
       The endpoint name of the parent segment.
 **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
 In a trace segment, the endpoint name is the name of first entry span.
      string parentEndpoint = 7;
      Returns:
      The bytes for parentEndpoint.

    • getNetworkAddressUsedAtPeer

      String getNetworkAddressUsedAtPeer()
       The network address, including ip/hostname and port, which is used in the client side.
 Such as Client --> use 127.0.11.8:913 -> Server
 then, in the reference of entry span reported by Server, the value of this field is 127.0.11.8:913.
 This plays the important role in the SkyWalking STAM(Streaming Topology Analysis Method)
 For more details, read https://wu-sheng.github.io/STAM/
      string networkAddressUsedAtPeer = 8;
      Returns:
      The networkAddressUsedAtPeer.

    • getNetworkAddressUsedAtPeerBytes

      com.google.protobuf.ByteString getNetworkAddressUsedAtPeerBytes()
       The network address, including ip/hostname and port, which is used in the client side.
 Such as Client --> use 127.0.11.8:913 -> Server
 then, in the reference of entry span reported by Server, the value of this field is 127.0.11.8:913.
 This plays the important role in the SkyWalking STAM(Streaming Topology Analysis Method)
 For more details, read https://wu-sheng.github.io/STAM/
      string networkAddressUsedAtPeer = 8;
      Returns:
      The bytes for networkAddressUsedAtPeer.