Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Idea: support classpath-based analysis #80

Open
chicobento opened this issue Dec 20, 2022 · 1 comment
Open

Idea: support classpath-based analysis #80

chicobento opened this issue Dec 20, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@chicobento
Copy link

Problem

Current strategy for finding documentation providers relies on analyzing the actual src code under a folder. This work for the service-specific metrics.
However, often metrics are provided by external JARs - as in the case a spring boot-based applications.
As an application owner, it would be nice to be able to compile a documentation containing all the metrics that can be potentially generated by the application so it can be delivered to customers.

Implementation ideas

Just throwing out some ideas. Im not much familiar yet with the metrics documentation strategy, so apologies if the ideas doesnt make sense.

Build time analysis

Find all documentation provider implementations (e.g ObservationDocumentation), and produce the objects by reflection. Additionally, if the sources are provided in the mvn repo, the javadoc could also be looked up on the dep-sources.jar.

Runtime analysis

Same as above, but done at runtime. Applications can also expose endpoints (such as spring boot actuators) for producing the docs.

@chicobento chicobento changed the title Support classpath-based analysis Idea: support classpath-based analysis Dec 20, 2022

This comment was marked as outdated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants