Apache SkyWalking改进提案(SWIP)
Apache SkyWalking改进提案(SWIP)是一个正式的文档,用于提出新的功能或对已有功能进行改进。这些提案与最终用户和开发者相关。
SkyWalking从v9.x版本开始就已经非常稳定了。我们已经走过了快速变化的阶段。核心概念、上报遥测和查询的协议、第三方集成以及流式处理内核都非常稳定。从现在(2024年)开始,SkyWalking社区将更多地关注改进,并对改进进行可控的管理。所有重大变更都需要经过更严格的评估,尽可能避免不兼容的破坏性变更。
什么被认为是重大变更?
重大变更的目录如下:
- 新的功能。这个功能在最新版本中还不存在。
- 查询协议的任何变更
- 数据收集协议的任何变更
- 动态配置API的任何变更
- 导出API的任何变更
- AI管道API的任何变更
- 存储结构的任何变更
问:代理端的功能或变更是否需要SWIP?
答:目前,SWIP针对的是OAP和UI端的变更。所有代理端变更都有待相关代理的提交者进行审核。
SWIP模板
这个模板的目的不是一个硬性要求。SWIP的主要目的是帮助PMC和社区成员更好地理解该提案。
# Title: SWIP-1234 xxxx
## Motivation
The description of new feature or improvement.
## Architecture Graph
Describe the relationship between your new proposal part and existing components.
## Proposed Changes
State your proposal in detail.
## Imported Dependencies libs and their licenses.
## Compatibility
Whether breaking configuration, storage structure, protocols.
## General usage docs
This doesn't have to be final version, but help the reviews to understand how to use this new feature.
_________
上面为官方原文，下面为翻译文件
# 标题:SWIP-1234 xxxx
## 动机
对新功能或改进的描述。
## 架构图
描述你的新提案部分与现有组件的关系。
## 建议的变更
详细阐述你的提案。
## 引入的依赖库及其许可证
## 兼容性
是否破坏了配置、存储结构或协议的兼容性。
## 常规用法文档
这不一定是最终版本,但有助于审查人员了解如何使用这个新功能。
SWIP流程
以下是发起一个SWIP的流程:
- 在GitHub的讨论页面发起SWIP讨论,标题为[DISCUSS] xxxx。
- 填写SWIP模板中的各个部分。
- 至少有一个SkyWalking提交者对这个讨论表示关注,并有意接受它。
这个提交者可以更新这个页面来授予一个SWIP ID,并将标题更新为[SWIP-ID NO.][DISCUSS] xxxx。 - 之后的所有讨论可以在这个讨论页面进行。
- 一旦通过足够的提交者支持,和/或通过邮件列表投票达成共识,这个SWIP应该加入这里作为SWIP-ID NO.md,并在下面列出。
所有已接受和已提出的SWIP都可以在这里找到。
下一个SWIP编号可以在官方网站得到，SkyWalking SWIP Page ,该网站为向SkyWalking项目提出改进建议提供了很好的指导。
