12. 定制
12.1. 禁用默认日志记录模式
Spring Cloud Sleuth 设置默认日志记录模式。要禁用它，请将spring.sleuth.default-logging-pattern-enabled属性设置为false.
12.2. 定制器
使用 Brave 5.7，您可以选择为您的项目提供定制器。勇敢的船
-
TracingCustomizer- 允许配置插件协作构建Tracing. -
CurrentTraceContextCustomizer- 允许配置插件协作构建CurrentTraceContext. -
ExtraFieldCustomizer- 允许配置插件协作构建ExtraFieldPropagation.Factory.
Sleuth 将搜索这些类型的 bean 并自动应用自定义。
12.3. HTTP
12.3.1. 数据政策
HTTP 请求的默认跨度数据策略在 Brave：github.com/openzipkin/brave/tree/master/instrumentation/http#span-data-policy 中进行了描述
要向 span 添加不同的数据，您需要注册一个类型的 beanbrave.http.HttpRequestParser或brave.http.HttpResponseParser基于时间
收集数据。
bean名称对应请求端或响应端，是否
客户端或服务器。例如sleuthHttpClientRequestParser改变什么
在将客户端请求发送到服务器之前收集。
为了您的方便@HttpClientRequestParser,@HttpClientResponseParser并且可以使用相应的服务器注释来注入适当的 bean
或者通过其静态字符串引用 bean 名称NAME领域。
下面是一个除了默认值之外添加 HTTP url 的示例：
@Configuration
class Config {
@Bean(name = { HttpClientRequestParser.NAME, HttpServerRequestParser.NAME })
HttpRequestParser sleuthHttpServerRequestParser() {
return (req, context, span) -> {
HttpRequestParser.DEFAULT.parse(req, context, span);
String url = req.url();
if (url != null) {
span.tag("http.url", url);
}
};
}
}12.3.2. 采样
如果需要客户端/服务器采样，只需注册一个类型为brave.sampler.SamplerFunction<HttpRequest>并命名 beansleuthHttpClientSampler用于客户端采样器和sleuthHttpServerSampler用于服务器采样器。
为方便起见，该@HttpClientSampler和@HttpServerSampler注释可用于注入适当的 bean 或引用 bean
名称通过其静态字符串NAME领域。
查看 Brave 的代码，了解如何制作基于路径的采样器 github.com/openzipkin/brave/tree/master/instrumentation/http#sampling-policy 示例
如果您想完全重写HttpTracingbean 您可以使用SkipPatternProvider接口来检索 URLPattern对于不应采样的跨度。下面你可以看到
用法示例SkipPatternProvider在服务器端，Sampler<HttpRequest>.
@Configuration
class Config {
@Bean(name = HttpServerSampler.NAME)
SamplerFunction<HttpRequest> myHttpSampler(SkipPatternProvider provider) {
Pattern pattern = provider.skipPattern();
return request -> {
String url = request.path();
boolean shouldSkip = pattern.matcher(url).matches();
if (shouldSkip) {
return false;
}
return null;
};
}
}12.4.TracingFilter
您还可以修改TracingFilter，这是负责处理输入 HTTP 请求并基于 HTTP 响应添加标签的组件。
您可以通过注册自己的TracingFilter豆。
在下面的示例中，我们将TracingFilterbean，添加ZIPKIN-TRACE-IDresponse 标头，并添加一个带有键custom和一个值tag到跨度。
@Component
@Order(TraceWebServletAutoConfiguration.TRACING_FILTER_ORDER + 1)
class MyFilter extends GenericFilterBean {
private final Tracer tracer;
MyFilter(Tracer tracer) {
this.tracer = tracer;
}
@Override
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
Span currentSpan = this.tracer.currentSpan();
if (currentSpan == null) {
chain.doFilter(request, response);
return;
}
// for readability we're returning trace id in a hex form
((HttpServletResponse) response).addHeader("ZIPKIN-TRACE-ID",
currentSpan.context().traceIdString());
// we can also add some custom tags
currentSpan.tag("custom", "tag");
chain.doFilter(request, response);
}
}12.5. 消息传递
Sleuth 会自动配置MessagingTracingbean 用作
Kafka 或 JMS 等消息传递工具的基础。
如果需要自定义消息传递跟踪的生产者/消费者采样，
只需注册一个类型为brave.sampler.SamplerFunction<MessagingRequest>和
命名 beansleuthProducerSampler用于生产者采样器和sleuthConsumerSampler用于消费者采样器。
为方便起见，该@ProducerSampler和@ConsumerSampler注释可用于注入适当的 bean 或引用 bean
名称通过其静态字符串NAME领域。
前任。这是一个采样器，每秒跟踪 100 个使用者请求，但
“警报”通道。其他请求将使用Tracing元件。
@Configuration
class Config {
}12.5.1. 自定义消息传递范围
为了更改默认的 span 名称和标签，只需注册一个MessageSpanCustomizer.您还可以
覆盖现有的DefaultMessageSpanCustomizer以扩展现有行为。
@Component
class MyMessageSpanCustomizer extends DefaultMessageSpanCustomizer {
@Override
public SpanCustomizer customizeHandle(SpanCustomizer spanCustomizer,
Message<?> message, MessageChannel messageChannel) {
return super.customizeHandle(spanCustomizer, message, messageChannel)
.name("changedHandle")
.tag("handleKey", "handleValue")
.tag("channelName", channelName(messageChannel));
}
@Override
public SpanCustomizer customizeSend(SpanCustomizer spanCustomizer,
Message<?> message, MessageChannel messageChannel) {
return super.customizeSend(spanCustomizer, message, messageChannel)
.name("changedSend")
.tag("sendKey", "sendValue")
.tag("channelName", channelName(messageChannel));
}
}12.6. RPC
Sleuth 会自动配置RpcTracingbean 用作
RPC 检测（例如 gRPC 或 Dubbo）的基础。
如果需要自定义 RPC 跟踪的客户端/服务器采样，
只需注册一个类型为brave.sampler.SamplerFunction<RpcRequest>和
命名 beansleuthRpcClientSampler用于客户端采样器和sleuthRpcServerSampler用于服务器采样器。
为方便起见，该@RpcClientSampler和@RpcServerSampler注释可用于注入适当的 bean 或引用 bean
名称通过其静态字符串NAME领域。
前任。这是一个采样器，每秒跟踪 100 个“GetUserToken”服务器请求。 这不会为对运行状况检查服务的请求启动新的跟踪。其他 请求将使用全局采样配置。
@Configuration
class Config {
@Bean(name = RpcServerSampler.NAME)
SamplerFunction<RpcRequest> myRpcSampler() {
Matcher<RpcRequest> userAuth = and(serviceEquals("users.UserService"),
methodEquals("GetUserToken"));
return RpcRuleSampler.newBuilder()
.putRule(serviceEquals("grpc.health.v1.Health"), Sampler.NEVER_SAMPLE)
.putRule(userAuth, RateLimitingSampler.create(100)).build();
}
}12.7. 自定义服务名称
默认情况下，Sleuth 假设当您向 Zipkin 发送 span 时，您希望该 span 的服务名称等于spring.application.name财产。
不过，情况并非总是如此。
在某些情况下，您希望为来自应用程序的所有跨度显式提供不同的服务名称。
为此，可以将以下属性传递给应用程序以覆盖该值（示例适用于名为myService):
spring.zipkin.service.name: myService12.8. 自定义报告的跨度
在报告跨度（例如，向 Zipkin）之前，您可能希望以某种方式修改该跨度。
您可以通过实现SpanHandler.
在 Sleuth 中，我们生成具有固定名称的跨度。
一些用户希望根据标签的值修改名称。
您可以实现SpanHandler接口来更改该名称。
以下示例显示如何注册两个实现SpanHandler:
@Bean
SpanHandler handlerOne() {
return new SpanHandler() {
@Override
public boolean end(TraceContext traceContext, MutableSpan span,
Cause cause) {
span.name("foo");
return true; // keep this span
}
};
}
@Bean
SpanHandler handlerTwo() {
return new SpanHandler() {
@Override
public boolean end(TraceContext traceContext, MutableSpan span,
Cause cause) {
span.name(span.name() + " bar");
return true; // keep this span
}
};
}前面的示例导致将报告的跨度的名称更改为foo bar，就在报告之前（例如，向 Zipkin）。
12.9. 主机定位器
| 本节介绍从服务发现定义主机。 这不是通过服务发现来寻找 Zipkin。 |
要定义与特定跨度相对应的主机，我们需要解析主机名和端口。 默认方法是从服务器属性中获取这些值。 如果未设置这些，我们尝试从网络接口检索主机名。
如果您启用了发现客户端，并且希望从服务注册表中的已注册实例中检索主机地址，则必须将spring.zipkin.locator.discovery.enabled属性（适用于基于 HTTP 和基于流的跨度报告），如下所示：
spring.zipkin.locator.discovery.enabled: true