From 6676414505f6ffc75e151fa162e351fa1de7204e Mon Sep 17 00:00:00 2001 From: Aaron Abbott Date: Tue, 25 Apr 2023 01:11:38 -0400 Subject: [PATCH] feat(opencensus-shim): add OpenCensus shim package boilerplate (#3750) Co-authored-by: Marc Pichler --- .../.eslintignore | 1 + .../.eslintrc.js | 7 + .../opentelemetry-shim-opencensus/.npmignore | 4 + .../opentelemetry-shim-opencensus/LICENSE | 201 ++++++++++++++++++ .../opentelemetry-shim-opencensus/README.md | 39 ++++ .../package.json | 72 +++++++ .../src/index.ts | 15 ++ .../test/ShimTracer.test.ts | 23 ++ .../tsconfig.json | 22 ++ tsconfig.json | 3 + 10 files changed, 387 insertions(+) create mode 100644 experimental/packages/opentelemetry-shim-opencensus/.eslintignore create mode 100644 experimental/packages/opentelemetry-shim-opencensus/.eslintrc.js create mode 100644 experimental/packages/opentelemetry-shim-opencensus/.npmignore create mode 100644 experimental/packages/opentelemetry-shim-opencensus/LICENSE create mode 100644 experimental/packages/opentelemetry-shim-opencensus/README.md create mode 100644 experimental/packages/opentelemetry-shim-opencensus/package.json create mode 100644 experimental/packages/opentelemetry-shim-opencensus/src/index.ts create mode 100644 experimental/packages/opentelemetry-shim-opencensus/test/ShimTracer.test.ts create mode 100644 experimental/packages/opentelemetry-shim-opencensus/tsconfig.json diff --git a/experimental/packages/opentelemetry-shim-opencensus/.eslintignore b/experimental/packages/opentelemetry-shim-opencensus/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/experimental/packages/opentelemetry-shim-opencensus/.eslintignore @@ -0,0 +1 @@ +build diff --git a/experimental/packages/opentelemetry-shim-opencensus/.eslintrc.js b/experimental/packages/opentelemetry-shim-opencensus/.eslintrc.js new file mode 100644 index 0000000000..f756f4488b --- /dev/null +++ b/experimental/packages/opentelemetry-shim-opencensus/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js') +} diff --git a/experimental/packages/opentelemetry-shim-opencensus/.npmignore b/experimental/packages/opentelemetry-shim-opencensus/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/experimental/packages/opentelemetry-shim-opencensus/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/experimental/packages/opentelemetry-shim-opencensus/LICENSE b/experimental/packages/opentelemetry-shim-opencensus/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/experimental/packages/opentelemetry-shim-opencensus/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/experimental/packages/opentelemetry-shim-opencensus/README.md b/experimental/packages/opentelemetry-shim-opencensus/README.md new file mode 100644 index 0000000000..63bea4df42 --- /dev/null +++ b/experimental/packages/opentelemetry-shim-opencensus/README.md @@ -0,0 +1,39 @@ +# OpenCensus shim + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +> **Note** +> This package is in active development and has not yet been released. You cannot install this +> package from NPM yet. + +OpenCensus shim allows existing OpenCensus instrumentation to report to OpenTelemetry. This +allows you to incrementally migrate your existing OpenCensus instrumentation to OpenTelemetry. +More details are available in the [OpenCensus Compatibility Specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/compatibility/opencensus.md). + +## Installation + +```bash +npm install --save @opentelemetry/shim-opencensus +``` + +## Usage + +TODO + +See [examples/opencensus-shim](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/examples/opencensus-shim) for a short example. + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +## Useful links + +- For more information on OpenTelemetry, visit: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js/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/shim-opencensus +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fshim-opencensus.svg diff --git a/experimental/packages/opentelemetry-shim-opencensus/package.json b/experimental/packages/opentelemetry-shim-opencensus/package.json new file mode 100644 index 0000000000..d9191233b4 --- /dev/null +++ b/experimental/packages/opentelemetry-shim-opencensus/package.json @@ -0,0 +1,72 @@ +{ + "name": "@opentelemetry/shim-opencensus", + "version": "0.38.0", + "description": "OpenCensus to OpenTelemetry shim", + "private": true, + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js", + "scripts": { + "prepublishOnly": "npm run compile", + "compile": "tsc --build", + "clean": "tsc --build --clean", + "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "version": "node ../../../scripts/version-update.js", + "watch": "tsc --build --watch", + "precompile": "lerna run version --scope $(npm pkg get name) --include-dependencies", + "prewatch": "npm run precompile", + "peer-api-check": "node ../../../scripts/peer-api-check.js" + }, + "keywords": [ + "opentelemetry", + "opencensus", + "nodejs", + "tracing", + "profiling" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=14" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/core": "1.11.0", + "@opentelemetry/context-async-hooks": "1.11.0", + "@opencensus/core": "0.1.0", + "@opentelemetry/api": ">=1.0.0 <1.5.0", + "@types/mocha": "10.0.0", + "@types/node": "18.6.5", + "codecov": "3.8.3", + "mocha": "10.0.0", + "nyc": "15.1.0", + "rimraf": "4.1.2", + "ts-mocha": "10.0.0", + "typescript": "4.4.4" + }, + "peerDependencies": { + "@opencensus/core": "^0.1.0", + "@opentelemetry/api": ">=1.0.0 <1.5.0" + }, + "dependencies": { + "@opentelemetry/core": "^1.0.0", + "@opentelemetry/context-async-hooks": "^1.0.0", + "semver": "^7.3.5", + "require-in-the-middle": "^6.0.0" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-shim-opencensus", + "sideEffects": false +} diff --git a/experimental/packages/opentelemetry-shim-opencensus/src/index.ts b/experimental/packages/opentelemetry-shim-opencensus/src/index.ts new file mode 100644 index 0000000000..bcd7cadc04 --- /dev/null +++ b/experimental/packages/opentelemetry-shim-opencensus/src/index.ts @@ -0,0 +1,15 @@ +/* + * 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. + */ diff --git a/experimental/packages/opentelemetry-shim-opencensus/test/ShimTracer.test.ts b/experimental/packages/opentelemetry-shim-opencensus/test/ShimTracer.test.ts new file mode 100644 index 0000000000..33c99a6d8a --- /dev/null +++ b/experimental/packages/opentelemetry-shim-opencensus/test/ShimTracer.test.ts @@ -0,0 +1,23 @@ +/* + * 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'; + +describe('ShimTracer', () => { + it('asserts true', () => { + assert.ok(true); + }); +}); diff --git a/experimental/packages/opentelemetry-shim-opencensus/tsconfig.json b/experimental/packages/opentelemetry-shim-opencensus/tsconfig.json new file mode 100644 index 0000000000..ddf3cfdeed --- /dev/null +++ b/experimental/packages/opentelemetry-shim-opencensus/tsconfig.json @@ -0,0 +1,22 @@ +{ + "extends": "../../../tsconfig.base.json", + "compilerOptions": { + "outDir": "build", + "rootDir": "." + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ], + "references": [ + { + "path": "../../../api" + }, + { + "path": "../../../packages/opentelemetry-context-async-hooks" + }, + { + "path": "../../../packages/opentelemetry-core" + } + ] +} diff --git a/tsconfig.json b/tsconfig.json index e54ecaeff9..101e77a159 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -104,6 +104,9 @@ { "path": "experimental/packages/opentelemetry-sdk-node" }, + { + "path": "experimental/packages/opentelemetry-shim-opencensus" + }, { "path": "experimental/packages/otlp-exporter-base" },