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

Fix deprecation annotations in metrics; update doc; revise examples (2.x) #4396

Merged
merged 6 commits into from
Jun 17, 2022
Merged

Fix deprecation annotations in metrics; update doc; revise examples (2.x) #4396

merged 6 commits into from
Jun 17, 2022

Conversation

tjquinno
Copy link
Member

@tjquinno tjquinno commented Jun 15, 2022

See #4365

This PR:

  1. Adjusts @Deprecated annotations as needed.
  2. Updates a few files in docs to refer to the non-deprecated alternatives.
  3. Updates many examples to use the non-deprecated alternatives.

Recall that metrics is now split into these components:

  • helidon-metrics-api - metrics-related interfaces (RegistryFactory, MetricsSettings, etc.) and a no-op implementation
  • helidon-metrics-service-api - MetricsSupport interface and no-op impl
  • helidon-metrics - full-featured metrics impl

In the many places where examples used deprecated classes or methods this PR updates the code to use the non-deprecated alternatives.

Note that this involves changes to poms. Our doc tells users how to build and package metrics-capable apps which work regardless of whether the full metrics impl is present at runtime. This involves declaring build-time dependencies on helidon-metrics-api and/or helidon-metrics-service-api (as needed) and then deciding if and how to make the full-featured impl available at runtime.

I have changed the examples accordingly (I should have done this when I created the new components), including adding a runtime-scope dependency on the full-featured metrics impl. This way the examples serve as metrics-capable apps, and they also exhibit live metrics as they have before.

@tjquinno tjquinno self-assigned this Jun 15, 2022
@tjquinno tjquinno added this to the 2.5.2 milestone Jun 15, 2022
@tjquinno tjquinno mentioned this pull request Jun 15, 2022
3 tasks
ljnelson
ljnelson previously approved these changes Jun 15, 2022
ljnelson
ljnelson previously approved these changes Jun 15, 2022
Copy link
Contributor

@ljamen ljamen left a comment

Choose a reason for hiding this comment

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

Doc looks good to me. I also double-checked the copyright years.

@tjquinno tjquinno requested a review from tomas-langer June 16, 2022 18:34
Copy link
Member

@tomas-langer tomas-langer left a comment

Choose a reason for hiding this comment

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

I have reopened one comment, as we need to be clear on the builder method, otherwise this seems OK

@tjquinno tjquinno merged commit 1d03f1a into helidon-io:helidon-2.x Jun 17, 2022
@tjquinno tjquinno deleted the metrics-depr-2.x branch June 17, 2022 15:12
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.

4 participants