micrometer-metrics/micrometer

Remove duplicated Spring Boot configuration properties documentation

Open

#4,982 创建于 2024年4月22日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Java (4,220 star) (935 fork)batch import
doc-updatehelp wanted

描述

See, for example, #4851 which is addressing the Micrometer documentation for our Influx registry implementation getting out of sync with the corresponding support in Spring Boot. While it may be convenient to see at a glance what configuration options are available by duplicating the Spring Boot configuration properties, it has problems like this becoming out of sync. Micrometer does not depend on Spring or Spring Boot, so we shouldn't be documenting its support (that is available in the Spring Boot documentation) like this.

That said, we don't want users to be completely unable to figure out what's configurable for a Micrometer registry implementation. I think a compromise we can take for now is linking to the JavaDoc site of the Config class for the registry. The JavaDoc for that class will contain all the methods and descriptions for them.

A perhaps nicer solution would be to generate a table that goes in the documentation with information like Config method name, description, default value.

贡献者指南