resource-detector-instana

- feat(resource-detector-instana): suppress tracing of the detectors internal HTTP requests

Author: trentm

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

@@ -22,21 +22,15 @@ npm install --save @opentelemetry/resource-detector-instana
 
 ```typescript
 import {
-  Resource,
   processDetector,
   envDetector,
 } from "@opentelemetry/resources";
-import { SEMRESATTRS_SERVICE_NAME } from "@opentelemetry/semantic-conventions";
 import { NodeSDK } from "@opentelemetry/sdk-node";
 import { instanaAgentDetector } from "@opentelemetry/resource-detector-instana";
 
-const globalResource = new Resource({
-   [SEMRESATTRS_SERVICE_NAME]: "TestService",
-});
-
 const sdk = new NodeSDK({
+   serviceName: "TestService",
    resourceDetectors: [envDetector, processDetector, instanaAgentDetector],
-   resource: globalResource,
 });
 
 sdk.start()

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

@@ -26,7 +26,7 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=8.12.0"
+    "node": "^18.19.0 || >=20.6.0"
   },
   "files": [
     "build/src/**/*.js",
@@ -42,7 +42,7 @@
   "devDependencies": {
     "@opentelemetry/api": "^1.3.0",
     "@opentelemetry/contrib-test-utils": "^0.45.1",
-    "@opentelemetry/sdk-node": "^0.57.2",
+    "@opentelemetry/sdk-node": "^0.200.0-dev.0",
     "@types/mocha": "10.0.10",
     "@types/node": "18.18.14",
     "@types/semver": "7.5.8",
@@ -52,7 +52,7 @@
     "typescript": "4.4.4"
   },
   "dependencies": {
-    "@opentelemetry/resources": "^1.10.0",
+    "@opentelemetry/resources": "^2.0.0-dev.0",
     "@opentelemetry/semantic-conventions": "^1.27.0"
   },
   "peerDependencies": {

detectors/node/opentelemetry-resource-detector-instana/src/detectors/InstanaAgentDetector.ts

@@ -13,28 +13,44 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+import { context, diag } from '@opentelemetry/api';
+import { suppressTracing } from '@opentelemetry/core';
 import {
-  DetectorSync,
-  Resource,
-  IResource,
-  ResourceAttributes,
+  ResourceDetector,
+  DetectedResource,
+  DetectedResourceAttributes,
 } from '@opentelemetry/resources';
-import { diag } from '@opentelemetry/api';
 import {
   SEMRESATTRS_PROCESS_PID,
   SEMRESATTRS_SERVICE_INSTANCE_ID,
 } from '@opentelemetry/semantic-conventions';
 import * as http from 'http';
 
-class InstanaAgentDetector implements DetectorSync {
+class InstanaAgentDetector implements ResourceDetector {
   readonly INSTANA_AGENT_DEFAULT_HOST = 'localhost';
   readonly INSTANA_AGENT_DEFAULT_PORT = 42699;
 
-  detect(): IResource {
-    return new Resource({}, this._getAttributes());
+  detect(): DetectedResource {
+    const dataPromise = context.with(suppressTracing(context.active()), () =>
+      this._gatherData()
+    );
+
+    const attrNames = [
+      SEMRESATTRS_PROCESS_PID,
+      SEMRESATTRS_SERVICE_INSTANCE_ID,
+    ];
+
+    const attributes = {} as DetectedResourceAttributes;
+    attrNames.forEach(name => {
+      // Each resource attribute is determined asynchronously in _gatherData().
+      attributes[name] = dataPromise.then(data => data[name]);
+    });
+
+    return { attributes };
   }
 
-  private async _getAttributes(): Promise<ResourceAttributes> {
+  private async _gatherData(): Promise<DetectedResourceAttributes> {
     const host =
       process.env.INSTANA_AGENT_HOST || this.INSTANA_AGENT_DEFAULT_HOST;
     const port = Number(

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

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export * from './InstanaAgentDetector';
+export { instanaAgentDetector } from './InstanaAgentDetector';

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

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 
-export * from './detectors';
+export { instanaAgentDetector } from './detectors';

detectors/node/opentelemetry-resource-detector-instana/test/InstanaAgentDetectorIntegrationTest.test.ts

@@ -16,12 +16,7 @@
 
 import * as nock from 'nock';
 import * as assert from 'assert';
-import {
-  Resource,
-  processDetector,
-  envDetector,
-} from '@opentelemetry/resources';
-import { SEMRESATTRS_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
+import { processDetector, envDetector } from '@opentelemetry/resources';
 import { NodeSDK } from '@opentelemetry/sdk-node';
 import { instanaAgentDetector } from '../src';
 
@@ -53,13 +48,9 @@ describe('[Integration] instanaAgentDetector', () => {
       .reply(200, () => mockedReply);
 
     const serviceName = 'TestService';
-    const globalResource = new Resource({
-      [SEMRESATTRS_SERVICE_NAME]: serviceName,
-    });
-
     const sdk = new NodeSDK({
+      serviceName,
       resourceDetectors: [envDetector, processDetector, instanaAgentDetector],
-      resource: globalResource,
     });
 
     sdk.start();
@@ -92,19 +83,14 @@ describe('[Integration] instanaAgentDetector', () => {
       .reply(200, () => mockedReply);
 
     const serviceName = 'TestService';
-    const globalResource = new Resource({
-      [SEMRESATTRS_SERVICE_NAME]: serviceName,
-    });
-
     const sdk = new NodeSDK({
+      serviceName,
       resourceDetectors: [envDetector, processDetector, instanaAgentDetector],
-      resource: globalResource,
     });
 
     sdk.start();
     const resource = sdk['_resource'];
-
-    await delay(500);
+    await resource.waitForAsyncAttributes?.();
 
     assert.equal(resource.attributes['process.pid'], 123);
     assert.equal(resource.attributes['process.runtime.name'], 'nodejs');

detectors/node/opentelemetry-resource-detector-instana/test/InstanaAgentDetectorUnitTest.test.ts

@@ -17,6 +17,7 @@
 import * as nock from 'nock';
 import * as assert from 'assert';
 import { instanaAgentDetector } from '../src';
+import { detectResources } from '@opentelemetry/resources';
 
 describe('[UNIT] instanaAgentDetector', () => {
   describe('when agent is running', () => {
@@ -53,7 +54,7 @@ describe('[UNIT] instanaAgentDetector', () => {
         .put('/com.instana.plugin.nodejs.discovery')
         .reply(200, () => mockedReply);
 
-      const resource = instanaAgentDetector.detect();
+      const resource = detectResources({ detectors: [instanaAgentDetector] });
       await resource.waitForAsyncAttributes?.();
 
       scope.done();
@@ -80,7 +81,7 @@ describe('[UNIT] instanaAgentDetector', () => {
         .put('/com.instana.plugin.nodejs.discovery')
         .reply(200, () => mockedReply);
 
-      const resource = instanaAgentDetector.detect();
+      const resource = detectResources({ detectors: [instanaAgentDetector] });
       await resource.waitForAsyncAttributes?.();
 
       scope.done();
@@ -97,7 +98,7 @@ describe('[UNIT] instanaAgentDetector', () => {
         .put('/com.instana.plugin.nodejs.discovery')
         .reply(500, () => new Error());
 
-      const resource = instanaAgentDetector.detect();
+      const resource = detectResources({ detectors: [instanaAgentDetector] });
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});
@@ -118,7 +119,7 @@ describe('[UNIT] instanaAgentDetector', () => {
         .delay(500)
         .reply(200, {});
 
-      const resource = instanaAgentDetector.detect();
+      const resource = detectResources({ detectors: [instanaAgentDetector] });
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});
@@ -131,7 +132,7 @@ describe('[UNIT] instanaAgentDetector', () => {
       process.env.INSTANA_AGENT_TIMEOUT_MS = '100';
       process.env.INSTANA_RETRY_TIMEOUT_MS = '100';
 
-      const resource = instanaAgentDetector.detect();
+      const resource = detectResources({ detectors: [instanaAgentDetector] });
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});