Allow configuring observation registry directly

[cfredri4]

This changes allows configuring the observation registry directly, instead of it being fetched from the application context. This is to allow observability when KafkaTemplate/KafkaMessageListenerContainer are used without an application context.

[sobychacko]

@ cfredri4 I think this needs more discussion. These changes modify the behavior of setting the default NOOP observation registry for both KafkaTemplate and the listener container. Why do you need to provide the ObservationRegistry as a non-bean, and why is the application context absent? Since there are some design changes in the PR, we will discuss this internally soon, but you can just give some more context around the changes. Thanks.

[cfredri4]

@cfredri4 I think this needs more discussion. These changes modify the behavior of setting the default NOOP observation registry for both KafkaTemplate and the listener container.

This was for simplicity's sake as the registry is nullable and null and NOOP are treated the same. But I can change back to NOOP if desired.

Why do you need to provide the ObservationRegistry as a non-bean, and why is the application context absent? Since there are some design changes in the PR, we will discuss this internally soon, but you can just give some more context around the changes. Thanks.

I have two situations where this change would be beneficial:

1. We sometimes use Spring Kafka in applications which are not Spring applications, i.e. they do not have a Spring application context. Here we need to create a mock ApplicationContext which implements getBeanProvider to return the registry; this is messy and fragile as it's dependent on internal logic in how KafkaTemplate/KafkaMessageListenerContainer works.

2. We sometimes have the need to use a different observation registry for Spring Kafka than what is in the application context. Here we need to do similar to # 1 above but then also make sure that this is done after Spring has already initialized KafkaTemplate/KafkaMessageListenerContainer as this time they are Spring beans.

Both of these situations would be trivial had it been possible to configure the observation registry directly.
Exactly the same thing can already be done for the KafkaAdmin, so to me it makes sense to allow it also for the observation registry.

[sobychacko]

@cfredri4 We are ok with the changes. However, could you re-work your solution so we don't break any existing behavior? Specifically, the default ObservationRegistry.NOOP should be restored in both KafkaTemplate and KafkaMessageListenerContainer. Thanks!

[sobychacko]

Also, please add the author tag with your name in all the classes you changed. Thanks!

[artembilan]

Please, consider to address reviews by tomorrow.
We have release on Monday, so might be great to have this in.

Thank you!

[cfredri4]

I have pushed some updates, please check.

[artembilan]

LGTM

[artembilan]

Well, sorry for the noise, but apparently there are some Checkstyle violations:

Error: eckstyle] [ERROR] /home/runner/work/spring-kafka/spring-kafka/spring-kafka/src/main/java/org/springframework/kafka/core/KafkaTemplate.java:496: Line matches the illegal pattern 'Trailing whitespace'. [Regexp]

Error: eckstyle] [ERROR] /home/runner/work/spring-kafka/spring-kafka/spring-kafka/src/main/java/org/springframework/kafka/listener/ContainerProperties.java:45:1: Wrong order for 'io.micrometer.observation.ObservationRegistry' import. [ImportOrder]
> Task :spring-kafka:checkstyleMain
Error: eckstyle] [ERROR] /home/runner/work/spring-kafka/spring-kafka/spring-kafka/src/main/java/org/springframework/kafka/listener/KafkaMessageListenerContainer.java:81:8: Unused import - org.springframework.beans.factory.ObjectProvider. [UnusedImports]

Please, consider to use Gradle check task before pushing commits to the PR.

Thanks

[cfredri4]

Fixed.