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

Class SpanAttachedEvent

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.apache.skywalking.apm.network.language.agent.v3.SpanAttachedEvent
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SpanAttachedEventOrBuilder
public final class SpanAttachedEvent extends com.google.protobuf.GeneratedMessageV3 implements SpanAttachedEventOrBuilder
 SpanAttachedEvent represents an attached event for a traced RPC.
 When an RPC is being traced by the in-process language agent, a span would be reported by the client-side agent.
 And the rover would be aware of this RPC due to the existing tracing header.
 Then, the rover agent collects extra information from the OS level to provide assistance information to diagnose network performance.
Protobuf type skywalking.v3.SpanAttachedEvent
See Also:

  • Field Details

  • Method Details

    • 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

    • hasStartTime

      public boolean hasStartTime()
       The nanosecond timestamp of the event's start time.
 Notice, most unit of timestamp in SkyWalking is milliseconds, but NANO-SECOND is required here.
 Because the attached event happens in the OS syscall level, most of them are executed rapidly.
      .skywalking.v3.Instant startTime = 1;
      Specified by:
      hasStartTime in interface SpanAttachedEventOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public Instant getStartTime()
       The nanosecond timestamp of the event's start time.
 Notice, most unit of timestamp in SkyWalking is milliseconds, but NANO-SECOND is required here.
 Because the attached event happens in the OS syscall level, most of them are executed rapidly.
      .skywalking.v3.Instant startTime = 1;
      Specified by:
      getStartTime in interface SpanAttachedEventOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public InstantOrBuilder getStartTimeOrBuilder()
       The nanosecond timestamp of the event's start time.
 Notice, most unit of timestamp in SkyWalking is milliseconds, but NANO-SECOND is required here.
 Because the attached event happens in the OS syscall level, most of them are executed rapidly.
      .skywalking.v3.Instant startTime = 1;
      Specified by:
      getStartTimeOrBuilder in interface SpanAttachedEventOrBuilder

    • getEvent

      public String getEvent()
       The official event name.
 For example, the event name is a method signature from syscall stack.
      string event = 2;
      Specified by:
      getEvent in interface SpanAttachedEventOrBuilder
      Returns:
      The event.

    • getEventBytes

      public com.google.protobuf.ByteString getEventBytes()
       The official event name.
 For example, the event name is a method signature from syscall stack.
      string event = 2;
      Specified by:
      getEventBytes in interface SpanAttachedEventOrBuilder
      Returns:
      The bytes for event.

    • hasEndTime

      public boolean hasEndTime()
       [Optional] The nanosecond timestamp of the event's end time.
      .skywalking.v3.Instant endTime = 3;
      Specified by:
      hasEndTime in interface SpanAttachedEventOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public Instant getEndTime()
       [Optional] The nanosecond timestamp of the event's end time.
      .skywalking.v3.Instant endTime = 3;
      Specified by:
      getEndTime in interface SpanAttachedEventOrBuilder
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      public InstantOrBuilder getEndTimeOrBuilder()
       [Optional] The nanosecond timestamp of the event's end time.
      .skywalking.v3.Instant endTime = 3;
      Specified by:
      getEndTimeOrBuilder in interface SpanAttachedEventOrBuilder

    • getTagsList

      public List<KeyStringValuePair> getTagsList()
       The tags for this event includes some extra OS level information,
 such as
 1. net_device used for this exit span.
 2. network L7 protocol
      repeated .skywalking.v3.KeyStringValuePair tags = 4;
      Specified by:
      getTagsList in interface SpanAttachedEventOrBuilder

    • getTagsOrBuilderList

      public List<? extends KeyStringValuePairOrBuilder> getTagsOrBuilderList()
       The tags for this event includes some extra OS level information,
 such as
 1. net_device used for this exit span.
 2. network L7 protocol
      repeated .skywalking.v3.KeyStringValuePair tags = 4;
      Specified by:
      getTagsOrBuilderList in interface SpanAttachedEventOrBuilder

    • getTagsCount

      public int getTagsCount()
       The tags for this event includes some extra OS level information,
 such as
 1. net_device used for this exit span.
 2. network L7 protocol
      repeated .skywalking.v3.KeyStringValuePair tags = 4;
      Specified by:
      getTagsCount in interface SpanAttachedEventOrBuilder

    • getTags

      public KeyStringValuePair getTags(int index)
       The tags for this event includes some extra OS level information,
 such as
 1. net_device used for this exit span.
 2. network L7 protocol
      repeated .skywalking.v3.KeyStringValuePair tags = 4;
      Specified by:
      getTags in interface SpanAttachedEventOrBuilder

    • getTagsOrBuilder

      public KeyStringValuePairOrBuilder getTagsOrBuilder(int index)
       The tags for this event includes some extra OS level information,
 such as
 1. net_device used for this exit span.
 2. network L7 protocol
      repeated .skywalking.v3.KeyStringValuePair tags = 4;
      Specified by:
      getTagsOrBuilder in interface SpanAttachedEventOrBuilder

    • getSummaryList

      public List<KeyIntValuePair> getSummaryList()
       The summary of statistics during this event.
 Each statistic provides a name(metric name) to represent the name, and an int64/long as the value.
      repeated .skywalking.v3.KeyIntValuePair summary = 5;
      Specified by:
      getSummaryList in interface SpanAttachedEventOrBuilder

    • getSummaryOrBuilderList

      public List<? extends KeyIntValuePairOrBuilder> getSummaryOrBuilderList()
       The summary of statistics during this event.
 Each statistic provides a name(metric name) to represent the name, and an int64/long as the value.
      repeated .skywalking.v3.KeyIntValuePair summary = 5;
      Specified by:
      getSummaryOrBuilderList in interface SpanAttachedEventOrBuilder

    • getSummaryCount

      public int getSummaryCount()
       The summary of statistics during this event.
 Each statistic provides a name(metric name) to represent the name, and an int64/long as the value.
      repeated .skywalking.v3.KeyIntValuePair summary = 5;
      Specified by:
      getSummaryCount in interface SpanAttachedEventOrBuilder

    • getSummary

      public KeyIntValuePair getSummary(int index)
       The summary of statistics during this event.
 Each statistic provides a name(metric name) to represent the name, and an int64/long as the value.
      repeated .skywalking.v3.KeyIntValuePair summary = 5;
      Specified by:
      getSummary in interface SpanAttachedEventOrBuilder

    • getSummaryOrBuilder

      public KeyIntValuePairOrBuilder getSummaryOrBuilder(int index)
       The summary of statistics during this event.
 Each statistic provides a name(metric name) to represent the name, and an int64/long as the value.
      repeated .skywalking.v3.KeyIntValuePair summary = 5;
      Specified by:
      getSummaryOrBuilder in interface SpanAttachedEventOrBuilder

    • hasTraceContext

      public boolean hasTraceContext()
       Refer to a trace context decoded from `sw8` header through network, such as HTTP header, MQ metadata
 https://skywalking.apache.org/docs/main/next/en/protocols/skywalking-cross-process-propagation-headers-protocol-v3/#standard-header-item
      .skywalking.v3.SpanAttachedEvent.SpanReference traceContext = 6;
      Specified by:
      hasTraceContext in interface SpanAttachedEventOrBuilder
      Returns:
      Whether the traceContext field is set.

    • getTraceContext

      public SpanAttachedEvent.SpanReference getTraceContext()
       Refer to a trace context decoded from `sw8` header through network, such as HTTP header, MQ metadata
 https://skywalking.apache.org/docs/main/next/en/protocols/skywalking-cross-process-propagation-headers-protocol-v3/#standard-header-item
      .skywalking.v3.SpanAttachedEvent.SpanReference traceContext = 6;
      Specified by:
      getTraceContext in interface SpanAttachedEventOrBuilder
      Returns:
      The traceContext.

    • getTraceContextOrBuilder

      public SpanAttachedEvent.SpanReferenceOrBuilder getTraceContextOrBuilder()
       Refer to a trace context decoded from `sw8` header through network, such as HTTP header, MQ metadata
 https://skywalking.apache.org/docs/main/next/en/protocols/skywalking-cross-process-propagation-headers-protocol-v3/#standard-header-item
      .skywalking.v3.SpanAttachedEvent.SpanReference traceContext = 6;
      Specified by:
      getTraceContextOrBuilder in interface SpanAttachedEventOrBuilder

    • 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 SpanAttachedEvent parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static SpanAttachedEvent parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static SpanAttachedEvent parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static SpanAttachedEvent parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SpanAttachedEvent parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static SpanAttachedEvent parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public SpanAttachedEvent.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SpanAttachedEvent.Builder newBuilder()

    • newBuilder

      public static SpanAttachedEvent.Builder newBuilder(SpanAttachedEvent prototype)

    • toBuilder

      public SpanAttachedEvent.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SpanAttachedEvent.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static SpanAttachedEvent getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SpanAttachedEvent> 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 SpanAttachedEvent getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder