GH:851 Kafka Streams topology visualization

Add Boot actuator endpoints for topology visualization.

Resolves https://github.com/spring-cloud/spring-cloud-stream-binder-kafka/issues/851
This commit is contained in:
Soby Chacko
2020-03-06 16:32:25 -05:00
committed by Christian Tzolov
parent db896532e6
commit cc5d1b1aa6
6 changed files with 157 additions and 3 deletions

View File

@@ -1448,6 +1448,19 @@ By default, the `Kafkastreams.cleanup()` method is called when the binding is st
See https://docs.spring.io/spring-kafka/reference/html/_reference.html#_configuration[the Spring Kafka documentation].
To modify this behavior simply add a single `CleanupConfig` `@Bean` (configured to clean up on start, stop, or neither) to the application context; the bean will be detected and wired into the factory bean.
=== Kafka Streams topology visualization
Kafka Streams binder provides the following actuator endpoints for retrieving the topology description using which you can visualize the topology using external tools.
`/actuator/topology`
`/actuator/topology/<applicaiton-id of the processor>`
You need to include the actuator and web dependencies from Spring Boot to access these endpoints.
Further, you also need to add `topology` to `management.endpoints.web.exposure.include` property.
By default, the `topology` endpoint is disabled.
=== Configuration Options
This section contains the configuration options used by the Kafka Streams binder.