文档中心

日志服务

请输入

最佳实践

智能体开发框架 VeADK 可观测最佳实践

本章节介绍智能体开发框架 VeADK 可观测最佳实践。

背景介绍

VeADK 提供可观测（Tracing）的能力，用于记录 Agent 执行过程中的关键路径与中间状态。支持将 Trace 数据输出至本地文件，或通过不同的 Exporter 上报至火山引擎日志服务 TLS，并在 TLS 的观测功能模块中进行 Agent 执行链路观测，有助于开发者进行调试、性能分析、行为追踪等任务。

准备工作

获取日志服务配置信息。

参数	示例	说明
endpoint	https://tls-cn-beijing.volces.com:4318/v1/traces	日志服务的服务入口。
service_name	tp_pj	服务名称。
region	cn-beijing	日志服务所在的地域（Region），需要和 endpoint 匹配。

在 VeADK 的 config.yaml 文件中配置日志服务连接信息。

model:
agent:
provider: openai
name: doubao-seed-1-6-flash-250828
api_base: https://ark.cn-beijing.volces.com/api/v3
api_key: your api_key

volcengine:
access_key: your ak
secret_key: your sk

observability:
opentelemetry:
tls:
endpoint: https://tls-cn-beijing.volces.com:4318/v1/traces
service_name: tp_pj
region: cn-beijing

在 agent.py 文件中配置创建日志服务的日志项目和 Trace 实例。

import asyncio

from veadk import Agent, Runner
from veadk.memory.short_term_memory import ShortTermMemory
from veadk.tools.demo_tools import get_city_weather
from veadk.tracing.telemetry.exporters.tls_exporter import TLSExporter
from veadk.tracing.telemetry.opentelemetry_tracer import OpentelemetryTracer
from veadk.tracing.telemetry.exporters.tls_exporter import TLSExporterConfig
from veadk.integrations.ve_tls.ve_tls import VeTLS
from os import getenv

# 初始化VeTLS客户端用于创建日志项目和追踪实例
ve_tls_client = VeTLS()

# 创建日志项目
project_name = "veadk_pj"
log_project_id = ve_tls_client.create_log_project(project_name)
print(f"Created log project with ID: {log_project_id}")

# 创建追踪实例
trace_instance_name = getenv("OBSERVABILITY_OPENTELEMETRY_TLS_SERVICE_NAME")
trace_instance = ve_tls_client.create_tracing_instance(log_project_id, trace_instance_name)
print(f"Created trace instance with ID: {trace_instance['TraceInstanceId']}")

在 agent.py 文件中配置日志服务 TLSExporter 用于上报 tracing 数据。

import asyncio

from veadk import Agent, Runner
from veadk.memory.short_term_memory import ShortTermMemory
from veadk.tools.demo_tools import get_city_weather
from veadk.tracing.telemetry.exporters.tls_exporter import TLSExporter
from veadk.tracing.telemetry.opentelemetry_tracer import OpentelemetryTracer
from veadk.tracing.telemetry.exporters.tls_exporter import TLSExporterConfig
from veadk.integrations.ve_tls.ve_tls import VeTLS
from os import getenv

# 初始化TLSExporter用于上报 tracing 数据
tls_exporter = TLSExporter(
config=TLSExporterConfig(
topic_id=trace_instance.get('TraceTopicId', trace_instance_name),
)
)

exporters = [tls_exporter]

tracer = OpentelemetryTracer(exporters=exporters)

agent = Agent(tools=[get_city_weather], tracers=[tracer])

session_id = "session_id_pj"

runner = Runner(agent=agent, short_term_memory=ShortTermMemory())

prompt = "How is the weather like in Beijing? Besides, tell me which tool you invoked."

asyncio.run(runner.run(messages=prompt, session_id=session_id))