Merge pull request #1 from frankzhaopeng/main docs: update Readme.md
Merge pull request #1 from frankzhaopeng/main
docs: update Readme.md
FeatureProbe 是一个开源的 『特性』管理 服务。它包含灰度放量、AB实验、实时配置变更等针对『特性粒度』的一系列管理操作。这里的『特性』包含业务功能、技术改造、运营活动等任何涉及代码开发的『特性』。它可以让开发人员、运营人员、运维人员安全、高效的完成线上变更,同时精细控制变更风险。『特性』粒度的发布管理是实现DevOps的核心工具之一,通过『特性』开关,可以降低分支开发带来的合并复杂性,轻松实现主干开发以及持续交付。
『特性』粒度开关管理服务已经是各个互联网大厂的标配平台,我们将互联网大厂内部『特性』开关管理平台的优秀实践与经验融入这个开源项目中。希望推广特性管理理念和实践在软件开发社区的普及,携手开源社区,提升软件开发行业的效能。
我们提供一个独立的文档服务,最新的文档将会更新在这里
根据我们的经验,FeatureProbe可以在以下场景中提升软件研发的效能:
开关管理
目标流量设置
流量监测
指标分析
FeatureProbe 的总体架构如下图所示:
特性管理平台
FeatureProbe Server处理SDK的链接,提供高性能的规则判定引擎。
各语言SDK
我们提供一个在线的FeatureProbe体验核心服务FeatureProbe,您可以直接访问,省去自己部署服务的步骤。
您也可以在自己服务器使用docker composer来部署一套自己的FeatureProbe服务:详见教程
在您App的代码中引入FeatureProbe的SDK,并通过类似以下的代码访问在FeatureProbe平台上创建的开关
if (fpClient.boolValue(YOUR_TOGGLE_KEY, user, false)) { // Do some new thing; } else { // Do the default thing; }
我们提供如下语言的SDK:
各语言SDK都提供example目录和代码,可以直接运行example代码来体验FeatureProbe平台与SDK的交互。
我们提供了一个受FeatureProbe控制的模拟网站应用(通过使用JS SDK)。你可以在线体验通过FeatureProbe控制网站应用的展示。见教程
我们仍在不断迭代,为FeatureProbe补充更多的功能,以便适应更多的使用场景和用户需求。开发活动会基于github的代码库持续发布。欢迎开源社区的朋友加入我们,提需求、报bug、参与社区讨论、提交PR都可以。
可以在project看到我们的迭代计划。
Please read CONTRIBUTING for details on our code of conduct, and the process for taking part in improving FeatureProbe.
This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
🍻 我们搭建了一个微信社区,帮助新朋友尽快了解FeatureProbe,新老朋友们也可以在社区一起讨论关于特性管理(Feature Management)相关的任何话题. 扫描以下二维码加入我们。
🙋 如果想上报BUG,或者贡献代码,请使用Github的Issue和PR功能: GitHub issue
如果FeatureProbe能帮到您,请⭐️star我们~
版权所有:中国计算机学会技术支持:开源发展技术委员会 京ICP备13000930号-9 京公网安备 11010802032778号
注意:完整代码库请跳转到 FeatureProbe,本目录只包含部分文档
💎 FeatureProbe
FeatureProbe 是一个开源的 『特性』管理 服务。它包含灰度放量、AB实验、实时配置变更等针对『特性粒度』的一系列管理操作。这里的『特性』包含业务功能、技术改造、运营活动等任何涉及代码开发的『特性』。它可以让开发人员、运营人员、运维人员安全、高效的完成线上变更,同时精细控制变更风险。『特性』粒度的发布管理是实现DevOps的核心工具之一,通过『特性』开关,可以降低分支开发带来的合并复杂性,轻松实现主干开发以及持续交付。
『特性』粒度开关管理服务已经是各个互联网大厂的标配平台,我们将互联网大厂内部『特性』开关管理平台的优秀实践与经验融入这个开源项目中。希望推广特性管理理念和实践在软件开发社区的普及,携手开源社区,提升软件开发行业的效能。
📚 文档服务
我们提供一个独立的文档服务,最新的文档将会更新在这里
🚀 FeatureProbe适用于哪些场景
根据我们的经验,FeatureProbe可以在以下场景中提升软件研发的效能:
🔎 FeatureProbe功能预览
开关管理
目标流量设置
流量监测
指标分析

🧩 FeatureProbe的技术架构
FeatureProbe 的总体架构如下图所示:
特性管理平台
FeatureProbe Server处理SDK的链接,提供高性能的规则判定引擎。
各语言SDK
🍭 2步体验FeatureProbe
1️⃣ 启动FeatureProbe核心服务
我们提供一个在线的FeatureProbe体验核心服务FeatureProbe,您可以直接访问,省去自己部署服务的步骤。
您也可以在自己服务器使用docker composer来部署一套自己的FeatureProbe服务:详见教程
2️⃣ 在你自己服务代码中调用FeatureProbe SDK
在您App的代码中引入FeatureProbe的SDK,并通过类似以下的代码访问在FeatureProbe平台上创建的开关
我们提供如下语言的SDK:
💻 服务端SDK
📲 客户端SDK
各语言SDK都提供example目录和代码,可以直接运行example代码来体验FeatureProbe平台与SDK的交互。
🙌 Contributing
我们仍在不断迭代,为FeatureProbe补充更多的功能,以便适应更多的使用场景和用户需求。开发活动会基于github的代码库持续发布。欢迎开源社区的朋友加入我们,提需求、报bug、参与社区讨论、提交PR都可以。
可以在project看到我们的迭代计划。
Please read CONTRIBUTING for details on our code of conduct, and the process for taking part in improving FeatureProbe.
📜 License
This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
🌈 Community and Sharing
🍻 我们搭建了一个微信社区,帮助新朋友尽快了解FeatureProbe,新老朋友们也可以在社区一起讨论关于特性管理(Feature Management)相关的任何话题. 扫描以下二维码加入我们。
🙋 如果想上报BUG,或者贡献代码,请使用Github的Issue和PR功能: GitHub issue
🎢 Star History
如果FeatureProbe能帮到您,请⭐️star我们~