OTel规范

OpenTelemetry规范描述了OpenTelemetry跨语言实现的要求，以及实现OTel（OpenTelemetry简写）标准规范的期望。对规范进行实质性更改必须遵循OpenTelemetry改进建议流程。小的更改，比如澄清说明、措辞更改、拼写/语法更正等，可以通过PR（Pull Request）直接提交。

需要额外注意的问题可在规范例会中提出。欧盟和美国时区的线上友好会晤在太平洋时间每周二上午8点举行，亚太时区的线上友好会晤在太平洋时间每周二下午4点举行。会议纪要保存在谷歌文档中，请参阅OpenTelemetry日历。

可通过电子邮件向技术委员会提交入会申请。技术委员会定期召开例会，会议纪要记录在此Git库。

Table of Contents

概览

词汇表

OpenTelemetry客户端版本控制和稳定性

lib库使用指南

三方包/库设计规范

通用错误处理使用指南

API标准规范

上下文

上下文渲染

数据携带

追踪

指标

SDK标准规范

追踪

资源

配置

数据标准规范

语义约定

协议

关于本项目

时间线

符号规约与惯例

标准规范的版本控制

首字母缩略词

贡献

许可证

项目时间线

OpenTelemetry项目页面上提供了当前项目状态以及有关过去值得注意的版本的信息。

有关当前工作和未来开发计划的信息在规范开发里程碑中。

符号规约与惯例

本规范中的关键词"MUST", “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, "OPTIONAL"在所有大写字母出现时（且仅在所有大写字母出现时）应按照BCP 14[RFC2119][RFC8174]的规定进行解释，如下所示。

如果本规范的实施未能满足本规范中定义的一个或多个"MUST", “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT"要求，则本规范的实施不符合要求。相反，如果满足规范中定义的所有"MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT” 要求，则规范的实现是符合的。

标准规范的版本控制

对规范的更改将根据Semantic Versioning 2.0进行版本控制，如中所述CHANGELOG.md。布局更改没有版本控制。规范的具体实现应该指定它们实现的版本。

对变更流程本身的变更目前没有版本控制，但将来可能会独立进行版本控制。

首字母缩略词

OpenTelemetry项目使用的官方首字母缩略词是“OTel”。

请不要使用“OT”以避免与现在不推荐使用的“OpenTracing”项目混淆。

贡献

参考CONTRIBUTING.md有关贡献过程的详细介绍。

许可证

向OpenTelemetry规范库贡献参与，需要您同意您的开源贡献在Apache2.0许可证许可前提下。