resource-detector-container

chore(resource-detector-container)!: `ContainerDetector` class is no longer exported

Author: trentm

detectors/node/opentelemetry-resource-detector-container/README.md

@@ -30,7 +30,7 @@ const tracerProvider = new NodeTracerProvider({ resource });
 
 This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
 
-### ContainerDetector
+### Container Detector
 
 Populates `container.id` for processes running on containers supporting : docker( cgroup v1 or v2 ) or with containerd
 

detectors/node/opentelemetry-resource-detector-container/package.json

@@ -21,7 +21,7 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=14"
+    "node": "^18.19.0 || >=20.6.0"
   },
   "files": [
     "build/src/**/*.js",
@@ -52,8 +52,8 @@
     "@opentelemetry/api": "^1.0.0"
   },
   "dependencies": {
-    "@opentelemetry/core": "^1.26.0",
-    "@opentelemetry/resources": "^1.10.0",
+    "@opentelemetry/core": "^2.0.0-dev.0",
+    "@opentelemetry/resources": "^2.0.0-dev.0",
     "@opentelemetry/semantic-conventions": "^1.27.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-container#readme",

detectors/node/opentelemetry-resource-detector-container/src/detectors/ContainerDetector.ts

@@ -14,11 +14,9 @@
  * limitations under the License.
  */
 import {
-  DetectorSync,
-  IResource,
-  Resource,
-  ResourceAttributes,
   ResourceDetectionConfig,
+  ResourceDetector,
+  DetectedResource,
 } from '@opentelemetry/resources';
 
 import { SEMRESATTRS_CONTAINER_ID } from '@opentelemetry/semantic-conventions';
@@ -29,7 +27,7 @@ import { context, diag } from '@opentelemetry/api';
 import { suppressTracing } from '@opentelemetry/core';
 import { extractContainerIdFromLine } from './utils';
 
-export class ContainerDetector implements DetectorSync {
+export class ContainerDetector implements ResourceDetector {
   readonly CONTAINER_ID_LENGTH = 64;
   readonly DEFAULT_CGROUP_V1_PATH = '/proc/self/cgroup';
   readonly DEFAULT_CGROUP_V2_PATH = '/proc/self/mountinfo';
@@ -43,35 +41,17 @@ export class ContainerDetector implements DetectorSync {
 
   private static readFileAsync = util.promisify(fs.readFile);
 
-  detect(_config?: ResourceDetectionConfig): IResource {
-    const attributes = context.with(suppressTracing(context.active()), () =>
-      this._getAttributes()
-    );
-    return new Resource({}, attributes);
+  detect(_config?: ResourceDetectionConfig): DetectedResource {
+    const attributes = {
+      [SEMRESATTRS_CONTAINER_ID]: this._getContainerIdWithSuppressedTracing()
+    }
+    return { attributes };
   }
 
-  /**
-   * Attempts to obtain the container ID from the file system. If the
-   * file read is successful it returns a promise containing a {@link ResourceAttributes}
-   * object with the container ID. Returns a promise containing an
-   * empty {@link ResourceAttributes} if the paths do not exist or fail
-   * to read.
-   */
-  async _getAttributes(): Promise<ResourceAttributes> {
-    try {
-      const containerId = await this._getContainerId();
-      return !containerId
-        ? {}
-        : {
-            [SEMRESATTRS_CONTAINER_ID]: containerId,
-          };
-    } catch (e) {
-      diag.debug(
-        'Container Detector did not identify running inside a supported container, no container attributes will be added to resource: ',
-        e
-      );
-      return {};
-    }
+  async _getContainerIdWithSuppressedTracing(): Promise<string | undefined> {
+    return context.with(suppressTracing(context.active()), () =>
+      this._getContainerId()
+    );
   }
 
   private async _getContainerIdV1(): Promise<string | undefined> {

detectors/node/opentelemetry-resource-detector-container/src/detectors/index.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from './ContainerDetector';
+export { containerDetector } from './ContainerDetector';

detectors/node/opentelemetry-resource-detector-container/src/index.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from './detectors';
+export { containerDetector } from './detectors';

detectors/node/opentelemetry-resource-detector-container/test/ContainerDetector.test.ts

@@ -17,13 +17,14 @@
 import * as sinon from 'sinon';
 import * as assert from 'assert';
 
-import { containerDetector } from '../src';
 import {
   assertContainerResource,
   assertEmptyResource,
 } from '@opentelemetry/contrib-test-utils';
+import { detectResources } from '@opentelemetry/resources';
 
-import { ContainerDetector } from '../src';
+import { containerDetector } from '../src';
+import { ContainerDetector } from '../src/detectors/ContainerDetector';
 
 describe('ContainerDetector', () => {
   let readStub: sinon.SinonStub;
@@ -48,7 +49,7 @@ describe('ContainerDetector', () => {
         .stub(ContainerDetector, 'readFileAsync' as any)
         .resolves(undefined);
 
-      const resource = containerDetector.detect();
+      const resource = detectResources({detectors: [containerDetector]});
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});
@@ -60,7 +61,7 @@ describe('ContainerDetector', () => {
         .stub(ContainerDetector, 'readFileAsync' as any)
         .resolves(correctCgroupV1Data);
 
-      const resource = containerDetector.detect();
+      const resource = detectResources({detectors: [containerDetector]});
       await resource.waitForAsyncAttributes?.();
 
       sinon.assert.calledOnce(readStub);
@@ -77,7 +78,7 @@ describe('ContainerDetector', () => {
       readStub.onFirstCall().resolves('');
       readStub.onSecondCall().resolves(correctCgroupV2Data);
 
-      const resource = containerDetector.detect();
+      const resource = detectResources({detectors: [containerDetector]});
       await resource.waitForAsyncAttributes?.();
       sinon.assert.calledTwice(readStub);
 
@@ -93,7 +94,7 @@ describe('ContainerDetector', () => {
       readStub.onFirstCall().resolves('');
       readStub.onSecondCall().resolves(correctCgroupV2PodmanData);
 
-      const resource = containerDetector.detect();
+      const resource = detectResources({detectors: [containerDetector]});
       await resource.waitForAsyncAttributes?.();
       sinon.assert.calledTwice(readStub);
 
@@ -109,7 +110,7 @@ describe('ContainerDetector', () => {
       readStub.onFirstCall().resolves('');
       readStub.onSecondCall().resolves(wrongCgroupV2Data);
 
-      const resource = containerDetector.detect();
+      const resource = detectResources({detectors: [containerDetector]});
       await resource.waitForAsyncAttributes?.();
       sinon.assert.calledTwice(readStub);
 
@@ -131,7 +132,7 @@ describe('ContainerDetector', () => {
         .stub(ContainerDetector, 'readFileAsync' as any)
         .resolves('');
 
-      const resource = containerDetector.detect();
+      const resource = detectResources({detectors: [containerDetector]});
       await resource.waitForAsyncAttributes?.();
       assert.deepStrictEqual(resource.attributes, {});
 
@@ -148,7 +149,7 @@ describe('ContainerDetector', () => {
         .stub(ContainerDetector, 'readFileAsync' as any)
         .rejects(errorMsg.fileNotFoundError);
 
-      const resource = containerDetector.detect();
+      const resource = detectResources({detectors: [containerDetector]});
       await resource.waitForAsyncAttributes?.();
 
       sinon.assert.calledOnce(readStub);
@@ -166,7 +167,7 @@ describe('ContainerDetector', () => {
         .stub(ContainerDetector, 'readFileAsync' as any)
         .rejects(errorMsg.fileNotFoundError);
 
-      const resource = containerDetector.detect();
+      const resource = detectResources({detectors: [containerDetector]});
       await resource.waitForAsyncAttributes?.();
       sinon.assert.calledOnce(readStub);
       assertEmptyResource(resource);

detectors/node/opentelemetry-resource-detector-container/test/ContainerDetectorIntegration.test.ts

@@ -22,7 +22,7 @@ import {
   SimpleSpanProcessor,
 } from '@opentelemetry/sdk-trace-base';
 import { NodeSDK } from '@opentelemetry/sdk-node';
-import { IResource } from '@opentelemetry/resources';
+import { detectResources } from '@opentelemetry/resources';
 
 describe('[Integration] ContainerDetector', () => {
   it('should not start spans for detector reads to filesystem', async () => {
@@ -54,7 +54,7 @@ describe('[Integration] ContainerDetector', () => {
     await spanProcessor.forceFlush();
     const numSpansAfterRequire = memoryExporter.getFinishedSpans().length;
 
-    const resource = containerDetector.detect() as IResource;
+    const resource = detectResources({detectors: [containerDetector]});
     await resource.waitForAsyncAttributes?.();
 
     // Wait for the next loop to let the span close properly