fix: when auto-detecting service name, use version as service.version

(instead of concatenating it into service.name)
dash0hq · Sep 17, 2024 · be71b6c · be71b6c
1 parent 11457e8
commit be71b6c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 11 deletions.
diff --git a/src/detectors/node/opentelemetry-resource-detector-service-name-fallback/index.ts b/src/detectors/node/opentelemetry-resource-detector-service-name-fallback/index.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { DetectorSync, Resource } from '@opentelemetry/resources';
-import { SEMRESATTRS_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
+import { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
 
 import { readPackageJson } from './packageJsonUtil';
 
@@ -15,7 +15,7 @@ export default class ServiceNameFallbackDetector implements DetectorSync {
     if (
       hasOptedOutOfServiceNameFallbackDetection() ||
       hasOTelServiceNameSet() ||
-      hasServiceNameSetViaResourceAttributesThing()
+      hasServiceNameSetViaOTelResourceAttributesEnvVar()
     ) {
       return {};
     }
@@ -24,7 +24,10 @@ export default class ServiceNameFallbackDetector implements DetectorSync {
     if (!packageJson) {
       return {};
     }
-    return { [SEMRESATTRS_SERVICE_NAME]: `${packageJson.name}@${packageJson.version}` };
+    return {
+      [SEMRESATTRS_SERVICE_NAME]: packageJson.name,
+      [SEMRESATTRS_SERVICE_VERSION]: packageJson.version,
+    };
   }
 }
 
@@ -38,7 +41,7 @@ function hasOTelServiceNameSet() {
   return otelServiceName && otelServiceName.trim() !== '';
 }
 
-function hasServiceNameSetViaResourceAttributesThing() {
+function hasServiceNameSetViaOTelResourceAttributesEnvVar() {
   const otelResourceAttributes = process.env.OTEL_RESOURCE_ATTRIBUTES;
   if (otelResourceAttributes) {
     const rawAttributes: string[] = otelResourceAttributes.split(',');

diff --git a/src/detectors/node/opentelemetry-resource-detector-service-name-fallback/index_test.ts b/src/detectors/node/opentelemetry-resource-detector-service-name-fallback/index_test.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Resource } from '@opentelemetry/resources';
-import { SEMRESATTRS_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
+import { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
 import { expect } from 'chai';
 import Sinon from 'sinon';
 import sinon from 'sinon';
@@ -57,11 +57,12 @@ describe('service name fallback', () => {
     });
   });
 
-  it('sets a service name based on package.json attributes', async () => {
+  it('sets a service name and version based on package.json attributes', async () => {
     givenAValidPackageJsonFile();
     const result = serviceNameFallback.detect();
     const attributes = await waitForAsyncDetection(result);
-    expect(attributes).to.have.property(SEMRESATTRS_SERVICE_NAME, '@example/[email protected]');
+    expect(attributes).to.have.property(SEMRESATTRS_SERVICE_NAME, '@example/app-under-test');
+    expect(attributes).to.have.property(SEMRESATTRS_SERVICE_VERSION, '2.13.47');
   });
 
   it('does not set a service name if DASH0_AUTOMATIC_SERVICE_NAME is false', async () => {
@@ -85,7 +86,8 @@ describe('service name fallback', () => {
     process.env.OTEL_SERVICE_NAME = '   ';
     const result = serviceNameFallback.detect();
     const attributes = await waitForAsyncDetection(result);
-    expect(attributes).to.have.property(SEMRESATTRS_SERVICE_NAME, '@example/[email protected]');
+    expect(attributes).to.have.property(SEMRESATTRS_SERVICE_NAME, '@example/app-under-test');
+    expect(attributes).to.have.property(SEMRESATTRS_SERVICE_VERSION, '2.13.47');
   });
 
   it('does not set a service name if OTEL_RESOURCE_ATTRIBUTES has the service.name key', async () => {
@@ -101,7 +103,8 @@ describe('service name fallback', () => {
     process.env.OTEL_RESOURCE_ATTRIBUTES = 'key1=value,key2=value';
     const result = serviceNameFallback.detect();
     const attributes = await waitForAsyncDetection(result);
-    expect(attributes).to.have.property(SEMRESATTRS_SERVICE_NAME, '@example/[email protected]');
+    expect(attributes).to.have.property(SEMRESATTRS_SERVICE_NAME, '@example/app-under-test');
+    expect(attributes).to.have.property(SEMRESATTRS_SERVICE_VERSION, '2.13.47');
   });
 
   it('does not set a service name if no package.json can be found', async () => {

diff --git a/test/integration/test.ts b/test/integration/test.ts
@@ -177,8 +177,8 @@ describe('attach', () => {
         expectMatchingSpan(
           traces,
           [
-            resource =>
-              expectResourceAttribute(resource, 'service.name', 'dash0-app-under-test-express-typescript@1.0.0'),
+            resource => expectResourceAttribute(resource, 'service.name', 'dash0-app-under-test-express-typescript'),
+            resource => expectResourceAttribute(resource, 'service.version', '1.0.0'),
           ],
           [
             span => expect(span.kind).to.equal(SpanKind.SERVER, 'span kind should be server'),