Spring Cloud Sleuth 配置说明

た入场券 2022-11-16 13:43 788阅读 0赞

<table> 
 <thead> 
  <tr> 
   <th align="left">名称</th> 
   <th align="left">默认值</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">spring.sleuth.async.configurer.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用默认的AsyncConfigurer.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.async.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用检测与异步相关的组件，以便在线程之间传递跟踪信息.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.async.ignored-beans</td> 
   <td align="left"></td> 
   <td align="left">{@link java.util.concurrent.Executor} Bean名称列表，应忽略这些名称，而不应将它们包装在跟踪表示中</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.baggage.correlation-enabled</td> 
   <td align="left">true</td> 
   <td align="left">使行李环境与日志环境相关联.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.baggage.correlation-fields</td> 
   <td align="left"></td> 
   <td align="left">为了自动将行李值设置为Slf4j的MDC中，例如默认只有spanId和traceId，这里可以添加一个 parentSpanId，注意不要为MDC添加太多的内容这样对性能不好</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.baggage.local-fields</td> 
   <td align="left"></td> 
   <td align="left">是要在本地传播的名称的列表</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.baggage.remote-fields</td> 
   <td align="left"></td> 
   <td align="left">是要接受并传播到远程服务的标头名称的列表。 例如，字段“ x-request-id”将按原样设置，包括前缀.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.baggage.tag-fields</td> 
   <td align="left"></td> 
   <td align="left">如果要将行李条目添加为标签，以使可以通过行李条目搜索跨度，则可以spring.sleuth.baggage.tag-fields使用列入白名单的行李钥匙列表来设置的值</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.circuitbreaker.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用Spring Cloud CircuitBreaker工具.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.enabled</td> 
   <td align="left">true</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.feign.enabled</td> 
   <td align="left">true</td> 
   <td align="left">在使用Feign时启用跨度信息传播.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.feign.processor.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用将Feign Context包装在其跟踪表示中的后处理器.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.function.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用对Spring Cloud Function和基于Spring Cloud Function的项目的检测（例如Spring Cloud Stream）.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.grpc.enabled</td> 
   <td align="left">true</td> 
   <td align="left">使用GRPC时启用跨度信息传播.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.http.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用HTTP支持.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.integration.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用Spring Integration侦探检测.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.integration.patterns</td> 
   <td align="left">[!hystrixStreamOutput*, <strong>, !channel</strong>]</td> 
   <td align="left">通道名称将与之匹配的模式数组。 @see org.springframework.integration.config.GlobalChannelInterceptor＃patterns（）默认为与Hystrix Stream和功能Stream通道名称不匹配的任何通道名称.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.integration.websockets.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用对WebSocket的跟踪.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.messaging.enabled</td> 
   <td align="left">false</td> 
   <td align="left">是否应该打开消息传递.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.messaging.jms.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用JMS跟踪.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.messaging.jms.remote-service-name</td> 
   <td align="left">jms</td> 
   <td align="left">JMS远程服务名称.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.messaging.kafka.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用Kafka跟踪.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.messaging.kafka.mapper.enabled</td> 
   <td align="left">true</td> 
   <td align="left">为Kafka启用DefaultKafkaHeaderMapper跟踪.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.messaging.kafka.remote-service-name</td> 
   <td align="left">kafka</td> 
   <td align="left">Kafka远程服务名称.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.messaging.kafka.streams.enabled</td> 
   <td align="left">false</td> 
   <td align="left">是否应打开Kafka流.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.messaging.rabbit.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用RabbitMQ跟踪.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.messaging.rabbit.remote-service-name</td> 
   <td align="left">rabbitmq</td> 
   <td align="left">Rabbit远程服务名称.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.mongodb.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用MongoDb的跟踪.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.opentracing.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用OpenTracing支持.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.propagation.type</td> 
   <td align="left"></td> 
   <td align="left">跟踪上下文传播类型.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.quartz.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用Quartz跟踪.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.reactor.decorate-on-each</td> 
   <td align="left">true</td> 
   <td align="left">当在每个运算符上使用true装饰时，性能会下降，但是日志记录将始终包含每个运算符中的跟踪条目。 如果在最后一个运算符上使用false修饰符，则会有更好的表现，但日志记录可能并不总是包含跟踪条目。 通过{@link SleuthReactorProperties＃instrumentationType} @不推荐使用显式值</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.reactor.enabled</td> 
   <td align="left">true</td> 
   <td align="left">如果为true，则启用对反应堆的检测.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.reactor.instrumentation-type</td> 
   <td align="left"></td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.redis.enabled</td> 
   <td align="left">true</td> 
   <td align="left">使用Redis时启用跨度信息传播.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.redis.remote-service-name</td> 
   <td align="left">redis</td> 
   <td align="left">远程Redis端点的服务名称.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.rpc.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用RPC跟踪.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.rxjava.schedulers.hook.enabled</td> 
   <td align="left">true</td> 
   <td align="left">通过RxJavaSchedulersHook启用对RxJava的支持.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.rxjava.schedulers.ignoredthreads</td> 
   <td align="left">[HystrixMetricPoller, ^RxComputation.*$]</td> 
   <td align="left">不会采样其跨度的线程名称.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.sampler.probability</td> 
   <td align="left"></td> 
   <td align="left">应该采样的请求的概率。 例如。 1.0-应抽样100％的请求。 精度仅是整数（即不支持0.1％的迹线）.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.sampler.rate</td> 
   <td align="left">10</td> 
   <td align="left">对于低流量的端点，每秒速率可能是一个不错的选择，因为它可以为您提供浪涌保护。 例如，您可能永远不会期望端点每秒收到50个以上的请求。 如果流量突然激增到每秒5000个请求，那么每秒仍然会有50条痕迹。 相反，如果您有一个百分比（例如10％），则同一浪涌最终将导致每秒500条痕迹，这可能会使您的存储设备超负荷。 为此，Amazon X-Ray包括一个限速采样器（名为Reservoir）。 勇敢者通过{@link brave.sampler.RateLimitingSampler}采用了相同的方法.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.sampler.refresh.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用采样器的刷新范围.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.scheduled.enabled</td> 
   <td align="left">true</td> 
   <td align="left">为{@link org.springframework.scheduling.annotation.Scheduled}启用跟踪.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.scheduled.skip-pattern</td> 
   <td align="left"></td> 
   <td align="left">应该跳过的类的完全限定名称的模式.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.span-filter.additional-span-name-patterns-to-ignore</td> 
   <td align="left"></td> 
   <td align="left">要忽略的跨度名称的其他列表。 将附加到{@link #spanNamePatternsToSkip}.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.span-filter.enabled</td> 
   <td align="left">false</td> 
   <td align="left">将打开默认的Sleuth处理程序机制。 可能会忽略某些跨度的导出;</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.span-filter.span-name-patterns-to-skip</td> 
   <td align="left">^catalogWatchTaskScheduler$</td> 
   <td align="left">要忽略的范围名称列表。 它们不会被发送到外部系统.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.supports-join</td> 
   <td align="left">true</td> 
   <td align="left">true表示跟踪系统支持在客户端和服务器之间共享跨度ID.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.trace-id128</td> 
   <td align="left">false</td> 
   <td align="left">为true时，生成128位跟踪ID，而不是64位跟踪ID.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.tracer.mode</td> 
   <td align="left"></td> 
   <td align="left">设置应该选择哪个跟踪器实现.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.web.additional-skip-pattern</td> 
   <td align="left"></td> 
   <td align="left">跟踪中应跳过的URL的其他模式。 这将附加到{@link SleuthWebProperties＃skipPattern}.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.web.client.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用拦截器注入{@link org.springframework.web.client.RestTemplate}.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.web.client.skip-pattern</td> 
   <td align="left"></td> 
   <td align="left">在客户端跟踪中应跳过的URL的模式.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.web.enabled</td> 
   <td align="left">true</td> 
   <td align="left">如果为true，则启用对Web应用程序的检测.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.web.filter-order</td> 
   <td align="left">0</td> 
   <td align="left">跟踪过滤器应注册的顺序.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.web.ignore-auto-configured-skip-patterns</td> 
   <td align="left">false</td> 
   <td align="left">如果设置为true，将忽略自动配置的跳过模式.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.web.servlet.enabled</td> 
   <td align="left">true</td> 
   <td align="left">启用Servlet检测.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.web.skip-pattern</td> 
   <td align="left">/api-docs.**</td> 
   <td align="left">/swagger.**</td> 
  </tr> 
  <tr> 
   <td align="left">spring.sleuth.web.webclient.enabled</td> 
   <td align="left">true</td> 
   <td align="left">为WebClient启用跟踪检测.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.activemq.message-max-bytes</td> 
   <td align="left">100000</td> 
   <td align="left">通过ActiveMQ发送给Zipkin的跨度给定消息的最大字节数.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.activemq.queue</td> 
   <td align="left">zipkin</td> 
   <td align="left">ActiveMQ队列的名称，应将跨度发送到Zipkin.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.base-url</td> 
   <td align="left">localhost:9411/</td> 
   <td align="left">zipkin查询服务器实例的URL。 如果在服务发现中注册了Zipkin，您还可以提供Zipkin服务器的服务ID（例如[zipkinserver /]（https：// zipkinserver /））.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.compression.enabled</td> 
   <td align="left">false</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.discovery-client-enabled</td> 
   <td align="left"></td> 
   <td align="left">如果设置为{@code false}，则始终将{@link ZipkinProperties＃baseUrl}视为URL.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.enabled</td> 
   <td align="left">true</td> 
   <td align="left">允许发送跨度到Zipkin.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.encoder</td> 
   <td align="left"></td> 
   <td align="left">发送到Zipkin的跨度的编码类型。 如果您的服务器不是最新服务器，请设置为{@link SpanBytesEncoder＃JSON_V1}.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.kafka.topic</td> 
   <td align="left">zipkin</td> 
   <td align="left">Kafka主题的名称，应将跨度发送到Zipkin.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.locator.discovery.enabled</td> 
   <td align="left">false</td> 
   <td align="left">通过服务发现启用主机名定位.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.message-timeout</td> 
   <td align="left">1</td> 
   <td align="left">将待处理的跨度批量发送到Zipkin之前的超时时间（以秒为单位）.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.rabbitmq.addresses</td> 
   <td align="left"></td> 
   <td align="left">用于发送跨度到Zipkin的RabbitMQ经纪人的地址</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.rabbitmq.queue</td> 
   <td align="left">zipkin</td> 
   <td align="left">应该将跨度发送到Zipkin的RabbitMQ队列的名称.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.sender.type</td> 
   <td align="left"></td> 
   <td align="left">将跨度发送到Zipkin的方法.</td> 
  </tr> 
  <tr> 
   <td align="left">spring.zipkin.service.name</td> 
   <td align="left"></td> 
   <td align="left">通过HTTP从中发送跨度的服务名称，该名称应显示在Zipkin中.</td> 
  </tr> 
 </tbody> 
</table>

--------------------

官方文档：[https://cloud.spring.io/spring-cloud-sleuth/reference/html/][https_cloud.spring.io_spring-cloud-sleuth_reference_html]

--------------------

（END）

[https_cloud.spring.io_spring-cloud-sleuth_reference_html]: https://cloud.spring.io/spring-cloud-sleuth/reference/html/