feat: add sync resource detector api and service and deployment detectors

detectors/node/resource-detector-deployment/README.md

@@ -0,0 +1,44 @@
+# OpenTelemetry Deployment Resource Detector for Node.js
+[![NPM version](https://img.shields.io/npm/v/opentelemetry-resource-detector-deployment.svg)](https://www.npmjs.com/package/opentelemetry-resource-detector-deployment)
+
+This module provides automatic resource detector for [Deployment](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/deployment_environment.md)
+
+## Installation
+
+```bash
+npm install --save opentelemetry-resource-detector-deployment
+```
+
+##  Usage
+
+### Synchronous SDK Initialization
+```js
+import { detectSyncResources } from 'opentelemetry-resource-detector-sync-api';
+import { deploymentSyncDetector } from 'opentelemetry-resource-detector-deployment';
+
+const resource = detectSyncResources({
+    detectors: [deploymentSyncDetector, /* add other sync detectors here */],
+});
+const tracerProvider = new NodeTracerProvider({ resource });
+```
+
+### Asynchronous SDK Initialization
+```js
+import { detectResources } from '@opentelemetry/resources';
+import { deploymentDetector } from 'opentelemetry-resource-detector-deployment';
+
+( async () => {
+    const resource = await detectResources({
+        detectors: [deploymentDetector, /* add other async detectors here */],
+    });
+    const tracerProvider = new NodeTracerProvider({ resource });
+    // Initialize auto instrumentation plugins and register provider.
+    // Make sure you don't 'require' instrumented packages elsewhere 
+    // before they are registered here
+})();
+```
+
+## Attributes
+| Attribute | Type | Source |
+| --- | --- | --- |
+| `deployment.environment` | string | `process.env.NODE_ENV` |

detectors/node/resource-detector-deployment/package.json

@@ -0,0 +1,61 @@
+{
+    "name": "opentelemetry-resource-detector-deployment",
+    "version": "0.4.0",
+    "description": "open telemetry resource detector for deployment",
+    "keywords": [
+        "opentelemetry"
+    ],
+    "homepage": "https://github.com/aspecto-io/opentelemetry-ext-js",
+    "license": "Apache-2.0",
+    "main": "dist/src/index.js",
+    "files": [
+        "dist/src/**/*.js",
+        "dist/src/**/*.d.ts",
+        "LICENSE",
+        "README.md"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/aspecto-io/opentelemetry-ext-js.git"
+    },
+    "scripts": {
+        "build": "tsc",
+        "prepare": "yarn run build",
+        "test": "mocha",
+        "test:jaeger": "OTEL_EXPORTER_JAEGER_AGENT_HOST=localhost mocha",
+        "watch": "tsc -w",
+        "version:update": "node ../../../scripts/version-update.js",
+        "test:ci": "yarn test",
+        "version": "yarn run version:update"
+    },
+    "bugs": {
+        "url": "https://github.com/aspecto-io/opentelemetry-ext-js/issues"
+    },
+    "peerDependencies": {
+        "@opentelemetry/api": "^0.20.0"
+    },
+    "dependencies": {
+        "@opentelemetry/resources": "^0.20.0",
+        "@opentelemetry/semantic-conventions": "^0.20.0",
+        "opentelemetry-resource-detector-sync-api": "^0.4.0"
+    },
+    "devDependencies": {
+        "@opentelemetry/api": "^0.20.0",
+        "@types/mocha": "^8.2.2",
+        "expect": "^26.6.2",
+        "mocha": "^8.4.0",
+        "opentelemetry-instrumentation-mocha": "0.0.1-rc.1",
+        "ts-node": "^9.1.1",
+        "typescript": "^4.0.5"
+    },
+    "mocha": {
+        "extension": [
+            "ts"
+        ],
+        "spec": "test/**/*.spec.ts",
+        "require": [
+            "ts-node/register",
+            "opentelemetry-instrumentation-mocha"
+        ]
+    }
+}

detectors/node/resource-detector-deployment/src/deployment.ts

@@ -0,0 +1,18 @@
+import { ResourceAttributes as ResourceAttributesKeys } from '@opentelemetry/semantic-conventions';
+import { Resource } from '@opentelemetry/resources';
+import { SyncDetector, syncDetectorToDetector } from 'opentelemetry-resource-detector-sync-api';
+
+class DeploymentSyncDetector implements SyncDetector {
+    detect(): Resource {
+        if (process.env.NODE_ENV) {
+            return new Resource({
+                [ResourceAttributesKeys.DEPLOYMENT_ENVIRONMENT]: process.env.NODE_ENV,
+            });
+        } else {
+            return Resource.empty();
+        }
+    }
+}
+
+export const deploymentSyncDetector = new DeploymentSyncDetector();
+export const deploymentDetector = syncDetectorToDetector(deploymentSyncDetector);

detectors/node/resource-detector-deployment/src/index.ts

@@ -0,0 +1 @@
+export * from './deployment';

detectors/node/resource-detector-deployment/test/deployment.spec.ts

@@ -0,0 +1,24 @@
+import 'mocha';
+import expect from 'expect';
+import { deploymentDetector, deploymentSyncDetector } from '../src';
+import { ResourceAttributes } from '@opentelemetry/semantic-conventions';
+
+describe('deployment detector', () => {
+    it('read deployment environment from environment variable', () => {
+        process.env.NODE_ENV = 'env from testing';
+        const resource = deploymentSyncDetector.detect();
+        expect(resource.attributes[ResourceAttributes.DEPLOYMENT_ENVIRONMENT]).toMatch('env from testing');
+    });
+
+    it('no deployment environment in environment variable', () => {
+        delete process.env.NODE_ENV;
+        const resource = deploymentSyncDetector.detect();
+        expect(resource.attributes[ResourceAttributes.DEPLOYMENT_ENVIRONMENT]).toBeUndefined();
+    });
+
+    it('async version', async () => {
+        process.env.NODE_ENV = 'env from testing';
+        const resource = await deploymentDetector.detect();
+        expect(resource.attributes[ResourceAttributes.DEPLOYMENT_ENVIRONMENT]).toMatch('env from testing');
+    });
+});

detectors/node/resource-detector-deployment/tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "extends": "../../../tsconfig.base.json",
+    "compilerOptions": {
+        "rootDir": ".",
+        "outDir": "./dist",
+        "types": ["node"]
+    }
+}

detectors/node/resource-detector-service/README.md

@@ -0,0 +1,46 @@
+# OpenTelemetry Service Resource Detector for Node.js
+[![NPM version](https://img.shields.io/npm/v/opentelemetry-resource-detector-service.svg)](https://www.npmjs.com/package/opentelemetry-resource-detector-service)
+
+This module provides automatic resource detector for [Service](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#service)
+
+## Installation
+
+```bash
+npm install --save opentelemetry-resource-detector-service
+```
+
+##  Usage
+
+### Synchronous SDK Initialization
+```js
+import { detectSyncResources } from 'opentelemetry-resource-detector-sync-api';
+import { serviceSyncDetector } from 'opentelemetry-resource-detector-service';
+
+const resource = detectSyncResources({
+    detectors: [serviceSyncDetector, /* add other sync detectors here */],
+});
+const tracerProvider = new NodeTracerProvider({ resource });
+```
+
+### Asynchronous SDK Initialization
+```js
+import { detectResources } from '@opentelemetry/resources';
+import { serviceDetector } from 'opentelemetry-resource-detector-service';
+
+( async () => {
+    const resource = await detectResources({
+        detectors: [serviceDetector, /* add other async detectors here */],
+    });
+    const tracerProvider = new NodeTracerProvider({ resource });
+    // Initialize auto instrumentation plugins and register provider.
+    // Make sure you don't 'require' instrumented packages elsewhere 
+    // before they are registered here
+})();
+```
+
+## Attributes
+| Attribute | Type | Source |
+| --- | --- | --- |
+| `service.name` | string | `process.env.OTEL_SERVICE_NAME`. If not set, will try to read `name` attribute from package.json. If not set will fallback to `unknown_service: concatenated with process.executable.name` (according to specification) |
+| `serivce.version` | string | `version` attribute from package.json |
+| `service.instance.id` | [string (v4 UUID)](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) | Automatically generated by the detector for each invocation of the service |

detectors/node/resource-detector-service/package.json

@@ -0,0 +1,62 @@
+{
+    "name": "opentelemetry-resource-detector-service",
+    "version": "0.4.0",
+    "description": "open telemetry resource detector for service",
+    "keywords": [
+        "opentelemetry"
+    ],
+    "homepage": "https://github.com/aspecto-io/opentelemetry-ext-js",
+    "license": "Apache-2.0",
+    "main": "dist/src/index.js",
+    "files": [
+        "dist/src/**/*.js",
+        "dist/src/**/*.d.ts",
+        "LICENSE",
+        "README.md"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/aspecto-io/opentelemetry-ext-js.git"
+    },
+    "scripts": {
+        "build": "tsc",
+        "prepare": "yarn run build",
+        "test": "mocha",
+        "test:jaeger": "OTEL_EXPORTER_JAEGER_AGENT_HOST=localhost mocha",
+        "watch": "tsc -w",
+        "version:update": "node ../../../scripts/version-update.js",
+        "test:ci": "yarn test",
+        "version": "yarn run version:update"
+    },
+    "bugs": {
+        "url": "https://github.com/aspecto-io/opentelemetry-ext-js/issues"
+    },
+    "peerDependencies": {
+        "@opentelemetry/api": "^0.20.0"
+    },
+    "dependencies": {
+        "@opentelemetry/resources": "^0.20.0",
+        "@opentelemetry/semantic-conventions": "^0.20.0",
+        "opentelemetry-resource-detector-sync-api": "^0.4.0",
+        "uuid": "^8.3.2"
+    },
+    "devDependencies": {
+        "@opentelemetry/api": "^0.20.0",
+        "@types/mocha": "^8.2.2",
+        "expect": "^26.6.2",
+        "mocha": "^8.4.0",
+        "opentelemetry-instrumentation-mocha": "0.0.1-rc.1",
+        "ts-node": "^9.1.1",
+        "typescript": "^4.0.5"
+    },
+    "mocha": {
+        "extension": [
+            "ts"
+        ],
+        "spec": "test/**/*.spec.ts",
+        "require": [
+            "ts-node/register",
+            "opentelemetry-instrumentation-mocha"
+        ]
+    }
+}

detectors/node/resource-detector-service/src/index.ts

@@ -0,0 +1 @@
+export * from './service';

detectors/node/resource-detector-service/src/service.ts

@@ -0,0 +1,45 @@
+import { ResourceAttributes as ResourceAttributesKeys } from '@opentelemetry/semantic-conventions';
+import { Resource, defaultServiceName, ResourceAttributes } from '@opentelemetry/resources';
+import { SyncDetector, syncDetectorToDetector } from 'opentelemetry-resource-detector-sync-api';
+import { v4 as uuidv4 } from 'uuid';
+import * as fs from 'fs';
+
+// set as global to make sure it's the same on any invocation even for multiple
+// instances of ServiceSyncDetector
+const instanceId = uuidv4();
+
+class ServiceSyncDetector implements SyncDetector {
+    detect(): Resource {
+        const packageJson = this.loadJsonFile('package.json');
+        const attributes: ResourceAttributes = {
+            [ResourceAttributesKeys.SERVICE_INSTANCE_ID]: instanceId,
+            [ResourceAttributesKeys.SERVICE_NAME]: this.getServiceName(packageJson),
+        };
+        const serviceVersion = packageJson?.version;
+        if (serviceVersion) {
+            attributes[ResourceAttributesKeys.SERVICE_VERSION] = serviceVersion;
+        }
+        return new Resource(attributes);
+    }
+
+    getServiceName(packageJson: any): string {
+        const fromEnv = process.env.OTEL_SERVICE_NAME;
+        if (fromEnv) return fromEnv;
+
+        const fromPackageJson = packageJson?.name;
+        if (fromPackageJson) return fromPackageJson;
+
+        return defaultServiceName();
+    }
+
+    loadJsonFile(path: string): any {
+        try {
+            return JSON.parse(fs.readFileSync(path).toString());
+        } catch (err) {
+            return null;
+        }
+    }
+}
+
+export const serviceSyncDetector = new ServiceSyncDetector();
+export const serviceDetector = syncDetectorToDetector(serviceSyncDetector);

detectors/node/resource-detector-service/test/service.spec.ts

@@ -0,0 +1,37 @@
+import 'mocha';
+import expect from 'expect';
+import { serviceDetector, serviceSyncDetector } from '../src';
+import { ResourceAttributes } from '@opentelemetry/semantic-conventions';
+
+describe('service detector', () => {
+    it('read service from package json', () => {
+        const resource = serviceSyncDetector.detect();
+        expect(resource.attributes[ResourceAttributes.SERVICE_NAME]).toMatch('opentelemetry-resource-detector-service');
+        expect(resource.attributes[ResourceAttributes.SERVICE_VERSION]).toMatch(/\d+.\d+.\d+/);
+        expect(resource.attributes[ResourceAttributes.SERVICE_INSTANCE_ID]).toMatch(
+            /[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}/
+        );
+    });
+
+    it('read service from env variable', () => {
+        process.env.OTEL_SERVICE_NAME = 'otel service name from env';
+        const resource = serviceSyncDetector.detect();
+        expect(resource.attributes[ResourceAttributes.SERVICE_NAME]).toMatch('otel service name from env');
+        delete process.env.OTEL_SERVICE_NAME;
+    });
+
+    it('calling detect twice return same resource', () => {
+        const resource1 = serviceSyncDetector.detect();
+        const resource2 = serviceSyncDetector.detect();
+        expect(resource1).toStrictEqual(resource2);
+    });
+
+    it('async version', async () => {
+        const resource = await serviceDetector.detect();
+        expect(resource.attributes[ResourceAttributes.SERVICE_NAME]).toMatch('opentelemetry-resource-detector-service');
+        expect(resource.attributes[ResourceAttributes.SERVICE_VERSION]).toMatch(/\d+.\d+.\d+/);
+        expect(resource.attributes[ResourceAttributes.SERVICE_INSTANCE_ID]).toMatch(
+            /[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}/
+        );
+    });
+});

detectors/node/resource-detector-service/tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "extends": "../../../tsconfig.base.json",
+    "compilerOptions": {
+        "rootDir": ".",
+        "outDir": "./dist",
+        "types": ["node"]
+    }
+}