From b4d3bb35e6734047fee45f9b740622f0c364f76f Mon Sep 17 00:00:00 2001 From: maryliag Date: Thu, 13 Mar 2025 11:45:30 -0400 Subject: [PATCH 01/12] add tests for baggage log record processor --- .github/component_owners.yml | 2 + .../.eslintignore | 1 + .../baggage-log-record-processor/.eslintrc.js | 7 + .../baggage-log-record-processor/CHANGELOG.md | 9 + packages/baggage-log-record-processor/LICENSE | 201 ++++++++++++++++++ .../baggage-log-record-processor/README.md | 73 +++++++ .../baggage-log-record-processor/package.json | 56 +++++ .../src/baggage-log-record-processor.ts | 74 +++++++ .../baggage-log-record-processor/src/index.ts | 18 ++ .../baggage-log-record-processor/src/types.ts | 26 +++ .../test/baggage-log-record-processor.test.ts | 94 ++++++++ .../tsconfig.json | 11 + 12 files changed, 572 insertions(+) create mode 100644 packages/baggage-log-record-processor/.eslintignore create mode 100644 packages/baggage-log-record-processor/.eslintrc.js create mode 100644 packages/baggage-log-record-processor/CHANGELOG.md create mode 100644 packages/baggage-log-record-processor/LICENSE create mode 100644 packages/baggage-log-record-processor/README.md create mode 100644 packages/baggage-log-record-processor/package.json create mode 100644 packages/baggage-log-record-processor/src/baggage-log-record-processor.ts create mode 100644 packages/baggage-log-record-processor/src/index.ts create mode 100644 packages/baggage-log-record-processor/src/types.ts create mode 100644 packages/baggage-log-record-processor/test/baggage-log-record-processor.test.ts create mode 100644 packages/baggage-log-record-processor/tsconfig.json diff --git a/.github/component_owners.yml b/.github/component_owners.yml index ac8556dbdc..9d6167f619 100644 --- a/.github/component_owners.yml +++ b/.github/component_owners.yml @@ -30,6 +30,8 @@ components: - pichlermarc - legendecas - blumamir + packages/baggage-log-record-processor: + - maryliag packages/baggage-span-processor: - mikegoldsmith - jamiedanielson diff --git a/packages/baggage-log-record-processor/.eslintignore b/packages/baggage-log-record-processor/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/packages/baggage-log-record-processor/.eslintignore @@ -0,0 +1 @@ +build diff --git a/packages/baggage-log-record-processor/.eslintrc.js b/packages/baggage-log-record-processor/.eslintrc.js new file mode 100644 index 0000000000..f726f3becb --- /dev/null +++ b/packages/baggage-log-record-processor/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../eslint.config.js') +} diff --git a/packages/baggage-log-record-processor/CHANGELOG.md b/packages/baggage-log-record-processor/CHANGELOG.md new file mode 100644 index 0000000000..5aea2669c5 --- /dev/null +++ b/packages/baggage-log-record-processor/CHANGELOG.md @@ -0,0 +1,9 @@ +# Changelog + +### Features + +* Add new baggage log record processor package + +## 0.1.0 + +Initial version. diff --git a/packages/baggage-log-record-processor/LICENSE b/packages/baggage-log-record-processor/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/packages/baggage-log-record-processor/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/packages/baggage-log-record-processor/README.md b/packages/baggage-log-record-processor/README.md new file mode 100644 index 0000000000..bbf5c4525b --- /dev/null +++ b/packages/baggage-log-record-processor/README.md @@ -0,0 +1,73 @@ +# OpenTelemetry Baggage Log Record Processor for Node.js + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-url] + +The BaggageLogRecordProcessor reads entries stored in Baggage from the parent context and adds the [baggage](https://opentelemetry.io/docs/concepts/signals/baggage) entries' keys and +values to the log record as attributes on log emit. + +⚠ Warning ⚠️ + +Do not put sensitive information in Baggage. + +To repeat: a consequence of adding data to Baggage is that the keys and values will appear in all outgoing HTTP headers from the application. + +Compatible with OpenTelemetry JS API and SDK `1.0+`. + +## Installation + +```bash +npm install --save @opentelemetry/baggage-log-record-processor +``` + +### Usage + +Add to the log record processors that copies all baggage entries during configuration: + +```javascript +import { NodeSDK, logs } from '@opentelemetry/sdk-node'; +import { ALLOW_ALL_BAGGAGE_KEYS, BaggageLogRecordProcessor } from '@opentelemetry/baggage-log-record-processor'; + +const logRecordProcessor = [ + new logs.SimpleLogRecordProcessor( + new logs.ConsoleLogRecordExporter()), + new BaggageLogRecordProcessor(ALLOW_ALL_BAGGAGE_KEYS)]; + +const sdk = new NodeSDK({ + serviceName: "example-service", + logRecordProcessor +}); + +sdk.start(); +``` + +Alternatively, you can provide a custom baggage key predicate to select which baggage keys you want to copy. + +For example, to only copy baggage entries that start with `my-key`: + +```javascript +new BaggageLogRecordProcessor((baggageKey: string) => key.startsWith('my-key')) +``` + +For example, to only copy baggage entries that matches the regex `^key.+`: + +```javascript +const regex = new RegExp("^key.+") +new BaggageLogRecordProcessor((baggageKey: string) => regex.test(baggageKey)) +``` + +## 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-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/baggage-log-record-processor +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fbaggage-log-record-processor.svg diff --git a/packages/baggage-log-record-processor/package.json b/packages/baggage-log-record-processor/package.json new file mode 100644 index 0000000000..278b5f6b62 --- /dev/null +++ b/packages/baggage-log-record-processor/package.json @@ -0,0 +1,56 @@ +{ + "name": "@opentelemetry/baggage-log-record-processor", + "version": "0.1.0", + "description": "OpenTelemetry Baggage Log Record Processor for Node.js", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "clean": "rimraf build/*", + "compile": "tsc -p .", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "prewatch": "npm run precompile", + "prepublishOnly": "npm run compile", + "tdd": "npm run test -- --watch-extensions ts --watch", + "test": "nyc mocha test/**/*.test.ts", + "version:update": "node ../../scripts/version-update.js", + "watch": "tsc -w" + }, + "keywords": [ + "opentelemetry", + "nodejs", + "log", + "baggage", + "plugin" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=14" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts" + ], + "publishConfig": { + "access": "public" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.0.0" + }, + "dependencies": { + "@opentelemetry/sdk-trace-base": "^1.0.0" + }, + "devDependencies": { + "@opentelemetry/api": "^1.0.0", + "@types/mocha": "8.2.3", + "@types/node": "18.18.14", + "expect": "29.2.0", + "nyc": "15.1.0", + "rimraf": "5.0.10", + "typescript": "4.4.4" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/baggage-log-record-processor#readme" +} diff --git a/packages/baggage-log-record-processor/src/baggage-log-record-processor.ts b/packages/baggage-log-record-processor/src/baggage-log-record-processor.ts new file mode 100644 index 0000000000..d851f190a2 --- /dev/null +++ b/packages/baggage-log-record-processor/src/baggage-log-record-processor.ts @@ -0,0 +1,74 @@ +/* + * 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 { BaggageKeyPredicate } from './types'; +import { Context, propagation } from '@opentelemetry/api'; +import { LogRecord, LogRecordProcessor } from '@opentelemetry/sdk-logs'; + +/** + * BaggageLogRecordProcessor is a {@link LogRecordProcessor} that reads entries stored in {@link Baggage} + * from the parent context and adds the baggage entries' keys and + * values to the log as attributes on log emit. + * + * ⚠ Warning ⚠️ + * + * Do not put sensitive information in Baggage. + * + * To repeat: a consequence of adding data to Baggage is that the keys and + * values will appear in all outgoing HTTP headers from the application. + */ +export class BaggageLogRecordProcessor implements LogRecordProcessor { + private _keyPredicate: BaggageKeyPredicate; + + /** + * Constructs a new BaggageLogRecordProcessor instance. + * @param keyPredicate A predicate that determines whether a baggage key-value pair should be added to new log as a log attribute. + */ + constructor(keyPredicate: BaggageKeyPredicate) { + this._keyPredicate = keyPredicate; + } + + /** + * Forces to export all finished log records. + */ + forceFlush(): Promise { + // no-op + return Promise.resolve(); + } + + /** + * Called when a {@link LogRecord} is emit + * @param logRecord the ReadWriteLogRecord that just emitted. + * @param context the current Context, or an empty Context if the Logger was obtained with include_trace_context=false + */ + onEmit(logRecord: LogRecord, context?: Context): void { + if (context) { + (propagation.getBaggage(context)?.getAllEntries() ?? []) + .filter(entry => this._keyPredicate(entry[0])) + .forEach(entry => logRecord.setAttribute(entry[0], entry[1].value)); + } + + } + + /** + * Shuts down the processor. Called when SDK is shut down. This is an + * opportunity for processor to do any cleanup required. + */ + shutdown(): Promise { + // no-op + return Promise.resolve(); + } +} diff --git a/packages/baggage-log-record-processor/src/index.ts b/packages/baggage-log-record-processor/src/index.ts new file mode 100644 index 0000000000..afdea6c6f8 --- /dev/null +++ b/packages/baggage-log-record-processor/src/index.ts @@ -0,0 +1,18 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export { BaggageLogRecordProcessor } from './baggage-log-record-processor'; +export { ALLOW_ALL_BAGGAGE_KEYS, BaggageKeyPredicate } from './types'; diff --git a/packages/baggage-log-record-processor/src/types.ts b/packages/baggage-log-record-processor/src/types.ts new file mode 100644 index 0000000000..62abb59f47 --- /dev/null +++ b/packages/baggage-log-record-processor/src/types.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. + */ + +/** + * A function that determines whether a baggage key-value pair should be added to new + * log record as a log attribute. + */ +export type BaggageKeyPredicate = (baggageKey: string) => boolean; + +/** + * A {@link BaggageKeyPredicate} that includes all baggage keys. + */ +export const ALLOW_ALL_BAGGAGE_KEYS: BaggageKeyPredicate = (_: string) => true; diff --git a/packages/baggage-log-record-processor/test/baggage-log-record-processor.test.ts b/packages/baggage-log-record-processor/test/baggage-log-record-processor.test.ts new file mode 100644 index 0000000000..3b2580274f --- /dev/null +++ b/packages/baggage-log-record-processor/test/baggage-log-record-processor.test.ts @@ -0,0 +1,94 @@ +/* + * 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 { BaggageLogRecordProcessor } from '../src/baggage-log-record-processor'; +import { ALLOW_ALL_BAGGAGE_KEYS } from '../src/types'; +import { propagation, ROOT_CONTEXT, diag, DiagLogLevel, DiagConsoleLogger } from '@opentelemetry/api'; +import { logs } from '@opentelemetry/api-logs'; +import { LoggerProvider, LogRecord, InMemoryLogRecordExporter, SimpleLogRecordProcessor } from '@opentelemetry/sdk-logs'; +import { LoggerProviderSharedState } from '@opentelemetry/sdk-logs/build/src/internal/LoggerProviderSharedState'; +import { expect } from 'expect'; + +describe('BaggageLogRecordProcessor with all keys filter', () => { + const baggageProcessor = new BaggageLogRecordProcessor(ALLOW_ALL_BAGGAGE_KEYS); + + const bag = propagation.createBaggage({ + brand: { value: 'samsonite' }, + }); + const expectedAttrs = { + brand: 'samsonite', + }; + + let logRecord: LogRecord; + + + beforeEach(() => { + const loggerProvider = new LoggerProvider(); + const memoryLogExporter = new InMemoryLogRecordExporter(); + loggerProvider.addLogRecordProcessor( + new SimpleLogRecordProcessor(memoryLogExporter) + ); + logs.setGlobalLoggerProvider(loggerProvider); + + diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO); + diag.info('info message'); + + const logRecords = memoryLogExporter.getFinishedLogRecords(); + console.log(logRecords); // <<< Returning no logs + logRecord = new LogRecord( + new LoggerProviderSharedState( + logRecords[0].resource, + 100, + {attributeValueLengthLimit: 100, attributeCountLimit: 100} + ), + logRecords[0].instrumentationScope, + logRecords[0] + ); + loggerProvider.getLogger('baggage-testing').emit(logRecord); + + // logRecord = { + // ...logRecords[0], + // totalAttributesCount: 0, + // _isReadonly: false, + // _logRecordLimits: 100, + // setAttribute: + // // severityNumber: 5, + // // severityText: 'debug', + // // body: 'log message', + // // attributes: {}, + // // hrTime: [1609504210, 150000000], + // // hrTimeObserved: [1609504210, 150000000], + // }; + + }); + + it('onEmit adds current Baggage entries to a log record as attributes', () => { + expect(logRecord.attributes).toEqual({}); + const ctx = propagation.setBaggage(ROOT_CONTEXT, bag); + + baggageProcessor.onEmit(logRecord, ctx); + + expect(logRecord.attributes).toEqual(expectedAttrs); + }); + + it('forceFlush is a no-op and does not throw error', async () => { + await expect(baggageProcessor.forceFlush()).resolves.not.toThrow(); + }); + + it('shutdown is a no-op and does not throw error', async () => { + await expect(baggageProcessor.shutdown()).resolves.not.toThrow(); + }); +}); diff --git a/packages/baggage-log-record-processor/tsconfig.json b/packages/baggage-log-record-processor/tsconfig.json new file mode 100644 index 0000000000..4078877ce6 --- /dev/null +++ b/packages/baggage-log-record-processor/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} From 56bf632073642e02e8c021e53f363d52085d44c4 Mon Sep 17 00:00:00 2001 From: maryliag Date: Thu, 13 Mar 2025 12:04:15 -0400 Subject: [PATCH 02/12] fix lint --- .release-please-manifest.json | 1 + package-lock.json | 78 +++++++++++++++++++ .../baggage-log-record-processor/CHANGELOG.md | 2 +- .../baggage-log-record-processor/package.json | 2 +- release-please-config.json | 1 + 5 files changed, 82 insertions(+), 2 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 8402c34a6b..384edb6ece 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -10,6 +10,7 @@ "metapackages/auto-instrumentations-node": "0.55.2", "metapackages/auto-instrumentations-web": "0.45.0", "packages/baggage-span-processor": "0.3.1", + "packages/baggage-log-record-processor": "0.0.1", "packages/opentelemetry-host-metrics": "0.35.5", "packages/opentelemetry-id-generator-aws-xray": "1.2.2", "packages/opentelemetry-propagation-utils": "0.30.15", diff --git a/package-lock.json b/package-lock.json index 616578c16c..95f8ccd05f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9479,6 +9479,10 @@ "resolved": "metapackages/auto-instrumentations-web", "link": true }, + "node_modules/@opentelemetry/baggage-log-record-processor": { + "resolved": "packages/baggage-log-record-processor", + "link": true + }, "node_modules/@opentelemetry/baggage-span-processor": { "resolved": "packages/baggage-span-processor", "link": true @@ -35591,6 +35595,50 @@ "resolved": "https://registry.npmjs.org/zone.js/-/zone.js-0.15.0.tgz", "integrity": "sha512-9oxn0IIjbCZkJ67L+LkhYWRyAy7axphb3VgE2MBDlOqnmHMPWGYMxJxBYFueFq/JGY2GMwS0rU+UCLunEmy5UA==" }, + "packages/baggage-log-record-processor": { + "version": "0.0.1", + "license": "Apache-2.0", + "dependencies": { + "@opentelemetry/sdk-trace-base": "^1.0.0" + }, + "devDependencies": { + "@opentelemetry/api": "^1.0.0", + "@types/mocha": "8.2.3", + "@types/node": "18.18.14", + "expect": "29.2.0", + "nyc": "15.1.0", + "rimraf": "5.0.10", + "typescript": "4.4.4" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.0.0" + } + }, + "packages/baggage-log-record-processor/node_modules/@types/node": { + "version": "18.18.14", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", + "integrity": "sha512-iSOeNeXYNYNLLOMDSVPvIFojclvMZ/HDY2dU17kUlcsOsSQETbWIslJbYLZgA+ox8g2XQwSHKTkght1a5X26lQ==", + "dev": true, + "dependencies": { + "undici-types": "~5.26.4" + } + }, + "packages/baggage-log-record-processor/node_modules/typescript": { + "version": "4.4.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", + "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, "packages/baggage-span-processor": { "name": "@opentelemetry/baggage-span-processor", "version": "0.3.1", @@ -47022,6 +47070,36 @@ } } }, + "@opentelemetry/baggage-log-record-processor": { + "version": "file:packages/baggage-log-record-processor", + "requires": { + "@opentelemetry/api": "^1.0.0", + "@opentelemetry/sdk-trace-base": "^1.0.0", + "@types/mocha": "8.2.3", + "@types/node": "18.18.14", + "expect": "29.2.0", + "nyc": "15.1.0", + "rimraf": "5.0.10", + "typescript": "4.4.4" + }, + "dependencies": { + "@types/node": { + "version": "18.18.14", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", + "integrity": "sha512-iSOeNeXYNYNLLOMDSVPvIFojclvMZ/HDY2dU17kUlcsOsSQETbWIslJbYLZgA+ox8g2XQwSHKTkght1a5X26lQ==", + "dev": true, + "requires": { + "undici-types": "~5.26.4" + } + }, + "typescript": { + "version": "4.4.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", + "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", + "dev": true + } + } + }, "@opentelemetry/baggage-span-processor": { "version": "file:packages/baggage-span-processor", "requires": { diff --git a/packages/baggage-log-record-processor/CHANGELOG.md b/packages/baggage-log-record-processor/CHANGELOG.md index 5aea2669c5..a71ebbd21b 100644 --- a/packages/baggage-log-record-processor/CHANGELOG.md +++ b/packages/baggage-log-record-processor/CHANGELOG.md @@ -4,6 +4,6 @@ * Add new baggage log record processor package -## 0.1.0 +## 0.0.1 Initial version. diff --git a/packages/baggage-log-record-processor/package.json b/packages/baggage-log-record-processor/package.json index 278b5f6b62..8bb8aa673d 100644 --- a/packages/baggage-log-record-processor/package.json +++ b/packages/baggage-log-record-processor/package.json @@ -1,6 +1,6 @@ { "name": "@opentelemetry/baggage-log-record-processor", - "version": "0.1.0", + "version": "0.0.1", "description": "OpenTelemetry Baggage Log Record Processor for Node.js", "main": "build/src/index.js", "types": "build/src/index.d.ts", diff --git a/release-please-config.json b/release-please-config.json index b0993722d4..a55d06f9ec 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -17,6 +17,7 @@ "metapackages/auto-instrumentations-node": {}, "metapackages/auto-instrumentations-web": {}, "packages/baggage-span-processor": {}, + "packages/baggage-log-record-processor": {}, "packages/opentelemetry-host-metrics": {}, "packages/opentelemetry-id-generator-aws-xray": {}, "packages/opentelemetry-propagation-utils": {}, From ae90638bb52bd702113eb3436239132650541533 Mon Sep 17 00:00:00 2001 From: maryliag Date: Thu, 13 Mar 2025 12:14:19 -0400 Subject: [PATCH 03/12] fix dependency version --- package-lock.json | 5 +++-- packages/baggage-log-record-processor/package.json | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 0fee23a2c4..f9e0ea017b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -35711,6 +35711,7 @@ "integrity": "sha512-9oxn0IIjbCZkJ67L+LkhYWRyAy7axphb3VgE2MBDlOqnmHMPWGYMxJxBYFueFq/JGY2GMwS0rU+UCLunEmy5UA==" }, "packages/baggage-log-record-processor": { + "name": "@opentelemetry/baggage-log-record-processor", "version": "0.0.1", "license": "Apache-2.0", "dependencies": { @@ -35718,7 +35719,7 @@ }, "devDependencies": { "@opentelemetry/api": "^1.0.0", - "@types/mocha": "8.2.3", + "@types/mocha": "10.0.10", "@types/node": "18.18.14", "expect": "29.2.0", "nyc": "15.1.0", @@ -46363,7 +46364,7 @@ "requires": { "@opentelemetry/api": "^1.0.0", "@opentelemetry/sdk-trace-base": "^1.0.0", - "@types/mocha": "8.2.3", + "@types/mocha": "10.0.10", "@types/node": "18.18.14", "expect": "29.2.0", "nyc": "15.1.0", diff --git a/packages/baggage-log-record-processor/package.json b/packages/baggage-log-record-processor/package.json index 8bb8aa673d..24c991f4f4 100644 --- a/packages/baggage-log-record-processor/package.json +++ b/packages/baggage-log-record-processor/package.json @@ -45,7 +45,7 @@ }, "devDependencies": { "@opentelemetry/api": "^1.0.0", - "@types/mocha": "8.2.3", + "@types/mocha": "10.0.10", "@types/node": "18.18.14", "expect": "29.2.0", "nyc": "15.1.0", From 7eabd3d1d5f66d48f439ca71b0bb7d80e580a44b Mon Sep 17 00:00:00 2001 From: maryliag Date: Thu, 13 Mar 2025 14:32:03 -0400 Subject: [PATCH 04/12] finish tests --- .../src/baggage-log-record-processor.ts | 1 - .../test/baggage-log-record-processor.test.ts | 153 ++++++++++++------ 2 files changed, 101 insertions(+), 53 deletions(-) diff --git a/packages/baggage-log-record-processor/src/baggage-log-record-processor.ts b/packages/baggage-log-record-processor/src/baggage-log-record-processor.ts index d851f190a2..610b0ec10f 100644 --- a/packages/baggage-log-record-processor/src/baggage-log-record-processor.ts +++ b/packages/baggage-log-record-processor/src/baggage-log-record-processor.ts @@ -60,7 +60,6 @@ export class BaggageLogRecordProcessor implements LogRecordProcessor { .filter(entry => this._keyPredicate(entry[0])) .forEach(entry => logRecord.setAttribute(entry[0], entry[1].value)); } - } /** diff --git a/packages/baggage-log-record-processor/test/baggage-log-record-processor.test.ts b/packages/baggage-log-record-processor/test/baggage-log-record-processor.test.ts index 3b2580274f..3fcfba16e4 100644 --- a/packages/baggage-log-record-processor/test/baggage-log-record-processor.test.ts +++ b/packages/baggage-log-record-processor/test/baggage-log-record-processor.test.ts @@ -16,72 +16,121 @@ import { BaggageLogRecordProcessor } from '../src/baggage-log-record-processor'; import { ALLOW_ALL_BAGGAGE_KEYS } from '../src/types'; -import { propagation, ROOT_CONTEXT, diag, DiagLogLevel, DiagConsoleLogger } from '@opentelemetry/api'; -import { logs } from '@opentelemetry/api-logs'; -import { LoggerProvider, LogRecord, InMemoryLogRecordExporter, SimpleLogRecordProcessor } from '@opentelemetry/sdk-logs'; -import { LoggerProviderSharedState } from '@opentelemetry/sdk-logs/build/src/internal/LoggerProviderSharedState'; +import { propagation, ROOT_CONTEXT } from '@opentelemetry/api'; +import { + InMemoryLogRecordExporter, + LoggerProvider, + SimpleLogRecordProcessor, +} from '@opentelemetry/sdk-logs'; import { expect } from 'expect'; -describe('BaggageLogRecordProcessor with all keys filter', () => { - const baggageProcessor = new BaggageLogRecordProcessor(ALLOW_ALL_BAGGAGE_KEYS); - +describe('BaggageLogRecordProcessor with all keys', () => { + const baggageProcessor = new BaggageLogRecordProcessor( + ALLOW_ALL_BAGGAGE_KEYS + ); const bag = propagation.createBaggage({ brand: { value: 'samsonite' }, + color: { value: 'blue' }, }); - const expectedAttrs = { - brand: 'samsonite', - }; - - let logRecord: LogRecord; - - beforeEach(() => { + it('onEmit adds current Baggage entries to a log record as attributes', () => { const loggerProvider = new LoggerProvider(); - const memoryLogExporter = new InMemoryLogRecordExporter(); + const exporter = new InMemoryLogRecordExporter(); + loggerProvider.addLogRecordProcessor(baggageProcessor); loggerProvider.addLogRecordProcessor( - new SimpleLogRecordProcessor(memoryLogExporter) + new SimpleLogRecordProcessor(exporter) ); - logs.setGlobalLoggerProvider(loggerProvider); - - diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO); - diag.info('info message'); - - const logRecords = memoryLogExporter.getFinishedLogRecords(); - console.log(logRecords); // <<< Returning no logs - logRecord = new LogRecord( - new LoggerProviderSharedState( - logRecords[0].resource, - 100, - {attributeValueLengthLimit: 100, attributeCountLimit: 100} - ), - logRecords[0].instrumentationScope, - logRecords[0] + const logger = loggerProvider.getLogger('my-logger'); + const ctx = propagation.setBaggage(ROOT_CONTEXT, bag); + + logger.emit({ + body: 'my log body', + context: ctx, + }); + + const logRecords = exporter.getFinishedLogRecords(); + expect(logRecords.length).toBe(1); + expect(logRecords[0].attributes).toEqual({ + brand: 'samsonite', + color: 'blue', + }); + }); + + it('forceFlush is a no-op and does not throw error', async () => { + await expect(baggageProcessor.forceFlush()).resolves.not.toThrow(); + }); + + it('shutdown is a no-op and does not throw error', async () => { + await expect(baggageProcessor.shutdown()).resolves.not.toThrow(); + }); +}); + +describe('BaggageLogRecordProcessor startWith key filter', () => { + const baggageProcessor = new BaggageLogRecordProcessor((key: string) => + key.startsWith('brand') + ); + const bag = propagation.createBaggage({ + brand: { value: 'samsonite' }, + color: { value: 'blue' }, + }); + + it('onEmit adds current filtered by startWith Baggage entries to a log record as attributes', () => { + const loggerProvider = new LoggerProvider(); + const exporter = new InMemoryLogRecordExporter(); + loggerProvider.addLogRecordProcessor(baggageProcessor); + loggerProvider.addLogRecordProcessor( + new SimpleLogRecordProcessor(exporter) ); - loggerProvider.getLogger('baggage-testing').emit(logRecord); - - // logRecord = { - // ...logRecords[0], - // totalAttributesCount: 0, - // _isReadonly: false, - // _logRecordLimits: 100, - // setAttribute: - // // severityNumber: 5, - // // severityText: 'debug', - // // body: 'log message', - // // attributes: {}, - // // hrTime: [1609504210, 150000000], - // // hrTimeObserved: [1609504210, 150000000], - // }; - + const logger = loggerProvider.getLogger('my-logger'); + const ctx = propagation.setBaggage(ROOT_CONTEXT, bag); + + logger.emit({ + body: 'my log body', + context: ctx, + }); + + const logRecords = exporter.getFinishedLogRecords(); + expect(logRecords.length).toBe(1); + expect(logRecords[0].attributes).toEqual({ brand: 'samsonite' }); }); - it('onEmit adds current Baggage entries to a log record as attributes', () => { - expect(logRecord.attributes).toEqual({}); + it('forceFlush is a no-op and does not throw error', async () => { + await expect(baggageProcessor.forceFlush()).resolves.not.toThrow(); + }); + + it('shutdown is a no-op and does not throw error', async () => { + await expect(baggageProcessor.shutdown()).resolves.not.toThrow(); + }); +}); + +describe('BaggageLogRecordProcessor with regex key filter', () => { + const regex = new RegExp('^col.+'); + const baggageProcessor = new BaggageLogRecordProcessor((key: string) => + regex.test(key) + ); + const bag = propagation.createBaggage({ + brand: { value: 'samsonite' }, + color: { value: 'blue' }, + }); + + it('onEmit adds current filtered by regex Baggage entries to a log record as attributes', () => { + const loggerProvider = new LoggerProvider(); + const exporter = new InMemoryLogRecordExporter(); + loggerProvider.addLogRecordProcessor(baggageProcessor); + loggerProvider.addLogRecordProcessor( + new SimpleLogRecordProcessor(exporter) + ); + const logger = loggerProvider.getLogger('my-logger'); const ctx = propagation.setBaggage(ROOT_CONTEXT, bag); - - baggageProcessor.onEmit(logRecord, ctx); - expect(logRecord.attributes).toEqual(expectedAttrs); + logger.emit({ + body: 'my log body', + context: ctx, + }); + + const logRecords = exporter.getFinishedLogRecords(); + expect(logRecords.length).toBe(1); + expect(logRecords[0].attributes).toEqual({ color: 'blue' }); }); it('forceFlush is a no-op and does not throw error', async () => { From 02fe94bdbfb59dd16349451c11e0a83b0feb4aa4 Mon Sep 17 00:00:00 2001 From: maryliag Date: Thu, 13 Mar 2025 14:42:38 -0400 Subject: [PATCH 05/12] fix dependencies --- package-lock.json | 4 ++-- packages/baggage-log-record-processor/package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index f9e0ea017b..5c8d8cc86b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -35715,7 +35715,7 @@ "version": "0.0.1", "license": "Apache-2.0", "dependencies": { - "@opentelemetry/sdk-trace-base": "^1.0.0" + "@opentelemetry/sdk-logs": "0.57.2" }, "devDependencies": { "@opentelemetry/api": "^1.0.0", @@ -46363,7 +46363,7 @@ "version": "file:packages/baggage-log-record-processor", "requires": { "@opentelemetry/api": "^1.0.0", - "@opentelemetry/sdk-trace-base": "^1.0.0", + "@opentelemetry/sdk-logs": "0.57.2", "@types/mocha": "10.0.10", "@types/node": "18.18.14", "expect": "29.2.0", diff --git a/packages/baggage-log-record-processor/package.json b/packages/baggage-log-record-processor/package.json index 24c991f4f4..464c1d1fa2 100644 --- a/packages/baggage-log-record-processor/package.json +++ b/packages/baggage-log-record-processor/package.json @@ -41,7 +41,7 @@ "@opentelemetry/api": "^1.0.0" }, "dependencies": { - "@opentelemetry/sdk-trace-base": "^1.0.0" + "@opentelemetry/sdk-logs": "0.57.2" }, "devDependencies": { "@opentelemetry/api": "^1.0.0", From 6e05983c03d1d62a41aecd87923377a820e29983 Mon Sep 17 00:00:00 2001 From: maryliag Date: Thu, 13 Mar 2025 14:54:00 -0400 Subject: [PATCH 06/12] update changelog --- packages/baggage-log-record-processor/CHANGELOG.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/packages/baggage-log-record-processor/CHANGELOG.md b/packages/baggage-log-record-processor/CHANGELOG.md index a71ebbd21b..628262bbaa 100644 --- a/packages/baggage-log-record-processor/CHANGELOG.md +++ b/packages/baggage-log-record-processor/CHANGELOG.md @@ -1,9 +1,5 @@ # Changelog -### Features - -* Add new baggage log record processor package - ## 0.0.1 Initial version. From 92a7e5420165c565e6c12cecff2f954272122be9 Mon Sep 17 00:00:00 2001 From: maryliag Date: Wed, 19 Mar 2025 10:54:01 -0400 Subject: [PATCH 07/12] update dependencies after merge with main --- package-lock.json | 106 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) diff --git a/package-lock.json b/package-lock.json index 6c3673dcb2..07a28f7d43 100644 --- a/package-lock.json +++ b/package-lock.json @@ -34759,6 +34759,70 @@ "@opentelemetry/api": "^1.0.0" } }, + "packages/baggage-log-record-processor/node_modules/@opentelemetry/api-logs": { + "version": "0.57.2", + "resolved": "https://registry.npmjs.org/@opentelemetry/api-logs/-/api-logs-0.57.2.tgz", + "integrity": "sha512-uIX52NnTM0iBh84MShlpouI7UKqkZ7MrUszTmaypHBu4r7NofznSnQRfJ+uUeDtQDj6w8eFGg5KBLDAwAPz1+A==", + "dependencies": { + "@opentelemetry/api": "^1.3.0" + }, + "engines": { + "node": ">=14" + } + }, + "packages/baggage-log-record-processor/node_modules/@opentelemetry/core": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/@opentelemetry/core/-/core-1.30.1.tgz", + "integrity": "sha512-OOCM2C/QIURhJMuKaekP3TRBxBKxG/TWWA0TL2J6nXUtDnuCtccy49LUJF8xPFXMX+0LMcxFpCo8M9cGY1W6rQ==", + "dependencies": { + "@opentelemetry/semantic-conventions": "1.28.0" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@opentelemetry/api": ">=1.0.0 <1.10.0" + } + }, + "packages/baggage-log-record-processor/node_modules/@opentelemetry/resources": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/@opentelemetry/resources/-/resources-1.30.1.tgz", + "integrity": "sha512-5UxZqiAgLYGFjS4s9qm5mBVo433u+dSPUFWVWXmLAD4wB65oMCoXaJP1KJa9DIYYMeHu3z4BZcStG3LC593cWA==", + "dependencies": { + "@opentelemetry/core": "1.30.1", + "@opentelemetry/semantic-conventions": "1.28.0" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@opentelemetry/api": ">=1.0.0 <1.10.0" + } + }, + "packages/baggage-log-record-processor/node_modules/@opentelemetry/sdk-logs": { + "version": "0.57.2", + "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-logs/-/sdk-logs-0.57.2.tgz", + "integrity": "sha512-TXFHJ5c+BKggWbdEQ/inpgIzEmS2BGQowLE9UhsMd7YYlUfBQJ4uax0VF/B5NYigdM/75OoJGhAV3upEhK+3gg==", + "dependencies": { + "@opentelemetry/api-logs": "0.57.2", + "@opentelemetry/core": "1.30.1", + "@opentelemetry/resources": "1.30.1" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@opentelemetry/api": ">=1.4.0 <1.10.0" + } + }, + "packages/baggage-log-record-processor/node_modules/@opentelemetry/semantic-conventions": { + "version": "1.28.0", + "resolved": "https://registry.npmjs.org/@opentelemetry/semantic-conventions/-/semantic-conventions-1.28.0.tgz", + "integrity": "sha512-lp4qAiMTD4sNWW4DbKLBkfiMZ4jbAboJIGOQr5DvciMRI494OapieI9qiODpOt0XBr1LjIDy1xAGAnVs5supTA==", + "engines": { + "node": ">=14" + } + }, "packages/baggage-log-record-processor/node_modules/@types/node": { "version": "18.18.14", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", @@ -35243,6 +35307,7 @@ "nyc": "15.1.0", "rimraf": "5.0.10", "sinon": "15.2.0", + "test-all-versions": "6.1.0", "typescript": "5.0.4" }, "engines": { @@ -43997,6 +44062,46 @@ "typescript": "4.4.4" }, "dependencies": { + "@opentelemetry/api-logs": { + "version": "0.57.2", + "resolved": "https://registry.npmjs.org/@opentelemetry/api-logs/-/api-logs-0.57.2.tgz", + "integrity": "sha512-uIX52NnTM0iBh84MShlpouI7UKqkZ7MrUszTmaypHBu4r7NofznSnQRfJ+uUeDtQDj6w8eFGg5KBLDAwAPz1+A==", + "requires": { + "@opentelemetry/api": "^1.3.0" + } + }, + "@opentelemetry/core": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/@opentelemetry/core/-/core-1.30.1.tgz", + "integrity": "sha512-OOCM2C/QIURhJMuKaekP3TRBxBKxG/TWWA0TL2J6nXUtDnuCtccy49LUJF8xPFXMX+0LMcxFpCo8M9cGY1W6rQ==", + "requires": { + "@opentelemetry/semantic-conventions": "1.28.0" + } + }, + "@opentelemetry/resources": { + "version": "1.30.1", + "resolved": "https://registry.npmjs.org/@opentelemetry/resources/-/resources-1.30.1.tgz", + "integrity": "sha512-5UxZqiAgLYGFjS4s9qm5mBVo433u+dSPUFWVWXmLAD4wB65oMCoXaJP1KJa9DIYYMeHu3z4BZcStG3LC593cWA==", + "requires": { + "@opentelemetry/core": "1.30.1", + "@opentelemetry/semantic-conventions": "1.28.0" + } + }, + "@opentelemetry/sdk-logs": { + "version": "0.57.2", + "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-logs/-/sdk-logs-0.57.2.tgz", + "integrity": "sha512-TXFHJ5c+BKggWbdEQ/inpgIzEmS2BGQowLE9UhsMd7YYlUfBQJ4uax0VF/B5NYigdM/75OoJGhAV3upEhK+3gg==", + "requires": { + "@opentelemetry/api-logs": "0.57.2", + "@opentelemetry/core": "1.30.1", + "@opentelemetry/resources": "1.30.1" + } + }, + "@opentelemetry/semantic-conventions": { + "version": "1.28.0", + "resolved": "https://registry.npmjs.org/@opentelemetry/semantic-conventions/-/semantic-conventions-1.28.0.tgz", + "integrity": "sha512-lp4qAiMTD4sNWW4DbKLBkfiMZ4jbAboJIGOQr5DvciMRI494OapieI9qiODpOt0XBr1LjIDy1xAGAnVs5supTA==" + }, "@types/node": { "version": "18.18.14", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", @@ -44988,6 +45093,7 @@ "nyc": "15.1.0", "rimraf": "5.0.10", "sinon": "15.2.0", + "test-all-versions": "6.1.0", "typescript": "5.0.4" }, "dependencies": { From 03037b5f3b428e4d2c1da7cd608e80a5a0900b09 Mon Sep 17 00:00:00 2001 From: maryliag Date: Wed, 19 Mar 2025 11:31:49 -0400 Subject: [PATCH 08/12] update node version --- package-lock.json | 2 +- packages/baggage-log-record-processor/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 07a28f7d43..fbea68d904 100644 --- a/package-lock.json +++ b/package-lock.json @@ -34753,7 +34753,7 @@ "typescript": "4.4.4" }, "engines": { - "node": ">=14" + "node": "^18.19.0 || >=20.6.0" }, "peerDependencies": { "@opentelemetry/api": "^1.0.0" diff --git a/packages/baggage-log-record-processor/package.json b/packages/baggage-log-record-processor/package.json index 464c1d1fa2..63b46fe47a 100644 --- a/packages/baggage-log-record-processor/package.json +++ b/packages/baggage-log-record-processor/package.json @@ -27,7 +27,7 @@ "author": "OpenTelemetry Authors", "license": "Apache-2.0", "engines": { - "node": ">=14" + "node": "^18.19.0 || >=20.6.0" }, "files": [ "build/src/**/*.js", From ce9f22e0ed24ba89f1370cb8303c1b1063766ab1 Mon Sep 17 00:00:00 2001 From: Marylia Gutierrez Date: Wed, 19 Mar 2025 11:57:09 -0400 Subject: [PATCH 09/12] Apply suggestions from code review Co-authored-by: David Luna --- packages/baggage-log-record-processor/package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/baggage-log-record-processor/package.json b/packages/baggage-log-record-processor/package.json index 63b46fe47a..ae21ed0a3e 100644 --- a/packages/baggage-log-record-processor/package.json +++ b/packages/baggage-log-record-processor/package.json @@ -41,7 +41,7 @@ "@opentelemetry/api": "^1.0.0" }, "dependencies": { - "@opentelemetry/sdk-logs": "0.57.2" + "@opentelemetry/sdk-logs": "^0.200.0" }, "devDependencies": { "@opentelemetry/api": "^1.0.0", @@ -50,7 +50,7 @@ "expect": "29.2.0", "nyc": "15.1.0", "rimraf": "5.0.10", - "typescript": "4.4.4" + "typescript": "5.0.4" }, "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/baggage-log-record-processor#readme" } From da765725fd59929c281715148490d601c053769f Mon Sep 17 00:00:00 2001 From: maryliag Date: Wed, 19 Mar 2025 11:57:57 -0400 Subject: [PATCH 10/12] update dependencies --- package-lock.json | 175 ++-------------------------------------------- 1 file changed, 4 insertions(+), 171 deletions(-) diff --git a/package-lock.json b/package-lock.json index fbea68d904..ab31bcac60 100644 --- a/package-lock.json +++ b/package-lock.json @@ -34741,7 +34741,7 @@ "version": "0.0.1", "license": "Apache-2.0", "dependencies": { - "@opentelemetry/sdk-logs": "0.57.2" + "@opentelemetry/sdk-logs": "^0.200.0" }, "devDependencies": { "@opentelemetry/api": "^1.0.0", @@ -34750,7 +34750,7 @@ "expect": "29.2.0", "nyc": "15.1.0", "rimraf": "5.0.10", - "typescript": "4.4.4" + "typescript": "5.0.4" }, "engines": { "node": "^18.19.0 || >=20.6.0" @@ -34759,70 +34759,6 @@ "@opentelemetry/api": "^1.0.0" } }, - "packages/baggage-log-record-processor/node_modules/@opentelemetry/api-logs": { - "version": "0.57.2", - "resolved": "https://registry.npmjs.org/@opentelemetry/api-logs/-/api-logs-0.57.2.tgz", - "integrity": "sha512-uIX52NnTM0iBh84MShlpouI7UKqkZ7MrUszTmaypHBu4r7NofznSnQRfJ+uUeDtQDj6w8eFGg5KBLDAwAPz1+A==", - "dependencies": { - "@opentelemetry/api": "^1.3.0" - }, - "engines": { - "node": ">=14" - } - }, - "packages/baggage-log-record-processor/node_modules/@opentelemetry/core": { - "version": "1.30.1", - "resolved": "https://registry.npmjs.org/@opentelemetry/core/-/core-1.30.1.tgz", - "integrity": "sha512-OOCM2C/QIURhJMuKaekP3TRBxBKxG/TWWA0TL2J6nXUtDnuCtccy49LUJF8xPFXMX+0LMcxFpCo8M9cGY1W6rQ==", - "dependencies": { - "@opentelemetry/semantic-conventions": "1.28.0" - }, - "engines": { - "node": ">=14" - }, - "peerDependencies": { - "@opentelemetry/api": ">=1.0.0 <1.10.0" - } - }, - "packages/baggage-log-record-processor/node_modules/@opentelemetry/resources": { - "version": "1.30.1", - "resolved": "https://registry.npmjs.org/@opentelemetry/resources/-/resources-1.30.1.tgz", - "integrity": "sha512-5UxZqiAgLYGFjS4s9qm5mBVo433u+dSPUFWVWXmLAD4wB65oMCoXaJP1KJa9DIYYMeHu3z4BZcStG3LC593cWA==", - "dependencies": { - "@opentelemetry/core": "1.30.1", - "@opentelemetry/semantic-conventions": "1.28.0" - }, - "engines": { - "node": ">=14" - }, - "peerDependencies": { - "@opentelemetry/api": ">=1.0.0 <1.10.0" - } - }, - "packages/baggage-log-record-processor/node_modules/@opentelemetry/sdk-logs": { - "version": "0.57.2", - "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-logs/-/sdk-logs-0.57.2.tgz", - "integrity": "sha512-TXFHJ5c+BKggWbdEQ/inpgIzEmS2BGQowLE9UhsMd7YYlUfBQJ4uax0VF/B5NYigdM/75OoJGhAV3upEhK+3gg==", - "dependencies": { - "@opentelemetry/api-logs": "0.57.2", - "@opentelemetry/core": "1.30.1", - "@opentelemetry/resources": "1.30.1" - }, - "engines": { - "node": ">=14" - }, - "peerDependencies": { - "@opentelemetry/api": ">=1.4.0 <1.10.0" - } - }, - "packages/baggage-log-record-processor/node_modules/@opentelemetry/semantic-conventions": { - "version": "1.28.0", - "resolved": "https://registry.npmjs.org/@opentelemetry/semantic-conventions/-/semantic-conventions-1.28.0.tgz", - "integrity": "sha512-lp4qAiMTD4sNWW4DbKLBkfiMZ4jbAboJIGOQr5DvciMRI494OapieI9qiODpOt0XBr1LjIDy1xAGAnVs5supTA==", - "engines": { - "node": ">=14" - } - }, "packages/baggage-log-record-processor/node_modules/@types/node": { "version": "18.18.14", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", @@ -34832,19 +34768,6 @@ "undici-types": "~5.26.4" } }, - "packages/baggage-log-record-processor/node_modules/typescript": { - "version": "4.4.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", - "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", - "dev": true, - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=4.2.0" - } - }, "packages/baggage-span-processor": { "name": "@opentelemetry/baggage-span-processor", "version": "0.4.0", @@ -35778,31 +35701,6 @@ "@opentelemetry/api": "^1.3.0" } }, - "plugins/node/opentelemetry-instrumentation-aws-sdk/node_modules/@aws-sdk/types": { - "version": "3.370.0", - "resolved": "https://registry.npmjs.org/@aws-sdk/types/-/types-3.370.0.tgz", - "integrity": "sha512-8PGMKklSkRKjunFhzM2y5Jm0H2TBu7YRNISdYzXLUHKSP9zlMEYagseKVdmox0zKHf1LXVNuSlUV2b6SRrieCQ==", - "dev": true, - "dependencies": { - "@smithy/types": "^1.1.0", - "tslib": "^2.5.0" - }, - "engines": { - "node": ">=14.0.0" - } - }, - "plugins/node/opentelemetry-instrumentation-aws-sdk/node_modules/@smithy/types": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/@smithy/types/-/types-1.2.0.tgz", - "integrity": "sha512-z1r00TvBqF3dh4aHhya7nz1HhvCg4TRmw51fjMrh5do3h+ngSstt/yKlNbHeb9QxJmFbmN8KEVSWgb1bRvfEoA==", - "dev": true, - "dependencies": { - "tslib": "^2.5.0" - }, - "engines": { - "node": ">=14.0.0" - } - }, "plugins/node/opentelemetry-instrumentation-aws-sdk/node_modules/@types/node": { "version": "18.18.14", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", @@ -44053,55 +43951,15 @@ "version": "file:packages/baggage-log-record-processor", "requires": { "@opentelemetry/api": "^1.0.0", - "@opentelemetry/sdk-logs": "0.57.2", + "@opentelemetry/sdk-logs": "^0.200.0", "@types/mocha": "10.0.10", "@types/node": "18.18.14", "expect": "29.2.0", "nyc": "15.1.0", "rimraf": "5.0.10", - "typescript": "4.4.4" + "typescript": "5.0.4" }, "dependencies": { - "@opentelemetry/api-logs": { - "version": "0.57.2", - "resolved": "https://registry.npmjs.org/@opentelemetry/api-logs/-/api-logs-0.57.2.tgz", - "integrity": "sha512-uIX52NnTM0iBh84MShlpouI7UKqkZ7MrUszTmaypHBu4r7NofznSnQRfJ+uUeDtQDj6w8eFGg5KBLDAwAPz1+A==", - "requires": { - "@opentelemetry/api": "^1.3.0" - } - }, - "@opentelemetry/core": { - "version": "1.30.1", - "resolved": "https://registry.npmjs.org/@opentelemetry/core/-/core-1.30.1.tgz", - "integrity": "sha512-OOCM2C/QIURhJMuKaekP3TRBxBKxG/TWWA0TL2J6nXUtDnuCtccy49LUJF8xPFXMX+0LMcxFpCo8M9cGY1W6rQ==", - "requires": { - "@opentelemetry/semantic-conventions": "1.28.0" - } - }, - "@opentelemetry/resources": { - "version": "1.30.1", - "resolved": "https://registry.npmjs.org/@opentelemetry/resources/-/resources-1.30.1.tgz", - "integrity": "sha512-5UxZqiAgLYGFjS4s9qm5mBVo433u+dSPUFWVWXmLAD4wB65oMCoXaJP1KJa9DIYYMeHu3z4BZcStG3LC593cWA==", - "requires": { - "@opentelemetry/core": "1.30.1", - "@opentelemetry/semantic-conventions": "1.28.0" - } - }, - "@opentelemetry/sdk-logs": { - "version": "0.57.2", - "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-logs/-/sdk-logs-0.57.2.tgz", - "integrity": "sha512-TXFHJ5c+BKggWbdEQ/inpgIzEmS2BGQowLE9UhsMd7YYlUfBQJ4uax0VF/B5NYigdM/75OoJGhAV3upEhK+3gg==", - "requires": { - "@opentelemetry/api-logs": "0.57.2", - "@opentelemetry/core": "1.30.1", - "@opentelemetry/resources": "1.30.1" - } - }, - "@opentelemetry/semantic-conventions": { - "version": "1.28.0", - "resolved": "https://registry.npmjs.org/@opentelemetry/semantic-conventions/-/semantic-conventions-1.28.0.tgz", - "integrity": "sha512-lp4qAiMTD4sNWW4DbKLBkfiMZ4jbAboJIGOQr5DvciMRI494OapieI9qiODpOt0XBr1LjIDy1xAGAnVs5supTA==" - }, "@types/node": { "version": "18.18.14", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", @@ -44110,12 +43968,6 @@ "requires": { "undici-types": "~5.26.4" } - }, - "typescript": { - "version": "4.4.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", - "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", - "dev": true } } }, @@ -44536,25 +44388,6 @@ "typescript": "5.0.4" }, "dependencies": { - "@aws-sdk/types": { - "version": "3.370.0", - "resolved": "https://registry.npmjs.org/@aws-sdk/types/-/types-3.370.0.tgz", - "integrity": "sha512-8PGMKklSkRKjunFhzM2y5Jm0H2TBu7YRNISdYzXLUHKSP9zlMEYagseKVdmox0zKHf1LXVNuSlUV2b6SRrieCQ==", - "dev": true, - "requires": { - "@smithy/types": "^1.1.0", - "tslib": "^2.5.0" - } - }, - "@smithy/types": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/@smithy/types/-/types-1.2.0.tgz", - "integrity": "sha512-z1r00TvBqF3dh4aHhya7nz1HhvCg4TRmw51fjMrh5do3h+ngSstt/yKlNbHeb9QxJmFbmN8KEVSWgb1bRvfEoA==", - "dev": true, - "requires": { - "tslib": "^2.5.0" - } - }, "@types/node": { "version": "18.18.14", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", From 15e5e464c0c43a5667fc5fa879e934ebb9bf5e98 Mon Sep 17 00:00:00 2001 From: maryliag Date: Wed, 19 Mar 2025 12:42:06 -0400 Subject: [PATCH 11/12] add dependencies back --- package-lock.json | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/package-lock.json b/package-lock.json index ab31bcac60..bc78068554 100644 --- a/package-lock.json +++ b/package-lock.json @@ -35701,6 +35701,31 @@ "@opentelemetry/api": "^1.3.0" } }, + "plugins/node/opentelemetry-instrumentation-aws-sdk/node_modules/@aws-sdk/types": { + "version": "3.370.0", + "resolved": "https://registry.npmjs.org/@aws-sdk/types/-/types-3.370.0.tgz", + "integrity": "sha512-8PGMKklSkRKjunFhzM2y5Jm0H2TBu7YRNISdYzXLUHKSP9zlMEYagseKVdmox0zKHf1LXVNuSlUV2b6SRrieCQ==", + "dev": true, + "dependencies": { + "@smithy/types": "^1.1.0", + "tslib": "^2.5.0" + }, + "engines": { + "node": ">=14.0.0" + } + }, + "plugins/node/opentelemetry-instrumentation-aws-sdk/node_modules/@smithy/types": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@smithy/types/-/types-1.2.0.tgz", + "integrity": "sha512-z1r00TvBqF3dh4aHhya7nz1HhvCg4TRmw51fjMrh5do3h+ngSstt/yKlNbHeb9QxJmFbmN8KEVSWgb1bRvfEoA==", + "dev": true, + "dependencies": { + "tslib": "^2.5.0" + }, + "engines": { + "node": ">=14.0.0" + } + }, "plugins/node/opentelemetry-instrumentation-aws-sdk/node_modules/@types/node": { "version": "18.18.14", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", @@ -44388,6 +44413,25 @@ "typescript": "5.0.4" }, "dependencies": { + "@aws-sdk/types": { + "version": "3.370.0", + "resolved": "https://registry.npmjs.org/@aws-sdk/types/-/types-3.370.0.tgz", + "integrity": "sha512-8PGMKklSkRKjunFhzM2y5Jm0H2TBu7YRNISdYzXLUHKSP9zlMEYagseKVdmox0zKHf1LXVNuSlUV2b6SRrieCQ==", + "dev": true, + "requires": { + "@smithy/types": "^1.1.0", + "tslib": "^2.5.0" + } + }, + "@smithy/types": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@smithy/types/-/types-1.2.0.tgz", + "integrity": "sha512-z1r00TvBqF3dh4aHhya7nz1HhvCg4TRmw51fjMrh5do3h+ngSstt/yKlNbHeb9QxJmFbmN8KEVSWgb1bRvfEoA==", + "dev": true, + "requires": { + "tslib": "^2.5.0" + } + }, "@types/node": { "version": "18.18.14", "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", From 3ece9a4b6a35c834650644de798ad0dcde105553 Mon Sep 17 00:00:00 2001 From: maryliag Date: Thu, 27 Mar 2025 08:57:00 -0400 Subject: [PATCH 12/12] update text --- packages/baggage-log-record-processor/README.md | 2 +- packages/baggage-log-record-processor/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/baggage-log-record-processor/README.md b/packages/baggage-log-record-processor/README.md index bbf5c4525b..52403ad398 100644 --- a/packages/baggage-log-record-processor/README.md +++ b/packages/baggage-log-record-processor/README.md @@ -1,4 +1,4 @@ -# OpenTelemetry Baggage Log Record Processor for Node.js +# OpenTelemetry Baggage Log Record Processor [![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-url] diff --git a/packages/baggage-log-record-processor/package.json b/packages/baggage-log-record-processor/package.json index ae21ed0a3e..56aa2cb894 100644 --- a/packages/baggage-log-record-processor/package.json +++ b/packages/baggage-log-record-processor/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/baggage-log-record-processor", "version": "0.0.1", - "description": "OpenTelemetry Baggage Log Record Processor for Node.js", + "description": "OpenTelemetry Baggage Log Record Processor", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js-contrib",