程序包 org.apache.skywalking.apm.network.language.agent.v3

接口 SpanObjectOrBuilder

所有超级接口:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
所有已知实现类:
SpanObject, SpanObject.Builder
public interface SpanObjectOrBuilder extends com.google.protobuf.MessageOrBuilder

  • 方法详细资料

    • getSpanId

      int getSpanId()
       The number id of the span. Should be unique in the whole segment.
 Starting at 0.
      int32 spanId = 1;
      返回:
      The spanId.

    • getParentSpanId

      int getParentSpanId()
       The number id of the parent span in the whole segment.
 -1 represents no parent span.
 Also, be known as the root/first span of the segment.
      int32 parentSpanId = 2;
      返回:
      The parentSpanId.

    • getStartTime

      long getStartTime()
       Start timestamp in milliseconds of this span,
 measured between the current time and midnight, January 1, 1970 UTC.
      int64 startTime = 3;
      返回:
      The startTime.

    • getEndTime

      long getEndTime()
       End timestamp in milliseconds of this span,
 measured between the current time and midnight, January 1, 1970 UTC.
      int64 endTime = 4;
      返回:
      The endTime.

    • getRefsList

      List<SegmentReference> getRefsList()
       <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.
      repeated .skywalking.v3.SegmentReference refs = 5;

    • getRefs

      SegmentReference getRefs(int index)
       <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.
      repeated .skywalking.v3.SegmentReference refs = 5;

    • getRefsCount

      int getRefsCount()
       <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.
      repeated .skywalking.v3.SegmentReference refs = 5;

    • getRefsOrBuilderList

      List<? extends SegmentReferenceOrBuilder> getRefsOrBuilderList()
       <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.
      repeated .skywalking.v3.SegmentReference refs = 5;

    • getRefsOrBuilder

      SegmentReferenceOrBuilder getRefsOrBuilder(int index)
       <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.
      repeated .skywalking.v3.SegmentReference refs = 5;

    • getOperationName

      String getOperationName()
       A logic name represents this span.
 We don't recommend to include the parameter, such as HTTP request parameters, as a part of the operation, especially this is the name of the entry span.
 All statistic for the endpoints are aggregated base on this name. Those parameters should be added in the tags if necessary.
 If in some cases, it have to be a part of the operation name,
 users should use the Group Parameterized Endpoints capability at the backend to get the meaningful metrics.
 Read https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/endpoint-grouping-rules.md
      string operationName = 6;
      返回:
      The operationName.

    • getOperationNameBytes

      com.google.protobuf.ByteString getOperationNameBytes()
       A logic name represents this span.
 We don't recommend to include the parameter, such as HTTP request parameters, as a part of the operation, especially this is the name of the entry span.
 All statistic for the endpoints are aggregated base on this name. Those parameters should be added in the tags if necessary.
 If in some cases, it have to be a part of the operation name,
 users should use the Group Parameterized Endpoints capability at the backend to get the meaningful metrics.
 Read https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/endpoint-grouping-rules.md
      string operationName = 6;
      返回:
      The bytes for operationName.

    • getPeer

      String getPeer()
       Remote address of the peer in RPC/MQ case.
 This is required when spanType = Exit, as it is a part of the SkyWalking STAM(Streaming Topology Analysis Method).
 For more details, read https://wu-sheng.github.io/STAM/
      string peer = 7;
      返回:
      The peer.

    • getPeerBytes

      com.google.protobuf.ByteString getPeerBytes()
       Remote address of the peer in RPC/MQ case.
 This is required when spanType = Exit, as it is a part of the SkyWalking STAM(Streaming Topology Analysis Method).
 For more details, read https://wu-sheng.github.io/STAM/
      string peer = 7;
      返回:
      The bytes for peer.

    • getSpanTypeValue

      int getSpanTypeValue()
       Span type represents the role in the RPC context.
      .skywalking.v3.SpanType spanType = 8;
      返回:
      The enum numeric value on the wire for spanType.

    • getSpanType

      SpanType getSpanType()
       Span type represents the role in the RPC context.
      .skywalking.v3.SpanType spanType = 8;
      返回:
      The spanType.

    • getSpanLayerValue

      int getSpanLayerValue()
       Span layer represent the component tech stack, related to the network tech.
      .skywalking.v3.SpanLayer spanLayer = 9;
      返回:
      The enum numeric value on the wire for spanLayer.

    • getSpanLayer

      SpanLayer getSpanLayer()
       Span layer represent the component tech stack, related to the network tech.
      .skywalking.v3.SpanLayer spanLayer = 9;
      返回:
      The spanLayer.

    • getComponentId

      int getComponentId()
       Component id is a predefinited number id in the SkyWalking.
 It represents the framework, tech stack used by this tracked span, such as Spring.
 All IDs are defined in the https://github.com/apache/skywalking/blob/master/oap-server/server-bootstrap/src/main/resources/component-libraries.yml
 Send a pull request if you want to add languages, components or mapping defintions,
 all public components could be accepted.
 Follow this doc for more details, https://github.com/apache/skywalking/blob/master/docs/en/guides/Component-library-settings.md
      int32 componentId = 10;
      返回:
      The componentId.

    • getIsError

      boolean getIsError()
       The status of the span. False means the tracked execution ends in the unexpected status.
 This affects the successful rate statistic in the backend.
 Exception or error code happened in the tracked process doesn't mean isError == true, the implementations of agent plugin and tracing SDK make the final decision.
      bool isError = 11;
      返回:
      The isError.

    • getTagsList

      List<KeyStringValuePair> getTagsList()
       String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags
      repeated .skywalking.v3.KeyStringValuePair tags = 12;

    • getTags

      KeyStringValuePair getTags(int index)
       String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags
      repeated .skywalking.v3.KeyStringValuePair tags = 12;

    • getTagsCount

      int getTagsCount()
       String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags
      repeated .skywalking.v3.KeyStringValuePair tags = 12;

    • getTagsOrBuilderList

      List<? extends KeyStringValuePairOrBuilder> getTagsOrBuilderList()
       String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags
      repeated .skywalking.v3.KeyStringValuePair tags = 12;

    • getTagsOrBuilder

      KeyStringValuePairOrBuilder getTagsOrBuilder(int index)
       String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags
      repeated .skywalking.v3.KeyStringValuePair tags = 12;

    • getLogsList

      List<Log> getLogsList()
       String key, String value pair with an accurate timestamp.
 Logging some events happening in the context of the span duration.
      repeated .skywalking.v3.Log logs = 13;

    • getLogs

      Log getLogs(int index)
       String key, String value pair with an accurate timestamp.
 Logging some events happening in the context of the span duration.
      repeated .skywalking.v3.Log logs = 13;

    • getLogsCount

      int getLogsCount()
       String key, String value pair with an accurate timestamp.
 Logging some events happening in the context of the span duration.
      repeated .skywalking.v3.Log logs = 13;

    • getLogsOrBuilderList

      List<? extends LogOrBuilder> getLogsOrBuilderList()
       String key, String value pair with an accurate timestamp.
 Logging some events happening in the context of the span duration.
      repeated .skywalking.v3.Log logs = 13;

    • getLogsOrBuilder

      LogOrBuilder getLogsOrBuilder(int index)
       String key, String value pair with an accurate timestamp.
 Logging some events happening in the context of the span duration.
      repeated .skywalking.v3.Log logs = 13;

    • getSkipAnalysis

      boolean getSkipAnalysis()
       Force the backend don't do analysis, if the value is TRUE.
 The backend has its own configurations to follow or override this.
 Use this mostly because the agent/SDK could know more context of the service role.
      bool skipAnalysis = 14;
      返回:
      The skipAnalysis.