1、skywalking源码--Agent收集trace数据

原创

已于 2025-02-14 20:16:37 修改 · 913 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#skywalking #agent收集trace数据

于 2022-08-30 14:53:05 首次发布

本文深入剖析SkyWalking 8.9.0版本中的链路追踪机制，详细介绍了trace数据的创建、暂存及传递过程涉及的主要类和方法。特别关注了trace和context相关的类，如TraceSegment、AbstractTracingSpan等。

本源码来自于skywalking-agent 8.9.0版本

注：本篇文章主要是作为自己看书后的总结，内容有可能会存在一些个人理解上的偏差，如果有网友找出问题欢迎提出，感谢！！！如果我理解上的错误误导了您，在此表示抱歉！！！

文章目录

概述

本篇文章讲述trace数据的创建、暂存、传递过程所涉及的类、方法实现，相关代码在apm-agent-core模块，主要是context包下的类。本篇主要讲述 trace和context 相关类。我们在下一篇还会根据本篇来讲述我们公司在这块的改造，敬请期待！！！

代码截图

在这里插入图片描述

trace

一个完整的trace可以简单的描述为segment、spand、id组成，当然实际并不是这样的，它更加复杂，因为这里里面涉及到跨进程、跨线程的传递、如何高效发送，所以会产生一些其他的存储对象。因此我们可以理解为在每个进程内都会存储一个 segment，这个segment里面会去处理跨进程、跨线程的传递、如何高效发送这些问题。

Segment相关

这个就是上面讲的segment。

代码

public class TraceSegment {
   
   
    /**
     * The id of this trace segment. Every segment has its unique-global-id.
     */
    private String traceSegmentId;

    /**
     * The refs of parent trace segments, except the primary one. For most RPC call, {@link #ref} contains only one
     * element, but if this segment is a start span of batch process, the segment faces multi parents, at this moment,
     * we only cache the first parent segment reference.
     * <p>
     * This field will not be serialized. Keeping this field is only for quick accessing.
     */
    private TraceSegmentRef ref;

    /**
     * The spans belong to this trace segment. They all have finished. All active spans are hold and controlled by
     * "skywalking-api" module.
     */
    private List<AbstractTracingSpan> spans;

    /**
     * The <code>relatedGlobalTraceId</code> represent the related trace. Most time it related only one
     * element, because only one parent {@link TraceSegment} exists, but, in batch scenario, the num becomes greater
     * than 1, also meaning multi-parents {@link TraceSegment}. But we only related the first parent TraceSegment.
     */
    private DistributedTraceId relatedGlobalTraceId;

    private boolean ignore = false;

    private boolean isSizeLimited = false;

    private final long createTime;

    /**
     * Create a default/empty trace segment, with current time as start time, and generate a new segment id.
     */
    public TraceSegment() {
   
   
        this.traceSegmentId = GlobalIdGenerator.generate();
        this.spans = new LinkedList<>();
        this.relatedGlobalTraceId = new NewDistributedTraceId();
        this.createTime = System.currentTimeMillis();
    }

    public TraceSegment(boolean ignore) {
   
   
        this();
        this.ignore = ignore;
    }

    /**
     * Establish the link between this segment and its parents.
     *
     * @param refSegment {@link TraceSegmentRef}
     */
    public void ref(TraceSegmentRef refSegment) {
   
   
        if (null == ref) {
   
   
            this.ref = refSegment;
        }
    }

    /**
     * Establish the line between this segment and the relative global trace id.
     */
    public void relatedGlobalTrace(DistributedTraceId distributedTraceId) {
   
   
        if (relatedGlobalTraceId instanceof NewDistributedTraceId) {
   
   
            this.relatedGlobalTraceId = distributedTraceId;
        }
    }

    /**
     * After {@link AbstractSpan} is finished, as be controller by "skywalking-api" module, notify the {@link
     * TraceSegment} to archive it.
     */
    public void archive(AbstractTracingSpan finishedSpan) {
   
   
        spans.add(finishedSpan);
    }

    /**
     * Finish this {@link TraceSegment}. <p> return this, for chaining
     */
    public TraceSegment finish(boolean isSizeLimited) {
   
   
        this.isSizeLimited = isSizeLimited;
        return this;
    }

    public String getTraceSegmentId() {
   
   
        return traceSegmentId;
    }

    /**
     * Get the first parent segment reference.
     */
    public TraceSegmentRef getRef() {
   
   
        return ref;
    }

    public DistributedTraceId getRelatedGlobalTrace() {
   
   
        return relatedGlobalTraceId;
    }

    public boolean isSingleSpanSegment() {
   
   
        return this.spans != null && this.spans.size() == 1;
    }

    public boolean isIgnore() {
   
   
        return ignore;
    }

    public void setIgnore(boolean ignore) {
   
   
        this.ignore = ignore;
    }

    /**
     * This is a high CPU cost method, only called when sending to collector or test cases.
     *
     * @return the segment as GRPC service parameter
     */
    public SegmentObject transform() {
   
   
        SegmentObject.Builder traceSegmentBuilder = SegmentObject.newBuilder();
        traceSegmentBuilder.setTraceId(getRelatedGlobalTrace().getId());
        /*
         * Trace Segment
         */
        traceSegmentBuilder.setTraceSegmentId(this.traceSegmentId);
        // Don't serialize TraceSegmentReference

        // SpanObject
        for (AbstractTracingSpan span : this.spans) {
   
   
            traceSegmentBuilder.addSpans(span.transform());
        }
        traceSegmentBuilder.setService(Config.Agent.SERVICE_NAME);
        traceSegmentBuilder.setServiceInstance(Config.Agent.INSTANCE_NAME);
        traceSegmentBuilder.setIsSizeLimited(this.isSizeLimited);

        return traceSegmentBuilder.build();
    }

    @Override
    public String toString() {
   
   
        return "TraceSegment{" + "traceSegmentId='" + traceSegmentId + '\'' + ", ref=" + ref + ", spans=" + spans + "}";
    }

    public long createTime() {
   
   
        return this.createTime;
    }
}