refactor(server): align route-span attrs with OTel semantic conventions (#23198)

This commit is contained in:
Kit Langton
2026-04-17 19:29:33 -04:00
committed by opencode
parent 7b98f544ff
commit eafbe5c57c
2 changed files with 48 additions and 11 deletions

View File

@@ -5,9 +5,12 @@ import { AppRuntime } from "@/effect/app-runtime"
type AppEnv = Parameters<typeof AppRuntime.runPromise>[0] extends Effect.Effect<any, any, infer R> ? R : never
// Build the base span attributes for an HTTP handler: method, path, and every
// matched route param (sessionID, messageID, partID, providerID, ptyID, …)
// prefixed with `opencode.`. This makes each request's root span searchable
// by ID in motel without having to parse the path string.
// matched route param. Names follow OTel attribute-naming guidance:
// domain-first (`session.id`, `message.id`, …) so they match the existing
// OTel `session.id` semantic convention and the bare `message.id` we
// already emit from Tool.execute. Non-standard route params fall back to
// `opencode.<name>` since those are internal implementation details
// (per https://opentelemetry.io/blog/2025/how-to-name-your-span-attributes/).
export interface RequestLike {
readonly req: {
readonly method: string
@@ -16,13 +19,23 @@ export interface RequestLike {
}
}
// Normalize a Hono route param key (e.g. `sessionID`, `messageID`, `name`)
// to an OTel attribute key. `fooID` → `foo.id` for ID-shaped params; any
// other param is namespaced under `opencode.` to avoid colliding with
// standard conventions.
export function paramToAttributeKey(key: string): string {
const m = key.match(/^(.+)ID$/)
if (m) return `${m[1].toLowerCase()}.id`
return `opencode.${key}`
}
export function requestAttributes(c: RequestLike): Record<string, string> {
const attributes: Record<string, string> = {
"http.method": c.req.method,
"http.path": new URL(c.req.url).pathname,
}
for (const [key, value] of Object.entries(c.req.param())) {
attributes[`opencode.${key}`] = value
attributes[paramToAttributeKey(key)] = value
}
return attributes
}