open-liberty: LG-334: Add HTTP metrics to monitor-1.0, mpMetrics and OpenTelemetry
Description
Open Liberty needs HTTP metrics to allow for:
- easy computation of APDEX (https://en.wikipedia.org/wiki/Apdex)
- RED metrics (rate, error, duration)
- latency, traffic, errors from the four golden signals (https://sre.google/sre-book/monitoring-distributed-systems/#xref_monitoring_golden-signals)
For mpMetrics, metric naming should be based on rules from OpenTelemetry semantic conventions. Note that work on MP Metrics 5.0 is in progress and that spec could influence the naming of HTTP metrics. see https://opentelemetry.io/docs/reference/specification/metrics/semantic_conventions/http-metrics/#http-server
- http.server.duration
- http.server.active_requests
Metrics for HTTP MUST avoid cardinality explosion. To that end, the use of URL templates is required so that metrics are meaningful and number of distinct metric names is not unbounded.
see also what metrics Spring includes for HTTP: https://www.baeldung.com/micrometer
Documents
When available, add links to required feature documents. Use “N/A” to mark particular documents which are not required by the feature.
- Aha: Externally raised RFE (Aha)
- Link the RFE with this issue
- UFO: Link to Upcoming Feature Overview document
- FTS: Link to Feature Test Summary GH Issue https://github.com/OpenLiberty/open-liberty/issues/29385
- Beta Blog: Link to Beta Blog Post GH Issue https://github.com/OpenLiberty/open-liberty/issues/29019
- GA Blog: Link to GA Blog Post GH Issue: https://github.com/OpenLiberty/open-liberty/issues/29558 (shared blog with main Telemetry 2.0 feature)
Process Overview
General Instructions
The process steps occur roughly in the order as presented. Process steps occasionally overlap.
Each process step has a number of tasks which must be completed or must be marked as not applicable (“N/A”).
Unless otherwise indicated, the tasks are the responsibility of the Feature Owner or a Delegate of the Feature Owner.
If you need assistance, reach out to the OpenLiberty/release-architect.
Important: Labels are used to trigger particular steps and must be added as indicated.
Prioritization (Complete Before Development Starts)
The (OpenLiberty/chief-architect) and area leads are responsible for prioritizing the features and determining which features are being actively worked on.
Prioritization
- Feature added to the “New” column of the Open Liberty project board
- Epics can be added to the board in one of two ways:
- From this issue, use the “Projects” section to select the appropriate project board.
- From the appropriate project board click “Add card” and select your Feature Epic issue
- Epics can be added to the board in one of two ways:
- Priority assigned
- Attend the Liberty Backlog Prioritization meeting
Design (Complete Before Development Starts)
Design preliminaries determine whether a formal design, which will be provided by an Upcoming Feature Overview (UFO) document, must be created and reviewed. A formal design is required if the feature requires any of the following: UI, Serviceability, SVT, Performance testing, or non-trivial documentation/ID.
Design Preliminaries
- UI requirements identified. (Owner and UI focal point)
- ID requirements identified. (Owner and ID focal point)
- Refer to Documenting Open Liberty.
- Feature Owner adds label
ID Required, if non-trivial documentation needs to be created by the ID team. - ID adds label
ID Required - Trivial, if no design will be performed and only trivial ID updates are needed.
- Serviceability Requirements Identified. (Owner and Serviceability focal point)
- SVT Requirements Identified. (Owner and SVT focal point)
- Performance testing requirements identified. (Owner and Performance focal point)
Design
- POC Design / UFO review requested.
- Owner adds label
Design Review Request
- Owner adds label
- POC Design / UFO review scheduled. (David Chang)
- POC Design / UFO review completed.
- POC / UFO Review follow-ons completed.
- Design / UFO approved. (OpenLiberty/chief-architect) or N/A
- (OpenLiberty/chief-architect) adds label
Design Approved - Add the public link to the UFO in Box to the Documents section.
- The UFO must always accurately reflect the final implementation of the feature. Any changes must be first approved. Afterwards, update the UFO by creating a copy of the original approved slide(s) at the end of the deck and prepend “OLD” to the title(s). A single updated copy of the slide(s) should take the original’s place, and have its title(s) prepended with “UPDATED”.
- (OpenLiberty/chief-architect) adds label
No Design
- No Design requested.
- Owner adds label
No Design Approval Request
- Owner adds label
- No Design / No UFO approved. (OpenLiberty/chief-architect) or N/A
- Approver adds label
No Design Approved
- Approver adds label
FAT Documentation
- “Feature Test Summary” child task created
- Use the Feature Test Summary Template
- Add FTS issue link to the Documents section.
Implementation
A feature must be prioritized and socialized (or No Design Approved) before any implementation work may begin and is the minimum before any beta code may be delivered. All new Liberty content must be inaccessible in our GA releases until it is Feature Complete by either marking it kind=noship or beta fencing it.
Code may not GA until this feature has obtained the “Design Approved” or “No Design Approved” label, along with all other tasks outlines in GA section.
Feature Development Begins
- Add the
In Progresslabel
Legal and Translation
In order to avoid last minute blockers and significant disruptions to the feature, the legal items need to be done as early in the feature process as possible, either in design or as early into the development as possible. Similarly, translation is to be done concurrently with development. Both MUST be completed before Beta or GA is requested.
Legal (Complete before Feature Complete Date)
- Changed or new open source libraries are cleared and approved, or N/A. (Legal Release Services/Cass Tucker/Release PM).
- Licenses and Certificates of Originality (COOs) are updated, or N/A
Translation (Complete 1 week before Feature Complete Date)
- PII updates are merged, or N/A. Note timing with translation shipments.
Beta
In order to facilitate early feedback from users, all new features and functionality should first be released as part of a beta release.
Beta Code
- Beta fence the functionality
kind=beta,ibm:beta,ProductInfo.getBetaEdition()
- Beta development complete and feature ready for inclusion in a beta release
- Add label
target:betaand the appropriatetarget:YY00X-beta(where YY00X is the targeted beta version).
- Add label
- Feature delivered into beta
- (OpenLiberty/release-manager) adds label
release:YY00X-beta(where YY00X is the first beta version that included the functionality).
- (OpenLiberty/release-manager) adds label
Beta Blog (Complete 1.5 weeks before beta eGA)
- Beta blog issue created and populated using the Open Liberty BETA blog post template.
- Add a link to the beta blog issue in the Documents section.
GA
A feature is ready to GA after it is Feature Complete and has obtained all necessary Focal Point Approvals.
Feature Complete
- Feature implementation and tests completed.
- All PRs are merged.
- All epic and child issues are closed.
- All stop ship issues are completed.
- Legal: all necessary approvals granted.
- Translation: All messages translated or sent for translation for upcoming release
- GA development complete and feature ready for inclusion in a GA release
- Add label
target:gaand the appropriatetarget:YY00X(where YY00X is the targeted GA version). - Inclusion in a release requires the completion of all Focal Point Approvals.
- Add label
Focal Point Approvals (Complete by Feature Complete Date)
These occur only after GA of this feature is requested (by adding a target:ga label). GA of this feature may not occur until all approvals are obtained.
All Features
- FAT All Tests complete and running successfully in SOE or N/A. (OpenLiberty/fat-approvers)
- Approver adds label
focalApproved:fat.
- Approver adds label
- Demo Demo is scheduled for an upcoming EOI or N/A. (OpenLiberty/demo-approvers)
- Approver adds label
focalApproved:demo.
- Approver adds label
- Globalization Translation and TVT are complete or N/A. (OpenLiberty/globalization-approvers)
- Approver adds label
focalApproved:globalization.
- Approver adds label
Design Approved Features
- Accessibility Accessibility testing completed or N/A. (OpenLiberty/accessibility-approvers)
- Approver adds label
focalApproved:accessibility.
- Approver adds label
- APIs/Externals Externals have been reviewed or N/A. (OpenLiberty/externals-approvers)
- Approver adds label
focalApproved:externals
- Approver adds label
- ID Documentation is complete or N/A. (OpenLiberty/id-approvers)
- Approver adds label
focalApproved:id. -
NOTE: If only trivial documentation changes are required, you may reach out to the ID Feature Focal to request a
ID Required - Triviallabel. Unlike features with regular ID requirement, those withID Required - Triviallabel do not have a hard requirement for a Design/UFO.
- Approver adds label
- Performance Performance testing is complete or N/A. (OpenLiberty/performance-approvers)
- Approver adds label
focalApproved:performance.
- Approver adds label
- Serviceability Serviceability has been addressed or N/A. (OpenLiberty/serviceability-approvers)
- Approver adds label
focalApproved:sve.
- Approver adds label
- STE Skills Transfer Education chart deck is complete or N/A. (OpenLiberty/ste-approvers)
- Approver adds label
focalApproved:ste.
- Approver adds label
- SVT System Verification Test is complete or N/A. (OpenLiberty/svt-approvers)
- Approver adds label
focalApproved:svt.
- Approver adds label
Remove Beta Fencing (Complete by Feature Complete Date)
- Beta guards are removed, or N/A
- Only after all necessary Focal Point Approvals have been granted.
GA Blog (Complete by Feature Complete Date)
- GA Blog issue created and populated using the Open Liberty GA release blog post template.
- Add a link to the GA Blog issue in the Documents section.
Post GA
- Replace
target:YY00Xlabel with the appropriaterelease:YY00X. (OpenLiberty/release-manager)
Other Deliverables
- OL Guides OL Guides assessment is complete or N/A. (Yee-Kang Chang)
- Standalone Feature Blog Post A blog post specifically about your feature or N/A. (OpenLiberty/release-architect)
- This should be strongly considered for larger or more prominent features.
- Follow instructions in the blogs repo.
- WDT Liberty Developer Tools work is complete or N/A. (Leonard Theivendra)
About this issue
- Original URL
- State: closed
- Created 5 years ago
- Comments: 15 (15 by maintainers)
@Channyboy , UFO link is broken…perhaps forgot to set the link expiry?