diff --git a/.github/component_owners.yml b/.github/component_owners.yml
index cafc2a7065..210413659d 100644
--- a/.github/component_owners.yml
+++ b/.github/component_owners.yml
@@ -27,6 +27,9 @@ components:
- pichlermarc
- legendecas
- blumamir
+ packages/baggage-span-processor:
+ - mikegoldsmith
+ - jamiedanielson
packages/opentelemetry-host-metrics:
- legendecas
packages/opentelemetry-id-generator-aws-xray:
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
index eb6cd74761..43ec74b8a0 100644
--- a/.release-please-manifest.json
+++ b/.release-please-manifest.json
@@ -8,6 +8,7 @@
"detectors/node/opentelemetry-resource-detector-instana": "0.9.0",
"metapackages/auto-instrumentations-node": "0.46.0",
"metapackages/auto-instrumentations-web": "0.39.0",
+ "packages/baggage-span-processor": "0.1.0",
"packages/opentelemetry-host-metrics": "0.35.1",
"packages/opentelemetry-id-generator-aws-xray": "1.2.2",
"packages/opentelemetry-propagation-utils": "0.30.9",
diff --git a/package-lock.json b/package-lock.json
index a5edc671e2..17021fa231 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -8898,6 +8898,10 @@
"resolved": "metapackages/auto-instrumentations-web",
"link": true
},
+ "node_modules/@opentelemetry/baggage-span-processor": {
+ "resolved": "packages/baggage-span-processor",
+ "link": true
+ },
"node_modules/@opentelemetry/context-async-hooks": {
"version": "1.24.0",
"resolved": "https://registry.npmjs.org/@opentelemetry/context-async-hooks/-/context-async-hooks-1.24.0.tgz",
@@ -37267,6 +37271,38 @@
"tslib": "^2.0.0"
}
},
+ "packages/baggage-span-processor": {
+ "name": "@opentelemetry/baggage-span-processor",
+ "version": "0.1.0",
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@opentelemetry/api": "^1.0.0",
+ "@opentelemetry/sdk-trace-base": "^1.0.0"
+ },
+ "devDependencies": {
+ "@opentelemetry/api": "^1.3.0",
+ "@types/mocha": "8.2.3",
+ "@types/node": "18.6.5",
+ "expect": "29.2.0",
+ "mocha": "7.2.0",
+ "nyc": "15.1.0",
+ "rimraf": "5.0.5",
+ "ts-mocha": "10.0.0",
+ "typescript": "4.4.4"
+ },
+ "engines": {
+ "node": ">=14"
+ },
+ "peerDependencies": {
+ "@opentelemetry/api": "^1.0.0"
+ }
+ },
+ "packages/baggage-span-processor/node_modules/@types/mocha": {
+ "version": "8.2.3",
+ "resolved": "https://registry.npmjs.org/@types/mocha/-/mocha-8.2.3.tgz",
+ "integrity": "sha512-ekGvFhFgrc2zYQoX4JeZPmVzZxw6Dtllga7iGHzfbYIYkAMUx/sAFP2GdFpLff+vdHXu5fl7WX9AT+TtqYcsyw==",
+ "dev": true
+ },
"packages/opentelemetry-host-metrics": {
"name": "@opentelemetry/host-metrics",
"version": "0.35.1",
@@ -46817,6 +46853,29 @@
}
}
},
+ "@opentelemetry/baggage-span-processor": {
+ "version": "file:packages/baggage-span-processor",
+ "requires": {
+ "@opentelemetry/api": "^1.3.0",
+ "@opentelemetry/sdk-trace-base": "^1.0.0",
+ "@types/mocha": "8.2.3",
+ "@types/node": "18.6.5",
+ "expect": "29.2.0",
+ "mocha": "7.2.0",
+ "nyc": "15.1.0",
+ "rimraf": "5.0.5",
+ "ts-mocha": "10.0.0",
+ "typescript": "4.4.4"
+ },
+ "dependencies": {
+ "@types/mocha": {
+ "version": "8.2.3",
+ "resolved": "https://registry.npmjs.org/@types/mocha/-/mocha-8.2.3.tgz",
+ "integrity": "sha512-ekGvFhFgrc2zYQoX4JeZPmVzZxw6Dtllga7iGHzfbYIYkAMUx/sAFP2GdFpLff+vdHXu5fl7WX9AT+TtqYcsyw==",
+ "dev": true
+ }
+ }
+ },
"@opentelemetry/context-async-hooks": {
"version": "1.24.0",
"resolved": "https://registry.npmjs.org/@opentelemetry/context-async-hooks/-/context-async-hooks-1.24.0.tgz",
diff --git a/packages/baggage-span-processor/.eslintignore b/packages/baggage-span-processor/.eslintignore
new file mode 100644
index 0000000000..378eac25d3
--- /dev/null
+++ b/packages/baggage-span-processor/.eslintignore
@@ -0,0 +1 @@
+build
diff --git a/packages/baggage-span-processor/.eslintrc.js b/packages/baggage-span-processor/.eslintrc.js
new file mode 100644
index 0000000000..f726f3becb
--- /dev/null
+++ b/packages/baggage-span-processor/.eslintrc.js
@@ -0,0 +1,7 @@
+module.exports = {
+ "env": {
+ "mocha": true,
+ "node": true
+ },
+ ...require('../../eslint.config.js')
+}
diff --git a/packages/baggage-span-processor/CHANGELOG.md b/packages/baggage-span-processor/CHANGELOG.md
new file mode 100644
index 0000000000..bb2d503c69
--- /dev/null
+++ b/packages/baggage-span-processor/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+Initial version.
diff --git a/packages/baggage-span-processor/LICENSE b/packages/baggage-span-processor/LICENSE
new file mode 100644
index 0000000000..261eeb9e9f
--- /dev/null
+++ b/packages/baggage-span-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-span-processor/README.md b/packages/baggage-span-processor/README.md
new file mode 100644
index 0000000000..913abdba9d
--- /dev/null
+++ b/packages/baggage-span-processor/README.md
@@ -0,0 +1,63 @@
+# OpenTelemetry Baggage Span Processor for Node.js
+
+[![NPM Published Version][npm-img]][npm-url]
+[![Apache License][license-image]][license-url]
+
+The BaggageSpanProcessor 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 span as attributes on span start.
+
+Add this span processor to a tracer provider.
+
+Keys and values added to Baggage will appear on subsequent child spans for a trace within this service *and* be propagated to external services in accordance with any configured propagation formats configured.
+If the external services also have a Baggage span processor, the keys and values will appear in those child spans as well.
+
+⚠ 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-span-processor
+```
+
+### Usage
+
+Add to the span processors during configuration:
+
+```javascript
+import { NodeSDK, tracing } from "@opentelemetry/sdk-node";
+import { BaggageSpanProcessor } from "@opentelemetry/baggage-span-processor";
+
+const spanProcessors = [
+ new tracing.SimpleSpanProcessor(
+ new tracing.ConsoleSpanExporter()),
+ new BaggageSpanProcessor()];
+
+const sdk = new NodeSDK({
+ serviceName: "example-service",
+ spanProcessors
+});
+
+sdk.start();
+```
+
+## 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/host-metrics
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fhost-metrics.svg
diff --git a/packages/baggage-span-processor/package.json b/packages/baggage-span-processor/package.json
new file mode 100644
index 0000000000..ca10dfb792
--- /dev/null
+++ b/packages/baggage-span-processor/package.json
@@ -0,0 +1,59 @@
+{
+ "name": "@opentelemetry/baggage-span-processor",
+ "version": "0.1.0",
+ "description": "OpenTelemetry Baggage Span Processor for Node.js",
+ "main": "build/src/index.ts",
+ "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",
+ "precompile": "tsc --version && lerna run version:update --scope @opentelemetry/baggage-span-processor --include-dependencies",
+ "prewatch": "npm run precompile",
+ "prepublishOnly": "npm run compile",
+ "tdd": "npm run test -- --watch-extensions ts --watch",
+ "test": "nyc ts-mocha -p tsconfig.json test/**/*.test.ts",
+ "version:update": "node ../../scripts/version-update.js",
+ "watch": "tsc -w"
+ },
+ "keywords": [
+ "opentelemetry",
+ "nodejs",
+ "tracing",
+ "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.6.5",
+ "expect": "29.2.0",
+ "mocha": "7.2.0",
+ "nyc": "15.1.0",
+ "rimraf": "5.0.5",
+ "ts-mocha": "10.0.0",
+ "typescript": "4.4.4"
+ },
+ "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/baggage-span-processor#readme"
+}
diff --git a/packages/baggage-span-processor/src/baggage-span-processor.ts b/packages/baggage-span-processor/src/baggage-span-processor.ts
new file mode 100644
index 0000000000..13d3c84260
--- /dev/null
+++ b/packages/baggage-span-processor/src/baggage-span-processor.ts
@@ -0,0 +1,84 @@
+/*
+ * 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, propagation } from '@opentelemetry/api';
+import {
+ SpanProcessor,
+ Span,
+ ReadableSpan,
+} from '@opentelemetry/sdk-trace-base';
+
+/**
+ * BaggageSpanProcessor is a {@link SpanProcessor} that reads entries stored in {@link Baggage}
+ * from the parent context and adds the baggage entries' keys and
+ * values to the span as attributes on span start.
+ *
+ * Add this span processor to a tracer provider.
+ *
+ * Keys and values added to Baggage will appear on subsequent child
+ * spans for a trace within this service *and* be propagated to external
+ * services in accordance with any configured propagation formats
+ * configured. If the external services also have a Baggage span
+ * processor, the keys and values will appear in those child spans as
+ * well.
+ *
+ * ⚠ 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 BaggageSpanProcessor implements SpanProcessor {
+ /**
+ * Forces to export all finished spans
+ */
+ forceFlush(): Promise {
+ // no-op
+ return Promise.resolve();
+ }
+
+ /**
+ * 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 {
+ (propagation.getBaggage(parentContext)?.getAllEntries() ?? []).forEach(
+ entry => {
+ span.setAttribute(entry[0], entry[1].value);
+ }
+ );
+ }
+
+ /**
+ * 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.
+ */
+ shutdown(): Promise {
+ // no-op
+ return Promise.resolve();
+ }
+}
diff --git a/packages/baggage-span-processor/src/index.ts b/packages/baggage-span-processor/src/index.ts
new file mode 100644
index 0000000000..39e175e9b3
--- /dev/null
+++ b/packages/baggage-span-processor/src/index.ts
@@ -0,0 +1,17 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { BaggageSpanProcessor } from './baggage-span-processor';
diff --git a/packages/baggage-span-processor/test/baggage-span-processor.test.ts b/packages/baggage-span-processor/test/baggage-span-processor.test.ts
new file mode 100644
index 0000000000..2829858ab1
--- /dev/null
+++ b/packages/baggage-span-processor/test/baggage-span-processor.test.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 { BaggageSpanProcessor } from '../src/baggage-span-processor';
+import {
+ propagation,
+ ROOT_CONTEXT,
+ SpanKind,
+ TraceFlags,
+} from '@opentelemetry/api';
+import { BasicTracerProvider, Span } from '@opentelemetry/sdk-trace-base';
+import { expect } from 'expect';
+
+describe('BaggageSpanProcessor', () => {
+ const baggageProcessor = new BaggageSpanProcessor();
+
+ const bag = propagation.createBaggage({
+ brand: { value: 'samsonite' },
+ });
+
+ const expectedAttrs = {
+ brand: 'samsonite',
+ };
+
+ let span: Span;
+
+ beforeEach(() => {
+ span = new Span(
+ new BasicTracerProvider().getTracer('baggage-testing'),
+ ROOT_CONTEXT,
+ 'Edward W. Span',
+ {
+ traceId: 'e4cda95b652f4a1592b449d5929fda1b',
+ spanId: '7e0c63257de34c92',
+ traceFlags: TraceFlags.SAMPLED,
+ },
+ SpanKind.SERVER
+ );
+ });
+
+ it('onStart adds current Baggage entries to a span as attributes', () => {
+ expect(span.attributes).toEqual({});
+ const ctx = propagation.setBaggage(ROOT_CONTEXT, bag);
+
+ baggageProcessor.onStart(span, ctx);
+
+ expect(span.attributes).toEqual(expectedAttrs);
+ });
+
+ it('forceFlush is a no-op and does not throw error', async () => {
+ await expect(baggageProcessor.forceFlush()).resolves.not.toThrow();
+ });
+
+ it('onEnd is a no-op and does not throw error', async () => {
+ expect(() => baggageProcessor.onEnd(span)).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-span-processor/tsconfig.json b/packages/baggage-span-processor/tsconfig.json
new file mode 100644
index 0000000000..4078877ce6
--- /dev/null
+++ b/packages/baggage-span-processor/tsconfig.json
@@ -0,0 +1,11 @@
+{
+ "extends": "../../tsconfig.base",
+ "compilerOptions": {
+ "rootDir": ".",
+ "outDir": "build"
+ },
+ "include": [
+ "src/**/*.ts",
+ "test/**/*.ts"
+ ]
+}
diff --git a/release-please-config.json b/release-please-config.json
index 63294044ec..8142b3b582 100644
--- a/release-please-config.json
+++ b/release-please-config.json
@@ -15,6 +15,7 @@
"detectors/node/opentelemetry-resource-detector-instana": {},
"metapackages/auto-instrumentations-node": {},
"metapackages/auto-instrumentations-web": {},
+ "packages/baggage-span-processor": {},
"packages/opentelemetry-host-metrics": {},
"packages/opentelemetry-id-generator-aws-xray": {},
"packages/opentelemetry-propagation-utils": {},
@@ -67,4 +68,4 @@
"propagators/opentelemetry-propagator-instana": {},
"propagators/opentelemetry-propagator-ot-trace": {}
}
-}
\ No newline at end of file
+}