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

Archetype: SE "MicroProfile" metrics as a choice #5903

Open
tjquinno opened this issue Jan 18, 2023 · 2 comments
Open

Archetype: SE "MicroProfile" metrics as a choice #5903

tjquinno opened this issue Jan 18, 2023 · 2 comments
Assignees
Labels
3.x Issues for 3.x version branch archetypes bug Something isn't working design This issue requires design/architecture decisions P3
Milestone

Comments

@tjquinno
Copy link
Member

tjquinno commented Jan 18, 2023

From the public helidon-users slack channel: https://helidon.slack.com/archives/CCS216A5A/p1674059219702039

The user ran helidon init to create a custom SE app, selected yes for observability and yes for metrics.

The user was surprised to be given a choice "MicroProfile" while generating an SE app.

There are at least two potential problems with this:

  1. This user was confused to be offers a "MicroProfile" choice for metrics while generating an SE app. It's true that the Helidon SE metrics implementation is heavily inspired by MicroProfile Metrics but it is also incorrect to call it "MicroProfile." It's not an impl of MP metrics.

  2. Users might expect that given the two choices that they are two roughly equivalent choices (as with, for example, the JSON library choices offered). That's not the case here.

    The Micrometer work is an integration with Micrometer but that is completely parallel to and separate from Helidon's metrics. Perhaps most importantly, the Helidon-provided metrics are not present in the Micrometer meter registry if the user chooses that.

What would be clearer, I think, would be if the user says yes to metrics then that's it--we add the dependency on helidon-metrics and create and register the metrics service in the generated Java code.

In my mind, it would be fine for users to manually add the Micrometer integration if they want it and not have helidon init ask about Micrometer at all.


Notes from our group consensus reached on 23 Jan:

We should revise the starter and CLI so that users who choose observability -> metrics will always get the MP metrics-inspired Helidon metrics API and impl. As an option (boolean in Romain's terms) they can also add the Micrometer integration (default = no).

@romain-grecourt romain-grecourt transferred this issue from helidon-io/helidon-build-tools Jan 18, 2023
@romain-grecourt romain-grecourt changed the title helidon init custom SE prompts about "MicroProfile" metrics as a choice Archetype: SE "MicroProfile" metrics as a choice Jan 18, 2023
@romain-grecourt romain-grecourt added the 3.x Issues for 3.x version branch label Jan 18, 2023
@m0mus m0mus added design This issue requires design/architecture decisions Monday labels Jan 19, 2023
@edbratt
Copy link
Member

edbratt commented Jan 23, 2023

FWIW, the dependency package is 'helidon-metrics'. Perhaps "Helidon Metrics" is a reasonable title for Quick Start and/or CLI interview. The documentation is clear that the implementation is "... inspired by—​but does not fully implement—​the MicroProfile Metrics specification."

@tjquinno
Copy link
Member Author

tjquinno commented Feb 6, 2023

Conclusion of discussion:

The archetype should offer Helidon metrics as a yes/no choice.

Micrometer metrics integration should be separate yes/no choice.

Helidon and Micrometer metrics should not be presented as peer choices (i.e., not radio buttons).

@tjquinno tjquinno added the bug Something isn't working label Feb 6, 2023
@m0mus m0mus added P3 and removed Monday labels Jun 17, 2024
@m0mus m0mus added this to the 3.2.9 milestone Jun 17, 2024
@barchetta barchetta modified the milestones: 3.2.9, 3.2.10 Aug 22, 2024
@barchetta barchetta modified the milestones: 3.2.10, 3.2.11 Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.x Issues for 3.x version branch archetypes bug Something isn't working design This issue requires design/architecture decisions P3
Projects
Status: High priority
Development

No branches or pull requests

6 participants