使用 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 的键/值信息。当记录此信息时,关联的跨度和跟踪 ID 也会被记录下来,以便监控系统可以跟踪它们并与相同的跨度 ID 相关联。其次,当我们调用 map 操作时,我们不是直接在 KStream 类上调用它,而是将其包装在 transform 操作中,然后从 KafkaStreamsTracing 调用 map。在这种情况下,记录的消息也将包含跨度 ID 和跟踪 ID。

以下是一个示例,我们使用低级转换器 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() {
                }
            }));
}