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

Docs: metrics documentation improvements #9473

Open
barchetta opened this issue Nov 7, 2024 · 3 comments · May be fixed by #9635
Open

Docs: metrics documentation improvements #9473

barchetta opened this issue Nov 7, 2024 · 3 comments · May be fixed by #9635
Assignees
Labels

Comments

@barchetta
Copy link
Member

Problem Description

Feedback from a customer

  1. Improve description of various metrics. While duplicating existing content to provide more details about the different metrics might not be the best strategy, docs could link to source that provide more details.
  2. In some cases, some summarization might also be useful and save significant headaches to the users. Take for example the Prometheus-specific suffixes: that info is scattered across multiple sources and quite difficult to reconcile.
@github-project-automation github-project-automation bot moved this to Triage in Backlog Nov 7, 2024
@m0mus m0mus added 4.x Version 4.x P3 labels Nov 7, 2024
@m0mus m0mus moved this from Triage to Sprint Scope in Backlog Nov 7, 2024
@tjquinno
Copy link
Member

tjquinno commented Jan 6, 2025

  1. Descriptions of meter types:
    The existing SE metrics guide includes this section https://helidon.io/docs/latest/se/guides/metrics#_application_specific_metrics_data which describes the meter types and shows coding examples for each.

    The MP metrics guide has a little of the same information but (IMO) in a less useful way.

    Neither the SE nor the MP non-guide metrics pages describe the meter types at all.

    Do we want to have this information in all four pages (SE and MP, guide and single page)? If not, which ones would be the best fit?

  2. Summarizations:
    We could definitely mention the Prometheus format early on and link to a relevant external page.

    What other specific summarizations would help?

@barchetta
Copy link
Member Author

I like the approach that the reference (non-guide) documentation uses today, which is a table summarizing the metric types with links to the javadocs for each one. We might want to flesh out the SE javadocs as they are a little thin.

@tjquinno
Copy link
Member

tjquinno commented Jan 7, 2025

OK. I will plan at least these changes:

  1. Expanding the table you mentioned to have more explanation of each meter type and add links to relevant Micrometer doc pages.
  2. Including that same table in the MP reference doc page (it is not there now) with links to the relevant MicroProfile Metrics types.
  3. Expanding the Javadoc for the Helidon metrics API meter type interfaces.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Sprint Scope
Development

Successfully merging a pull request may close this issue.

3 participants