chore: set default service name (#2227)

Author: dyladan

README.md

@@ -232,6 +232,8 @@ To request automatic tracing support for a module not on this list, please [file
 
 - `JaegerHttpTracePropagator` renamed to `JaegerPropagator`
 
+- `serviceName` configuration removed from Collector exporters. Use `service.name` Resource attribute instead.
+
 ### 0.18.x to 0.19.0
 
 - API is now a peer dependency. This means that users will need to include `@opentelemetry/api` as a dependency of their project in order to use the SDK. NPM version 7+ (Node 15+) should do this automatically.

packages/opentelemetry-core/src/utils/environment.ts

@@ -76,6 +76,7 @@ export type ENVIRONMENT = {
   OTEL_EXPORTER_ZIPKIN_ENDPOINT?: string;
   OTEL_LOG_LEVEL?: DiagLogLevel;
   OTEL_RESOURCE_ATTRIBUTES?: string;
+  OTEL_SERVICE_NAME?: string;
   OTEL_TRACES_EXPORTER?: string;
   OTEL_TRACES_SAMPLER_ARG?: string;
   OTEL_TRACES_SAMPLER?: string;
@@ -115,6 +116,7 @@ export const DEFAULT_ENVIRONMENT: Required<ENVIRONMENT> = {
   OTEL_NO_PATCH_MODULES: [],
   OTEL_PROPAGATORS: ['tracecontext', 'baggage'],
   OTEL_RESOURCE_ATTRIBUTES: '',
+  OTEL_SERVICE_NAME: '',
   OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT: 128,
   OTEL_SPAN_EVENT_COUNT_LIMIT: 128,
   OTEL_SPAN_LINK_COUNT_LIMIT: 128,

packages/opentelemetry-exporter-collector-grpc/README.md

@@ -13,6 +13,11 @@ This module provides exporter for web and node to be used with [opentelemetry-co
 npm install --save @opentelemetry/exporter-collector-grpc
 ```
 
+## Service Name
+
+The OpenTelemetry Collector Exporter does not have a service name configuration.
+In order to set the service name, use the `service.name` resource attribute as prescribed in the [OpenTelemetry Resource Semantic Conventions][semconv-resource-service-name].
+
 ## Traces in Node - GRPC
 
 The CollectorTraceExporter in Node expects the URL to only be the hostname. It will not work with `/v1/traces`.
@@ -22,7 +27,6 @@ const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/tra
 const { CollectorTraceExporter } =  require('@opentelemetry/exporter-collector-grpc');
 
 const collectorOptions = {
-  serviceName: 'basic-service',
   // url is optional and can be omitted - default is localhost:4317
   url: '<collector-hostname>:<port>',
 };
@@ -47,7 +51,6 @@ const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/tra
 const { CollectorTraceExporter } =  require('@opentelemetry/exporter-collector-grpc');
 
 const collectorOptions = {
-  serviceName: 'basic-service',
   // url is optional and can be omitted - default is localhost:4317
   url: '<collector-hostname>:<port>',
   credentials: grpc.credentials.createSsl(),
@@ -88,7 +91,6 @@ const metadata = new grpc.Metadata();
 metadata.set('k', 'v');
 
 const collectorOptions = {
-  serviceName: 'basic-service',
   // url is optional and can be omitted - default is localhost:4317
   url: '<collector-hostname>:<port>',
   metadata, // // an optional grpc.Metadata object to be sent with each request
@@ -114,7 +116,6 @@ The CollectorTraceExporter in Node expects the URL to only be the hostname. It w
 const { MeterProvider } = require('@opentelemetry/metrics');
 const { CollectorMetricExporter } =  require('@opentelemetry/exporter-collector-grpc');
 const collectorOptions = {
-  serviceName: 'basic-service',
   // url is optional and can be omitted - default is localhost:4317
   url: '<collector-hostname>:<port>',
 };
@@ -161,3 +162,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [npm-url]: https://www.npmjs.com/package/@opentelemetry/exporter-collector-grpc
 [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fexporter-collector-grpc.svg
 [opentelemetry-collector-url]: https://github.com/open-telemetry/opentelemetry-collector
+[semconv-resource-service-name]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service

packages/opentelemetry-exporter-collector-grpc/src/CollectorMetricExporter.ts

@@ -24,7 +24,6 @@ import { CollectorExporterNodeBase } from './CollectorExporterNodeBase';
 import { getEnv } from '@opentelemetry/core';
 import { validateAndNormalizeUrl } from './util';
 
-const DEFAULT_SERVICE_NAME = 'collector-metric-exporter';
 const DEFAULT_COLLECTOR_URL = 'localhost:4317';
 
 /**
@@ -59,10 +58,6 @@ export class CollectorMetricExporter
       : DEFAULT_COLLECTOR_URL;
   }
 
-  getDefaultServiceName(config: CollectorExporterConfigNode): string {
-    return config.serviceName || DEFAULT_SERVICE_NAME;
-  }
-
   getServiceClientType() {
     return ServiceClientType.METRICS;
   }

packages/opentelemetry-exporter-collector-grpc/src/CollectorTraceExporter.ts

@@ -24,7 +24,6 @@ import { CollectorExporterConfigNode, ServiceClientType } from './types';
 import { getEnv } from '@opentelemetry/core';
 import { validateAndNormalizeUrl } from './util';
 
-const DEFAULT_SERVICE_NAME = 'collector-trace-exporter';
 const DEFAULT_COLLECTOR_URL = 'localhost:4317';
 
 /**
@@ -52,10 +51,6 @@ export class CollectorTraceExporter
       : DEFAULT_COLLECTOR_URL;
   }
 
-  getDefaultServiceName(config: CollectorExporterConfigNode): string {
-    return config.serviceName || DEFAULT_SERVICE_NAME;
-  }
-
   getServiceClientType() {
     return ServiceClientType.SPANS;
   }

packages/opentelemetry-exporter-collector-grpc/test/CollectorMetricExporter.test.ts

@@ -131,7 +131,6 @@ const testCollectorMetricExporter = (params: TestParams) =>
       collectorExporter = new CollectorMetricExporter({
         url: 'grpcs://' + address,
         credentials,
-        serviceName: 'basic-service',
         metadata: params.metadata,
       });
       // Overwrites the start time to make tests consistent
@@ -169,7 +168,6 @@ const testCollectorMetricExporter = (params: TestParams) =>
         // Need to stub/spy on the underlying logger as the 'diag' instance is global
         const spyLoggerWarn = sinon.stub(diag, 'warn');
         collectorExporter = new CollectorMetricExporter({
-          serviceName: 'basic-service',
           url: `http://${address}`,
           headers: {
             foo: 'bar',
@@ -181,7 +179,6 @@ const testCollectorMetricExporter = (params: TestParams) =>
       it('should warn about path in url', () => {
         const spyLoggerWarn = sinon.stub(diag, 'warn');
         collectorExporter = new CollectorMetricExporter({
-          serviceName: 'basic-service',
           url: `http://${address}/v1/metrics`
         });
         const args = spyLoggerWarn.args[0];

packages/opentelemetry-exporter-collector-grpc/test/CollectorTraceExporter.test.ts

@@ -124,7 +124,6 @@ const testCollectorExporter = (params: TestParams) =>
           )
         : undefined;
       collectorExporter = new CollectorTraceExporter({
-        serviceName: 'basic-service',
         url: 'grpcs://' + address,
         credentials,
         metadata: params.metadata,
@@ -146,7 +145,6 @@ const testCollectorExporter = (params: TestParams) =>
         // Need to stub/spy on the underlying logger as the 'diag' instance is global
         const spyLoggerWarn = sinon.stub(diag, 'warn');
         collectorExporter = new CollectorTraceExporter({
-          serviceName: 'basic-service',
           url: `http://${address}`,
           headers: {
             foo: 'bar',
@@ -158,7 +156,6 @@ const testCollectorExporter = (params: TestParams) =>
       it('should warn about path in url', () => {
         const spyLoggerWarn = sinon.stub(diag, 'warn');
         collectorExporter = new CollectorTraceExporter({
-          serviceName: 'basic-service',
           url: `http://${address}/v1/trace`,
         });
         const args = spyLoggerWarn.args[0];

packages/opentelemetry-exporter-collector-grpc/test/helper.ts

@@ -28,6 +28,7 @@ import { Resource } from '@opentelemetry/resources';
 import { ReadableSpan } from '@opentelemetry/tracing';
 import * as assert from 'assert';
 import * as grpc from '@grpc/grpc-js';
+import { VERSION } from '@opentelemetry/core';
 
 const meterProvider = new metrics.MeterProvider({
   interval: 30000,
@@ -157,11 +158,11 @@ export const mockedReadableSpan: ReadableSpan = {
     },
   ],
   duration: [0, 8885000],
-  resource: new Resource({
+  resource: Resource.default().merge(new Resource({
     service: 'ui',
     version: 1,
     cost: 112.12,
-  }),
+  })),
   instrumentationLibrary: { name: 'default', version: '0.0.1' },
 };
 
@@ -409,11 +410,32 @@ export function ensureResourceIsCorrect(
   assert.deepStrictEqual(resource, {
     attributes: [
       {
-        key: 'service.name',
-        value: {
-          stringValue: 'basic-service',
-          value: 'stringValue',
-        },
+        "key": "service.name",
+        "value": {
+          "stringValue": `unknown_service:${process.argv0}`,
+          "value": "stringValue"
+        }
+      },
+      {
+        "key": "telemetry.sdk.language",
+        "value": {
+          "stringValue": "nodejs",
+          "value": "stringValue"
+        }
+      },
+      {
+        "key": "telemetry.sdk.name",
+        "value": {
+          "stringValue": "opentelemetry",
+          "value": "stringValue"
+        }
+      },
+      {
+        "key": "telemetry.sdk.version",
+        "value": {
+          "stringValue": VERSION,
+          "value": "stringValue"
+        }
       },
       {
         key: 'service',

packages/opentelemetry-exporter-collector-proto/README.md

@@ -13,14 +13,18 @@ This module provides exporter for node to be used with [opentelemetry-collector]
 npm install --save @opentelemetry/exporter-collector-proto
 ```
 
+## Service Name
+
+The OpenTelemetry Collector Exporter does not have a service name configuration.
+In order to set the service name, use the `service.name` resource attribute as prescribed in the [OpenTelemetry Resource Semantic Conventions][semconv-resource-service-name].
+
 ## Traces in Node - PROTO over http
 
 ```js
 const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { CollectorTraceExporter } =  require('@opentelemetry/exporter-collector-proto');
 
 const collectorOptions = {
-  serviceName: 'basic-service',
   url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/traces
   headers: {
     foo: 'bar'
@@ -41,7 +45,6 @@ provider.register();
 const { MeterProvider } = require('@opentelemetry/metrics');
 const { CollectorMetricExporter } =  require('@opentelemetry/exporter-collector-proto');
 const collectorOptions = {
-  serviceName: 'basic-service',
   url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/metrics
 };
 const exporter = new CollectorMetricExporter(collectorOptions);
@@ -84,3 +87,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [npm-url]: https://www.npmjs.com/package/@opentelemetry/exporter-collector-proto
 [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fexporter-collector-proto.svg
 [opentelemetry-collector-url]: https://github.com/open-telemetry/opentelemetry-collector
+[semconv-resource-service-name]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service

packages/opentelemetry-exporter-collector-proto/src/CollectorMetricExporter.ts

@@ -24,7 +24,6 @@ import { ServiceClientType } from './types';
 import { CollectorExporterNodeBase } from './CollectorExporterNodeBase';
 import { getEnv, baggageUtils } from '@opentelemetry/core';
 
-const DEFAULT_SERVICE_NAME = 'collector-metric-exporter';
 const DEFAULT_COLLECTOR_URL = 'http://localhost:4317/v1/metrics';
 
 /**
@@ -69,10 +68,6 @@ export class CollectorMetricExporter
       : DEFAULT_COLLECTOR_URL;
   }
 
-  getDefaultServiceName(config: CollectorExporterNodeConfigBase): string {
-    return config.serviceName || DEFAULT_SERVICE_NAME;
-  }
-
   getServiceClientType() {
     return ServiceClientType.METRICS;
   }