53. Sampling

可以采用采样来减少收集和报告的过程外数据。如果未对 Span 进行采样,则不会增加开销(无操作)。

采样是一项前期决策,这意味着报告数据的决策是在跟踪的第一个操作中做出的,并且该决策会向下游传播。

默认情况下,全局采样器将单个速率应用于所有跟踪的操作。 Tracer.Builder.sampler控制此设置,默认情况下将跟踪每个请求。

53.1 声明式采样

一些应用程序需要基于 java 方法的类型或 Comments 进行采样。

大多数用户使用框架拦截器来自动化这种策略。以下示例显示了它可能在内部如何工作:

@Autowired Tracer tracer;

// derives a sample rate from an annotation on a java method
DeclarativeSampler<Traced> sampler = DeclarativeSampler.create(Traced::sampleRate);

@Around("@annotation(traced)")
public Object traceThing(ProceedingJoinPoint pjp, Traced traced) throws Throwable {
  // When there is no trace in progress, this decides using an annotation
  Sampler decideUsingAnnotation = declarativeSampler.toSampler(traced);
  Tracer tracer = tracer.withSampler(decideUsingAnnotation);

  // This code looks the same as if there was no declarative override
  ScopedSpan span = tracer.startScopedSpan(spanName(pjp));
  try {
    return pjp.proceed();
  } catch (RuntimeException | Error e) {
    span.error(e);
    throw e;
  } finally {
    span.finish();
  }
}

53.2 自定义采样

根据操作的不同,您可能需要应用不同的策略。例如,您可能不想跟踪对静态资源(例如图像)的请求,或者您想跟踪所有对新 API 的请求。

大多数用户使用框架拦截器来自动化这种策略。以下示例显示了它可能在内部如何工作:

@Autowired Tracer tracer;
@Autowired Sampler fallback;

Span nextSpan(final Request input) {
  Sampler requestBased = Sampler() {
    @Override public boolean isSampled(long traceId) {
      if (input.url().startsWith("/experimental")) {
        return true;
      } else if (input.url().startsWith("/static")) {
        return false;
      }
      return fallback.isSampled(traceId);
    }
  };
  return tracer.withSampler(requestBased).nextSpan();
}

53.3 在 Spring Cloud Sleuth 中采样

默认情况下,Spring Cloud Sleuth 将所有范围设置为不可导出。这意味着跟踪将显示在日志中,而不显示在任何远程存储中。测试默认值通常就足够了,如果仅使用日志(例如,使用 ELK 聚合器),则可能只需要它即可。如果您将 Span 数据导出到 Zipkin,则还有一个Sampler.ALWAYS_SAMPLE设置可以导出所有内容,还有一个ProbabilityBasedSampler设置可以对固定比例的 Span 进行采样。

Note

如果使用spring-cloud-sleuth-zipkin,则默认为ProbabilityBasedSampler。您可以通过设置spring.sleuth.sampler.probability来配置导出。传递的值必须是0.01.0的两倍。

可以通过创建 bean 定义来安装采样器,如以下示例所示:

@Bean
public Sampler defaultSampler() {
	return Sampler.ALWAYS_SAMPLE;
}

Tip

您可以将 HTTPHeadersX-B3-Flags设置为1,或者在进行消息传递时,可以将spanFlagsHeaders 设置为1。这样做将强制电流 Span 可导出,而不管采样决定如何。

为了使用受速率限制的采样器,请设置spring.sleuth.sampler.rate属性以选择每秒钟间隔要接受的跟踪量。最小数字为 0,最大数字为 2,147,483,647(最大整数)。