使用 Spring Cloud Sleuth 进行追踪
当 Spring Cloud Sleuth 存在于基于 Spring Cloud Stream Kafka Streams 绑定器的应用程序的类路径中时,其消费者和生产者都会自动被注入跟踪信息。然而,为了追踪任何应用程序特定的操作,这些操作需要通过用户代码显式地进行注入。这可以通过在应用程序中注入 Spring Cloud Sleuth 的 KafkaStreamsTracing
bean,然后通过这个注入的 bean 调用各种 Kafka Streams 操作来实现。以下是一些使用示例。
@Bean
public BiFunction<KStream<String, Long>, KTable<String, String>, KStream<String, Long>> clicks(KafkaStreamsTracing kafkaStreamsTracing) {
return (userClicksStream, userRegionsTable) -> (userClicksStream
.transformValues(kafkaStreamsTracing.peek("span-1", (key, value) -> LOG.info("key/value: " + key + "/" + value)))
.leftJoin(userRegionsTable, (clicks, region) -> new RegionWithClicks(region == null ?
"UNKNOWN" : region, clicks),
Joined.with(Serdes.String(), Serdes.Long(), null))
.transform(kafkaStreamsTracing.map("span-2", (key, value) -> {
LOG.info("Click Info: " + value.getRegion() + "/" + value.getClicks());
return new KeyValue<>(value.getRegion(),
value.getClicks());
}))
.groupByKey(Grouped.with(Serdes.String(), Serdes.Long()))
.reduce(Long::sum, Materialized.as(CLICK_UPDATES))
.toStream());
}
在上面的示例中,有两个地方添加了显式的追踪工具。首先,我们记录了来自传入 KStream
的键/值信息。当记录这些信息时,相关的 span 和 trace ID 也会被记录,以便监控系统可以跟踪它们并与相同的 span ID 进行关联。其次,当我们调用 map
操作时,不是直接在 KStream
类上调用它,而是将其包装在 transform
操作中,然后从 KafkaStreamsTracing
调用 map
。在这种情况下,记录的消息也将包含 span ID 和 trace ID。
这是另一个示例,我们使用低级别的 transformer API 来访问各种 Kafka Streams 头信息。当 spring-cloud-sleuth
在类路径上时,所有的追踪头信息也可以像这样访问。
@Bean
public Function<KStream<String, String>, KStream<String, String>> process(KafkaStreamsTracing kafkaStreamsTracing) {
return input -> input.transform(kafkaStreamsTracing.transformer(
"transformer-1",
() -> new Transformer<String, String, KeyValue<String, String>>() {
ProcessorContext context;
@Override
public void init(ProcessorContext context) {
this.context = context;
}
@Override
public KeyValue<String, String> transform(String key, String value) {
LOG.info("Headers: " + this.context.headers());
LOG.info("K/V:" + key + "/" + value);
// More transformations, business logic execution, etc. go here.
return KeyValue.pair(key, value);
}
@Override
public void close() {
}
}));
}