|
| 1 | +[//]: # (The syntax preceeding this line is a comment marker used to help guide the author in populating this document) |
| 2 | +[//]: # (to github. Unlike HTML comments commonly used throughout istio.io documentation, this comment will not be rendered) |
| 3 | +[//]: # (by github. Comments must be separated by carriage return preceding and concluding the text and be a single line.) |
| 4 | + |
| 5 | +[//]: # (This is a living document representing the maturity of a feature. Completion of this template enables Istio work groups) |
| 6 | +[//]: # (to collect information on potential new functionality. This template should be completed before users are exposed to) |
| 7 | +[//]: # (any new experimental feature. Please complete this template during development.) |
| 8 | + |
| 9 | +[//]: # (The feature implementation section must be completed before submission of the document.) |
| 10 | + |
| 11 | +# Feature: |
| 12 | + |
| 13 | +[//]: # (All information in this section is mandatory.) |
| 14 | + |
| 15 | +**Feature name:** |
| 16 | + |
| 17 | +[//]: # (The name of the feature, e.g. Multiple control planes) |
| 18 | + |
| 19 | +Configurable Telemetry Production |
| 20 | + |
| 21 | +**Primary lead(s):** |
| 22 | + |
| 23 | +[//]: # (The primary lead or leads responsible for the feature. These individuals serve as a point of contact for the feature.) |
| 24 | + |
| 25 | +douglas-reid |
| 26 | + |
| 27 | +**Short description:** |
| 28 | + |
| 29 | +[//]: # (A short description of the feature. One or two sentences maximum.) |
| 30 | + |
| 31 | +The Telemetry API enables control of the telemetry production within a mesh. |
| 32 | + |
| 33 | +**Design Docs:** |
| 34 | + |
| 35 | +[//]: # (Design docs for feature) |
| 36 | + |
| 37 | +- [Proposal: Telemetry API](https://docs.google.com/document/d/1pTFVzGii7sB4uALMsrUN4ALFc0J7vI2UyBnJpP_bsgU/edit#heading=h.gryauiau89tc) |
| 38 | +- [Telemetry API: Metrics - Key Decisions](https://docs.google.com/document/d/1ZdzLM5E6oY1a6MjE9SRnnpMyrANjGx4y_Opg290Ol-M/edit?usp=sharing&resourcekey=0-uERWDjv-m4Ccyr8eP2mgxg) |
| 39 | +- [Logging Configuration with Telemetry API](https://docs.google.com/document/d/1m7F5Tz0E-n7P3Qmq7ecCx-ykhA_njlxGFNx8LIMPBBg/edit?usp=sharing&resourcekey=0-JxDkXLnu2L8xtsAHDXxyCQ) |
| 40 | +- [Telemetry API Migration](https://docs.google.com/document/d/1FMvwyoooGeiACf9b7R0A6iJyB6ZuiP7hv5-XDmXtHLo/edit?usp=sharing) |
| 41 | + |
| 42 | + |
| 43 | +**Relevant Documentation:** |
| 44 | + |
| 45 | +[//]: # (Links to relevant documentation for feature) |
| 46 | + |
| 47 | +- [Telemetry API](https://istio.io/latest/docs/tasks/observability/telemetry/) |
| 48 | + |
| 49 | +**RFC:** |
| 50 | + |
| 51 | +[//]: # (Link to RFC for feature) |
| 52 | + |
| 53 | +- [RFC: Telemetry API](https://docs.google.com/document/d/1Tv-A2eftrNQrouMsdBLiHdILIwVN3n2c7RJYNVuv7GY/edit#) |
| 54 | +- [RFC: Telemetry API Scope](https://docs.google.com/document/d/1PfmqSpO5c3jCdQ__DppPYlW9IzupSkA5WhuOTGGwlK8/edit#) |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## Experimental |
| 59 | + |
| 60 | +### Requirements: |
| 61 | + |
| 62 | +[//]: # (All information in this section is mandatory for promotion. Please modify the links in this) |
| 63 | +[//]: # (section.) |
| 64 | + |
| 65 | +- [X] [User stories](https://docs.google.com/document/d/1pTFVzGii7sB4uALMsrUN4ALFc0J7vI2UyBnJpP_bsgU/edit#bookmark=id.dp9fgncrklih) reviewed in a work group meeting. |
| 66 | + |
| 67 | +[//]: # (User stories are a way to communicate user value. User stories follow the style) |
| 68 | +[//]: # (as a [type of user], I want [an action] so that [a benefit/a value]. Istio currently has no user) |
| 69 | +[//]: # (story template. Maybe you can make one?) |
| 70 | + |
| 71 | +[//]: # (User stories must be presented in a work group meeting. They need no approval and are later integrated) |
| 72 | +[//]: # (into the RFCs, which do need approval for alpha. You may find value to negotiate within the work group where the) |
| 73 | +[//]: # (user stories are presented to help clarify the user stories.) |
| 74 | + |
| 75 | +- [X] [RFC Authored] - [RFC: Telemetry API](https://docs.google.com/document/d/1Tv-A2eftrNQrouMsdBLiHdILIwVN3n2c7RJYNVuv7GY/?usp=sharing). |
| 76 | + |
| 77 | +[//]: # (An RFC is mandatory to graduate to experimental. The RFC does not have to be reviewed in a work group) |
| 78 | +[//]: # (meeting to graduate to experimental.) |
| 79 | + |
| 80 | +- [X] [Documentation](https://istio.io/latest/docs/tasks/observability/telemetry/) for enabling and using the feature. |
| 81 | + |
| 82 | +[//]: # (The documentation instructions may exist on the developer wiki or the team drive. They may include instructions) |
| 83 | +[//]: # (for building running a `istioctl experimental command`, or using the preview profile,) |
| 84 | +[//]: # (or any other relevant information.) |
| 85 | + |
| 86 | +- [X] Feedback plan: utilize GitHub issues, forum discussions, and direct engagements. |
| 87 | + |
| 88 | +[//]: # (This may include user feedback meetings, discuss.istio.io conversations, GitHub issues, or mailing lists.) |
| 89 | + |
| 90 | +- [X] Disabled by default. |
| 91 | + |
| 92 | +- [X] No impact on performance when the feature is disabled. |
| 93 | + |
| 94 | + |
| 95 | +[//]: # (Once all other items are completed, features.yaml should be updated to promote the feature) |
| 96 | + |
| 97 | +- [X] [features.yaml](https://github.com/istio/enhancements/blob/master/features.yaml) updated for this feature |
| 98 | +--- |
| 99 | + |
| 100 | +## Alpha |
| 101 | + |
| 102 | +### Requirements: |
| 103 | + |
| 104 | +**Design** |
| 105 | + |
| 106 | +- [X] RFC has been approved describing the intention of the feature as well as the user stories behind the feature. |
| 107 | + |
| 108 | +**Config** |
| 109 | + |
| 110 | +- [X] Explicit user action is required to enable this feature (e.g. a config field, config resource, or installation action). |
| 111 | + |
| 112 | +> Link to instructions for enabling |
| 113 | +
|
| 114 | +**Docs** |
| 115 | + |
| 116 | +- [X] Reference docs are published to preliminary.istio.io or the Istio wiki. |
| 117 | +- [ ] Basic feature docs are published on preliminary.istio.io describing what the feature does, how to use it, and any caveats. |
| 118 | +- [X] Release notes entries added as appropriate |
| 119 | +- [ ] Upgrade notes entries added as appropriate |
| 120 | + |
| 121 | +**Tests** |
| 122 | + |
| 123 | +- [ ] Automated integration tests cover core use cases with the feature enabled. |
| 124 | +- [X] When disabled, the feature does not affect system stability or performance. |
| 125 | + |
| 126 | +**API** |
| 127 | + |
| 128 | +- [X] Initial API review. |
| 129 | + |
| 130 | +**Approvals** |
| 131 | + |
| 132 | +- [X] The appropriate work group(s) have reviewed and approved promotion of the feature. |
| 133 | +- [ ] The TOC has reviewed and approved promotion of the feature as part of the |
| 134 | + roadmap for a release. |
| 135 | + |
| 136 | +**Promotion** |
| 137 | + |
| 138 | +[//]: # (Once all other items are completed, features.yaml should be updated to promote the feature) |
| 139 | + |
| 140 | +- [ ] [features.yaml](https://github.com/istio/enhancements/blob/master/features.yaml) updated for this feature |
| 141 | + |
| 142 | +--- |
| 143 | + |
| 144 | +## Beta |
| 145 | + |
| 146 | +### Requirements: |
| 147 | + |
| 148 | +**Design** |
| 149 | + |
| 150 | +- [X] Design doc describing the intention of the feature, how it will be |
| 151 | + implemented, and any thoughts on how to test the feature has been approved by |
| 152 | + relevant work group leads |
| 153 | +- [X] Feature coverage and test plans written and approved. |
| 154 | + |
| 155 | +**Docs** |
| 156 | + |
| 157 | +- [ ] Documentation on istio.io includes performance expectations; may have caveats. |
| 158 | +- [X] Documentation on istio.io includes samples/tutorials. |
| 159 | +- [ ] Documentation on istio.io includes appropriate glossary entries. |
| 160 | +- [ ] All new documentation containing user actions includes istio.io tests. |
| 161 | +- [ ] Release notes have been added. |
| 162 | +- [ ] Upgrade notes have been added. |
| 163 | + |
| 164 | +**Tests** |
| 165 | + |
| 166 | +- [ ] Integration tests cover feature edge cases |
| 167 | +- [ ] End-to-end tests cover samples/tutorials |
| 168 | +- [ ] Fixed issues have tests to prevent regressions |
| 169 | +- [ ] Stability/stress test suite includes coverage for the feature. |
| 170 | + |
| 171 | +**Performance** |
| 172 | + |
| 173 | +- [X] Feature coverage and test plans written and approved |
| 174 | +- [ ] Tests exist with the feature enabled that can be integrated with our automated performance testing. |
| 175 | + |
| 176 | +**API** |
| 177 | + |
| 178 | +- [ ] TOC has reviewed the API and determined it to be complete. |
| 179 | + |
| 180 | +**Tooling** |
| 181 | + |
| 182 | +- [ ] Any necessary tooling to use/debug the feature has been implemented and is complete. |
| 183 | + |
| 184 | +**Bugs** |
| 185 | + |
| 186 | +- [ ] Feature has no known major issues. |
| 187 | + |
| 188 | +**Approvals** |
| 189 | + |
| 190 | +- [ ] The appropriate work group(s) have reviewed and approved promotion of the feature. |
| 191 | +- [ ] The supportability review panel has reviewed promotion of the feature OR a WG has decided one is not required. |
| 192 | +- [ ] The TOC has reviewed and approved promotion of the feature as part of the |
| 193 | + road map for a release. |
| 194 | + |
| 195 | + |
| 196 | +**Promotion** |
| 197 | + |
| 198 | +[//]: # (Once all other items are completed, features.yaml should be updated to promote the feature) |
| 199 | + |
| 200 | +- [ ] [features.yaml](https://github.com/istio/enhancements/blob/master/features.yaml) updated for this feature |
| 201 | +--- |
| 202 | + |
| 203 | +## Stable |
| 204 | + |
| 205 | +### Requirements: |
| 206 | + |
| 207 | +**Performance** |
| 208 | + |
| 209 | +- [ ] Latency, throughput, and scalability are quantified and documented on |
| 210 | + istio.io. |
| 211 | + |
| 212 | +**Bugs** |
| 213 | + |
| 214 | +- [ ] Feature has no known major issues. |
| 215 | + |
| 216 | +**Approvals** |
| 217 | + |
| 218 | +- [ ] The appropriate work group(s) have reviewed and approved promotion of the feature. |
| 219 | +- [ ] The [supportability review panel](https://docs.google.com/document/d/1w0epyFhhDSf_TwFEfa_lrn1v61mXNJKpEp_kUgp4sSc/edit#) has reviewed the feature in order to find any supportability concerns OR a WG has decided one is not required. |
| 220 | +- [ ] The TOC has reviewed and approved promotion of the feature as part of the |
| 221 | + roadmap for a release. |
| 222 | + |
| 223 | + |
| 224 | +**Promotion** |
| 225 | + |
| 226 | +[//]: # (Once all other items are completed, features.yaml should be updated to promote the feature) |
| 227 | + |
| 228 | +- [ ] [features.yaml](https://github.com/istio/enhancements/blob/master/features.yaml) updated for this feature |
0 commit comments