diff --git a/detectors/node/opentelemetry-resource-detector-github/.eslintignore b/detectors/node/opentelemetry-resource-detector-github/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/.eslintignore @@ -0,0 +1 @@ +build diff --git a/detectors/node/opentelemetry-resource-detector-github/.eslintrc.js b/detectors/node/opentelemetry-resource-detector-github/.eslintrc.js new file mode 100644 index 0000000000..7b832129ab --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js') +} diff --git a/detectors/node/opentelemetry-resource-detector-github/.npmignore b/detectors/node/opentelemetry-resource-detector-github/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/detectors/node/opentelemetry-resource-detector-github/LICENSE b/detectors/node/opentelemetry-resource-detector-github/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/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 [yyyy] [name of copyright owner] + + 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-github/README.md b/detectors/node/opentelemetry-resource-detector-github/README.md new file mode 100644 index 0000000000..5e2509d469 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/README.md @@ -0,0 +1,33 @@ +# OpenTelemetry Resource Detector for GitHub Actions + +Resource detector for GitHub Actions. + +Detects `GITHUB_*` environment variables [specified here](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables) and adds as attributes on a resource. + +This is useful for collecting telemetry in GitHub Actions-powered CI/CD workflows. + +The OpenTelemetry Resource is an immutable representation of the entity producing telemetry. For example, a process producing telemetry that is running in a container on Kubernetes has a Pod name, it is in a namespace and possibly is part of a Deployment which also has a name. All three of these attributes can be included in the `Resource`. + +## Installation + +```bash +npm install --save @opentelemetry/resource-detector-github +``` + +## Usage + +```js + +const { gitHubDetector } = require('@opentelemetry/opentelemetry-resource-detector-github') + +async function run() { + // Initialize GitHub Resource Detector + const resource = await gitHubDetector.detect(); +}; + +run() +``` + +## Useful links + +* [GitHub Action Enviornment Variables](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables) diff --git a/detectors/node/opentelemetry-resource-detector-github/package.json b/detectors/node/opentelemetry-resource-detector-github/package.json new file mode 100644 index 0000000000..759224cc83 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/package.json @@ -0,0 +1,67 @@ +{ + "name": "@opentelemetry/resource-detector-github", + "version": "0.11.0", + "description": "OpenTelemetry SDK resource detector for GitHub", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js", + "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", + "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" + }, + "keywords": [ + "opentelemetry", + "nodejs", + "resources", + "stats", + "github", + "profiling" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.0.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/core": "^0.12.0", + "@opentelemetry/tracing": "^0.12.0", + "@types/mocha": "8.0.1", + "@types/node": "14.0.27", + "@types/sinon": "9.0.4", + "codecov": "3.7.2", + "gts": "2.0.2", + "mocha": "7.2.0", + "nock": "12.0.3", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "sinon": "9.0.2", + "ts-mocha": "7.0.0", + "ts-node": "8.10.2", + "typescript": "3.9.7" + }, + "dependencies": { + "@opentelemetry/api": "^0.12.0", + "@opentelemetry/core": "^0.12.0", + "@opentelemetry/resources": "^0.12.0" + } +} diff --git a/detectors/node/opentelemetry-resource-detector-github/src/detectors/GitHubDetector.ts b/detectors/node/opentelemetry-resource-detector-github/src/detectors/GitHubDetector.ts new file mode 100644 index 0000000000..1a5f010370 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/src/detectors/GitHubDetector.ts @@ -0,0 +1,75 @@ +/* + * 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, + ResourceAttributes, +} from '@opentelemetry/resources'; + +/** + * The GitHubDetector can be used to detect GitHub Actions environment variables and returns + * a {@link Resource} populated with GitHub-specific metadata that exists + * in GitHub Actions environments. + * + * More information about GitHub Action environment variables is available here: + * https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables + * + * Returns an empty Resource if detection fails. + */ +class GitHubDetector implements Detector { + private _attributes: ResourceAttributes = {}; + + /** + * Adds an environment variable attribute if a non-empty string. + * @param key + * @param value + */ + private addAttributeIfExists(key: string, value: string | undefined) { + if (typeof value === 'string' && value.length > 0) { + this._attributes[key] = value; + } + } + + /** + * Attempts to obtain GitHub repository information from GitHub Actions + * environment variables: + * https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables + * + * If succesful it returns a promise containing a {@link Resource} + * populated with GitHub metadata. Returns a promise containing an + * empty {@link Resource} if the connection fails. + * + */ + async detect(): Promise { + this._attributes = {}; + this.addAttributeIfExists('github.workflow', process.env.GITHUB_WORKFLOW); + this.addAttributeIfExists('github.run_id', process.env.GITHUB_RUN_ID); + this.addAttributeIfExists( + 'github.run_number', + process.env.GITHUB_RUN_NUMBER + ); + this.addAttributeIfExists('github.actor', process.env.GITHUB_ACTOR); + this.addAttributeIfExists('github.sha', process.env.GITHUB_SHA); + this.addAttributeIfExists('github.ref', process.env.GITHUB_REF); + this.addAttributeIfExists('github.head_ref', process.env.GITHUB_HEAD_REF); + this.addAttributeIfExists('github.base_ref', process.env.GITHUB_BASE_REF); + + return new Resource(this._attributes); + } +} + +export const gitHubDetector = new GitHubDetector(); diff --git a/detectors/node/opentelemetry-resource-detector-github/src/detectors/index.ts b/detectors/node/opentelemetry-resource-detector-github/src/detectors/index.ts new file mode 100644 index 0000000000..1927c949d4 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/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 './GitHubDetector'; diff --git a/detectors/node/opentelemetry-resource-detector-github/src/index.ts b/detectors/node/opentelemetry-resource-detector-github/src/index.ts new file mode 100644 index 0000000000..9bfde8defd --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/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-github/src/version.ts b/detectors/node/opentelemetry-resource-detector-github/src/version.ts new file mode 100644 index 0000000000..714520138d --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/src/version.ts @@ -0,0 +1,18 @@ +/* + * 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. + */ + +// this is autogenerated file, see scripts/version-update.js +export const VERSION = '0.11.0'; diff --git a/detectors/node/opentelemetry-resource-detector-github/test/detectors/GitHubDetector.test.ts b/detectors/node/opentelemetry-resource-detector-github/test/detectors/GitHubDetector.test.ts new file mode 100644 index 0000000000..1fcb9a9c13 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/test/detectors/GitHubDetector.test.ts @@ -0,0 +1,73 @@ +/* + * 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 assert from 'assert'; +import * as sinon from 'sinon'; + +import { gitHubDetector } from '../../src/detectors'; + +describe('GitHubResourceDetector', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + + process.env.GITHUB_WORKFLOW = ''; + process.env.GITHUB_RUN_ID = ''; + process.env.GITHUB_RUN_NUMBER = ''; + process.env.GITHUB_ACTOR = ''; + process.env.GITHUB_SHA = ''; + process.env.GITHUB_REF = ''; + process.env.GITHUB_HEAD_REF = ''; + process.env.GITHUB_BASE_REF = ''; + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('should successfully return github resource data', async () => { + process.env.GITHUB_WORKFLOW = 'workflow-foo'; + process.env.GITHUB_RUN_ID = 'run-id-foo'; + process.env.GITHUB_RUN_NUMBER = '42'; + process.env.GITHUB_ACTOR = 'octocat'; + process.env.GITHUB_SHA = 'git-sha'; + process.env.GITHUB_REF = 'git-ref'; + process.env.GITHUB_HEAD_REF = 'ref/foo'; + process.env.GITHUB_BASE_REF = 'ref/bar'; + + const resource = await gitHubDetector.detect(); + + assert.ok(resource); + assert.deepStrictEqual(resource.attributes, { + 'github.workflow': 'workflow-foo', + 'github.run_id': 'run-id-foo', + 'github.run_number': '42', + 'github.actor': 'octocat', + 'github.sha': 'git-sha', + 'github.ref': 'git-ref', + 'github.head_ref': 'ref/foo', + 'github.base_ref': 'ref/bar', + }); + }); + + it('should return empty resource when no GitHub env vars exists', async () => { + const resource = await gitHubDetector.detect(); + + assert.ok(resource); + assert.deepStrictEqual(resource.attributes, {}); + }); +}); diff --git a/detectors/node/opentelemetry-resource-detector-github/tsconfig.json b/detectors/node/opentelemetry-resource-detector-github/tsconfig.json new file mode 100644 index 0000000000..28be80d266 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-github/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} diff --git a/lerna.json b/lerna.json index f186c5c58f..230d9c1f31 100644 --- a/lerna.json +++ b/lerna.json @@ -6,7 +6,8 @@ "metapackages/*", "plugins/node/*", "plugins/web/*", - "propagators/*" + "propagators/*", + "detectors/node/*" ], "version": "0.11.0", "changelog": {