OpenTelemetry属性命名的五个最佳实践( 三 )

  • 创建您不使用的属性,即使看起来将来可能对某人有用 。除非有确凿的证据证明属性的有用性,最好还是暂时不要添加 。
  • 将堆栈跟踪、uuid(唯一用户标识)或异常信息放入自定义属性 。建议在发生时将它们记录为跨度上的Event,并且事件的名称必须为 "exception" 。详见规范中的异常部分 。
  • 属性键重复 —— 要么覆盖同一跨度上的键,要么拥有两个具有不同名称的相同值 。重复的属性键可能会引起冲突并覆盖数据 。它还使查询和分析变得复杂 。
  • 未设置或空值 。未设置的值提供不了有用的信息 。没有值的属性占用存储空间 , 但对故障排除或分析没有帮助 。它们还可能通过扭曲总数来扭曲分析 。这也会引起混淆 。
  • 在 OpenTelemetry 文档中还有更多有用的见解和建议,因此在制定属性标准时建议查阅最新的规范 。
    结论追踪数据收集是观测性的一个必要部分 。但这需要建立一套流程,以确保数据是有用的、可访问的,并且具有洞察力 。命名规范需要一些前期工作,但通过采纳这些最佳实践 —— 从确保语义清晰和维护统一库到了解数据、与服务水平保持一致 , 以及预测新的用例 —— 您的团队可以提升遥测的效用 。
    这种方法不仅简化故障排除,还帮助您在组织内建立一个有效的观测文化 。这项工作的结果是一个充满可访问洞察的丰富 OTel 数据集 , 使更加智能、更加迅速的决策成为可能 。




    推荐阅读