Skip to content

✨ feat(observability): instrument Agent Runtime with OTel GenAI semantic conventions#15123

Merged
arvinxx merged 3 commits into
canaryfrom
feat/lobe-5594-agent-runtime-otel
May 25, 2026
Merged

✨ feat(observability): instrument Agent Runtime with OTel GenAI semantic conventions#15123
arvinxx merged 3 commits into
canaryfrom
feat/lobe-5594-agent-runtime-otel

Conversation

@arvinxx

@arvinxx arvinxx commented May 22, 2026

Copy link
Copy Markdown
Member

Summary

Implements LOBE-5594 β€” adds the foundational OpenTelemetry instrumentation for the Agent Runtime so a full agent invocation tree can be rendered in Jaeger / Grafana Tempo / Cloud-side viewers, aligned with the OTel GenAI semconv v1.41 (spec).

  • New module @lobechat/observability-otel/modules/agent-runtime exposing a shared tracer plus type-safe attribute builders for the four span kinds. Attribute names live in semconv.ts and are namespaced under gen_ai.* (spec) and lobehub.* (LobeHub-specific extensions per the issue's design).
  • invoke_agent {agent.name} wraps AgentRuntimeService.executeStep (operation id, agent identity, conversation id, accumulated tokens, completion reason).
  • chat {model} wraps the LLM call in RuntimeExecutors.call_llm, captures gen_ai.response.time_to_first_chunk on the first onText / onThinking chunk, plus finish reasons and per-call token breakdown (input / output / cache-read / reasoning).
  • execute_tool {tool.name} is opened per tool execution in both call_tool and the concurrent call_tools_batch. LobeHub ToolSource (builtin / client / mcp / klavis / lobehubSkill) is mapped to the OTel-recommended gen_ai.tool.type enum; success/attempts captured as lobehub.tool.*.
  • context_engineering wraps serverMessagesEngine, surfacing message count, system role length, tool count, knowledge / memory injection flags, history-compression marker, image presence.

Span layering (matches the issue's reference tree):

[invoke_agent {agent.name}]
β”œβ”€ [context_engineering]
β”œβ”€ [chat {model}]
β”œβ”€ [execute_tool web_search]
└─ [execute_tool knowledge_base]

Spans are no-ops when OTEL is not initialized (default @opentelemetry/api provider), so runs without ENABLE_TELEMETRY keep their previous cost profile and behavior.

Test plan

  • bunx vitest run packages/observability-otel/src/modules/agent-runtime/attributes.test.ts β€” 8 unit tests for attribute builders / span-name helpers
  • bunx vitest run src/server/modules/AgentRuntime/ src/server/services/agentRuntime/ src/server/modules/Mecha/ContextEngineering/ β€” 547 tests pass
  • bun run type-check β€” clean (only pre-existing packages/local-file-shell execa errors remain)
  • Verify span tree in a local OTEL collector / Jaeger run before enabling the cloud rollout
  • Confirm zero-cost path when ENABLE_TELEMETRY is unset (no measurable overhead on executeStep / call_llm)

πŸ€– Generated with Claude Code

@dosubot dosubot Bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label May 22, 2026
@vercel

vercel Bot commented May 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
lobehub Ready Ready Preview, Comment May 25, 2026 6:04am

Request Review

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @arvinxx, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@dosubot dosubot Bot added the feature:agent Assistant/Agent configuration and behavior label May 22, 2026
@codecov

codecov Bot commented May 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 87.61632% with 173 lines in your changes missing coverage. Please review.
βœ… Project coverage is 70.93%. Comparing base (3c52998) to head (977c84f).
⚠️ Report is 2 commits behind head on canary.

Additional details and impacted files
@@            Coverage Diff             @@
##           canary   #15123      +/-   ##
==========================================
+ Coverage   70.92%   70.93%   +0.01%     
==========================================
  Files        3152     3152              
  Lines      314060   314255     +195     
  Branches    28568    28609      +41     
==========================================
+ Hits       222738   222919     +181     
- Misses      91154    91168      +14     
  Partials      168      168              
Flag Coverage Ξ”
app 61.81% <87.61%> (+0.02%) ⬆️
database 92.20% <ΓΈ> (ΓΈ)
packages/agent-runtime 80.48% <ΓΈ> (ΓΈ)
packages/builtin-tool-lobe-agent 19.87% <ΓΈ> (ΓΈ)
packages/context-engine 84.13% <ΓΈ> (ΓΈ)
packages/conversation-flow 91.28% <ΓΈ> (ΓΈ)
packages/file-loaders 87.89% <ΓΈ> (ΓΈ)
packages/memory-user-memory 74.99% <ΓΈ> (ΓΈ)
packages/model-bank 99.99% <ΓΈ> (ΓΈ)
packages/model-runtime 83.88% <ΓΈ> (ΓΈ)
packages/prompts 72.54% <ΓΈ> (ΓΈ)
packages/python-interpreter 92.90% <ΓΈ> (ΓΈ)
packages/ssrf-safe-fetch 0.00% <ΓΈ> (ΓΈ)
packages/types 35.07% <ΓΈ> (ΓΈ)
packages/utils 88.47% <ΓΈ> (ΓΈ)
packages/web-crawler 88.08% <ΓΈ> (ΓΈ)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Ξ”
Store 68.02% <ΓΈ> (ΓΈ)
Services 54.68% <ΓΈ> (ΓΈ)
Server 72.22% <87.61%> (+0.04%) ⬆️
Libs 56.77% <ΓΈ> (ΓΈ)
Utils 85.96% <ΓΈ> (ΓΈ)
πŸš€ New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • πŸ“¦ JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

arvinxx and others added 3 commits May 25, 2026 13:33
…c conventions

Introduces a new `@lobechat/observability-otel/modules/agent-runtime` module
with `gen_ai.*` attribute helpers (aligned with OTel GenAI semconv v1.41) and
LobeHub-specific `lobehub.*` extensions, then instruments the core execution
path with four span types:

- `invoke_agent {agent.name}` around `AgentRuntimeService.executeStep`,
  carrying `gen_ai.agent.*`, `gen_ai.conversation.id`, accumulated token
  usage and `lobehub.agent.completion_reason`.
- `chat {model}` around the LLM call in `RuntimeExecutors.call_llm`,
  including `gen_ai.response.time_to_first_chunk` captured on the first
  text/reasoning chunk, finish reasons, and per-call token breakdown.
- `execute_tool {tool.name}` per tool call in both `call_tool` and the
  concurrent `call_tools_batch`, with `gen_ai.tool.type` mapped from
  LobeHub `ToolSource` and `lobehub.tool.success` / `lobehub.tool.attempts`.
- `context_engineering` around `serverMessagesEngine` invocations, with
  message/token/knowledge/memory/tool-count metadata.

Spans are no-ops when OTEL is not initialized (the `@opentelemetry/api`
default provider), so runs without `ENABLE_TELEMETRY` keep their previous
cost profile.

Refs LOBE-5594.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@arvinxx arvinxx force-pushed the feat/lobe-5594-agent-runtime-otel branch from ab6704b to 977c84f Compare May 25, 2026 05:37
@arvinxx arvinxx merged commit 248d6ec into canary May 25, 2026
35 checks passed
@arvinxx arvinxx deleted the feat/lobe-5594-agent-runtime-otel branch May 25, 2026 11:43
hardy-one pushed a commit to hardy-one/lobehub that referenced this pull request May 27, 2026
…tic conventions (lobehub#15123)

* ✨ feat(observability): add Agent Runtime OTel spans per GenAI semantic conventions

Introduces a new `@lobechat/observability-otel/modules/agent-runtime` module
with `gen_ai.*` attribute helpers (aligned with OTel GenAI semconv v1.41) and
LobeHub-specific `lobehub.*` extensions, then instruments the core execution
path with four span types:

- `invoke_agent {agent.name}` around `AgentRuntimeService.executeStep`,
  carrying `gen_ai.agent.*`, `gen_ai.conversation.id`, accumulated token
  usage and `lobehub.agent.completion_reason`.
- `chat {model}` around the LLM call in `RuntimeExecutors.call_llm`,
  including `gen_ai.response.time_to_first_chunk` captured on the first
  text/reasoning chunk, finish reasons, and per-call token breakdown.
- `execute_tool {tool.name}` per tool call in both `call_tool` and the
  concurrent `call_tools_batch`, with `gen_ai.tool.type` mapped from
  LobeHub `ToolSource` and `lobehub.tool.success` / `lobehub.tool.attempts`.
- `context_engineering` around `serverMessagesEngine` invocations, with
  message/token/knowledge/memory/tool-count metadata.

Spans are no-ops when OTEL is not initialized (the `@opentelemetry/api`
default provider), so runs without `ENABLE_TELEMETRY` keep their previous
cost profile.

Refs LOBE-5594.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fix(observability): align agent runtime GenAI attributes

* test(agent-runtime): stabilize agent signal hook integration

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
arvinxx added a commit that referenced this pull request May 29, 2026
# πŸš€ LobeHub Release (20260528)

**Release Date:** May 28, 2026  
**Since v2.2.0:** 220 merged PRs Β· 15 contributors

> This cycle brings heterogeneous "platform agents" you can dispatch to
local or remote devices, a rebuilt onboarding flow, document-centric
chat, and a unified model-runtime error model β€” with new DeepSeek V4 and
Gemini 3.5 Flash support along the way.

---

## ✨ Highlights

- **More Hetero Agents (OpenClaw / Hermes)** β€” Create heterogeneous
agents and dispatch them to local or remote devices through the device
gateway, with an execution-target switcher in the composer and
persistent CLI sessions. (#15065, #15179, #15022)
- **iMessage on Desktop** β€” New iMessage setup and bridge on desktop,
plus bot attachments across every platform. (#15228, #15227, #15029)
- **Skills in the Composer** β€” Drag skill chips into chat, trigger
installed skills from the slash menu mid-line, and surface project-level
skills in the homogeneous agent runtime. (#15095, #15061, #15110)
- **New Models** β€” DeepSeek V4 Flash/Pro and Gemini 3.5 Flash across
providers, with thinking params for structured output and chat cost
estimates. (#15031, #15001, #15051, #14876)
- **Agent Runtime Observability** β€” OpenTelemetry GenAI semantic
conventions plus per-call generation tracing. (#15123, #15124)

---

## πŸ€– Agents & Heterogeneous Runtime

- **Platform agent creation** β€” OpenClaw/Hermes creation UI, device
guard, and remote dispatch backend. (#15065)
- **Execution-target switcher** β€” Pick local vs remote execution
directly in the composer; device-selection UX with actionable guidance.
(#15179, #15111)
- **CLI hetero dispatch** β€” OpenClaw/Hermes dispatch with persistent
sessions and a notify protocol. (#15022)
- **Gateway snapshot as source of truth** β€” Consume the gateway
`uiMessages` snapshot at step boundaries to keep chat state consistent.
(#15153, #15152)
- **Client sub-agent as a normal tool call** β€” Simplifies the sub-agent
execution path. (#15281)
- **Hermes agent chain** β€” Implements the Hermes agent chain logic.
(#15189)
- **Device registry** β€” TRPC endpoints to register, list, update, and
remove devices. (#15299)
- **Desktop device routing** β€” Route gateway agent runs through `lh
hetero exec`; restore `userId` in gateway dispatch and gate local-system
by execution target. (#15132, #15232)
- **Agent signals** β€” Anchor agent-signal receipts to messages and
isolate memory-agent messages into a child thread. (#14969, #14921)

---

## πŸš€ Onboarding

- **Simplified first screen** β€” Defer topic creation to first send.
(#15090)
- **Market Agent Picker** β€” Added as a classic onboarding step, with
template prefetch. (#14980, #15041)
- **Welcome guidance** β€” Show agent welcome guidance on first run.
(#15098)
- **Mobile** β€” Adapt agent onboarding UI and restore Classic-step
padding on mobile. (#15019, #15032)
- **Discovery** β€” Streamline discovery to a single profession question.
(#14987)
- **Analytics** β€” Track onboarding step events and create-agent modal
source. (#15133, #15028)

---

## πŸ“„ Documents, Pages & Knowledge

- **Thread chat in preview** β€” Embed thread chat in the document preview
portal. (#15216)
- **Non-markdown rendering** β€” Render non-markdown docs as a read-only
highlight. (#15272)
- **Multi-select** β€” Multi-select delete in the document tree. (#15125)
- **Page-agent streaming** β€” Preview `initPage` streaming arguments.
(#15039)
- **Per-agent topics** β€” Per-agent topic management page. (#15207)
- **Server-side category** β€” Derive document category server-side and
drop frontend predicates. (#15076)

---

## 🧩 Skills & Tools

- **Drag skill chips** β€” Drag skills into chat input and register
agent-document skills. (#15095)
- **Slash menu** β€” Installed skills appear in the slash menu with a
mid-line trigger. (#15061)
- **Project skills** β€” Recognize project-level skills in the homogeneous
agent runtime and surface them regardless of active device. (#15110,
#15177)
- **VFS archiving** β€” Archive oversized tool results to VFS instead of
truncating. (#15074)
- **@localfile mentions** β€” Drag folders into chat input as `@localFile`
mentions on desktop. (#15071)

---

## 🧠 Model Runtime & Providers

- **Error spec registry** β€” Unify error codes into a spec + pattern
registry, split `ProviderBizError` into finer codes, classify Cloud-only
codes via a tier digit, and add `DatabasePersistError`. (#15262, #15286,
#15278, #15279)
- **New models** β€” DeepSeek V4 Flash/Pro (opencode-go) and Gemini 3.5
Flash; DeepSeek V4 Pro on SiliconCloud. (#15031, #15001, #15017, #15267)
- **Structured output** β€” Thinking params for structured output, Bedrock
structured generation, and DeepSeek `generateObject` tool choice.
(#15051, #15174, #15054)
- **Cost** β€” Chat cost estimate support; preserve usage cost in custom
streams. (#14876, #15218)

---

## πŸ’¬ Chat & User Experience

- **Follow-up chips** β€” Extend follow-up chip suggestions to general
chat with scene-specific model config. (#15101, #14797)
- **Input drafts** β€” Persist unsent input drafts across tab switches and
prevent repeated draft restore. (#14992, #15024)
- **Command menu** β€” Order topic/message search by recency and promote
inline type filters. (#15094, #14986)
- **Zoom HUD** β€” Show a zoom-level HUD on Cmd +/βˆ’ and Cmd 0. (#15294)
- **Copy** β€” Unescape markdown escapes when copying user messages.
(#15253)

---

## πŸ–₯️ Desktop

- **App Nap fix** β€” Prevent App Nap from dropping the gateway WebSocket
during display sleep. (#14994)
- **File preview** β€” Preview `.cjs`/`.mjs`/no-extension files instead of
binary fallback and expand `~` when opening local files. (#15168,
#15284)
- **Cross-platform settings** β€” Open settings via main-window navigation
on Windows/Linux and restore the route after an update restart. (#15036,
#14922)
- **Token refresh** β€” Prevent frequent logout from token-refresh
retries. (#14928)

---

## πŸ“Š Observability

- **OTel GenAI** β€” Instrument Agent Runtime with OpenTelemetry GenAI
semantic conventions. (#15123)
- **Generation tracing** β€” Per-call `llm_generation_tracing` with a
pre-allocated tracingId and recordFeedback router. (#15124, #15146)
- **Error classification** β€” Persist `ERROR_CODE_SPECS` classification
on operation errors. (#15273)

---

## πŸ—ƒοΈ Database Migrations

- **Batch migrations** β€” Topic usage stats, push tokens,
`tasks.editor_data`, and document shares. (#15280)
- **Tracing & eval tables** β€” Add `llm_generation_tracing` and agent
eval experiment tables. (#15126)

> Self-hosted operators should run the database migration (`pnpm
db:migrate`, or restart with auto-migrate enabled) after upgrading. The
changes are additive and backwards-compatible.

---

## πŸ”’ Security & Reliability

- **Security:** Remove the `getPlaintextCred` tool to prevent plaintext
credential exposure. (#14998)
- **Security:** Prompt account selection for Google OAuth and add
`prompt=consent` to the OIDC authorization URL to fix missing refresh
tokens. (#15234, #15010)
- **Reliability:** Preserve streamed content across a mid-stream cancel.
(#15173)
- **Reliability:** Bound the Redis command timeout and configure the
Anthropic client timeout. (#15091, #15042)
- **Reliability:** Prevent infinite recursion in the assistant chain.
(#15288)

---

## πŸ‘₯ Contributors

Huge thanks to **15 contributors** who shipped **220 merged PRs** this
cycle.

@AnotiaWang Β· @sxjeru Β· @algojogacor Β· @hardy-one Β· @arvinxx Β· @Innei Β·
@tjx666 Β· @lijian Β· @AmAzing129 Β· @rdmclin2 Β· @neko Β· @cy948 Β·
@CanisMinor Β· @sudongyuer Β· @rivertwilight

Plus @lobehubbot and renovate[bot] for maintenance.

---

**Full Changelog**: v2.2.0...release/weekly-20260528
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature:agent Assistant/Agent configuration and behavior size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant