From 49a090e3961d09c3e6dc6ef8b22a7bba8431447e Mon Sep 17 00:00:00 2001 From: abhinav mathur Date: Thu, 10 Feb 2022 10:46:48 -0500 Subject: [PATCH] feat: adding docker container id detector for supported version(cgroup v1) --- .../.eslintignore | 1 + .../.eslintrc.js | 8 + .../.npmignore | 4 + .../LICENSE | 201 ++++++++++++++++++ .../package.json | 58 +++++ .../src/detectors/Dockercgroupv1Detector.ts | 91 ++++++++ .../src/detectors/index.ts | 16 ++ .../src/index.ts | 16 ++ .../test/Dockercgroupv1Detector.test.ts | 114 ++++++++++ .../tsconfig.json | 12 ++ 10 files changed, 521 insertions(+) create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.eslintignore create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.eslintrc.js create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.npmignore create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/LICENSE create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/package.json create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/detectors/Dockercgroupv1Detector.ts create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/detectors/index.ts create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/index.ts create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/test/Dockercgroupv1Detector.test.ts create mode 100644 detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/tsconfig.json diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.eslintignore b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.eslintignore new file mode 100644 index 0000000000..c795b054e5 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.eslintignore @@ -0,0 +1 @@ +build \ No newline at end of file diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.eslintrc.js b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.eslintrc.js new file mode 100644 index 0000000000..96ceb53506 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.eslintrc.js @@ -0,0 +1,8 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js') + } + \ No newline at end of file diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.npmignore b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/LICENSE b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/LICENSE new file mode 100644 index 0000000000..a42588e10f --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2021] OpenTelemetry Authors + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/package.json b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/package.json new file mode 100644 index 0000000000..74ce198a81 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/package.json @@ -0,0 +1,58 @@ +{ + "name": "@opentelemetry/resource-docker-cgroup-v1", + "version": "1.0.0", + "description": "Opentelemetry resource detector to get docker containerId", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "clean": "rimraf build/*", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../", + "compile": "npm run version:update && tsc -p .", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "precompile": "tsc --version && lerna run version --scope @opentelemetry/resource-detector-docker-cgroup-v1 --include-dependencies", + "prewatch": "npm run precompile", + "prepare": "npm run compile", + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "tdd": "npm run test -- --watch-extensions ts --watch", + "version:update": "node ../../../scripts/version-update.js", + "watch": "tsc -w" + }, + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/api": "^1.0.4", + "@opentelemetry/contrib-test-utils": "^0.29.0", + "@types/mocha": "8.2.3", + "@types/node": "^17.0.14", + "@types/sinon": "10.0.2", + "eslint-plugin-header": "^3.1.1", + "mocha": "7.2.0", + "nock": "12.0.3", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "sinon": "^12.0.1", + "ts-mocha": "8.0.0", + "typescript": "^4.5.5" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.0.4" + }, + "dependencies": { + "@opentelemetry/core": "^1.0.1", + "@opentelemetry/resources": "^1.0.1", + "@opentelemetry/semantic-conventions": "^1.0.1", + "gts": "^3.1.0" + } +} diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/detectors/Dockercgroupv1Detector.ts b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/detectors/Dockercgroupv1Detector.ts new file mode 100644 index 0000000000..fa975538c8 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/detectors/Dockercgroupv1Detector.ts @@ -0,0 +1,91 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import { + Detector, + Resource, + ResourceDetectionConfig, +} from '@opentelemetry/resources'; + +import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'; + +import * as fs from 'fs'; +import * as util from 'util'; +import { diag } from '@opentelemetry/api'; + +export class DockercgroupDetector implements Detector { + readonly CONTAINER_ID_LENGTH = 64; + readonly DEFAULT_CGROUP_PATH = '/proc/self/cgroup'; + readonly TIMEOUT_MS = 2000; + readonly UTF8_UNICODE = 'utf8'; + + private static readFileAsync = util.promisify(fs.readFile); + private static fileAccessAsync = util.promisify(fs.access); + + async detect(_config?: ResourceDetectionConfig): Promise { + try { + if (!(await this._isSupportedDocker())) { + return Resource.empty(); + } + + const containerId = await this._getContainerId(); + + return !containerId + ? Resource.empty() + : new Resource({ + [SemanticResourceAttributes.CONTAINER_ID]: containerId || '', + }); + } catch (e) { + diag.warn('Process is not running on a supported docker version', e); + return Resource.empty(); + } + } + + private async _getContainerId(): Promise { + try { + const rawData = await DockercgroupDetector.readFileAsync( + this.DEFAULT_CGROUP_PATH, + this.UTF8_UNICODE + ); + const splitData = rawData.trim().split('\n'); + for (const str of splitData) { + if (str.length >= this.CONTAINER_ID_LENGTH) { + return str.substring(str.length - this.CONTAINER_ID_LENGTH); + } + } + } catch (e) { + let errorMessage = ''; + if (e instanceof Error) { + errorMessage = e.message; + diag.warn( + `Docker CGROUP Detector failed to read container ID: ${errorMessage}` + ); + } + } + return undefined; + } + + private async _isSupportedDocker(): Promise { + try { + await DockercgroupDetector.fileAccessAsync(this.DEFAULT_CGROUP_PATH); + return true; + } catch (e) { + diag.error(`cannot access ${this.DEFAULT_CGROUP_PATH} folder ${e}`); + return false; + } + } +} + +export const dockercgroupDetector = new DockercgroupDetector(); diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/detectors/index.ts b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/detectors/index.ts new file mode 100644 index 0000000000..806f96b2a3 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/detectors/index.ts @@ -0,0 +1,16 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +export * from './Dockercgroupv1Detector'; diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/index.ts b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/index.ts new file mode 100644 index 0000000000..9bfde8defd --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/src/index.ts @@ -0,0 +1,16 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +export * from './detectors'; diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/test/Dockercgroupv1Detector.test.ts b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/test/Dockercgroupv1Detector.test.ts new file mode 100644 index 0000000000..2112d3d921 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/test/Dockercgroupv1Detector.test.ts @@ -0,0 +1,114 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as nock from 'nock'; +import * as sinon from 'sinon'; +import * as assert from 'assert'; +import { Resource } from '@opentelemetry/resources'; +import { dockercgroupDetector } from '../src'; +import { + assertContainerResource, + assertEmptyResource, +} from '@opentelemetry/contrib-test-utils'; +import { DockercgroupDetector } from '../src'; + +describe('dockercgroupDetector', () => { + const errorMsg = { + fileNotFoundError: new Error('cannot find cgroup file'), + }; + + const correctCgroupData = + 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklm'; + let readStub, fileStub; + + beforeEach(() => { + nock.disableNetConnect(); + nock.cleanAll(); + }); + + afterEach(() => { + sinon.restore(); + nock.enableNetConnect(); + }); + + describe('Supported docker - Container ID ', () => { + it('should return a container ID for supported docker - cgroup v1', async () => { + fileStub = sinon + .stub(DockercgroupDetector, 'fileAccessAsync' as any) + .resolves(undefined); + + const resource: Resource = await dockercgroupDetector.detect(); + + assert.ok(resource); + }); + + it('should return an empty resource for file access denied', async () => { + fileStub = sinon + .stub(DockercgroupDetector, 'fileAccessAsync' as any) + .rejects('permission denied'); + + const resource: Resource = await dockercgroupDetector.detect(); + + assert.ok(resource); + }); + + it('should return a resource with container ID with a valid container ID present', async () => { + fileStub = sinon + .stub(DockercgroupDetector, 'fileAccessAsync' as any) + .resolves(); + readStub = sinon + .stub(DockercgroupDetector, 'readFileAsync' as any) + .resolves(correctCgroupData); + + const resource: Resource = await dockercgroupDetector.detect(); + + assert.ok(resource); + assertContainerResource(resource, { + id: 'bcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklm', + }); + }); + + it('should return a resource with clusterName attribute when cgroup file does not contain valid Container ID', async () => { + fileStub = sinon + .stub(DockercgroupDetector, 'fileAccessAsync' as any) + .resolves(); + readStub = sinon + .stub(DockercgroupDetector, 'readFileAsync' as any) + .onSecondCall() + .resolves(''); + + const resource: Resource = await dockercgroupDetector.detect(); + + assert.ok(resource); + }); + + it('should return an empty resource when containerId is not valid', async () => { + const errorMsg = { + fileNotFoundError: new Error('cannot file in the path}'), + }; + fileStub = sinon + .stub(DockercgroupDetector, 'fileAccessAsync' as any) + .resolves(''); + readStub = sinon + .stub(DockercgroupDetector, 'readFileAsync' as any) + .onSecondCall() + .rejects(errorMsg); + + const resource: Resource = await dockercgroupDetector.detect(); + assertEmptyResource(resource); + }); + }); +}); diff --git a/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/tsconfig.json b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/tsconfig.json new file mode 100644 index 0000000000..505b67a248 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-docker-cgroup-v1/tsconfig.json @@ -0,0 +1,12 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] + } + \ No newline at end of file