Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: adopt opentelemetry-propagator-jaeger #1931

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
5131ee6
Move jaeger propagator to propagators folder
dyladan Apr 17, 2020
e29e3dd
chore: fix build and link
dyladan Apr 17, 2020
c63d7af
chore: force ci build
dyladan Apr 17, 2020
9a950db
chore: 0.7.0 release proposal
mayurkale22 Apr 19, 2020
a0b0a37
chore: enable declaration map to allow jumping through packages
legendecas Apr 28, 2020
c629239
chore: bump otel dependencies to 0.8.0
dyladan May 13, 2020
77c6c4d
chore: bump dependency to be explicitly 8.3
dyladan May 29, 2020
6b7723c
chore: 0.8.0 release proposal
dyladan May 29, 2020
79fc32e
chore: update version.ts files
dyladan May 29, 2020
7bd4c82
chore(deps): pin dependencies
renovate-bot Jun 9, 2020
b39799b
chore(deps): update dependency @types/webpack-env to v1.15.2
renovate-bot Jun 9, 2020
e7b96ff
chore(deps): update dependency @types/node to v12.12.47
renovate-bot Jun 9, 2020
7f7c34a
chore(deps): update dependency gts to v2
renovate-bot Jun 9, 2020
563e8a8
chore(deps): update dependency karma to v5
renovate-bot Jun 9, 2020
b19cc22
chore(deps): update dependency karma-coverage-istanbul-reporter to v3
renovate-bot Jun 9, 2020
19e5523
chore(deps): update dependency karma-mocha to v2
renovate-bot Jun 10, 2020
44ca1a0
chore(deps): update dependency sinon to v9
renovate-bot Jun 10, 2020
2a7f003
chore(deps): update dependency ts-loader to v7
renovate-bot Jun 10, 2020
38457c4
chore(deps): update dependency ts-mocha to v7
renovate-bot Jun 10, 2020
3720ecc
chore(deps): update dependency typescript to v3.9.5
renovate-bot Jun 10, 2020
6e6c0fb
Update dependency karma to v5.1.0
renovate-bot Jun 11, 2020
acc418f
Update opentelemetry monorepo to ^0.9.0
renovate-bot Jun 18, 2020
b97f6eb
chore: setting up linter for propagators
rezakrimi Jun 25, 2020
a2bf076
chore: adding browser linting settings for jeaeger propagator
rezakrimi Jun 25, 2020
61c0c7b
chore(deps): update dependency typescript to v3.9.6
renovate-bot Jul 1, 2020
543e974
chore(deps): update dependency ts-loader to v8
renovate-bot Jul 8, 2020
bfb5a71
style: running npm run lint:fix on all packages
rezakrimi Jul 10, 2020
4214629
fix: fixing some of the linting issues & versions script
rezakrimi Jul 13, 2020
cb50cfe
chore: bump codecov
dyladan Jul 21, 2020
2354a5c
chore: bump opentelemetry core dependencies
dyladan Jul 30, 2020
de938f8
chore: 0.9.0 proposal
dyladan Aug 3, 2020
8718dc9
fix: new version with TextMapPropagator interface (#196)
jufab Sep 7, 2020
256b5a2
v0.10.0 proposal (#199)
obecny Sep 9, 2020
852619e
chore(deps): update dependency ts-node to v9 (#185)
renovate-bot Sep 30, 2020
36057e0
chore: bump core dependencies
dyladan Oct 28, 2020
662a8ba
chore: release 0.11.0 proposal
dyladan Oct 30, 2020
f099a74
fix: missing .fields() method in jaeger propagator (#268)
jtmalinowski Dec 8, 2020
266cfd1
chore(deps): update dependency ts-mocha to v8 (#237)
renovate-bot Dec 14, 2020
d05e954
updating to core v.0.13.0 (#277)
obecny Dec 17, 2020
1a88a53
chore: update to OTel v0.14.0 (#283)
Flarna Dec 18, 2020
a6fd423
chore: 0.12.0 proposal (#287)
obecny Dec 21, 2020
5aa49d1
chore: v0.12.1 proposal
dyladan Jan 14, 2021
c8a9390
chore: update to otel 0.15.0
Flarna Jan 22, 2021
1fcc95d
chore: update to OTel 0.15.0
Flarna Jan 22, 2021
b053e82
chore: version 0.13.0
dyladan Jan 22, 2021
a1c5dca
chore: change links to point to main
dyladan Jan 27, 2021
cebf93c
chore: update typescript to 4.x and gts to 3.x (#336)
Flarna Feb 9, 2021
98e77d2
chore: 0.13.1 proposal
dyladan Feb 10, 2021
1ac0346
chore: update version.ts files
dyladan Feb 10, 2021
b864d7f
fix: linting errors in jaeger propagator README
jtmalinowski Feb 23, 2021
41942df
chore: align jaeger propagator with latest release
jtmalinowski Mar 8, 2021
047f7c2
fix: adapt propagator-jaeger to core structure
jtmalinowski Mar 28, 2021
2d73ee3
Merge remote-tracking branch 'upstream/main' into chore/adopt-jaeger-…
jtmalinowski Mar 28, 2021
f92a2db
chore: upgrade dependencies in propagator-jaeger
jtmalinowski Mar 28, 2021
550ae3f
Merge branch 'main' into chore/adopt-jaeger-propagator
dyladan Mar 29, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/opentelemetry-propagator-jaeger/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
build
8 changes: 8 additions & 0 deletions packages/opentelemetry-propagator-jaeger/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
"env": {
"mocha": true,
"commonjs": true,
"browser": true,
},
...require('../../eslint.config.js')
}
201 changes: 201 additions & 0 deletions packages/opentelemetry-propagator-jaeger/LICENSE
Original file line number Diff line number Diff line change
@@ -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.
61 changes: 61 additions & 0 deletions packages/opentelemetry-propagator-jaeger/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# OpenTelemetry Propagator Jaeger

[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Apache License][license-image]][license-image]

OpenTelemetry Jaeger propagator provides HTTP header propagation for systems that are using Jaeger HTTP header format.

Format:
{trace-id}:{span-id}:{parent-span-id}:{flags}

* {trace-id}
* 64-bit or 128-bit random number in base16 format.
* Can be variable length, shorter values are 0-padded on the left.
* Value of 0 is invalid.

* {span-id}
* 64-bit random number in base16 format.

* {parent-span-id}
* Set to 0 because this field is deprecated.
* {flags}
* One byte bitmap, as two hex digits.

Example of usage:

```javascript
const { NodeTracerProvider } = require('@opentelemetry/node');
const { JaegerHttpTracePropagator } = require('@opentelemetry/propagator-jaeger');

const provider = new NodeTracerProvider();
provider.register({
// Use Jaeger propagator
propagator: new JaegerHttpTracePropagator()
});
```

## Trace on Jaeger UI

![example image](jaeger-tracing.png)

## Useful links

* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
* For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
* For help or feedback on this project, join us in [GitHub Discussions][discussions-url]

## License

Apache 2.0 - See [LICENSE][license-url] for more information.

[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-propagator-jaeger
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-propagator-jaeger
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-propagator-jaeger
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-propagator-jaeger&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/propagator-jaeger
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fpropagator-jaeger.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions packages/opentelemetry-propagator-jaeger/karma.conf.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*!
* Copyright The OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

const karmaWebpackConfig = require('../../karma.webpack');
const karmaBaseConfig = require('../../karma.base');

module.exports = (config) => {
config.set(Object.assign({}, karmaBaseConfig, {
webpack: karmaWebpackConfig,
}))
};
73 changes: 73 additions & 0 deletions packages/opentelemetry-propagator-jaeger/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{
"name": "@opentelemetry/propagator-jaeger",
"version": "0.18.0",
"description": "OpenTelemetry Jaeger propagator provides HTTP header propagation for systems that are using Jaeger HTTP header format.",
"main": "build/src/index.js",
"types": "build/src/index.d.ts",
"repository": "open-telemetry/opentelemetry-js",
"scripts": {
"compile": "tsc --build",
"test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts' --exclude 'test/index-webpack.ts'",
"test:browser": "nyc karma start --single-run",
"tdd": "npm run tdd:node",
"tdd:node": "npm run test -- --watch-extensions ts --watch",
"tdd:browser": "karma start",
"codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
"clean": "tsc --build --clean",
"lint": "eslint . --ext .ts",
"lint:fix": "eslint . --ext .ts --fix",
"version": "node ../../scripts/version-update.js",
"watch": "tsc --build --watch"
},
"keywords": [
"opentelemetry",
"nodejs",
"tracing",
"profiling",
"jaeger"
],
"author": "OpenTelemetry Authors",
"license": "Apache-2.0",
"engines": {
"node": ">=8.5.0"
},
"files": [
"build/src/**/*.js",
"build/src/**/*.js.map",
"build/src/**/*.d.ts",
Flarna marked this conversation as resolved.
Show resolved Hide resolved
"doc",
"LICENSE",
"README.md"
],
"publishConfig": {
"access": "public"
},
"devDependencies": {
"@types/mocha": "8.2.2",
"@types/node": "14.14.35",
"@types/sinon": "9.0.11",
"@types/webpack-env": "1.16.0",
"codecov": "3.8.1",
"gts": "3.1.0",
"istanbul-instrumenter-loader": "3.0.1",
"karma": "5.2.3",
"karma-chrome-launcher": "3.1.0",
"karma-coverage-istanbul-reporter": "3.0.3",
"karma-mocha": "2.0.1",
"karma-spec-reporter": "0.0.32",
"karma-webpack": "4.0.2",
"mocha": "7.2.0",
"nyc": "15.1.0",
"rimraf": "3.0.2",
"sinon": "9.2.4",
"ts-loader": "8.0.18",
"ts-mocha": "8.0.0",
"ts-node": "9.1.1",
"typescript": "4.2.3",
"webpack": "4.46.0"
},
"dependencies": {
"@opentelemetry/api": "^0.18.0",
"@opentelemetry/core": "^0.18.0"
}
}
Loading