From 461dc4ba9ed486b41aa83e804efacb55fccd29ab Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Mon, 6 Feb 2023 22:55:01 +0100 Subject: [PATCH 1/6] fix(sdk-metrics): fix flaky LastValueAggregator test by using fake timer (#3587) * fix(sdk-metrics): fix flaky LastValueAggregator test by using fake timers * fix(changelog): add changelog entry. * fix(sdk-metrics): change LastValueAggregation timer increment to 100ms --- CHANGELOG.md | 2 ++ .../test/aggregator/LastValue.test.ts | 23 ++++++++++++++----- 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 33c3c17e8d..8184b771a5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,8 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/ ### :house: (Internal) +* fix(sdk-metrics): ix flaky LastValueAggregator test by using fake timer [#3587](https://github.com/open-telemetry/opentelemetry-js/pull/3587) @pichlermarc + ## 1.9.1 ### :bug: (Bug Fix) diff --git a/packages/sdk-metrics/test/aggregator/LastValue.test.ts b/packages/sdk-metrics/test/aggregator/LastValue.test.ts index 206b4c4acc..2fd35156c5 100644 --- a/packages/sdk-metrics/test/aggregator/LastValue.test.ts +++ b/packages/sdk-metrics/test/aggregator/LastValue.test.ts @@ -16,15 +16,26 @@ import { HrTime } from '@opentelemetry/api'; import * as assert from 'assert'; +import * as sinon from 'sinon'; import { AggregationTemporality } from '../../src'; import { LastValueAccumulation, LastValueAggregator, } from '../../src/aggregator'; import { MetricData, DataPointType } from '../../src/export/MetricData'; -import { commonValues, defaultInstrumentDescriptor, sleep } from '../util'; +import { commonValues, defaultInstrumentDescriptor } from '../util'; describe('LastValueAggregator', () => { + let clock: sinon.SinonFakeTimers; + + beforeEach(() => { + clock = sinon.useFakeTimers(); + }); + + afterEach(() => { + sinon.restore(); + }); + describe('createAccumulation', () => { it('no exceptions on createAccumulation', () => { const aggregator = new LastValueAggregator(); @@ -47,16 +58,16 @@ describe('LastValueAggregator', () => { assert.deepStrictEqual(aggregator.merge(prev, delta), expected); }); - it('return the newly sampled accumulation', async () => { + it('return the newly sampled accumulation', () => { const aggregator = new LastValueAggregator(); const accumulation1 = aggregator.createAccumulation([0, 0]); const accumulation2 = aggregator.createAccumulation([1, 1]); accumulation1.record(2); - await sleep(1); + clock.tick(100); accumulation2.record(3); // refresh the accumulation1 - await sleep(1); + clock.tick(100); accumulation1.record(4); assert.deepStrictEqual( @@ -92,7 +103,7 @@ describe('LastValueAggregator', () => { assert.deepStrictEqual(aggregator.diff(prev, curr), expected); }); - it('return the newly sampled accumulation', async () => { + it('return the newly sampled accumulation', () => { const aggregator = new LastValueAggregator(); const accumulation1 = aggregator.createAccumulation([0, 0]); const accumulation2 = aggregator.createAccumulation([1, 1]); @@ -100,7 +111,7 @@ describe('LastValueAggregator', () => { accumulation1.record(2); accumulation2.record(3); // refresh the accumulation1 - await sleep(1); + clock.tick(100); accumulation1.record(4); assert.deepStrictEqual( From ae3b4282f814c437b0d55a012ad6ada544cf62ea Mon Sep 17 00:00:00 2001 From: Mend Renovate Date: Tue, 7 Feb 2023 15:53:12 +0000 Subject: [PATCH 2/6] fix(deps): update dependency require-in-the-middle to v6 (#3584) Co-authored-by: Daniel Dyla --- .../packages/opentelemetry-instrumentation/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/experimental/packages/opentelemetry-instrumentation/package.json b/experimental/packages/opentelemetry-instrumentation/package.json index 05cc761e75..ca15993c47 100644 --- a/experimental/packages/opentelemetry-instrumentation/package.json +++ b/experimental/packages/opentelemetry-instrumentation/package.json @@ -68,7 +68,7 @@ "url": "https://github.com/open-telemetry/opentelemetry-js/issues" }, "dependencies": { - "require-in-the-middle": "^5.0.3", + "require-in-the-middle": "^6.0.0", "semver": "^7.3.2", "shimmer": "^1.2.1" }, From 92fbec99ec35f6d2db351b3c4fec26bd4d1c86a3 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Tue, 7 Feb 2023 10:23:05 -0800 Subject: [PATCH 3/6] Separate Events API from Logs API (#3550) * added events API package * removed events from Logs API * updated logs tests * added tooling and tests to api-events * fixed package name, updated changelog, updated tsconfig * lint * added back precompile script, minor updates * tsconfig updates * changed logger to emitter in a test * added domain as a required parameter for creating an emitter, removed from Event * lint * Update experimental/packages/api-events/package.json Co-authored-by: Chengzhong Wu --------- Co-authored-by: Daniel Dyla Co-authored-by: Nev <54870357+MSNev@users.noreply.github.com> Co-authored-by: Chengzhong Wu --- CHANGELOG.md | 1 + .../packages/api-events/.eslintignore | 1 + experimental/packages/api-events/.eslintrc.js | 8 + experimental/packages/api-events/LICENSE | 201 ++++++++++++++++++ experimental/packages/api-events/README.md | 60 ++++++ .../packages/api-events/karma.conf.js | 24 +++ experimental/packages/api-events/package.json | 87 ++++++++ .../api-events/src/NoopEventEmitter.ts | 22 ++ .../src/NoopEventEmitterProvider.ts | 33 +++ .../packages/api-events/src/api/events.ts | 92 ++++++++ experimental/packages/api-events/src/index.ts | 23 ++ .../api-events/src/internal/global-utils.ts | 55 +++++ .../src/platform/browser/globalThis.ts | 39 ++++ .../api-events/src/platform/browser/index.ts | 17 ++ .../packages/api-events/src/platform/index.ts | 17 ++ .../src/platform/node/globalThis.ts | 19 ++ .../api-events/src/platform/node/index.ts | 17 ++ .../src/types/Event.ts} | 7 +- .../api-events/src/types/EventEmitter.ts | 26 +++ .../src/types/EventEmitterOptions.ts | 30 +++ .../src/types/EventEmitterProvider.ts | 40 ++++ .../packages/api-events/test/api/api.test.ts | 71 +++++++ .../packages/api-events/test/index-webpack.ts | 20 ++ .../api-events/test/internal/global.test.ts | 82 +++++++ .../noop-event-emitter-provider.test.ts | 42 ++++ .../noop-event-emitter.test.ts | 39 ++++ .../packages/api-events/tsconfig.esm.json | 16 ++ .../packages/api-events/tsconfig.esnext.json | 16 ++ .../packages/api-events/tsconfig.json | 17 ++ experimental/packages/api-logs/README.md | 7 +- experimental/packages/api-logs/package.json | 1 - .../packages/api-logs/src/NoopLogger.ts | 4 +- experimental/packages/api-logs/src/index.ts | 1 - .../packages/api-logs/src/types/Logger.ts | 10 +- .../api-logs/src/types/LoggerOptions.ts | 12 -- .../noop-implementations/noop-logger.test.ts | 9 +- tsconfig.esm.json | 3 + tsconfig.esnext.json | 3 + tsconfig.json | 4 + 39 files changed, 1132 insertions(+), 44 deletions(-) create mode 100644 experimental/packages/api-events/.eslintignore create mode 100644 experimental/packages/api-events/.eslintrc.js create mode 100644 experimental/packages/api-events/LICENSE create mode 100644 experimental/packages/api-events/README.md create mode 100644 experimental/packages/api-events/karma.conf.js create mode 100644 experimental/packages/api-events/package.json create mode 100644 experimental/packages/api-events/src/NoopEventEmitter.ts create mode 100644 experimental/packages/api-events/src/NoopEventEmitterProvider.ts create mode 100644 experimental/packages/api-events/src/api/events.ts create mode 100644 experimental/packages/api-events/src/index.ts create mode 100644 experimental/packages/api-events/src/internal/global-utils.ts create mode 100644 experimental/packages/api-events/src/platform/browser/globalThis.ts create mode 100644 experimental/packages/api-events/src/platform/browser/index.ts create mode 100644 experimental/packages/api-events/src/platform/index.ts create mode 100644 experimental/packages/api-events/src/platform/node/globalThis.ts create mode 100644 experimental/packages/api-events/src/platform/node/index.ts rename experimental/packages/{api-logs/src/types/LogEvent.ts => api-events/src/types/Event.ts} (92%) create mode 100644 experimental/packages/api-events/src/types/EventEmitter.ts create mode 100644 experimental/packages/api-events/src/types/EventEmitterOptions.ts create mode 100644 experimental/packages/api-events/src/types/EventEmitterProvider.ts create mode 100644 experimental/packages/api-events/test/api/api.test.ts create mode 100644 experimental/packages/api-events/test/index-webpack.ts create mode 100644 experimental/packages/api-events/test/internal/global.test.ts create mode 100644 experimental/packages/api-events/test/noop-implementations/noop-event-emitter-provider.test.ts create mode 100644 experimental/packages/api-events/test/noop-implementations/noop-event-emitter.test.ts create mode 100644 experimental/packages/api-events/tsconfig.esm.json create mode 100644 experimental/packages/api-events/tsconfig.esnext.json create mode 100644 experimental/packages/api-events/tsconfig.json diff --git a/CHANGELOG.md b/CHANGELOG.md index 8184b771a5..c482e93702 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/ ### :rocket: (Enhancement) +* feat (api-logs): separate Events API into its own package [3550](https://github.com/open-telemetry/opentelemetry-js/pull/3550) @martinkuba * feat(sdk-metrics): apply binary search in histogram recording [#3539](https://github.com/open-telemetry/opentelemetry-js/pull/3539) @legendecas ### :bug: (Bug Fix) diff --git a/experimental/packages/api-events/.eslintignore b/experimental/packages/api-events/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/experimental/packages/api-events/.eslintignore @@ -0,0 +1 @@ +build diff --git a/experimental/packages/api-events/.eslintrc.js b/experimental/packages/api-events/.eslintrc.js new file mode 100644 index 0000000000..7654abb6ac --- /dev/null +++ b/experimental/packages/api-events/.eslintrc.js @@ -0,0 +1,8 @@ +module.exports = { + "env": { + "mocha": true, + "commonjs": true, + "shared-node-browser": true + }, + ...require('../../../eslint.config.js') +} diff --git a/experimental/packages/api-events/LICENSE b/experimental/packages/api-events/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/experimental/packages/api-events/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/api-events/README.md b/experimental/packages/api-events/README.md new file mode 100644 index 0000000000..3aff88eff6 --- /dev/null +++ b/experimental/packages/api-events/README.md @@ -0,0 +1,60 @@ +# OpenTelemetry API for JavaScript + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +This package provides everything needed to interact with the unstable OpenTelemetry Events API, including all TypeScript interfaces, enums, and no-op implementations. It is intended for use both on the server and in the browser. + +## Beta Software - Use at your own risk + +The events API is considered alpha software and there is no guarantee of stability or long-term support. When the API is stabilized, it will be made available and supported long-term in the `@opentelemetry/api` package and this package will be deprecated. + +## Quick Start + +Purposefully left blank until SDK is available. + +## Version Compatibility + +Because the npm installer and node module resolution algorithm could potentially allow two or more copies of any given package to exist within the same `node_modules` structure, the OpenTelemetry API takes advantage of a variable on the `global` object to store the global API. When an API method in the API package is called, it checks if this `global` API exists and proxies calls to it if and only if it is a compatible API version. This means if a package has a dependency on an OpenTelemetry API version which is not compatible with the API used by the end user, the package will receive a no-op implementation of the API. + +## Advanced Use + +### API Methods + +If you are writing an instrumentation library, or prefer to call the API methods directly rather than using the `register` method on the Tracer/Meter/Logger Provider, OpenTelemetry provides direct access to the underlying API methods through the `@opentelemetry/api-events` package. API entry points are defined as global singleton objects `trace`, `metrics`, `logs`, `events`, `propagation`, and `context` which contain methods used to initialize SDK implementations and acquire resources from the API. + +- [Events API Documentation][events-api-docs] + +```javascript +const api = require("@opentelemetry/api-events"); + +/* A specific implementation of EventEmitterProvider comes from an SDK */ +const eventEmitterProvider = createEventEmitterProvider(); + +/* Initialize EventEmitterProvider */ +api.events.setGlobalEventEmitterProvider(eventEmitterProvider); +/* returns eventEmitterProvider (no-op if a working provider has not been initialized) */ +api.events.getEventEmitterProvider(); +/* returns an event emitter from the registered global event emitter provider (no-op if a working provider has not been initialized) */ +const eventEmitter = api.events.getEventEmitter(name, version); + +// logging an event in an instrumentation library +eventEmitter.emit({ name: 'event-name', domain: 'event-domain' }); +``` + +## Useful links + +- 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/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/api-logs +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi-logs.svg +[logs-api-docs]: https://open-telemetry.github.io/opentelemetry-js/modules/_opentelemetry_api_logs.html diff --git a/experimental/packages/api-events/karma.conf.js b/experimental/packages/api-events/karma.conf.js new file mode 100644 index 0000000000..6174839d65 --- /dev/null +++ b/experimental/packages/api-events/karma.conf.js @@ -0,0 +1,24 @@ +/*! + * 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 + * + * 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. + */ + +const karmaWebpackConfig = require('../../../karma.webpack'); +const karmaBaseConfig = require('../../../karma.base'); + +module.exports = (config) => { + config.set(Object.assign({}, karmaBaseConfig, { + webpack: karmaWebpackConfig + })) +}; diff --git a/experimental/packages/api-events/package.json b/experimental/packages/api-events/package.json new file mode 100644 index 0000000000..da3732de78 --- /dev/null +++ b/experimental/packages/api-events/package.json @@ -0,0 +1,87 @@ +{ + "name": "@opentelemetry/api-events", + "version": "0.35.1", + "description": "Public events API for OpenTelemetry", + "main": "build/src/index.js", + "module": "build/esm/index.js", + "esnext": "build/esnext/index.js", + "types": "build/src/index.d.ts", + "browser": { + "./src/platform/index.ts": "./src/platform/browser/index.ts", + "./build/esm/platform/index.js": "./build/esm/platform/browser/index.js", + "./build/esnext/platform/index.js": "./build/esnext/platform/browser/index.js", + "./build/src/platform/index.js": "./build/src/platform/browser/index.js" + }, + "repository": "open-telemetry/opentelemetry-js", + "scripts": { + "prepublishOnly": "npm run compile", + "compile": "tsc --build tsconfig.json tsconfig.esm.json tsconfig.esnext.json", + "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json tsconfig.esnext.json", + "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts", + "test:browser": "nyc karma start --single-run", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../", + "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../", + "build": "npm run compile", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "version": "node ../../../scripts/version-update.js", + "watch": "tsc --build --watch tsconfig.json tsconfig.esm.json tsconfig.esnext.json", + "precompile": "lerna run version --scope $(npm pkg get name) --include-dependencies", + "prewatch": "node ../../../scripts/version-update.js" + }, + "keywords": [ + "opentelemetry", + "nodejs", + "browser", + "profiling", + "events", + "stats", + "monitoring" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=14" + }, + "files": [ + "build/esm/**/*.js", + "build/esm/**/*.js.map", + "build/esm/**/*.d.ts", + "build/esnext/**/*.js", + "build/esnext/**/*.js.map", + "build/esnext/**/*.d.ts", + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "dependencies": { + "@opentelemetry/api": "^1.0.0" + }, + "devDependencies": { + "@types/mocha": "10.0.0", + "@types/node": "18.6.5", + "@types/webpack-env": "1.16.3", + "codecov": "3.8.3", + "istanbul-instrumenter-loader": "3.0.1", + "karma": "6.3.16", + "karma-chrome-launcher": "3.1.0", + "karma-coverage-istanbul-reporter": "3.0.3", + "karma-mocha": "2.0.1", + "karma-spec-reporter": "0.0.32", + "karma-webpack": "4.0.2", + "mocha": "10.0.0", + "nyc": "15.1.0", + "ts-loader": "8.4.0", + "ts-mocha": "10.0.0", + "typescript": "4.4.4", + "webpack": "4.46.0" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/api-events", + "sideEffects": false +} diff --git a/experimental/packages/api-events/src/NoopEventEmitter.ts b/experimental/packages/api-events/src/NoopEventEmitter.ts new file mode 100644 index 0000000000..b576e02bcf --- /dev/null +++ b/experimental/packages/api-events/src/NoopEventEmitter.ts @@ -0,0 +1,22 @@ +/* + * 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 { EventEmitter } from './types/EventEmitter'; +import { Event } from './types/Event'; + +export class NoopEventEmitter implements EventEmitter { + emit(_event: Event): void {} +} diff --git a/experimental/packages/api-events/src/NoopEventEmitterProvider.ts b/experimental/packages/api-events/src/NoopEventEmitterProvider.ts new file mode 100644 index 0000000000..95731b0a8d --- /dev/null +++ b/experimental/packages/api-events/src/NoopEventEmitterProvider.ts @@ -0,0 +1,33 @@ +/* + * 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 { EventEmitterProvider } from './types/EventEmitterProvider'; +import { EventEmitter } from './types/EventEmitter'; +import { EventEmitterOptions } from './types/EventEmitterOptions'; +import { NoopEventEmitter } from './NoopEventEmitter'; + +export class NoopEventEmitterProvider implements EventEmitterProvider { + getEventEmitter( + _name: string, + _domain: string, + _version?: string | undefined, + _options?: EventEmitterOptions | undefined + ): EventEmitter { + return new NoopEventEmitter(); + } +} + +export const NOOP_EVENT_EMITTER_PROVIDER = new NoopEventEmitterProvider(); diff --git a/experimental/packages/api-events/src/api/events.ts b/experimental/packages/api-events/src/api/events.ts new file mode 100644 index 0000000000..f17c93a2d3 --- /dev/null +++ b/experimental/packages/api-events/src/api/events.ts @@ -0,0 +1,92 @@ +/* + * 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 { + API_BACKWARDS_COMPATIBILITY_VERSION, + GLOBAL_EVENTS_API_KEY, + _global, + makeGetter, +} from '../internal/global-utils'; +import { EventEmitterProvider } from '../types/EventEmitterProvider'; +import { NOOP_EVENT_EMITTER_PROVIDER } from '../NoopEventEmitterProvider'; +import { EventEmitter } from '../types/EventEmitter'; +import { EventEmitterOptions } from '../types/EventEmitterOptions'; + +export class EventsAPI { + private static _instance?: EventsAPI; + + private constructor() {} + + public static getInstance(): EventsAPI { + if (!this._instance) { + this._instance = new EventsAPI(); + } + + return this._instance; + } + + public setGlobalEventEmitterProvider( + provider: EventEmitterProvider + ): EventEmitterProvider { + if (_global[GLOBAL_EVENTS_API_KEY]) { + return this.getEventEmitterProvider(); + } + + _global[GLOBAL_EVENTS_API_KEY] = makeGetter( + API_BACKWARDS_COMPATIBILITY_VERSION, + provider, + NOOP_EVENT_EMITTER_PROVIDER + ); + + return provider; + } + + /** + * Returns the global event emitter provider. + * + * @returns EventEmitterProvider + */ + public getEventEmitterProvider(): EventEmitterProvider { + return ( + _global[GLOBAL_EVENTS_API_KEY]?.(API_BACKWARDS_COMPATIBILITY_VERSION) ?? + NOOP_EVENT_EMITTER_PROVIDER + ); + } + + /** + * Returns a event emitter from the global event emitter provider. + * + * @returns EventEmitter + */ + public getEventEmitter( + name: string, + domain: string, + version?: string, + options?: EventEmitterOptions + ): EventEmitter { + return this.getEventEmitterProvider().getEventEmitter( + name, + domain, + version, + options + ); + } + + /** Remove the global event emitter provider */ + public disable(): void { + delete _global[GLOBAL_EVENTS_API_KEY]; + } +} diff --git a/experimental/packages/api-events/src/index.ts b/experimental/packages/api-events/src/index.ts new file mode 100644 index 0000000000..63fadffd48 --- /dev/null +++ b/experimental/packages/api-events/src/index.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. + */ + +export * from './types/EventEmitter'; +export * from './types/EventEmitterProvider'; +export * from './types/Event'; +export * from './types/EventEmitterOptions'; + +import { EventsAPI } from './api/events'; +export const events = EventsAPI.getInstance(); diff --git a/experimental/packages/api-events/src/internal/global-utils.ts b/experimental/packages/api-events/src/internal/global-utils.ts new file mode 100644 index 0000000000..d58b890127 --- /dev/null +++ b/experimental/packages/api-events/src/internal/global-utils.ts @@ -0,0 +1,55 @@ +/* + * 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 { EventEmitterProvider } from '../types/EventEmitterProvider'; +import { _globalThis } from '../platform'; + +export const GLOBAL_EVENTS_API_KEY = Symbol.for( + 'io.opentelemetry.js.api.events' +); + +type Get = (version: number) => T; +type OtelGlobal = Partial<{ + [GLOBAL_EVENTS_API_KEY]: Get; +}>; + +export const _global = _globalThis as OtelGlobal; + +/** + * Make a function which accepts a version integer and returns the instance of an API if the version + * is compatible, or a fallback version (usually NOOP) if it is not. + * + * @param requiredVersion Backwards compatibility version which is required to return the instance + * @param instance Instance which should be returned if the required version is compatible + * @param fallback Fallback instance, usually NOOP, which will be returned if the required version is not compatible + */ +export function makeGetter( + requiredVersion: number, + instance: T, + fallback: T +): Get { + return (version: number): T => + version === requiredVersion ? instance : fallback; +} + +/** + * A number which should be incremented each time a backwards incompatible + * change is made to the API. This number is used when an API package + * attempts to access the global API to ensure it is getting a compatible + * version. If the global API is not compatible with the API package + * attempting to get it, a NOOP API implementation will be returned. + */ +export const API_BACKWARDS_COMPATIBILITY_VERSION = 1; diff --git a/experimental/packages/api-events/src/platform/browser/globalThis.ts b/experimental/packages/api-events/src/platform/browser/globalThis.ts new file mode 100644 index 0000000000..e8a79351b2 --- /dev/null +++ b/experimental/packages/api-events/src/platform/browser/globalThis.ts @@ -0,0 +1,39 @@ +/* + * 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. + */ + +// Updates to this file should also be replicated to @opentelemetry/api and +// @opentelemetry/core too. + +/** + * - globalThis (New standard) + * - self (Will return the current window instance for supported browsers) + * - window (fallback for older browser implementations) + * - global (NodeJS implementation) + * - (When all else fails) + */ + +/** only globals that common to node and browsers are allowed */ +// eslint-disable-next-line node/no-unsupported-features/es-builtins, no-undef +export const _globalThis: typeof globalThis = + typeof globalThis === 'object' + ? globalThis + : typeof self === 'object' + ? self + : typeof window === 'object' + ? window + : typeof global === 'object' + ? global + : ({} as typeof globalThis); diff --git a/experimental/packages/api-events/src/platform/browser/index.ts b/experimental/packages/api-events/src/platform/browser/index.ts new file mode 100644 index 0000000000..e9d6ebed71 --- /dev/null +++ b/experimental/packages/api-events/src/platform/browser/index.ts @@ -0,0 +1,17 @@ +/* + * 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 './globalThis'; diff --git a/experimental/packages/api-events/src/platform/index.ts b/experimental/packages/api-events/src/platform/index.ts new file mode 100644 index 0000000000..cdaf8858ce --- /dev/null +++ b/experimental/packages/api-events/src/platform/index.ts @@ -0,0 +1,17 @@ +/* + * 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 './node'; diff --git a/experimental/packages/api-events/src/platform/node/globalThis.ts b/experimental/packages/api-events/src/platform/node/globalThis.ts new file mode 100644 index 0000000000..36e97e2732 --- /dev/null +++ b/experimental/packages/api-events/src/platform/node/globalThis.ts @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** only globals that common to node and browsers are allowed */ +// eslint-disable-next-line node/no-unsupported-features/es-builtins +export const _globalThis = typeof globalThis === 'object' ? globalThis : global; diff --git a/experimental/packages/api-events/src/platform/node/index.ts b/experimental/packages/api-events/src/platform/node/index.ts new file mode 100644 index 0000000000..e9d6ebed71 --- /dev/null +++ b/experimental/packages/api-events/src/platform/node/index.ts @@ -0,0 +1,17 @@ +/* + * 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 './globalThis'; diff --git a/experimental/packages/api-logs/src/types/LogEvent.ts b/experimental/packages/api-events/src/types/Event.ts similarity index 92% rename from experimental/packages/api-logs/src/types/LogEvent.ts rename to experimental/packages/api-events/src/types/Event.ts index 7b37572c6c..03e4ef89db 100644 --- a/experimental/packages/api-logs/src/types/LogEvent.ts +++ b/experimental/packages/api-events/src/types/Event.ts @@ -16,7 +16,7 @@ import { Attributes } from '@opentelemetry/api'; -export interface LogEvent { +export interface Event { /** * The time when the event occurred as UNIX Epoch time in nanoseconds. */ @@ -27,11 +27,6 @@ export interface LogEvent { */ name: string; - /** - * The domain the event belongs to. - */ - domain?: string; - /** * Additional attributes that describe the event. */ diff --git a/experimental/packages/api-events/src/types/EventEmitter.ts b/experimental/packages/api-events/src/types/EventEmitter.ts new file mode 100644 index 0000000000..1222339516 --- /dev/null +++ b/experimental/packages/api-events/src/types/EventEmitter.ts @@ -0,0 +1,26 @@ +/* + * 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 { Event } from './Event'; + +export interface EventEmitter { + /** + * Emit an event. This method should only be used by instrumentations emitting events. + * + * @param event + */ + emit(event: Event): void; +} diff --git a/experimental/packages/api-events/src/types/EventEmitterOptions.ts b/experimental/packages/api-events/src/types/EventEmitterOptions.ts new file mode 100644 index 0000000000..f5b983884e --- /dev/null +++ b/experimental/packages/api-events/src/types/EventEmitterOptions.ts @@ -0,0 +1,30 @@ +/* + * 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 { Attributes } from '@opentelemetry/api'; + +export interface EventEmitterOptions { + /** + * The schemaUrl of the tracer or instrumentation library + * @default '' + */ + schemaUrl?: string; + + /** + * The instrumentation scope attributes to associate with emitted telemetry + */ + scopeAttributes?: Attributes; +} diff --git a/experimental/packages/api-events/src/types/EventEmitterProvider.ts b/experimental/packages/api-events/src/types/EventEmitterProvider.ts new file mode 100644 index 0000000000..276b2e627d --- /dev/null +++ b/experimental/packages/api-events/src/types/EventEmitterProvider.ts @@ -0,0 +1,40 @@ +/* + * 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 { EventEmitter } from './EventEmitter'; +import { EventEmitterOptions } from './EventEmitterOptions'; + +/** + * A registry for creating named {@link EventEmitter}s. + */ +export interface EventEmitterProvider { + /** + * Returns an EventEmitter, creating one if one with the given name, version, and + * schemaUrl pair is not already created. + * + * @param name The name of the event emitter or instrumentation library. + * @param domain The domain for events created by the event emitter. + * @param version The version of the event emitter or instrumentation library. + * @param options The options of the event emitter or instrumentation library. + * @returns EventEmitter An event emitter with the given name and version. + */ + getEventEmitter( + name: string, + domain: string, + version?: string, + options?: EventEmitterOptions + ): EventEmitter; +} diff --git a/experimental/packages/api-events/test/api/api.test.ts b/experimental/packages/api-events/test/api/api.test.ts new file mode 100644 index 0000000000..e091688ff8 --- /dev/null +++ b/experimental/packages/api-events/test/api/api.test.ts @@ -0,0 +1,71 @@ +/* + * 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 { EventEmitter, events } from '../../src'; +import { NoopEventEmitter } from '../../src/NoopEventEmitter'; +import { NoopEventEmitterProvider } from '../../src/NoopEventEmitterProvider'; + +describe('API', () => { + const dummyEventEmitter = new NoopEventEmitter(); + + it('should expose a event emitter provider via getEventEmitterProvider', () => { + const provider = events.getEventEmitterProvider(); + assert.ok(provider); + assert.strictEqual(typeof provider, 'object'); + }); + + describe('GlobalEventEmitterProvider', () => { + beforeEach(() => { + events.disable(); + }); + + it('should use the global event emitter provider', () => { + events.setGlobalEventEmitterProvider(new TestEventEmitterProvider()); + const eventEmitter = events + .getEventEmitterProvider() + .getEventEmitter('name', 'domain'); + assert.deepStrictEqual(eventEmitter, dummyEventEmitter); + }); + + it('should not allow overriding global provider if already set', () => { + const provider1 = new TestEventEmitterProvider(); + const provider2 = new TestEventEmitterProvider(); + events.setGlobalEventEmitterProvider(provider1); + assert.equal(events.getEventEmitterProvider(), provider1); + events.setGlobalEventEmitterProvider(provider2); + assert.equal(events.getEventEmitterProvider(), provider1); + }); + }); + + describe('getEventEmitter', () => { + beforeEach(() => { + events.disable(); + }); + + it('should return a event emitter instance from global provider', () => { + events.setGlobalEventEmitterProvider(new TestEventEmitterProvider()); + const eventEmitter = events.getEventEmitter('myEventEmitter', 'domain'); + assert.deepStrictEqual(eventEmitter, dummyEventEmitter); + }); + }); + + class TestEventEmitterProvider extends NoopEventEmitterProvider { + override getEventEmitter(): EventEmitter { + return dummyEventEmitter; + } + } +}); diff --git a/experimental/packages/api-events/test/index-webpack.ts b/experimental/packages/api-events/test/index-webpack.ts new file mode 100644 index 0000000000..061a48ccfa --- /dev/null +++ b/experimental/packages/api-events/test/index-webpack.ts @@ -0,0 +1,20 @@ +/* + * 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. + */ +const testsContext = require.context('.', true, /test$/); +testsContext.keys().forEach(testsContext); + +const srcContext = require.context('.', true, /src$/); +srcContext.keys().forEach(srcContext); diff --git a/experimental/packages/api-events/test/internal/global.test.ts b/experimental/packages/api-events/test/internal/global.test.ts new file mode 100644 index 0000000000..0a4eb04f57 --- /dev/null +++ b/experimental/packages/api-events/test/internal/global.test.ts @@ -0,0 +1,82 @@ +/* + * 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 { + _global, + GLOBAL_EVENTS_API_KEY, +} from '../../src/internal/global-utils'; +import { NoopEventEmitterProvider } from '../../src/NoopEventEmitterProvider'; + +const api1 = require('../../src') as typeof import('../../src'); + +// clear cache and load a second instance of the api +for (const key of Object.keys(require.cache)) { + delete require.cache[key]; +} +const api2 = require('../../src') as typeof import('../../src'); + +describe('Global Utils', () => { + // prove they are separate instances + assert.notStrictEqual(api1, api2); + // that return separate noop instances to start + assert.notStrictEqual( + api1.events.getEventEmitterProvider(), + api2.events.getEventEmitterProvider() + ); + + beforeEach(() => { + api1.events.disable(); + api2.events.disable(); + }); + + it('should change the global event emitter provider', () => { + const original = api1.events.getEventEmitterProvider(); + const newEventEmitterProvider = new NoopEventEmitterProvider(); + api1.events.setGlobalEventEmitterProvider(newEventEmitterProvider); + assert.notStrictEqual(api1.events.getEventEmitterProvider(), original); + assert.strictEqual( + api1.events.getEventEmitterProvider(), + newEventEmitterProvider + ); + }); + + it('should load an instance from one which was set in the other', () => { + api1.events.setGlobalEventEmitterProvider(new NoopEventEmitterProvider()); + assert.strictEqual( + api1.events.getEventEmitterProvider(), + api2.events.getEventEmitterProvider() + ); + }); + + it('should disable both if one is disabled', () => { + const original = api1.events.getEventEmitterProvider(); + + api1.events.setGlobalEventEmitterProvider(new NoopEventEmitterProvider()); + + assert.notStrictEqual(original, api1.events.getEventEmitterProvider()); + api2.events.disable(); + assert.strictEqual(original, api1.events.getEventEmitterProvider()); + }); + + it('should return the module NoOp implementation if the version is a mismatch', () => { + const original = api1.events.getEventEmitterProvider(); + api1.events.setGlobalEventEmitterProvider(new NoopEventEmitterProvider()); + const afterSet = _global[GLOBAL_EVENTS_API_KEY]!(-1); + + assert.strictEqual(original, afterSet); + }); +}); diff --git a/experimental/packages/api-events/test/noop-implementations/noop-event-emitter-provider.test.ts b/experimental/packages/api-events/test/noop-implementations/noop-event-emitter-provider.test.ts new file mode 100644 index 0000000000..ad88d37058 --- /dev/null +++ b/experimental/packages/api-events/test/noop-implementations/noop-event-emitter-provider.test.ts @@ -0,0 +1,42 @@ +/* + * 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 { NoopEventEmitter } from '../../src/NoopEventEmitter'; +import { NoopEventEmitterProvider } from '../../src/NoopEventEmitterProvider'; + +describe('NoopLoggerProvider', () => { + it('should not crash', () => { + const eventEmitterProvider = new NoopEventEmitterProvider(); + + assert.ok( + eventEmitterProvider.getEventEmitter('emitter-name', 'domain') instanceof + NoopEventEmitter + ); + assert.ok( + eventEmitterProvider.getEventEmitter( + 'emitter-name', + 'domain', + 'v1' + ) instanceof NoopEventEmitter + ); + assert.ok( + eventEmitterProvider.getEventEmitter('emitter-name', 'domain', 'v1', { + schemaUrl: 'https://opentelemetry.io/schemas/1.7.0', + }) instanceof NoopEventEmitter + ); + }); +}); diff --git a/experimental/packages/api-events/test/noop-implementations/noop-event-emitter.test.ts b/experimental/packages/api-events/test/noop-implementations/noop-event-emitter.test.ts new file mode 100644 index 0000000000..933a3e6e88 --- /dev/null +++ b/experimental/packages/api-events/test/noop-implementations/noop-event-emitter.test.ts @@ -0,0 +1,39 @@ +/* + * 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 { NoopEventEmitter } from '../../src/NoopEventEmitter'; +import { NoopEventEmitterProvider } from '../../src/NoopEventEmitterProvider'; + +describe('NoopEventEmitter', () => { + it('constructor should not crash', () => { + const logger = new NoopEventEmitterProvider().getEventEmitter( + 'test-noop', + 'test-domain' + ); + assert(logger instanceof NoopEventEmitter); + }); + + it('calling emit should not crash', () => { + const emitter = new NoopEventEmitterProvider().getEventEmitter( + 'test-noop', + 'test-domain' + ); + emitter.emit({ + name: 'event name', + }); + }); +}); diff --git a/experimental/packages/api-events/tsconfig.esm.json b/experimental/packages/api-events/tsconfig.esm.json new file mode 100644 index 0000000000..f0383c0042 --- /dev/null +++ b/experimental/packages/api-events/tsconfig.esm.json @@ -0,0 +1,16 @@ +{ + "extends": "../../../tsconfig.base.esm.json", + "compilerOptions": { + "outDir": "build/esm", + "rootDir": "src", + "tsBuildInfoFile": "build/esm/tsconfig.esm.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ], + "references": [ + { + "path": "../../../api" + } + ] +} diff --git a/experimental/packages/api-events/tsconfig.esnext.json b/experimental/packages/api-events/tsconfig.esnext.json new file mode 100644 index 0000000000..218899ff2d --- /dev/null +++ b/experimental/packages/api-events/tsconfig.esnext.json @@ -0,0 +1,16 @@ +{ + "extends": "../../../tsconfig.base.esnext.json", + "compilerOptions": { + "outDir": "build/esnext", + "rootDir": "src", + "tsBuildInfoFile": "build/esnext/tsconfig.esnext.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ], + "references": [ + { + "path": "../../../api" + } + ] +} diff --git a/experimental/packages/api-events/tsconfig.json b/experimental/packages/api-events/tsconfig.json new file mode 100644 index 0000000000..5849e79c03 --- /dev/null +++ b/experimental/packages/api-events/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../tsconfig.base.json", + "compilerOptions": { + "outDir": "build", + "rootDir": "." + }, + "files": [], + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ], + "references": [ + { + "path": "../../../api" + } + ] +} diff --git a/experimental/packages/api-logs/README.md b/experimental/packages/api-logs/README.md index 1d5a17fa76..b36d5bf06e 100644 --- a/experimental/packages/api-logs/README.md +++ b/experimental/packages/api-logs/README.md @@ -38,11 +38,8 @@ api.logs.getLoggerProvider(); /* returns a logger from the registered global logger provider (no-op if a working provider has not been initialized) */ const logger = api.logs.getLogger(name, version); -// logging an event in an instrumentation library -logger.emitEvent({ name: 'event-name', domain: 'event-domain' }); - -// logging an event in a log appender -logger.emitLogRecord({ severityNumber: SeverityNumber.TRACE, body: 'log data' }); +// logging a log record in a log appender +logger.emit({ severityNumber: SeverityNumber.TRACE, body: 'log data' }); ``` ## Useful links diff --git a/experimental/packages/api-logs/package.json b/experimental/packages/api-logs/package.json index 7f6f846e2f..d4f54600c3 100644 --- a/experimental/packages/api-logs/package.json +++ b/experimental/packages/api-logs/package.json @@ -35,7 +35,6 @@ "browser", "profiling", "logs", - "events", "stats", "monitoring" ], diff --git a/experimental/packages/api-logs/src/NoopLogger.ts b/experimental/packages/api-logs/src/NoopLogger.ts index 3f2227154c..dab79439ee 100644 --- a/experimental/packages/api-logs/src/NoopLogger.ts +++ b/experimental/packages/api-logs/src/NoopLogger.ts @@ -15,10 +15,8 @@ */ import { Logger } from './types/Logger'; -import { LogEvent } from './types/LogEvent'; import { LogRecord } from './types/LogRecord'; export class NoopLogger implements Logger { - emitLogRecord(_logRecord: LogRecord): void {} - emitEvent(_event: LogEvent): void {} + emit(_logRecord: LogRecord): void {} } diff --git a/experimental/packages/api-logs/src/index.ts b/experimental/packages/api-logs/src/index.ts index cf22a2e5eb..ce158ba323 100644 --- a/experimental/packages/api-logs/src/index.ts +++ b/experimental/packages/api-logs/src/index.ts @@ -17,7 +17,6 @@ export * from './types/Logger'; export * from './types/LoggerProvider'; export * from './types/LogRecord'; -export * from './types/LogEvent'; export * from './types/LoggerOptions'; import { LogsAPI } from './api/logs'; diff --git a/experimental/packages/api-logs/src/types/Logger.ts b/experimental/packages/api-logs/src/types/Logger.ts index b30f3aff93..e6d63940aa 100644 --- a/experimental/packages/api-logs/src/types/Logger.ts +++ b/experimental/packages/api-logs/src/types/Logger.ts @@ -15,7 +15,6 @@ */ import { LogRecord } from './LogRecord'; -import { LogEvent } from './LogEvent'; export interface Logger { /** @@ -23,12 +22,5 @@ export interface Logger { * * @param logRecord */ - emitLogRecord(logRecord: LogRecord): void; - - /** - * Emit an event. This method should only be used by instrumentations emitting events. - * - * @param event - */ - emitEvent(event: LogEvent): void; + emit(logRecord: LogRecord): void; } diff --git a/experimental/packages/api-logs/src/types/LoggerOptions.ts b/experimental/packages/api-logs/src/types/LoggerOptions.ts index 9b2fe06fc8..9a1c6e7c0c 100644 --- a/experimental/packages/api-logs/src/types/LoggerOptions.ts +++ b/experimental/packages/api-logs/src/types/LoggerOptions.ts @@ -23,18 +23,6 @@ export interface LoggerOptions { */ schemaUrl?: string; - /** - * The default domain for events created by the Logger. - * - * The combination of event name and event domain uiquely identifies an event. - * By supplying an event domain, it is possible to use the same event name across - * different domains / use cases. - * - * The default domain can be overridden when emitting an individual event. - * @default '' - */ - eventDomain?: string; - /** * The instrumentation scope attributes to associate with emitted telemetry */ diff --git a/experimental/packages/api-logs/test/noop-implementations/noop-logger.test.ts b/experimental/packages/api-logs/test/noop-implementations/noop-logger.test.ts index 85537d59f0..52ac38976b 100644 --- a/experimental/packages/api-logs/test/noop-implementations/noop-logger.test.ts +++ b/experimental/packages/api-logs/test/noop-implementations/noop-logger.test.ts @@ -25,14 +25,9 @@ describe('NoopLogger', () => { assert(logger instanceof NoopLogger); }); - it('calling emitEvent should not crash', () => { + it('calling emit should not crash', () => { const logger = new NoopLoggerProvider().getLogger('test-noop'); - logger.emitEvent({ name: 'event-name', domain: 'event-domain' }); - }); - - it('calling emitLogRecord should not crash', () => { - const logger = new NoopLoggerProvider().getLogger('test-noop'); - logger.emitLogRecord({ + logger.emit({ severityNumber: SeverityNumber.TRACE, body: 'log body', }); diff --git a/tsconfig.esm.json b/tsconfig.esm.json index afd8742243..67713e33e4 100644 --- a/tsconfig.esm.json +++ b/tsconfig.esm.json @@ -5,6 +5,9 @@ { "path": "api/tsconfig.esm.json" }, + { + "path": "experimental/packages/api-events/tsconfig.esm.json" + }, { "path": "experimental/packages/api-logs/tsconfig.esm.json" }, diff --git a/tsconfig.esnext.json b/tsconfig.esnext.json index c826225f26..7d10cc5f52 100644 --- a/tsconfig.esnext.json +++ b/tsconfig.esnext.json @@ -5,6 +5,9 @@ { "path": "api/tsconfig.esnext.json" }, + { + "path": "experimental/packages/api-events/tsconfig.esnext.json" + }, { "path": "experimental/packages/api-logs/tsconfig.esnext.json" }, diff --git a/tsconfig.json b/tsconfig.json index 347ccca34d..1948d987b2 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -5,6 +5,7 @@ "entryPointStrategy": "packages", "entryPoints": [ "api", + "experimental/packages/api-events", "experimental/packages/api-logs", "experimental/packages/exporter-trace-otlp-grpc", "experimental/packages/exporter-trace-otlp-http", @@ -54,6 +55,9 @@ { "path": "api" }, + { + "path": "experimental/packages/api-events" + }, { "path": "experimental/packages/api-logs" }, From dd2af92054b46c0f314a2e857434d3e8c5df53fa Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Wed, 8 Feb 2023 13:35:42 +0100 Subject: [PATCH 4/6] fix(prometheus-exporter): add possibility to respond to errors returned by `server.listen()` (#3552) --- experimental/CHANGELOG.md | 2 ++ .../README.md | 2 +- .../src/PrometheusExporter.ts | 17 +++++++++------ .../test/PrometheusExporter.test.ts | 21 +++++++++++++++++++ 4 files changed, 35 insertions(+), 7 deletions(-) diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md index 8d34640976..e2725a170a 100644 --- a/experimental/CHANGELOG.md +++ b/experimental/CHANGELOG.md @@ -10,6 +10,8 @@ All notable changes to experimental packages in this project will be documented ### :bug: (Bug Fix) +* fix(prometheus-exporter): add possibility to respond to errors returned by `server.listen()` [#3552](https://github.com/open-telemetry/opentelemetry-js/pull/3402) @pichlermarc + ### :books: (Refine Doc) ### :house: (Internal) diff --git a/experimental/packages/opentelemetry-exporter-prometheus/README.md b/experimental/packages/opentelemetry-exporter-prometheus/README.md index 97ea063d3c..d963acf877 100644 --- a/experimental/packages/opentelemetry-exporter-prometheus/README.md +++ b/experimental/packages/opentelemetry-exporter-prometheus/README.md @@ -25,7 +25,7 @@ const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus'); const { MeterProvider } = require('@opentelemetry/sdk-metrics'); // Add your port and startServer to the Prometheus options -const options = {port: 9464, startServer: true}; +const options = {port: 9464}; const exporter = new PrometheusExporter(options); // Creates MeterProvider and installs the exporter as a MetricReader diff --git a/experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts b/experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts index 63c00c4d6f..2a7cb5fb43 100644 --- a/experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts +++ b/experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts @@ -54,7 +54,10 @@ export class PrometheusExporter extends MetricReader { * @param config Exporter configuration * @param callback Callback to be called after a server was started */ - constructor(config: ExporterConfig = {}, callback?: () => void) { + constructor( + config: ExporterConfig = {}, + callback: (error: Error | void) => void = () => {} + ) { super({ aggregationSelector: _instrumentType => Aggregation.Default(), aggregationTemporalitySelector: _instrumentType => @@ -86,9 +89,10 @@ export class PrometheusExporter extends MetricReader { ).replace(/^([^/])/, '/$1'); if (config.preventServerStart !== true) { - this.startServer() - .then(callback) - .catch(err => diag.error(err)); + this.startServer().then(callback, err => { + diag.error(err); + callback(err); + }); } else if (callback) { callback(); } @@ -137,7 +141,8 @@ export class PrometheusExporter extends MetricReader { * Starts the Prometheus export server */ startServer(): Promise { - return new Promise(resolve => { + return new Promise((resolve, reject) => { + this._server.once('error', reject); this._server.listen( { port: this._port, @@ -156,7 +161,7 @@ export class PrometheusExporter extends MetricReader { /** * Request handler that responds with the current state of metrics * @param _request Incoming HTTP request of server instance - * @param response HTTP response objet used to response to request + * @param response HTTP response object used to response to request */ public getMetricsRequestHandler( _request: IncomingMessage, diff --git a/experimental/packages/opentelemetry-exporter-prometheus/test/PrometheusExporter.test.ts b/experimental/packages/opentelemetry-exporter-prometheus/test/PrometheusExporter.test.ts index 0b0365b5e7..55061be083 100644 --- a/experimental/packages/opentelemetry-exporter-prometheus/test/PrometheusExporter.test.ts +++ b/experimental/packages/opentelemetry-exporter-prometheus/test/PrometheusExporter.test.ts @@ -74,6 +74,27 @@ describe('PrometheusExporter', () => { }); }); + it('should pass server error to callback when port is already in use', done => { + const firstExporter = new PrometheusExporter({}, error => { + if (error) { + // This should not happen as the port should not be already in use when the test starts. + done(error); + } + }); + const secondExporter = new PrometheusExporter({}, error => { + firstExporter + .shutdown() + .then(() => secondExporter.shutdown()) + .then(() => + done( + error + ? undefined + : 'Second exporter should respond with EADDRINUSE but did not pass it to callback' + ) + ); + }); + }); + it('should not start the server if preventServerStart is passed as an option', () => { const exporter = new PrometheusExporter({ preventServerStart: true }); assert.ok(exporter['_server'].listening === false); From cb88e4ea11895b463c1a33df8156d2907e79c830 Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Wed, 8 Feb 2023 12:32:59 -0500 Subject: [PATCH 5/6] Add martin kuba to approvers list (#3594) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f1c4de9a46..482500bf5c 100644 --- a/README.md +++ b/README.md @@ -181,6 +181,7 @@ Approvers ([@open-telemetry/js-approvers](https://github.com/orgs/open-telemetry - [John Bley](https://github.com/johnbley), Splunk - [Marc Pichler](https://github.com/pichlermarc), Dynatrace - [Mark Wolff](https://github.com/markwolff), Microsoft +- [Martin Kuba](https://github.com/martinkuba), Lightstep - [Matthew Wear](https://github.com/mwear), LightStep - [Naseem K. Ullah](https://github.com/naseemkullah), Transit - [Neville Wylie](https://github.com/MSNev), Microsoft From c32a8457262102c4590693e9f8bf5cd7c5e161ce Mon Sep 17 00:00:00 2001 From: Amir Blum Date: Wed, 8 Feb 2023 21:40:19 +0200 Subject: [PATCH 6/6] Add haddasbronfman as approver (#3593) * Add haddasbronfman as approver * Delete performance.ts delete unrelated file * remove unrelated file --------- Co-authored-by: Daniel Dyla --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 482500bf5c..72c52f9b39 100644 --- a/README.md +++ b/README.md @@ -178,6 +178,7 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t Approvers ([@open-telemetry/js-approvers](https://github.com/orgs/open-telemetry/teams/javascript-approvers)): - [Gerhard Stöbich](https://github.com/Flarna), Dynatrace +- [Haddas Bronfman](https://github.com/haddasbronfman), Cisco - [John Bley](https://github.com/johnbley), Splunk - [Marc Pichler](https://github.com/pichlermarc), Dynatrace - [Mark Wolff](https://github.com/markwolff), Microsoft