Skip to content

docs(spec): 新增 OTLP 映射附录(对接 OTel 语义约定) - #40

Merged
TangJia025 merged 3 commits into
mainfrom
docs/2061-otlp-mapping
Oct 26, 2026
Merged

TangJia025 merged 3 commits into
mainfrom
docs/2061-otlp-mapping

Conversation

@TangJia025

Copy link
Copy Markdown
Contributor

新增 spec/otlp-mapping.md,作为 spec 契约的映射附录(非契约本体):主契约 log-format / metrics-format / common-fields 不动,只登记落盘字段将来接 OTLP 时对应的 OTel 语义键,避免届时返工。同时在 spec/README.md 目录表加一行索引。

Resolves https://github.com/opensourceways/backlog/issues/2061

内容

  • 版本锚定:semantic-conventions v1.44.0(2026-08-04)+ semantic-conventions-genai @ 9ffc7e0;列出该版本下的废弃项:deployment.environment、code.filepath / code.lineno、event.name。
  • 部署级字段 → Resource:service → service.name、env → deployment.environment.name、instance → service.instance.id。community 因请求级可变,只能作属性 osw.community,不能进 Resource(否则中心化多社区服务的整进程数据都会被写死成一个社区)。
  • 日志字段 → LogRecord:trace_id / span_id 必须落 LogRecord 原生字段;若当普通 attribute 写进 attributes,日志将永久关联不上 trace。logger 按最后一个 : 拆成 code.file.path + code.line.number;event 落 eventName(event.name 属性在 v1.44.0 已废弃)。
  • 指标:http_server_request_duration_seconds 恰好等于 semconv http.server.request.duration 的翻译结果,无需改名;登记 label 改名(method → http.request.method 等)与 status_code 的 string → int 转换;说明 http_server_requests_total 在 semconv 中无对应指标,不要自造 http.server.request.count。
  • gen_ai.*:已整体迁出主仓、独立出版节奏且无 tag,按 commit 锚定;本期只登记不实现,并标注会话 ID / 工具调用 ID 等高基数值禁止进 metric label。
  • 红线:不改落盘字段名与嵌套结构、community 不进 Resource、高基数不进 label、不硬造 semconv 指标名。

边界

  • 不改四语言 SDK 实现,不动现有 LTS 结构化字段与 Grafana 查询。
  • 出口落地方案(Collector filelog / prometheus receiver 配置)仅在 §6 示意,不在本期实现。

🤖 Generated with Claude Code

AI 使用声明

当前 PR 是否有 AI 参与:

  • 否
  • 是
    1. AI Agent 平台:Claude Code
    2. AI 模型:deepseek-v4-flash
    3. Prompt 上下文:业界可观测厂商调研后,追问 OTel 字段对齐的具体做法;按讨论结论新增本映射附录,并用 gh api 核对 semconv v1.44.0 的注册表与 genai 仓当前 commit

本文件是 spec 契约的映射附录而非契约本体:主契约(log/metrics/common-fields)
不动,只登记落盘字段将来接 OTLP 时对应的 OTel 语义键,避免届时返工。

- 部署级四字段 → Resource:service.name / deployment.environment.name /
  service.instance.id;community 因请求级可变,只能作属性(osw.community),
  不能进 Resource
- 日志字段 → LogRecord:trace_id / span_id 必须落原生字段而非 attributes;
  logger 拆 code.file.path + code.line.number;event 落 eventName(event.name
  属性在 v1.44.0 已废弃)
- 指标:http_server_request_duration_seconds 已等于 semconv 的翻译结果;
  登记 label 改名与 int 类型转换;说明 http_server_requests_total 无 semconv 对应
- gen_ai.* 已迁出主仓,单独锚定 semantic-conventions-genai 的 commit
- 版本锚定 v1.44.0,并列出该版本下的废弃项(deployment.environment、
  code.filepath/lineno、event.name)

Co-Authored-By: Claude Code <noreply@anthropic.com>
@opensourceways-bot

Copy link
Copy Markdown

Welcome To opensourceways Community

Hey @TangJia025 , thanks for your contribution to the community.

Bot Usage Manual

I'm the Bot here serving you. You can find the instructions on how to interact with me at Here . That means you can comment below every pull request or issue to trigger Bot Commands.

Contact Guide

If you have any questions, please contact the SIG: infratructure ,
and any of the maintainers: @GeorgeCao-hw, @TangJia025, @pkking, @zhongjun2 ,
and any of the committers: @GeorgeCao-hw, @TangJia025, @pkking, @zkhzkhz .

@opensourceways-bot

Copy link
Copy Markdown

CLA Signature Pass

TangJia025, thanks for your pull request. All authors of the commits have signed the CLA. 👍

新增两份调研文档:

- docs/可观测洞察.md:完整版。技术趋势 6 条、国际与国内厂商格局、
  与 obs-sdk / 社区可观测 / CI 可观测的关联,以及 P0-P2 行动建议
- docs/可观测洞察-概要版.md:概要版。第一章一张技术趋势表,
  第二章国内外各一张厂商路线与前沿实践表

调研时间 2026-10-26;Gartner MQ 事实按 2025/2026 两版核对(Chronosphere
为连续第三年 Leader,Coralogix 由 Visionary 升入 Leader,Splunk 降至 Challenger)。
其中引用的 spec/otlp-mapping.md 由 PR #40 提供,故本分支基于
docs/2061-otlp-mapping。

Co-Authored-By: Claude Code <noreply@anthropic.com>
…sights

docs: 新增可观测洞察(技术趋势 + 厂商路线)
@opensourceways-bot

Copy link
Copy Markdown

CLA Signature Pass

TangJia025, thanks for your pull request. All authors of the commits have signed the CLA. 👍

@TangJia025
TangJia025 merged commit 6aca786 into main Oct 26, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants