OpenTelemetry-JS 中解决日志服务名称显示为 unknown_service_node 的方法

在使用 OpenTelemetry Node.js SDK 时，开发者可能会遇到一个常见问题：当将日志数据通过 OTLP 导出到 Elastic Agent 时，日志被归类到 unknown_service_node 服务下，而不是显示预期的服务名称。本文将深入分析这个问题并提供解决方案。

问题现象

当开发者使用 OpenTelemetry Node.js SDK 配置多个应用向同一个 Collector 发送数据时，通常会出现以下情况：

• 指标(Metrics)和追踪(Traces)数据能够正确显示在各自的服务名称下
• 日志数据却被统一归类到 unknown_service_node 服务中

问题原因

这个问题的根本原因在于日志记录器(Logger)没有正确关联资源(Resource)信息。在 OpenTelemetry 中，资源用于标识产生遥测数据的实体（如服务）。如果没有明确指定资源信息，日志记录器将无法确定其所属的服务名称。

解决方案

要解决这个问题，我们需要创建一个包含服务名称的资源对象，并将其同时应用于 NodeSDK 和 LoggerProvider。以下是完整的解决方案：

import { Resource } from '@opentelemetry/resources';
import { SEMRESATTRS_SERVICE_NAME } from '@opentelemetry/semantic-conventions';

// 创建包含服务名称的资源对象
const resource = Resource.default().merge(
  new Resource({
    [SEMRESATTRS_SERVICE_NAME]: "App 1", // 你的服务名称
  })
);

// 将资源应用到NodeSDK
const sdk = new NodeSDK({
  resource: resource,
  // 其他配置...
});

// 将资源应用到LoggerProvider
const loggerProvider = new LoggerProvider({
  resource: resource,
});

实现原理

1. 资源(Resource)概念：在 OpenTelemetry 中，资源代表产生遥测数据的实体，通常包含服务名称、服务版本等信息。

2. 语义约定(Semantic Conventions)：SEMRESATTRS_SERVICE_NAME 是 OpenTelemetry 定义的语义属性常量，用于标识服务名称。

3. 资源合并：Resource.default() 获取默认资源，然后通过 merge() 方法将自定义的服务名称合并进去。

4. 应用资源：将创建好的资源对象同时传递给 NodeSDK 和 LoggerProvider，确保所有遥测数据（包括日志）都能正确关联到服务。

最佳实践

1. 统一资源配置：建议将资源创建逻辑提取到单独模块中，确保整个应用使用相同的资源配置。

2. 环境变量支持：可以通过环境变量动态设置服务名称，提高配置灵活性。

3. 完整属性：除了服务名称，还可以在资源中添加其他有用信息，如服务版本、部署环境等。

const resource = Resource.default().merge(
  new Resource({
    [SEMRESATTRS_SERVICE_NAME]: process.env.SERVICE_NAME || "default-service",
    ['service.version']: process.env.SERVICE_VERSION || "1.0.0",
    ['deployment.environment']: process.env.NODE_ENV || "development",
  })
);

通过以上方法，开发者可以确保日志数据与指标和追踪数据一样，正确显示在对应的服务名称下，而不是被归类到 unknown_service_node 中。