search

OpenLiberty / open-liberty

Open Liberty is a highly composable, fast to start, dynamic application server runtime environment
https://openliberty.io
Eclipse Public License 2.0
1.15k stars 587 forks source link

LG-261: MicroProfile Metrics 2.3 Implementation #9985

Closed donbourne closed 4 years ago

donbourne commented 4 years ago

LG-261 follow from LG-262 (SPEC + API + TCK) regarding the MicroProfile Metrics 2.3 release

The MicroProfile Metrics 2.3 release includes two new major features:

  1. New metric SimpleTimer (@SimplyTimed)

    • Light-weight alternative to the existing Timer metric; only tracks and reports values regarding total elapsed time and invocation count

  2. Metrics derived from tracking REST resource method usage (GET, POST, PUT,DELETE, OPTIONS,PATCH,HEAD)

    • Backed by the SimpleTimer metric it will track elapsed time duration and invocation count
    • Enabled with use of JAX-RS 2.1 (and if JAXRS methods are used). We will leverage the JAX-RS filter tracking used in APSFOUND-56

As as consequence of the second (REST metric) feature , mpMetrics-2.3 will now depend on monitor-1.0 feature.

WAD/UFO : https://ibm.ent.box.com/file/602205571172

atosak commented 4 years ago

List of Steps to complete or get approvals / sign-offs for Onboarding to the Liberty release (GM date)

Instructions:

TARGET COMPLETION DATE Before Development Starts or 8 weeks before Onboarding

Channyboy commented 4 years ago

Publicly available link: https://ibm.box.com/s/4vmex4gxj28y74s4grnn7p0hczrr4105

NottyCode commented 4 years ago

Feedback on design:

  1. Please use the new design template for future designs
  2. Slide 26 uses rest.request but earlier and later in the deck it uses REST.request, is this correct or is it a typo
  3. Slide 28 references installUtility which doesn't exist in Open Liberty so should not be there.
  4. Slide 29, the first bullet is likely unnecessary.
  5. Slide 35, I would prefer to see some statement about the performance effect rather than "it will have one" are we talking 5%, 10% more? Is anything being done to address this? It should be clear that this is vs the mpMetrics-3.2 feature and isn't a degradation in performance for an existing feature.
  6. Slide 36 doesn't talk about servicability, it talks about mitigating an unqualified performance impact, so really should be on slide 35.
Channyboy commented 4 years ago

@NottyCode Slide 26 is a typo. It should be REST.request and is now fixed.

Slide 28 and 29 fixed.

Slide 35 updated with statement.

Slide 36 modified to address customer concern regarding additional PMI stats (similar to APSFOUND-56)

Channyboy commented 4 years ago

Slide 35 updated with performance results from performance team.

gscottj commented 4 years ago

No new user interfaces are being added nor any changes to existing user interfaces. No required accessibility verification testing.

Channyboy commented 4 years ago

Further updates to WAD.

slide 35 - Clarified further the performance impact.

slide 36 - Activation of PMI stats are classified more-so as performance and has been removed.

Channyboy commented 4 years ago

@samwatibm Hi Sam, translation files have been merged. May you approve for globalization.

Channyboy commented 4 years ago

@chirp1 Doc issues are opened with this item: https://github.com/OpenLiberty/docs/issues/1109 AND https://github.ibm.com/was-liberty/liberty-docs/issues/1790

May you approve for ID.

Channyboy commented 4 years ago

@sabolo May you review? Feature Test Summary: https://github.com/OpenLiberty/open-liberty/issues/10946

Channyboy commented 4 years ago

@donbourne Serviceability Approval Comment - Please answer the following questions for serviceability approval:

  1. UFO -- does the UFO identify the most likely problems customers will see and identify how the feature will enable them to diagnose and solve those problems without resorting to raising a PMR? Have these issues been addressed in the implementation?

N/A - no problems expected to be encountered with new metric and metric data. Underlying logic behaves the same as other existing metrics (i.e registration, retrieval and export/display).

  1. Test and Demo -- As part of the serviceability process we're asking feature teams to test and analyze common problem paths for serviceability and demo those problem paths to someone not involved in the development of the feature (eg. L2, test team, or another development team). a) What problem paths were tested and demonstrated? b) Who did you demo to? c) Do the people you demo'd to agree that the serviceability of the demonstrated problem scenarios is sufficient to avoid PMRs for any problems customers are likely to encounter, or that L2 should be able to quickly address those problems without need to engage L3?

N/A - no problems expected to be encountered with new metric and metric data. Underlying logic behaves the same as other existing metrics (i.e registration, retrieval and export/display).

  1. SVT -- SVT team is often the first team to try new features and often encounters problems setting up and using them. Note that we're not expecting SVT to do full serviceability testing -- just to sign-off on the serviceability of the problem paths they encountered.

a) Who conducted SVT tests for this feature? Andrew Reider and Tanya Kulik

b) Do they agree that the serviceability of the problems they encountered is sufficient to avoid PMRs, or that L2 should be able to quickly address those problems without need to engage L3? Yes.

I agree with 3b for mpMetrics-2.3 , on the basis that the new feature is similar in complexity to the previous version with regard to problem resolution. Both versions are publicly documented (and most of it is the same), so developers/clients using either can potentially resolve issues on their own or using solutions that worked for version 2.2

Which L2 / L3 queues will handle PMRs for this feature? Ensure they are present in the contact reference file and in the queue contact summary, and that the respective L2/L3 teams know they are supporting it. Ask Don Bourne if you need links or more info.

WAS L3: Liberty Log Analytics

Channyboy commented 4 years ago

@tevans78 Demo is scheduled for Liberty 20.5 - March 10th EOI.

skasund commented 4 years ago

L2 has requested STE slides for this feature. The STE template can be found at the link below. You can use either one to create the education.

Slide Template: https://ibm.box.com/s/1an42g7zdgmaj84w7dft0indqfgi8ffm

Github Template: https://pages.github.ibm.com/WASL3/site/STE/about

Please upload the completed slides to the same STE Archive BOX folder. Thanks!

Channyboy commented 4 years ago

@skasund STE slide here : https://ibm.ent.box.com/file/629590802249

skasund commented 4 years ago

@Channyboy Thanks for the slides. I've approved the feature.

chirp1 commented 4 years ago

The writers are working down a prioritized backlog. As I mentioned to David Chan, the doc updates for OL likely won't be made by the time 20.0.0.4 goes out. David will have a GA log post for the Epic. Approving.

Channyboy commented 4 years ago

mpMetrics-2.3 moved to GA See https://github.com/OpenLiberty/open-liberty/pulls?q=is%3Apr+tevan+is%3Aclosed closing.