From b30fadfd87a046136f5c6e359e27125b6a1f04d6 Mon Sep 17 00:00:00 2001 From: seiyar81 Date: Fri, 28 Mar 2025 22:10:45 +0100 Subject: [PATCH] feat(detectors): add resource-detector-gitlab --- .github/component-label-map.yml | 4 + .github/component_owners.yml | 2 + .release-please-manifest.json | 1 + .../.eslintignore | 1 + .../.eslintrc.js | 7 + .../LICENSE | 201 ++++++++++++++++++ .../README.md | 67 ++++++ .../package.json | 62 ++++++ .../src/detectors/GitLabDetector.ts | 45 ++++ .../src/detectors/index.ts | 16 ++ .../src/index.ts | 16 ++ .../test/detectors/GitLabDetector.test.ts | 81 +++++++ .../tsconfig.esm.json | 11 + .../tsconfig.json | 11 + package-lock.json | 63 ++++++ release-please-config.json | 1 + 16 files changed, 589 insertions(+) create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/.eslintignore create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/.eslintrc.js create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/LICENSE create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/README.md create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/package.json create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/src/detectors/GitLabDetector.ts create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/src/detectors/index.ts create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/src/index.ts create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/test/detectors/GitLabDetector.test.ts create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/tsconfig.esm.json create mode 100644 detectors/node/opentelemetry-resource-detector-gitlab/tsconfig.json diff --git a/.github/component-label-map.yml b/.github/component-label-map.yml index 8837311372..d6bf13d93d 100644 --- a/.github/component-label-map.yml +++ b/.github/component-label-map.yml @@ -27,6 +27,10 @@ pkg:resource-detector-github: - changed-files: - any-glob-to-any-file: - detectors/node/opentelemetry-resource-detector-github/** +pkg:resource-detector-gitlab: + - changed-files: + - any-glob-to-any-file: + - detectors/node/opentelemetry-resource-detector-gitlab/** pkg:resource-detector-instana: - changed-files: - any-glob-to-any-file: diff --git a/.github/component_owners.yml b/.github/component_owners.yml index c53adad9af..9d9f7640fa 100644 --- a/.github/component_owners.yml +++ b/.github/component_owners.yml @@ -14,6 +14,8 @@ components: - punya detectors/node/opentelemetry-resource-detector-github: [] # Unmaintained + detectors/node/opentelemetry-resource-detector-gitlab: + - seiyar81 detectors/node/opentelemetry-resource-detector-instana: - kirrg001 incubator/opentelemetry-sampler-aws-xray: diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 5def797d4d..daf4332121 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -5,6 +5,7 @@ "detectors/node/opentelemetry-resource-detector-container": "0.7.0", "detectors/node/opentelemetry-resource-detector-gcp": "0.34.0", "detectors/node/opentelemetry-resource-detector-github": "0.31.0", + "detectors/node/opentelemetry-resource-detector-gitlab": "0.1.0", "detectors/node/opentelemetry-resource-detector-instana": "0.19.0", "metapackages/auto-configuration-propagators": "0.4.0", "metapackages/auto-instrumentations-node": "0.57.0", diff --git a/detectors/node/opentelemetry-resource-detector-gitlab/.eslintignore b/detectors/node/opentelemetry-resource-detector-gitlab/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/.eslintignore @@ -0,0 +1 @@ +build diff --git a/detectors/node/opentelemetry-resource-detector-gitlab/.eslintrc.js b/detectors/node/opentelemetry-resource-detector-gitlab/.eslintrc.js new file mode 100644 index 0000000000..7b832129ab --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/.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-gitlab/LICENSE b/detectors/node/opentelemetry-resource-detector-gitlab/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/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-gitlab/README.md b/detectors/node/opentelemetry-resource-detector-gitlab/README.md new file mode 100644 index 0000000000..32dec5d5fa --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/README.md @@ -0,0 +1,67 @@ +# OpenTelemetry Resource Detector for GitLab CI + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +Resource detector for GitLab CI. + +Detects some of the GitLab CI environment variables [specified here](https://docs.gitlab.com/ci/variables/predefined_variables/) and adds as attributes on a resource. + +This is useful for collecting telemetry in GitLab CI-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`. + +Compatible with OpenTelemetry JS API and SDK `1.0+`. + +## Installation + +```bash +npm install --save @opentelemetry/resource-detector-gitlab +``` + +## Usage + +```js +const { gitLabDetector } = require('@opentelemetry/resource-detector-gitlab') + +async function run() { + // Initialize GitLab Resource Detector + const resource = await gitLabDetector.detect(); +}; + +run() +``` + +## Available detectors + +### GitLab Detector + +| Resource Attribute | Description | +|------------------------|-----------------------------------------------------------------------------| +| gitlab.user_email | Value of Process Environment Variable `GITLAB_USER_EMAIL` | +| gitlab.user_id | Value of Process Environment Variable `GITLAB_USER_ID` | +| gitlab.project_path | Value of Process Environment Variable `CI_PROJECT_PATH` | +| gitlab.ref | Value of Process Environment Variable `CI_COMMIT_REF_NAME` | +| gitlab.source | Value of Process Environment Variable `CI_MERGE_REQUEST_SOURCE_BRANCH_NAME` | +| gitlab.target | Value of Process Environment Variable `CI_MERGE_REQUEST_TARGET_BRANCH_NAME` | +| gitlab.mr_iid | Value of Process Environment Variable `CI_MERGE_REQUEST_IID` | +| gitlab.pipeline_id | Value of Process Environment Variable `CI_PIPELINE_ID` | +| gitlab.pipeline_source | Value of Process Environment Variable `CI_PIPELINE_SOURCE` | +| gitlab.commit_sha | Value of Process Environment Variable `CI_COMMIT_SHA` | + +## Useful links + +- [GitLab CI Environment Variables](https://docs.gitlab.com/ci/variables/predefined_variables/) +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-gitlab +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-gitlab.svg diff --git a/detectors/node/opentelemetry-resource-detector-gitlab/package.json b/detectors/node/opentelemetry-resource-detector-gitlab/package.json new file mode 100644 index 0000000000..2fd0963655 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/package.json @@ -0,0 +1,62 @@ +{ + "name": "@opentelemetry/resource-detector-gitlab", + "version": "0.1.0", + "description": "OpenTelemetry SDK resource detector for GitLab", + "main": "build/src/index.js", + "module": "build/esm/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json", + "compile": "tsc --build tsconfig.json tsconfig.esm.json", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "prewatch": "npm run precompile", + "prepublishOnly": "npm run compile", + "test": "nyc mocha 'test/**/*.test.ts'", + "tdd": "npm run test -- --watch-extensions ts --watch", + "watch": "tsc --build --watch tsconfig.json tsconfig.esm.json" + }, + "keywords": [ + "opentelemetry", + "nodejs", + "resources", + "stats", + "gitlab", + "profiling" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": "^18.19.0 || >=20.6.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "build/esm/**/*.js", + "build/esm/**/*.js.map", + "build/esm/**/*.d.ts" + ], + "publishConfig": { + "access": "public" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.0.0" + }, + "devDependencies": { + "@opentelemetry/api": "^1.0.0", + "@types/mocha": "10.0.10", + "@types/node": "18.18.14", + "@types/sinon": "17.0.4", + "nyc": "15.1.0", + "rimraf": "5.0.10", + "sinon": "15.2.0", + "typescript": "5.0.4" + }, + "dependencies": { + "@opentelemetry/resources": "^2.0.0" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-gitlab#readme", + "sideEffects": false +} diff --git a/detectors/node/opentelemetry-resource-detector-gitlab/src/detectors/GitLabDetector.ts b/detectors/node/opentelemetry-resource-detector-gitlab/src/detectors/GitLabDetector.ts new file mode 100644 index 0000000000..2f167e0eea --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/src/detectors/GitLabDetector.ts @@ -0,0 +1,45 @@ +/* + * 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 { ResourceDetector, DetectedResource } from '@opentelemetry/resources'; + +/** + * The GitLabDetector can be used to detect GitLab CI environment variables + * and returns resource attributes with GitLab-specific metadata that exists + * in GitLab CI environments. + * + * More information about GitLab CI environment variables is available here: + * https://docs.gitlab.com/ci/variables/predefined_variables + */ +class GitLabDetector implements ResourceDetector { + detect(): DetectedResource { + const attributes = { + 'gitlab.user_email': process.env.GITLAB_USER_EMAIL || undefined, + 'gitlab.user_id': process.env.GITLAB_USER_ID || undefined, + 'gitlab.project_path': process.env.CI_PROJECT_PATH || undefined, + 'gitlab.ref': process.env.CI_COMMIT_REF_NAME || undefined, + 'gitlab.source': process.env.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME || undefined, + 'gitlab.target': process.env.CI_MERGE_REQUEST_TARGET_BRANCH_NAME || undefined, + 'gitlab.mr_iid': process.env.CI_MERGE_REQUEST_IID || undefined, + 'gitlab.pipeline_id': process.env.CI_PIPELINE_ID || undefined, + 'gitlab.pipeline_source': process.env.CI_PIPELINE_SOURCE || undefined, + 'gitlab.commit_sha': process.env.CI_COMMIT_SHA || undefined, + }; + return { attributes }; + } +} + +export const gitLabDetector = new GitLabDetector(); diff --git a/detectors/node/opentelemetry-resource-detector-gitlab/src/detectors/index.ts b/detectors/node/opentelemetry-resource-detector-gitlab/src/detectors/index.ts new file mode 100644 index 0000000000..70db4c9321 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/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 './GitLabDetector'; diff --git a/detectors/node/opentelemetry-resource-detector-gitlab/src/index.ts b/detectors/node/opentelemetry-resource-detector-gitlab/src/index.ts new file mode 100644 index 0000000000..9bfde8defd --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/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-gitlab/test/detectors/GitLabDetector.test.ts b/detectors/node/opentelemetry-resource-detector-gitlab/test/detectors/GitLabDetector.test.ts new file mode 100644 index 0000000000..b292fbaaf8 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/test/detectors/GitLabDetector.test.ts @@ -0,0 +1,81 @@ +/* + * 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 { detectResources } from '@opentelemetry/resources'; + +import { gitLabDetector } from '../../src/detectors'; + +describe('GitLabResourceDetector', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + + process.env.GITLAB_USER_EMAIL = ''; + process.env.GITLAB_USER_ID = ''; + process.env.CI_PROJECT_PATH = ''; + process.env.CI_COMMIT_REF_NAME = ''; + process.env.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME = ''; + process.env.CI_MERGE_REQUEST_TARGET_BRANCH_NAME = ''; + process.env.CI_MERGE_REQUEST_IID = ''; + process.env.CI_PIPELINE_ID = ''; + process.env.CI_PIPELINE_SOURCE = ''; + process.env.CI_COMMIT_SHA = ''; + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('should successfully return gitlab resource data', async () => { + process.env.GITLAB_USER_EMAIL = 'foo@bar'; + process.env.GITLAB_USER_ID = '42'; + process.env.CI_PROJECT_PATH = 'foo/bar'; + process.env.CI_COMMIT_REF_NAME = 'git-ref'; + process.env.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME = 'ref/foo'; + process.env.CI_MERGE_REQUEST_TARGET_BRANCH_NAME = 'ref/bar'; + process.env.CI_MERGE_REQUEST_IID = '1'; + process.env.CI_PIPELINE_ID = '424242'; + process.env.CI_PIPELINE_SOURCE = 'merge_request'; + process.env.CI_COMMIT_SHA = 'git-sha'; + + const resource = detectResources({ detectors: [gitLabDetector] }); + + assert.ok(resource); + assert.deepStrictEqual(resource.attributes, { + 'gitlab.user_email': 'foo@bar', + 'gitlab.user_id': '42', + 'gitlab.project_path': 'foo/bar', + 'gitlab.ref': 'git-ref', + 'gitlab.source': 'ref/foo', + 'gitlab.target': 'ref/bar', + 'gitlab.mr_iid': '1', + 'gitlab.pipeline_id': '424242', + 'gitlab.pipeline_source': 'merge_request', + 'gitlab.commit_sha': 'git-sha', + }); + }); + + it('should return empty resource when no GitLab env vars exists', async () => { + const resource = detectResources({ detectors: [gitLabDetector] }); + + assert.ok(resource); + assert.deepStrictEqual(resource.attributes, {}); + }); +}); diff --git a/detectors/node/opentelemetry-resource-detector-gitlab/tsconfig.esm.json b/detectors/node/opentelemetry-resource-detector-gitlab/tsconfig.esm.json new file mode 100644 index 0000000000..379f547a46 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/tsconfig.esm.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base.esm.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "build/esm", + "tsBuildInfoFile": "build/esm/tsconfig.esm.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ] +} diff --git a/detectors/node/opentelemetry-resource-detector-gitlab/tsconfig.json b/detectors/node/opentelemetry-resource-detector-gitlab/tsconfig.json new file mode 100644 index 0000000000..28be80d266 --- /dev/null +++ b/detectors/node/opentelemetry-resource-detector-gitlab/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} diff --git a/package-lock.json b/package-lock.json index ba14253a7a..25b4c15a98 100644 --- a/package-lock.json +++ b/package-lock.json @@ -268,6 +268,40 @@ "undici-types": "~5.26.4" } }, + "detectors/node/opentelemetry-resource-detector-gitlab": { + "name": "@opentelemetry/resource-detector-gitlab", + "version": "0.1.0", + "license": "Apache-2.0", + "dependencies": { + "@opentelemetry/resources": "^2.0.0" + }, + "devDependencies": { + "@opentelemetry/api": "^1.0.0", + "@types/mocha": "10.0.10", + "@types/node": "18.18.14", + "@types/sinon": "17.0.4", + "nyc": "15.1.0", + "rimraf": "5.0.10", + "sinon": "15.2.0", + "typescript": "5.0.4" + }, + "engines": { + "node": "^18.19.0 || >=20.6.0" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.0.0" + } + }, + "detectors/node/opentelemetry-resource-detector-gitlab/node_modules/@types/node": { + "version": "18.18.14", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", + "integrity": "sha512-iSOeNeXYNYNLLOMDSVPvIFojclvMZ/HDY2dU17kUlcsOsSQETbWIslJbYLZgA+ox8g2XQwSHKTkght1a5X26lQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~5.26.4" + } + }, "detectors/node/opentelemetry-resource-detector-instana": { "name": "@opentelemetry/resource-detector-instana", "version": "0.19.0", @@ -9471,6 +9505,10 @@ "resolved": "detectors/node/opentelemetry-resource-detector-github", "link": true }, + "node_modules/@opentelemetry/resource-detector-gitlab": { + "resolved": "detectors/node/opentelemetry-resource-detector-gitlab", + "link": true + }, "node_modules/@opentelemetry/resource-detector-instana": { "resolved": "detectors/node/opentelemetry-resource-detector-instana", "link": true @@ -47817,6 +47855,31 @@ } } }, + "@opentelemetry/resource-detector-gitlab": { + "version": "file:detectors/node/opentelemetry-resource-detector-gitlab", + "requires": { + "@opentelemetry/api": "^1.0.0", + "@opentelemetry/resources": "^2.0.0", + "@types/mocha": "10.0.10", + "@types/node": "18.18.14", + "@types/sinon": "17.0.4", + "nyc": "15.1.0", + "rimraf": "5.0.10", + "sinon": "15.2.0", + "typescript": "5.0.4" + }, + "dependencies": { + "@types/node": { + "version": "18.18.14", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", + "integrity": "sha512-iSOeNeXYNYNLLOMDSVPvIFojclvMZ/HDY2dU17kUlcsOsSQETbWIslJbYLZgA+ox8g2XQwSHKTkght1a5X26lQ==", + "dev": true, + "requires": { + "undici-types": "~5.26.4" + } + } + } + }, "@opentelemetry/resource-detector-instana": { "version": "file:detectors/node/opentelemetry-resource-detector-instana", "requires": { diff --git a/release-please-config.json b/release-please-config.json index b0993722d4..467d49adaa 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -12,6 +12,7 @@ "detectors/node/opentelemetry-resource-detector-container": {}, "detectors/node/opentelemetry-resource-detector-gcp": {}, "detectors/node/opentelemetry-resource-detector-github": {}, + "detectors/node/opentelemetry-resource-detector-gitlab": {}, "detectors/node/opentelemetry-resource-detector-instana": {}, "metapackages/auto-configuration-propagators": {}, "metapackages/auto-instrumentations-node": {},