diff --git a/CHANGELOG.md b/CHANGELOG.md index 613c2a18067..b11e8bd3ccc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,8 @@ For semantic convention package changes, see the [semconv CHANGELOG](packages/se ### :rocket: (Enhancement) +* feat: add processors for adding session.id attribute to spans and logs [#4972](https://github.com/open-telemetry/opentelemetry-js/pull/4972) + ### :bug: (Bug Fix) ### :books: (Refine Doc) diff --git a/experimental/packages/web-common/.eslintignore b/experimental/packages/web-common/.eslintignore new file mode 100644 index 00000000000..378eac25d31 --- /dev/null +++ b/experimental/packages/web-common/.eslintignore @@ -0,0 +1 @@ +build diff --git a/experimental/packages/web-common/.eslintrc.js b/experimental/packages/web-common/.eslintrc.js new file mode 100644 index 00000000000..fc24af194b2 --- /dev/null +++ b/experimental/packages/web-common/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + env: { + mocha: true, + node: true, + }, + ...require('../../../eslint.base.js'), +}; diff --git a/experimental/packages/web-common/.npmignore b/experimental/packages/web-common/.npmignore new file mode 100644 index 00000000000..9505ba9450f --- /dev/null +++ b/experimental/packages/web-common/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/experimental/packages/web-common/LICENSE b/experimental/packages/web-common/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/experimental/packages/web-common/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/web-common/README.md b/experimental/packages/web-common/README.md new file mode 100644 index 00000000000..b5c0bbacd6a --- /dev/null +++ b/experimental/packages/web-common/README.md @@ -0,0 +1,30 @@ +# OpenTelemetry Web Utils + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +**Note: This is an experimental package under active development. New releases may include breaking changes.** + +This package contains classes and utils that are common for web use cases. + +## Installation + +```bash +npm install --save @opentelemetry/web-common +``` + +## 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/sdk-logs +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fsdk%2Dlogs.svg diff --git a/experimental/packages/web-common/karma.conf.js b/experimental/packages/web-common/karma.conf.js new file mode 100644 index 00000000000..d1c8fbaac18 --- /dev/null +++ b/experimental/packages/web-common/karma.conf.js @@ -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 + * + * 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/web-common/package.json b/experimental/packages/web-common/package.json new file mode 100644 index 00000000000..14e43c793ab --- /dev/null +++ b/experimental/packages/web-common/package.json @@ -0,0 +1,104 @@ +{ + "name": "@opentelemetry/web-common", + "version": "0.53.0", + "publishConfig": { + "access": "public" + }, + "description": "Common utilities for web instrumentation", + "author": "OpenTelemetry Authors", + "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/web-common", + "license": "Apache-2.0", + "main": "build/src/index.js", + "module": "build/esm/index.js", + "esnext": "build/esnext/index.js", + "types": "build/src/index.d.ts", + "repository": { + "type": "git", + "url": "git+https://github.com/open-telemetry/opentelemetry-js.git" + }, + "bugs": { + "url": "https://github.com/open-telemetry/opentelemetry-js/issues" + }, + "engines": { + "node": ">=14" + }, + "scripts": { + "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json tsconfig.esnext.json", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../", + "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../", + "compile": "tsc --build tsconfig.json tsconfig.esm.json tsconfig.esnext.json", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "peer-api-check": "node ../../../scripts/peer-api-check.js", + "prepublishOnly": "npm run compile", + "precompile": "cross-var lerna run version --scope $npm_package_name --include-dependencies", + "prewatch": "npm run precompile", + "tdd": "npm run test -- --watch-extensions ts --watch", + "tdd:browser": "karma start", + "test": "nyc mocha test/**/*.test.ts", + "test:browser": "karma start --single-run", + "version": "node ../../../scripts/version-update.js", + "watch": "tsc --build --watch tsconfig.json tsconfig.esm.json tsconfig.esnext.json", + "align-api-deps": "node ../../../scripts/align-api-deps.js" + }, + "keywords": [ + "opentelemetry", + "web", + "tracing", + "profiling", + "stats", + "monitoring" + ], + "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" + ], + "sideEffects": false, + "peerDependencies": { + "@opentelemetry/api": ">=1.4.0 <1.10.0" + }, + "dependencies": { + "@opentelemetry/sdk-logs": "^0.53.0", + "@opentelemetry/sdk-trace-base": "^1.26.0", + "@opentelemetry/semantic-conventions": "1.27.0" + }, + "devDependencies": { + "@babel/core": "7.25.2", + "@opentelemetry/api": "1.9.0", + "@opentelemetry/api-events": "0.53.0", + "@opentelemetry/api-logs": "0.53.0", + "@types/mocha": "10.0.7", + "@types/node": "18.6.5", + "@types/sinon": "10.0.20", + "@types/webpack-env": "1.16.3", + "babel-loader": "8.3.0", + "babel-plugin-istanbul": "7.0.0", + "codecov": "3.8.3", + "cross-var": "1.1.0", + "karma": "6.4.4", + "karma-chrome-launcher": "3.1.0", + "karma-coverage": "2.2.1", + "karma-mocha": "2.0.1", + "karma-spec-reporter": "0.0.36", + "karma-webpack": "5.0.1", + "lerna": "6.6.2", + "mocha": "10.7.3", + "nyc": "15.1.0", + "sinon": "15.1.2", + "ts-loader": "9.5.1", + "typescript": "4.4.4", + "webpack": "5.94.0", + "webpack-cli": "5.1.4", + "webpack-merge": "5.10.0" + } +} diff --git a/experimental/packages/web-common/src/SessionLogRecordProcessor.ts b/experimental/packages/web-common/src/SessionLogRecordProcessor.ts new file mode 100644 index 00000000000..6f152bd043a --- /dev/null +++ b/experimental/packages/web-common/src/SessionLogRecordProcessor.ts @@ -0,0 +1,49 @@ +/* + * 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 { Context } from '@opentelemetry/api'; +import { LogRecord, LogRecordProcessor } from '@opentelemetry/sdk-logs'; +import { ATTR_SESSION_ID } from '@opentelemetry/semantic-conventions/incubating'; +import { SessionProvider } from './types/SessionProvider'; + +/** + * SessionLogRecordProcessor is a {@link SpanProcessor} adds the session.id attribute + */ +export class SessionLogRecordProcessor implements LogRecordProcessor { + private _sessionIdProvider: SessionProvider; + + constructor(sessionIdProvider: SessionProvider) { + this._sessionIdProvider = sessionIdProvider; + } + + onEmit(logRecord: LogRecord, _context?: Context | undefined): void { + const sessionId = this._sessionIdProvider?.getSessionId(); + if (sessionId) { + logRecord.setAttribute(ATTR_SESSION_ID, sessionId); + } + } + + /** + * Forces to export all finished spans + */ + async forceFlush(): Promise {} + + /** + * Shuts down the processor. Called when SDK is shut down. This is an + * opportunity for processor to do any cleanup required. + */ + async shutdown(): Promise {} +} diff --git a/experimental/packages/web-common/src/SessionSpanProcessor.ts b/experimental/packages/web-common/src/SessionSpanProcessor.ts new file mode 100644 index 00000000000..ee3f7370fb6 --- /dev/null +++ b/experimental/packages/web-common/src/SessionSpanProcessor.ts @@ -0,0 +1,67 @@ +/* + * 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 { Context } from '@opentelemetry/api'; +import { + SpanProcessor, + Span, + ReadableSpan, +} from '@opentelemetry/sdk-trace-base'; +import { ATTR_SESSION_ID } from '@opentelemetry/semantic-conventions/incubating'; +import { SessionProvider } from './types/SessionProvider'; + +/** + * SessionSpanProcessor is a {@link SpanProcessor} that adds the session.id attribute + */ +export class SessionSpanProcessor implements SpanProcessor { + private _sessionIdProvider: SessionProvider; + + constructor(sessionIdProvider: SessionProvider) { + this._sessionIdProvider = sessionIdProvider; + } + + /** + * Forces to export all finished spans + */ + async forceFlush(): Promise {} + + /** + * Called when a {@link Span} is started, if the `span.isRecording()` + * returns true. + * @param span the Span that just started. + */ + onStart(span: Span, _parentContext: Context): void { + const sessionId = this._sessionIdProvider?.getSessionId(); + if (sessionId) { + span.setAttribute(ATTR_SESSION_ID, sessionId); + } + } + + /** + * Called when a {@link ReadableSpan} is ended, if the `span.isRecording()` + * returns true. + * @param span the Span that just ended. + */ + onEnd(_: ReadableSpan): void { + // no-op + } + + /** + * Shuts down the processor. Called when SDK is shut down. This is an + * opportunity for processor to do any cleanup required. + */ + async shutdown(): Promise {} +} diff --git a/experimental/packages/web-common/src/index.ts b/experimental/packages/web-common/src/index.ts new file mode 100644 index 00000000000..a9b7d66facc --- /dev/null +++ b/experimental/packages/web-common/src/index.ts @@ -0,0 +1,21 @@ +/* + * 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 { SessionProvider } from './types/SessionProvider'; +export { + createSessionSpanProcessor, + createSessionLogRecordProcessor, +} from './utils'; diff --git a/experimental/packages/web-common/src/types/SessionProvider.ts b/experimental/packages/web-common/src/types/SessionProvider.ts new file mode 100644 index 00000000000..40915552b21 --- /dev/null +++ b/experimental/packages/web-common/src/types/SessionProvider.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. + */ + +export interface SessionProvider { + getSessionId(): string | null; +} diff --git a/experimental/packages/web-common/src/utils.ts b/experimental/packages/web-common/src/utils.ts new file mode 100644 index 00000000000..bcae118e7b9 --- /dev/null +++ b/experimental/packages/web-common/src/utils.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 { SessionProvider } from './types/SessionProvider'; +import { SpanProcessor } from '@opentelemetry/sdk-trace-base'; +import { SessionSpanProcessor } from './SessionSpanProcessor'; +import { LogRecordProcessor } from '@opentelemetry/sdk-logs'; +import { SessionLogRecordProcessor } from './SessionLogRecordProcessor'; + +export function createSessionSpanProcessor( + sessionProvider: SessionProvider +): SpanProcessor { + return new SessionSpanProcessor(sessionProvider); +} + +export function createSessionLogRecordProcessor( + sessionProvider: SessionProvider +): LogRecordProcessor { + return new SessionLogRecordProcessor(sessionProvider); +} diff --git a/experimental/packages/web-common/test/SessionLogRecordProcessor.test.ts b/experimental/packages/web-common/test/SessionLogRecordProcessor.test.ts new file mode 100644 index 00000000000..05cafa6d347 --- /dev/null +++ b/experimental/packages/web-common/test/SessionLogRecordProcessor.test.ts @@ -0,0 +1,101 @@ +/* + * 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 { SessionLogRecordProcessor } from '../src/SessionLogRecordProcessor'; +import { + InMemoryLogRecordExporter, + LoggerProvider, + SimpleLogRecordProcessor, +} from '@opentelemetry/sdk-logs'; + +describe('SessionLogRecordProcessor', function () { + it('adds session.id attribute', function () { + const expectedAttributes = { + 'session.id': '12345678', + }; + + const sessionProvider = { + getSessionId: () => { + return '12345678'; + }, + }; + + const exporter = new InMemoryLogRecordExporter(); + const processor = new SessionLogRecordProcessor(sessionProvider); + const provider = new LoggerProvider(); + provider.addLogRecordProcessor(processor); + provider.addLogRecordProcessor(new SimpleLogRecordProcessor(exporter)); + + const logger = provider.getLogger('session-testing'); + logger.emit({ body: 'test-body' }); + + const logRecord = exporter.getFinishedLogRecords()[0]; + assert.deepEqual(logRecord.attributes, expectedAttributes); + }); + + it('does not add session.id attribute when there is no session', function () { + const sessionProvider = { + getSessionId: () => { + return null; + }, + }; + + const exporter = new InMemoryLogRecordExporter(); + const processor = new SessionLogRecordProcessor(sessionProvider); + const provider = new LoggerProvider(); + provider.addLogRecordProcessor(processor); + provider.addLogRecordProcessor(new SimpleLogRecordProcessor(exporter)); + + const logger = provider.getLogger('session-testing'); + logger.emit({ body: 'test-body' }); + + const logRecord = exporter.getFinishedLogRecords()[0]; + assert.deepEqual(logRecord.attributes, {}); + }); + + it('does not add session.id attribute when there is no provider', function () { + const exporter = new InMemoryLogRecordExporter(); + const processor = new SessionLogRecordProcessor(null as any); + const provider = new LoggerProvider(); + provider.addLogRecordProcessor(processor); + provider.addLogRecordProcessor(new SimpleLogRecordProcessor(exporter)); + + const logger = provider.getLogger('session-testing'); + logger.emit({ body: 'test-body' }); + + const logRecord = exporter.getFinishedLogRecords()[0]; + assert.deepEqual(logRecord.attributes, {}); + }); + + it('forceFlush is a no-op and does not throw error', async function () { + const processor = new SessionLogRecordProcessor({ + getSessionId: () => { + return null; + }, + }); + await processor.forceFlush(); + }); + + it('shutdown is a no-op and does not throw error', async function () { + const processor = new SessionLogRecordProcessor({ + getSessionId: () => { + return null; + }, + }); + await processor.shutdown(); + }); +}); diff --git a/experimental/packages/web-common/test/SessionSpanProcessor.test.ts b/experimental/packages/web-common/test/SessionSpanProcessor.test.ts new file mode 100644 index 00000000000..bafda7bfe8e --- /dev/null +++ b/experimental/packages/web-common/test/SessionSpanProcessor.test.ts @@ -0,0 +1,101 @@ +/* + * 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 { BasicTracerProvider, Span } from '@opentelemetry/sdk-trace-base'; +import { SessionSpanProcessor } from '../src/SessionSpanProcessor'; +import { ROOT_CONTEXT } from '@opentelemetry/api'; + +describe('SessionSpanProcessor', function () { + it('adds session.id attribute', function () { + const expectedAttributes = { + 'session.id': '12345678', + }; + + const tracer = new BasicTracerProvider().getTracer('session-testing'); + const span = tracer.startSpan('test-span'); + + const sessionProvider = { + getSessionId: () => { + return '12345678'; + }, + }; + + const processor = new SessionSpanProcessor(sessionProvider); + processor.onStart(span as Span, ROOT_CONTEXT); + + assert.deepEqual((span as Span).attributes, expectedAttributes); + }); + + it('does not add session.id attribute when there is no session', function () { + const tracer = new BasicTracerProvider().getTracer('session-testing'); + const span = tracer.startSpan('test-span'); + + const sessionProvider = { + getSessionId: () => { + return null; + }, + }; + + const processor = new SessionSpanProcessor(sessionProvider); + processor.onStart(span as Span, ROOT_CONTEXT); + + assert.deepEqual((span as Span).attributes, {}); + }); + + it('does not add session.id attribute when there is no provider', function () { + const tracer = new BasicTracerProvider().getTracer('session-testing'); + const span = tracer.startSpan('test-span'); + + const processor = new SessionSpanProcessor(null as any); + processor.onStart(span as Span, ROOT_CONTEXT); + + assert.deepEqual((span as Span).attributes, {}); + }); + + it('forceFlush is a no-op and does not throw error', async function () { + const processor = new SessionSpanProcessor({ + getSessionId: () => { + return null; + }, + }); + await processor.forceFlush(); + }); + + it('onEnd is a no-op and does not throw error', async function () { + const tracer = new BasicTracerProvider().getTracer('session-testing'); + const span = tracer.startSpan('test-span'); + + const processor = new SessionSpanProcessor({ + getSessionId: () => { + return null; + }, + }); + + assert.doesNotThrow(() => { + processor.onEnd(span as Span); + }, 'onEnd threw an error when it should not have'); + }); + + it('shutdown is a no-op and does not throw error', async function () { + const processor = new SessionSpanProcessor({ + getSessionId: () => { + return null; + }, + }); + await processor.shutdown(); + }); +}); diff --git a/experimental/packages/web-common/test/index-webpack.ts b/experimental/packages/web-common/test/index-webpack.ts new file mode 100644 index 00000000000..802d6c4053e --- /dev/null +++ b/experimental/packages/web-common/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); +} diff --git a/experimental/packages/web-common/test/utils.test.ts b/experimental/packages/web-common/test/utils.test.ts new file mode 100644 index 00000000000..5cc81931e80 --- /dev/null +++ b/experimental/packages/web-common/test/utils.test.ts @@ -0,0 +1,45 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as assert from 'assert'; +import { + createSessionLogRecordProcessor, + createSessionSpanProcessor, +} from '../src/utils'; +import { SessionSpanProcessor } from '../src/SessionSpanProcessor'; +import { SessionLogRecordProcessor } from '../src/SessionLogRecordProcessor'; + +describe('createSessionSpanProcessor', function () { + it('returns an instance of a SessionSpanProcessor', function () { + const processor = createSessionSpanProcessor({ + getSessionId() { + return '1234'; + }, + }); + assert.ok(processor as SessionSpanProcessor); + }); +}); + +describe('createSessionLogRecordProcessor', function () { + it('returns an instance of a SessionLogRecordProcessor', function () { + const processor = createSessionLogRecordProcessor({ + getSessionId() { + return '1234'; + }, + }); + assert.ok(processor as SessionLogRecordProcessor); + }); +}); diff --git a/experimental/packages/web-common/tsconfig.esm.json b/experimental/packages/web-common/tsconfig.esm.json new file mode 100644 index 00000000000..ec46f6c3f73 --- /dev/null +++ b/experimental/packages/web-common/tsconfig.esm.json @@ -0,0 +1,31 @@ +{ + "extends": "../../../tsconfig.base.esm.json", + "compilerOptions": { + "outDir": "build/esm", + "rootDir": "src", + "tsBuildInfoFile": "build/esm/tsconfig.esm.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ], + "references": [ + { + "path": "../../../api" + }, + { + "path": "../../../packages/opentelemetry-sdk-trace-base" + }, + { + "path": "../../../semantic-conventions" + }, + { + "path": "../api-events" + }, + { + "path": "../api-logs" + }, + { + "path": "../sdk-logs" + } + ] +} diff --git a/experimental/packages/web-common/tsconfig.esnext.json b/experimental/packages/web-common/tsconfig.esnext.json new file mode 100644 index 00000000000..409a9fcb9b6 --- /dev/null +++ b/experimental/packages/web-common/tsconfig.esnext.json @@ -0,0 +1,31 @@ +{ + "extends": "../../../tsconfig.base.esnext.json", + "compilerOptions": { + "outDir": "build/esnext", + "rootDir": "src", + "tsBuildInfoFile": "build/esnext/tsconfig.esnext.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ], + "references": [ + { + "path": "../../../api" + }, + { + "path": "../../../packages/opentelemetry-sdk-trace-base" + }, + { + "path": "../../../semantic-conventions" + }, + { + "path": "../api-events" + }, + { + "path": "../api-logs" + }, + { + "path": "../sdk-logs" + } + ] +} diff --git a/experimental/packages/web-common/tsconfig.json b/experimental/packages/web-common/tsconfig.json new file mode 100644 index 00000000000..b2afc54f191 --- /dev/null +++ b/experimental/packages/web-common/tsconfig.json @@ -0,0 +1,31 @@ +{ + "extends": "../../../tsconfig.base.json", + "compilerOptions": { + "outDir": "build", + "rootDir": "." + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ], + "references": [ + { + "path": "../../../api" + }, + { + "path": "../../../packages/opentelemetry-sdk-trace-base" + }, + { + "path": "../../../semantic-conventions" + }, + { + "path": "../api-events" + }, + { + "path": "../api-logs" + }, + { + "path": "../sdk-logs" + } + ] +} diff --git a/package-lock.json b/package-lock.json index b5f6956aa78..609a12f6beb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1644,6 +1644,59 @@ "@opentelemetry/api": "^1.0.0" } }, + "experimental/packages/web-common": { + "version": "0.53.0", + "license": "Apache-2.0", + "dependencies": { + "@opentelemetry/sdk-logs": "^0.53.0", + "@opentelemetry/sdk-trace-base": "^1.26.0", + "@opentelemetry/semantic-conventions": "1.27.0" + }, + "devDependencies": { + "@babel/core": "7.25.2", + "@opentelemetry/api": "1.9.0", + "@opentelemetry/api-events": "0.53.0", + "@opentelemetry/api-logs": "0.53.0", + "@types/mocha": "10.0.7", + "@types/node": "18.6.5", + "@types/sinon": "10.0.20", + "@types/webpack-env": "1.16.3", + "babel-loader": "8.3.0", + "babel-plugin-istanbul": "7.0.0", + "codecov": "3.8.3", + "cross-var": "1.1.0", + "karma": "6.4.4", + "karma-chrome-launcher": "3.1.0", + "karma-coverage": "2.2.1", + "karma-mocha": "2.0.1", + "karma-spec-reporter": "0.0.36", + "karma-webpack": "5.0.1", + "lerna": "6.6.2", + "mocha": "10.7.3", + "nyc": "15.1.0", + "sinon": "15.1.2", + "ts-loader": "9.5.1", + "typescript": "4.4.4", + "webpack": "5.94.0", + "webpack-cli": "5.1.4", + "webpack-merge": "5.10.0" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@opentelemetry/api": ">=1.4.0 <1.10.0" + } + }, + "experimental/packages/web-common/node_modules/@types/sinon": { + "version": "10.0.20", + "resolved": "https://registry.npmjs.org/@types/sinon/-/sinon-10.0.20.tgz", + "integrity": "sha512-2APKKruFNCAZgx3daAyACGzWuJ028VVCUDk6o2rw/Z4PXT0ogwdV4KUegW0MwVs0Zu59auPXbbuBJHF12Sx1Eg==", + "dev": true, + "dependencies": { + "@types/sinonjs__fake-timers": "*" + } + }, "integration-tests/api": { "name": "@opentelemetry/integration-tests-api", "version": "1.26.0", @@ -6099,6 +6152,10 @@ "resolved": "packages/template", "link": true }, + "node_modules/@opentelemetry/web-common": { + "resolved": "experimental/packages/web-common", + "link": true + }, "node_modules/@parcel/watcher": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/@parcel/watcher/-/watcher-2.0.4.tgz", @@ -34220,6 +34277,52 @@ "typescript": "4.4.4" } }, + "@opentelemetry/web-common": { + "version": "file:experimental/packages/web-common", + "requires": { + "@babel/core": "7.25.2", + "@opentelemetry/api": "1.9.0", + "@opentelemetry/api-events": "0.53.0", + "@opentelemetry/api-logs": "0.53.0", + "@opentelemetry/sdk-logs": "^0.53.0", + "@opentelemetry/sdk-trace-base": "^1.26.0", + "@opentelemetry/semantic-conventions": "1.27.0", + "@types/mocha": "10.0.7", + "@types/node": "18.6.5", + "@types/sinon": "10.0.20", + "@types/webpack-env": "1.16.3", + "babel-loader": "8.3.0", + "babel-plugin-istanbul": "7.0.0", + "codecov": "3.8.3", + "cross-var": "1.1.0", + "karma": "6.4.4", + "karma-chrome-launcher": "3.1.0", + "karma-coverage": "2.2.1", + "karma-mocha": "2.0.1", + "karma-spec-reporter": "0.0.36", + "karma-webpack": "5.0.1", + "lerna": "6.6.2", + "mocha": "10.7.3", + "nyc": "15.1.0", + "sinon": "15.1.2", + "ts-loader": "9.5.1", + "typescript": "4.4.4", + "webpack": "5.94.0", + "webpack-cli": "5.1.4", + "webpack-merge": "5.10.0" + }, + "dependencies": { + "@types/sinon": { + "version": "10.0.20", + "resolved": "https://registry.npmjs.org/@types/sinon/-/sinon-10.0.20.tgz", + "integrity": "sha512-2APKKruFNCAZgx3daAyACGzWuJ028VVCUDk6o2rw/Z4PXT0ogwdV4KUegW0MwVs0Zu59auPXbbuBJHF12Sx1Eg==", + "dev": true, + "requires": { + "@types/sinonjs__fake-timers": "*" + } + } + } + }, "@parcel/watcher": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/@parcel/watcher/-/watcher-2.0.4.tgz", diff --git a/tsconfig.esm.json b/tsconfig.esm.json index 07de4a68c5a..149b8f83947 100644 --- a/tsconfig.esm.json +++ b/tsconfig.esm.json @@ -56,6 +56,9 @@ { "path": "experimental/packages/sdk-logs/tsconfig.esm.json" }, + { + "path": "experimental/packages/web-common/tsconfig.esm.json" + }, { "path": "packages/opentelemetry-context-zone/tsconfig.esm.json" }, diff --git a/tsconfig.esnext.json b/tsconfig.esnext.json index 2a5c7584bf9..5f071fd2246 100644 --- a/tsconfig.esnext.json +++ b/tsconfig.esnext.json @@ -56,6 +56,9 @@ { "path": "experimental/packages/sdk-logs/tsconfig.esnext.json" }, + { + "path": "experimental/packages/web-common/tsconfig.esnext.json" + }, { "path": "packages/opentelemetry-context-zone/tsconfig.esnext.json" }, diff --git a/tsconfig.json b/tsconfig.json index eaada3447e9..0069ce530a5 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -32,6 +32,7 @@ "experimental/packages/sdk-events", "experimental/packages/sdk-logs", "experimental/packages/shim-opencensus", + "experimental/packages/web-common", "packages/opentelemetry-context-async-hooks", "packages/opentelemetry-context-zone", "packages/opentelemetry-context-zone-peer-dep", @@ -144,6 +145,9 @@ { "path": "experimental/packages/shim-opencensus" }, + { + "path": "experimental/packages/web-common" + }, { "path": "packages/opentelemetry-context-async-hooks" },