Skip to content

Commit e9eb924

Browse files
martinkubapichlermarc
martinkuba
and
pichlermarc
authored
feat(web): add processors for adding session ID (#4972)
Co-authored-by: Marc Pichler <[email protected]>
1 parent 9c30124 commit e9eb924

24 files changed

+1037
-0
lines changed

‎CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ For semantic convention package changes, see the [semconv CHANGELOG](packages/se
1313

1414
### :rocket: (Enhancement)
1515

16+
* feat: add processors for adding session.id attribute to spans and logs [#4972](https://github.com/open-telemetry/opentelemetry-js/pull/4972)
17+
1618
### :bug: (Bug Fix)
1719

1820
### :books: (Refine Doc)

‎experimental/packages/web-common/.eslintignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build

‎experimental/packages/web-common/.eslintrc.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
module.exports = {
2+
env: {
3+
mocha: true,
4+
node: true,
5+
},
6+
...require('../../../eslint.base.js'),
7+
};

‎experimental/packages/web-common/.npmignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/bin
2+
/coverage
3+
/doc
4+
/test

‎experimental/packages/web-common/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎experimental/packages/web-common/README.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# OpenTelemetry Web Utils
2+
3+
[![NPM Published Version][npm-img]][npm-url]
4+
[![Apache License][license-image]][license-image]
5+
6+
**Note: This is an experimental package under active development. New releases may include breaking changes.**
7+
8+
This package contains classes and utils that are common for web use cases.
9+
10+
## Installation
11+
12+
```bash
13+
npm install --save @opentelemetry/web-common
14+
```
15+
16+
## Useful links
17+
18+
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
19+
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
20+
- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
21+
22+
## License
23+
24+
Apache 2.0 - See [LICENSE][license-url] for more information.
25+
26+
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
27+
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE
28+
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
29+
[npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-logs
30+
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fsdk%2Dlogs.svg

‎experimental/packages/web-common/karma.conf.js

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/*!
2+
* Copyright The OpenTelemetry Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
const karmaWebpackConfig = require('../../../karma.webpack');
18+
const karmaBaseConfig = require('../../../karma.base');
19+
20+
module.exports = config => {
21+
config.set(
22+
Object.assign({}, karmaBaseConfig, {
23+
webpack: karmaWebpackConfig,
24+
})
25+
);
26+
};

‎experimental/packages/web-common/package.json

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
{
2+
"name": "@opentelemetry/web-common",
3+
"version": "0.53.0",
4+
"publishConfig": {
5+
"access": "public"
6+
},
7+
"description": "Common utilities for web instrumentation",
8+
"author": "OpenTelemetry Authors",
9+
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/web-common",
10+
"license": "Apache-2.0",
11+
"main": "build/src/index.js",
12+
"module": "build/esm/index.js",
13+
"esnext": "build/esnext/index.js",
14+
"types": "build/src/index.d.ts",
15+
"repository": {
16+
"type": "git",
17+
"url": "git+https://github.com/open-telemetry/opentelemetry-js.git"
18+
},
19+
"bugs": {
20+
"url": "https://github.com/open-telemetry/opentelemetry-js/issues"
21+
},
22+
"engines": {
23+
"node": ">=14"
24+
},
25+
"scripts": {
26+
"clean": "tsc --build --clean tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
27+
"codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../",
28+
"codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../",
29+
"compile": "tsc --build tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
30+
"lint": "eslint . --ext .ts",
31+
"lint:fix": "eslint . --ext .ts --fix",
32+
"peer-api-check": "node ../../../scripts/peer-api-check.js",
33+
"prepublishOnly": "npm run compile",
34+
"precompile": "cross-var lerna run version --scope $npm_package_name --include-dependencies",
35+
"prewatch": "npm run precompile",
36+
"tdd": "npm run test -- --watch-extensions ts --watch",
37+
"tdd:browser": "karma start",
38+
"test": "nyc mocha test/**/*.test.ts",
39+
"test:browser": "karma start --single-run",
40+
"version": "node ../../../scripts/version-update.js",
41+
"watch": "tsc --build --watch tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
42+
"align-api-deps": "node ../../../scripts/align-api-deps.js"
43+
},
44+
"keywords": [
45+
"opentelemetry",
46+
"web",
47+
"tracing",
48+
"profiling",
49+
"stats",
50+
"monitoring"
51+
],
52+
"files": [
53+
"build/esm/**/*.js",
54+
"build/esm/**/*.js.map",
55+
"build/esm/**/*.d.ts",
56+
"build/esnext/**/*.js",
57+
"build/esnext/**/*.js.map",
58+
"build/esnext/**/*.d.ts",
59+
"build/src/**/*.js",
60+
"build/src/**/*.js.map",
61+
"build/src/**/*.d.ts",
62+
"doc",
63+
"LICENSE",
64+
"README.md"
65+
],
66+
"sideEffects": false,
67+
"peerDependencies": {
68+
"@opentelemetry/api": ">=1.4.0 <1.10.0"
69+
},
70+
"dependencies": {
71+
"@opentelemetry/sdk-logs": "^0.53.0",
72+
"@opentelemetry/sdk-trace-base": "^1.26.0",
73+
"@opentelemetry/semantic-conventions": "1.27.0"
74+
},
75+
"devDependencies": {
76+
"@babel/core": "7.25.2",
77+
"@opentelemetry/api": "1.9.0",
78+
"@opentelemetry/api-events": "0.53.0",
79+
"@opentelemetry/api-logs": "0.53.0",
80+
"@types/mocha": "10.0.7",
81+
"@types/node": "18.6.5",
82+
"@types/sinon": "10.0.20",
83+
"@types/webpack-env": "1.16.3",
84+
"babel-loader": "8.3.0",
85+
"babel-plugin-istanbul": "7.0.0",
86+
"codecov": "3.8.3",
87+
"cross-var": "1.1.0",
88+
"karma": "6.4.4",
89+
"karma-chrome-launcher": "3.1.0",
90+
"karma-coverage": "2.2.1",
91+
"karma-mocha": "2.0.1",
92+
"karma-spec-reporter": "0.0.36",
93+
"karma-webpack": "5.0.1",
94+
"lerna": "6.6.2",
95+
"mocha": "10.7.3",
96+
"nyc": "15.1.0",
97+
"sinon": "15.1.2",
98+
"ts-loader": "9.5.1",
99+
"typescript": "4.4.4",
100+
"webpack": "5.94.0",
101+
"webpack-cli": "5.1.4",
102+
"webpack-merge": "5.10.0"
103+
}
104+
}

0 commit comments

Comments
 (0)