Skip to content

Conversation

therepanic
Copy link
Contributor

@therepanic therepanic commented Sep 23, 2025

In fact, this inaccuracy has been described since the time when the autoconfigure module was in spring-grpc. I think we should consider using the observation option, although both options are fine, but this option is older and more familiar to use (spring grpc 1.0.0 has not been released yet, but nevertheless). In addition, I think that the original intention was to use the observation option. Furthermore, there are already options in the Spring ecosystem that simply use observation, such as spring.kafka.listener.observation-enabled.

Closes: gh-269

@therepanic therepanic changed the title fix Observation property name in _configprops.adoc Fix Observation property name in _configprops.adoc Sep 23, 2025
@onobc
Copy link
Contributor

onobc commented Sep 23, 2025

Agreed @therepanic, the singular observation is the intended name and is in fact the one used to guard the Observation auto-configuration. If we made it plural it would in fact be a breaking change as it is only a docs issue at this point.
m

Note

The _configprops.adoc is actually generated via the config props processor in the docs module. The content for that file is aggregated from the config props POJOs and the additional-spring-configuration-metadata.json file (here is where you define config props that are not defined in a config props POJO - e.g. these enabled properties).

Here is what I think needs to happen:

  • update the generated file so we can re-run the docs Github workflow - this will fix the currently available docs for the 0.x branch.
  • update the additional-spring-configuration-metadata.json file so that next time the docs are run that the generated file stays fixed?
  • re-target the PR to the 0.x branch
  • fix this in Spring Boot for main branch

If you don't have time to deal w/ the 0.x branch I am more than happy to cherry-pick your changes against main and put them in the 0.x branch.

Sound good?

@onobc onobc self-requested a review September 23, 2025 16:16
Copy link
Contributor

@onobc onobc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@therepanic therepanic changed the base branch from main to 0.x September 23, 2025 18:26
@therepanic
Copy link
Contributor Author

Hi, @onobc. Thank you for your review.

I did as you said and redirected the changes to 0.x. Also, I assume you have already updated additional-spring-configuration-metadata.json here spring-projects/spring-boot@6b2b95e

@therepanic therepanic requested a review from onobc September 23, 2025 18:36
@onobc
Copy link
Contributor

onobc commented Sep 24, 2025

Hi @therepanic , do you mind doing the 2nd bullet item as well (updating the source file so going forward the next time we run the generated file will retain the proper property name)?

@therepanic
Copy link
Contributor Author

Sorry, I forgot that we are on the 0.x branch and we need to update additional-spring-configuration-metadata.json in the autoconfigure module that is still in this branch. I rebase and push.

Copy link
Contributor

@onobc onobc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix @therepanic ! LGTM

@onobc onobc merged commit b47f377 into spring-projects:0.x Sep 24, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix Observation property name
2 participants