OpenMetrics 开源监控标准贡献代码完整教程新手入门 3 条路径【免费下载链接】OpenMetricsEvolving the Prometheus exposition format into a standard.项目地址: https://gitcode.com/gh_mirrors/op/OpenMetricsOpenMetrics 是基于并扩展 Prometheus exposition format 的指标暴露标准现正推进 IETF 标准化。这份 OpenMetrics 贡献指南帮你解决第一次参与开源监控标准该做什么的问题第一步干什么、去哪里干、做到什么程度算合格。 项目速览它是什么在 Prometheus exposition format 之上做的规范收束文本格式和 Protobuf 格式都有正式定义已进入 IETF 标准草案阶段specification/里的 RFC 草稿。解决什么问题全球 700 个 exporter 都在往这个格式上吐指标生态急需一个定版的标准来避免各自为政。核心特色对 Prometheus 格式几乎 100% 向后兼容同时新增了 Exemplars、info、stateset 等现代指标能力。社区现状项目已并入 Prometheus 生态OpenMetrics 2.0 正在开发中——现在加入正是参与新标准定型的好时机。️ 动手前的准备先克隆仓库先跑起来再说git clone https://gitcode.com/gh_mirrors/op/OpenMetrics核心目录结构每个目录一句话specification/— 标准规范本体Markdown 版 RFC 草稿 txtproto/— 数据模型的 Protobuf 定义src/— Go 编写的验证工具和测试命令行tests/— 解析器测试用例一个目录一个场景legacy/— 早期会议记录了解项目历史动手前把这三份文档过一遍CODE_OF_CONDUCT.md社区行为准则CNCF 版必读CONTRIBUTORS.md贡献者名单顺便看看谁活跃README.md里面完整写了 2.0 阶段的贡献流程和提案模板 提示src/目录是 Go 项目装好 Go 环境后在src/下跑一遍go test ./...全绿就算你的本地环境就绪了。 三条贡献路径提一个规范改进提案适合关心标准本身、善于表达痛点的人先读 specification/OpenMetrics.md确认你想加的能力不存在开一个 issue结构参考 README 里的模板先写 Problem Statement什么场景、被卡住在哪里再写 Proposed idea等维护者打标签出现triage:accepted:ready后就可以动手实现了做得好的标准提案像一份需求文档——先说痛点再说方案比如联邦端点无法遵循 OpenMetrics 规范而不是单位后缀要求很烦。为验证工具修一个 Bug适合会 Go、想最快接触代码的人在src/下执行make构建出openmetricsvalidator等二进制到src/bin/用测试数据复现问题例如cat tests/testdata/parsers/bad_help_0/metrics | ./bin/openmetricsvalidator在 src/validator/validator.go 里定位并修复跑 src/validator/validator_test.go 确认通过提交 PR 前在src/下执行go test ./...确保没有破坏其他用例做得好的标准Bug 可复现、修复有对应的测试用例兜底PR 描述里写清复现步骤。补充一组解析器测试用例适合纯新手门槛最低浏览 tests/testdata/parsers/每个目录一份metrics文件 一个test.json后者声明该输入是否应该能解析成功照抄simple_counter的结构新建目录放入你想验证的 metrics 内容在test.json里把shouldParse设为 true 或 false命名沿用现有bad_xxx/simple_xxx风格做得好的标准你的用例覆盖了一个现有用例没覆盖的边界行为比如转义、前导零、时间戳边界或 EOF 处理。 融入社区邮件列表规范讨论与新闻https://groups.google.com/forum/m/#!forum/openmetricsTwitter更新动态https://twitter.com/OpenMetricsIO2.0 路线图与会议纪要在 README 中引用legacy/meetings/保留了早期会议记录可作参考非代码贡献同样受欢迎改进文档清晰度、补充示例、把规范翻译到其他语言发一个 PR 就能起步。❓ 新手常见疑问QRFC 全文看不完还能贡献吗A能。先走测试用例那条路径读规范时只精读跟你用例相关的章节就行。Q我的 issue 被打了triage:deciding:needs-info标签怎么办A别慌意思只是信息不够把场景和动机补充完整维护者会重新评估。Q一个 PR 能顺手修好几个 Bug 吗A建议不要一个 PR 解决一个问题评审和合并都会更快。Q不确定是不是 Bug要不要先问A直接在仓库开 issue 问就算不是 Bug讨论本身也可能变成一次规范改进。 下一步打开仓库在src/下把验证工具构建并跑通然后去翻带triage:accepted:ready标签的 issue——那是社区已确认、正等人接手的问题。挑一个试试你的第一次开源贡献就从它开始。【免费下载链接】OpenMetricsEvolving the Prometheus exposition format into a standard.项目地址: https://gitcode.com/gh_mirrors/op/OpenMetrics创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考