swift-otel/swift-otel-semantic-conventions

Transform attribute mentions into DocC symbols

开放

#20 创建于 2025年5月26日

 (0 条评论) (0 个反应) (0 位负责人)Swift (6 个派生)auto 404
documentationgood first issuehelp wanted

仓库指标

星标
 (15 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

Introduction

OpenTelemetry's semantic conventions have a lot of documentation paragraphs that mention other attributes, for example this line from http.request.header:

The User-Agent header is already captured in the user_agent.original attribute.

Proposed Feature

A nice UX improvement for our generated documentation could be to link to transform these attribute mentions into actual Swift symbol references, i.e.

/// The `User-Agent` header is already captured in the ``OTelAttribute/userAgent/original`` attribute.

... for the OTelAttribute documentation and ...

/// The `User-Agent` header is already captured in the ``Tracing/SpanAttributes/UserAgentAttributes/NestedSpanAttributes/original`` attribute.

... for the SpanAttributes documentation.

Proposed Solution

This feature can likely be built on top of @NeedleInAJayStack's excellent work in #19, which already collects the connection between OTel attribute names and generated Swift symbol names into a Context type.

贡献者指南