OpenLLMetry项目中OpenAI Assistant API监控功能的Token统计问题分析

背景介绍

在OpenLLMetry项目的OpenAI监控组件中，开发者发现了一个关于Assistant API调用的监控数据不完整问题。该项目主要用于对各类生成式AI服务进行监控和追踪，但在处理OpenAI Assistant API的响应时，未能正确捕获关键的Token使用量数据。

问题现象

当开发者使用OpenAI Assistant API时，监控系统存在两个明显的功能缺失：

1. 系统属性标识缺失：监控数据中缺少gen_ai.system=openai这一关键标识，这使得后续的数据分析和归类变得困难。

2. Token统计信息丢失：虽然OpenAI Assistant API的响应中包含了详细的Token使用数据（包括prompt tokens、completion tokens和total tokens），但监控系统未能将这些数据记录到追踪信息中。

技术分析

监控数据收集机制

在标准的OpenAI API调用监控中，系统通常会从API响应中提取以下关键信息：

• 系统标识：用于区分不同的AI服务提供商
• Token用量：反映API调用的资源消耗情况
• 响应内容：用于调试和分析

问题根源

通过对代码的分析，我们发现问题的根源在于：

1. 系统属性设置遗漏：在创建监控span时，没有显式设置系统标识属性。

2. Token统计处理逻辑不完整：监控组件没有从run.usage对象中提取Token使用数据，即使这些数据已经包含在API响应中。

解决方案建议

要解决这个问题，需要在监控组件中做以下改进：

1. 添加系统标识：在创建span时，应当明确设置系统属性：

   span.set_attribute("gen_ai.system", "openai")
   

2. 完善Token统计处理：应当从API响应中提取Token使用数据并记录到监控信息中：

   if hasattr(run, 'usage') and run.usage:
       span.set_attribute("gen_ai.usage.prompt_tokens", run.usage.prompt_tokens)
       span.set_attribute("gen_ai.usage.completion_tokens", run.usage.completion_tokens)
       span.set_attribute("gen_ai.usage.total_tokens", run.usage.total_tokens)
   

影响评估

这个问题的存在会导致：

1. 监控数据不完整：无法准确统计API调用的资源消耗情况。

2. 数据分析困难：缺少系统标识使得跨系统比较和分析变得复杂。

3. 计费估算不准确：Token使用量是OpenAI API计费的重要依据，缺少这些数据会影响成本估算。

最佳实践建议

对于使用OpenLLMetry监控OpenAI服务的开发者，建议：

1. 及时更新到修复后的版本。

2. 在自定义监控逻辑时，确保捕获所有关键的API响应数据。

3. 定期检查监控数据的完整性，特别是Token使用量等关键指标。

总结

OpenLLMetry作为生成式AI服务的监控工具，其数据收集的完整性至关重要。本次发现的OpenAI Assistant API监控问题虽然看似简单，但直接影响到了监控数据的实用性和准确性。通过修复这个问题，可以显著提升监控系统的数据质量，为后续的性能分析和成本优化提供可靠依据。