附录
常见应用属性
可以在您的内部指定各种属性application.properties文件，在application.yml文件，或作为命令行开关。
本附录提供了常见 Spring Cloud Sleuth 属性的列表以及对使用它们的底层类的引用。
| 属性贡献可能来自类路径上的其他 jar 文件，因此您不应将其视为详尽的列表。 此外，您可以定义自己的属性。 |
| 名称 | 默认值 | 描述 |
|---|---|---|
spring.sleuth.async.configurer.enabled |
|
启用默认的 AsyncConfigurer。 |
spring.sleuth.async.enabled |
|
启用检测异步相关组件，以便在线程之间传递跟踪信息。 |
spring.sleuth.async.ignored-beans |
应忽略且不包装在跟踪表示中的 {@link java.util.concurrent.Executor} bean 名称的列表。 |
|
spring.sleuth.baggage.correlation-enabled |
|
启用将行李上下文与日志记录上下文相关联。 |
spring.sleuth.baggage.correlation-fields |
||
spring.sleuth.baggage.local-字段 |
||
spring.sleuth.baggage.remote-字段 |
引用的字段列表与在网络上引用的进程中相同。例如，字段“x-vcap-request-id”将按原样设置，包括前缀。 |
|
spring.sleuth.baggage.tag-fields |
||
spring.sleuth.circuitbreaker.enabled |
|
启用 Spring Cloud CircuitBreaker 检测。 |
spring.sleuth.启用 |
|
|
spring.sleuth.feign.enabled |
|
使用Feign时启用跨度信息传播。 |
spring.sleuth.feign.processor.enabled |
|
启用后处理器，将 Feign Context 包装在其跟踪表示中。 |
spring.sleuth.function.enabled |
|
启用 Spring Cloud Function 和基于 Spring Cloud Function 的项目（例如 Spring Cloud Stream）的检测。 |
spring.sleuth.grpc.启用 |
|
使用 GRPC 时启用跨度信息传播。 |
spring.sleuth.http.enabled |
|
启用 HTTP 支持。 |
spring.sleuth.integration.enabled |
|
启用 Spring Integration 侦探检测。 |
spring.sleuth.integration.patterns |
|
将与通道名称匹配的模式数组。@see org.springframework.integration.config.GlobalChannelInterceptor#patterns（） 默认为与 Hystrix Stream 和功能 Stream 通道名称不匹配的任何通道名称。 |
spring.sleuth.integration.websockets.enabled |
|
启用 WebSocket 的跟踪。 |
spring.sleuth.messaging.enabled |
|
是否应该打开消息传递。 |
spring.sleuth.messaging.jms.enabled |
|
启用 JMS 的跟踪。 |
spring.sleuth.messaging.jms.远程服务名称 |
|
JMS 远程服务名称。 |
spring.sleuth.messaging.kafka.enabled |
|
启用 Kafka 的跟踪。 |
spring.sleuth.messaging.kafka.mapper.enabled |
|
为 Kafka 启用 DefaultKafkaHeaderMapper 跟踪。 |
spring.sleuth.messaging.kafka.远程服务名称 |
|
Kafka 远程服务名称。 |
spring.sleuth.messaging.kafka.streams.enabled |
|
是否应该打开 Kafka Streams。 |
spring.sleuth.messaging.rabbit.enabled |
|
启用 RabbitMQ 的跟踪。 |
spring.sleuth.messaging.rabbit.remote-service-name |
|
Rabbit 远程服务名称。 |
spring.sleuth.mongodb.enabled |
|
启用 MongoDb 的跟踪。 |
spring.sleuth.opentracing.enabled |
|
启用 OpenTracing 支持。 |
spring.sleuth.propagation.type |
跟踪上下文传播类型。 |
|
spring.sleuth.quartz.enabled |
|
启用 Quartz 的跟踪。 |
spring.sleuth.reactor.装饰 |
|
当 true 在每个运算符上修饰时，性能会降低，但日志记录将始终包含每个运算符中的跟踪条目。当 false 在最后一个运算符上修饰时，将执行更高性能，但日志记录可能并不总是包含跟踪条目。@deprecated通过{@link SleuthReactorProperties#instrumentationType}使用显式值 |
spring.sleuth.reactor.启用 |
|
当 true 时，为反应堆启用仪器。 |
spring.sleuth.reactor.instrumentation-type |
||
spring.sleuth.redis.启用 |
|
使用 Redis 时启用跨度信息传播。 |
spring.sleuth.redis.remote-service-name |
|
远程 Redis 终结点的服务名称。 |
spring.sleuth.rpc.启用 |
|
启用 RPC 跟踪。 |
spring.sleuth.rxjava.schedulers.hook.enabled |
|
通过 RxJavaSchedulersHook 启用对 RxJava 的支持。 |
spring.sleuth.rxjava.schedulers.ignored线程 |
|
不会对跨度进行采样的线程名称。 |
spring.sleuth.sampler.概率 |
应采样的请求的概率。例如，应对 1.0 - 100% 请求进行采样。精度仅为整数（即不支持 0.1% 的跟踪）。 |
|
spring.sleuth.sampler.rate |
|
对于低流量端点，每秒速率可能是一个不错的选择，因为它允许您进行浪涌保护。例如，您可能永远不会期望终结点每秒收到超过 50 个请求。如果流量突然激增，达到每秒 5000 个请求，您最终仍将每秒获得 50 个跟踪。相反，如果您有一个百分比，例如 10%，同样的激增最终会每秒产生 500 条跟踪，可能会使您的存储过载。Amazon X-Ray 为此提供了一个速率限制采样器（名为 Reservoir）。Brave 通过 {@link brave.sampler.RateLimitingSampler} 采取了相同的方法。 |
spring.sleuth.sampler.refresh.enabled |
|
为采样器启用刷新范围。 |
spring.sleuth.scheduled.enabled |
|
启用 {@link org.springframework.scheduling.annotation.Scheduled} 的跟踪。 |
spring.sleuth.scheduled.skip-pattern |
应跳过的类的完全限定名称的模式。 |
|
spring.sleuth.span-filter.additional-span-name-patterns-to-ignore |
要忽略的跨度名称的其他列表。将附加到 {@link #spanNamePatternsToSkip}。 |
|
spring.sleuth.span-filter.enabled |
|
将打开默认的侦探处理程序机制。可能会忽略某些跨度的导出; |
spring.sleuth.span-filter.span-name-patterns-to-skip |
|
要忽略的范围名称列表。它们不会被发送到外部系统。 |
spring.sleuth.supports-join |
|
True 表示跟踪系统支持在客户端和服务器之间共享 span ID。 |
spring.sleuth.trace-id128 |
|
如果为 true，则生成 128 位跟踪 ID，而不是 64 位跟踪 ID。 |
spring.sleuth.tracer.mode |
设置应选择哪个跟踪器实现。 |
|
spring.sleuth.web.additional-skip-pattern |
跟踪中应跳过的 URL 的其他模式。这将附加到 {@link SleuthWebProperties#skipPattern} 中。 |
|
spring.sleuth.web.client.enabled |
|
启用拦截器注入 {@link org.springframework.web.client.RestTemplate}。 |
spring.sleuth.web.client.skip-pattern |
在客户端跟踪中应跳过的 URL 的模式。 |
|
spring.sleuth.web.enabled |
|
如果为 true，则为 Web 应用程序启用检测。 |
spring.sleuth.web.filter-order |
|
跟踪筛选器的注册顺序。 |
spring.sleuth.web.ignore-auto-configured-skip-patterns |
|
如果设置为 true，则将忽略自动配置的跳过模式。 |
spring.sleuth.web.servlet.enabled |
|
启用 servlet 检测。 |
spring.sleuth.web.skip-pattern |
|
跟踪中应跳过的 URL 的模式。 |
spring.sleuth.web.webclient.enabled |
|
为 WebClient 启用跟踪检测。 |
spring.zipkin.activemq.message-max-bytes |
|
给定消息的最大字节数，其跨度通过 ActiveMQ 发送到 Zipkin。 |
spring.zipkin.activemq.queue |
|
应将 span 发送到 Zipkin 的 ActiveMQ 队列的名称。 |
spring.zipkin.api 路径 |
要作为后缀附加到 baseUrl（上图）的 API 路径。如果您使用其他监控工具（例如 New Relic），则适用此作。跟踪 API 不需要 API 路径，因此您可以在配置中将其设置为空白 （“”）。 |
|
spring.zipkin.base-url |
zipkin 查询服务器实例的 URL。如果 Zipkin 在服务发现中注册，您还可以提供 Zipkin 服务器的服务 ID（例如 zipkinserver/）。 |
|
spring.zipkin.compression.enabled |
|
|
spring.zipkin.discovery-client-enabled |
如果设置为 {@code false}，则将始终将 {@link ZipkinProperties#baseUrl} 视为 URL。 |
|
spring.zipkin.启用 |
|
启用向 Zipkin 发送范围。 |
spring.zipkin.编码器 |
发送到 Zipkin 的 span 的编码类型。如果您的服务器不是最近的，请设置为 {@link SpanBytesEncoder#JSON_V1}。 |
|
spring.zipkin.kafka.topic |
|
应将跨度发送到 Zipkin 的 Kafka 主题的名称。 |
spring.zipkin.locator.discovery.enabled |
|
启用通过服务发现查找主机名。 |
spring.zipkin.message-超时 |
|
在待处理的跨度将批量发送到 Zipkin 之前的超时（以秒为单位）。 |
spring.zipkin.rabbitmq.地址 |
用于向 Zipkin 发送 span 的 RabbitMQ 代理的地址 |
|
spring.zipkin.rabbitmq.queue |
|
应将 span 发送到 Zipkin 的 RabbitMQ 队列的名称。 |
spring.zipkin.sender.类型 |
向 Zipkin 发送跨度的方法。 |
|
spring.zipkin.service.name |
通过 HTTP 发送 Span 的服务名称，应显示在 Zipkin 中。 |