Move jaeger propagator to propagators folder
This commit is contained in:
Daniel Dyla
parent
a7075889c8
commit
05cd84d1fa
|
|
@ -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.
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
# OpenTelemetry Propagator Jaeger
|
||||
[![Gitter chat][gitter-image]][gitter-url]
|
||||
[![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
|
||||
|
||||
|
||||
|
||||
## 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 on [gitter][gitter-url]
|
||||
|
||||
## License
|
||||
|
||||
Apache 2.0 - See [LICENSE][license-url] for more information.
|
||||
|
||||
[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg
|
||||
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
||||
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/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
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 60 KiB |
|
|
@ -0,0 +1,24 @@
|
|||
/*!
|
||||
* Copyright 2020, 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
|
||||
}))
|
||||
};
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
{
|
||||
"name": "@opentelemetry/propagator-jaeger",
|
||||
"version": "0.6.1",
|
||||
"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": {
|
||||
"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": "rimraf build/*",
|
||||
"lint": "gts check",
|
||||
"lint:fix": "gts fix",
|
||||
"precompile": "tsc --version",
|
||||
"compile": "npm run version:update && tsc -p .",
|
||||
"prepare": "npm run compile",
|
||||
"version:update": "node ../../scripts/version-update.js",
|
||||
"watch": "tsc -w"
|
||||
},
|
||||
"keywords": [
|
||||
"opentelemetry",
|
||||
"nodejs",
|
||||
"tracing",
|
||||
"profiling",
|
||||
"jaeger"
|
||||
],
|
||||
"author": "OpenTelemetry Authors",
|
||||
"license": "Apache-2.0",
|
||||
"engines": {
|
||||
"node": ">=8.0.0"
|
||||
},
|
||||
"files": [
|
||||
"build/src/**/*.js",
|
||||
"build/src/**/*.d.ts",
|
||||
"doc",
|
||||
"LICENSE",
|
||||
"README.md"
|
||||
],
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/mocha": "^7.0.0",
|
||||
"@types/node": "^12.6.8",
|
||||
"@types/sinon": "^7.0.13",
|
||||
"@types/webpack-env": "1.13.9",
|
||||
"codecov": "^3.6.1",
|
||||
"gts": "^1.1.0",
|
||||
"istanbul-instrumenter-loader": "^3.0.1",
|
||||
"karma": "^4.4.1",
|
||||
"karma-chrome-launcher": "^3.1.0",
|
||||
"karma-coverage-istanbul-reporter": "^2.1.0",
|
||||
"karma-mocha": "^1.3.0",
|
||||
"karma-spec-reporter": "^0.0.32",
|
||||
"karma-webpack": "^4.0.2",
|
||||
"mocha": "^6.1.0",
|
||||
"nyc": "^15.0.0",
|
||||
"rimraf": "^3.0.0",
|
||||
"sinon": "^7.5.0",
|
||||
"ts-loader": "^6.0.4",
|
||||
"ts-mocha": "^6.0.0",
|
||||
"ts-node": "^8.6.2",
|
||||
"tslint-consistent-codestyle": "^1.16.0",
|
||||
"tslint-microsoft-contrib": "^6.2.0",
|
||||
"typescript": "3.7.2",
|
||||
"webpack": "^4.35.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"@opentelemetry/api": "^0.6.1",
|
||||
"@opentelemetry/core": "^0.6.1"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
/*!
|
||||
* Copyright 2020, 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,
|
||||
HttpTextPropagator,
|
||||
SpanContext,
|
||||
TraceFlags,
|
||||
SetterFunction,
|
||||
GetterFunction,
|
||||
} from '@opentelemetry/api';
|
||||
import {
|
||||
getParentSpanContext,
|
||||
setExtractedSpanContext,
|
||||
} from '@opentelemetry/core';
|
||||
|
||||
export const UBER_TRACE_ID_HEADER = 'uber-trace-id';
|
||||
|
||||
/**
|
||||
* Propagates {@link SpanContext} through Trace Context format propagation.
|
||||
* {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.
|
||||
* Inspired by jaeger-client-node project.
|
||||
*/
|
||||
export class JaegerHttpTracePropagator implements HttpTextPropagator {
|
||||
private readonly _jaegerTraceHeader: string;
|
||||
|
||||
/**
|
||||
* @param {string} [customTraceHeader="uber-trace-id"] - HTTP header to inject\extract trace from.
|
||||
**/
|
||||
constructor(customTraceHeader?: string) {
|
||||
this._jaegerTraceHeader = customTraceHeader || UBER_TRACE_ID_HEADER;
|
||||
}
|
||||
|
||||
inject(context: Context, carrier: unknown, setter: SetterFunction) {
|
||||
const spanContext = getParentSpanContext(context);
|
||||
if (!spanContext) return;
|
||||
|
||||
const traceFlags = `0${(spanContext.traceFlags || TraceFlags.NONE).toString(
|
||||
16
|
||||
)}`;
|
||||
|
||||
setter(
|
||||
carrier,
|
||||
this._jaegerTraceHeader,
|
||||
`${spanContext.traceId}:${spanContext.spanId}:0:${traceFlags}`
|
||||
);
|
||||
}
|
||||
|
||||
extract(context: Context, carrier: unknown, getter: GetterFunction): Context {
|
||||
const uberTraceIdHeader = getter(carrier, this._jaegerTraceHeader);
|
||||
const uberTraceId = Array.isArray(uberTraceIdHeader)
|
||||
? uberTraceIdHeader[0]
|
||||
: uberTraceIdHeader;
|
||||
|
||||
if (typeof uberTraceId !== 'string') return context;
|
||||
|
||||
const spanContext = deserializeSpanContext(uberTraceId);
|
||||
if (!spanContext) return context;
|
||||
|
||||
return setExtractedSpanContext(context, spanContext);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} serializedString - a serialized span context.
|
||||
* @return {SpanContext} - returns a span context represented by the serializedString.
|
||||
**/
|
||||
function deserializeSpanContext(serializedString: string): SpanContext | null {
|
||||
const headers = decodeURIComponent(serializedString).split(':');
|
||||
if (headers.length !== 4) {
|
||||
return null;
|
||||
}
|
||||
const [traceId, spanId, , flags] = headers;
|
||||
|
||||
const traceFlags = flags.match(/^[0-9a-f]{2}$/i) ? parseInt(flags) & 1 : 1;
|
||||
|
||||
return { traceId, spanId, isRemote: true, traceFlags };
|
||||
}
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
/*!
|
||||
* Copyright 2020, 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 * from './JaegerHttpTracePropagator';
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
/*!
|
||||
* Copyright 2019, 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.
|
||||
*/
|
||||
|
||||
// this is autogenerated file, see scripts/version-update.js
|
||||
export const VERSION = '0.6.1';
|
||||
|
|
@ -0,0 +1,210 @@
|
|||
/*!
|
||||
* Copyright 2020, 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,
|
||||
defaultGetter,
|
||||
defaultSetter,
|
||||
SpanContext,
|
||||
TraceFlags,
|
||||
} from '@opentelemetry/api';
|
||||
import {
|
||||
getExtractedSpanContext,
|
||||
setExtractedSpanContext,
|
||||
} from '@opentelemetry/core';
|
||||
import * as assert from 'assert';
|
||||
import {
|
||||
JaegerHttpTracePropagator,
|
||||
UBER_TRACE_ID_HEADER,
|
||||
} from '../src/JaegerHttpTracePropagator';
|
||||
|
||||
describe('JaegerHttpTracePropagator', () => {
|
||||
const jaegerHttpTracePropagator = new JaegerHttpTracePropagator();
|
||||
const customHeader = 'new-header';
|
||||
const customJaegerHttpTracePropagator = new JaegerHttpTracePropagator(
|
||||
customHeader
|
||||
);
|
||||
let carrier: { [key: string]: unknown };
|
||||
|
||||
beforeEach(() => {
|
||||
carrier = {};
|
||||
});
|
||||
|
||||
describe('.inject()', () => {
|
||||
it('should set uber trace id header', () => {
|
||||
const spanContext: SpanContext = {
|
||||
traceId: 'd4cda95b652f4a1592b449d5929fda1b',
|
||||
spanId: '6e0c63257de34c92',
|
||||
traceFlags: TraceFlags.SAMPLED,
|
||||
};
|
||||
|
||||
jaegerHttpTracePropagator.inject(
|
||||
setExtractedSpanContext(Context.ROOT_CONTEXT, spanContext),
|
||||
carrier,
|
||||
defaultSetter
|
||||
);
|
||||
assert.deepStrictEqual(
|
||||
carrier[UBER_TRACE_ID_HEADER],
|
||||
'd4cda95b652f4a1592b449d5929fda1b:6e0c63257de34c92:0:01'
|
||||
);
|
||||
});
|
||||
|
||||
it('should use custom header if provided', () => {
|
||||
const spanContext: SpanContext = {
|
||||
traceId: 'd4cda95b652f4a1592b449d5929fda1b',
|
||||
spanId: '6e0c63257de34c92',
|
||||
traceFlags: TraceFlags.SAMPLED,
|
||||
};
|
||||
|
||||
customJaegerHttpTracePropagator.inject(
|
||||
setExtractedSpanContext(Context.ROOT_CONTEXT, spanContext),
|
||||
carrier,
|
||||
defaultSetter
|
||||
);
|
||||
assert.deepStrictEqual(
|
||||
carrier[customHeader],
|
||||
'd4cda95b652f4a1592b449d5929fda1b:6e0c63257de34c92:0:01'
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('.extract()', () => {
|
||||
it('should extract context of a sampled span from carrier', () => {
|
||||
carrier[UBER_TRACE_ID_HEADER] =
|
||||
'd4cda95b652f4a1592b449d5929fda1b:6e0c63257de34c92:0:01';
|
||||
const extractedSpanContext = getExtractedSpanContext(
|
||||
jaegerHttpTracePropagator.extract(
|
||||
Context.ROOT_CONTEXT,
|
||||
carrier,
|
||||
defaultGetter
|
||||
)
|
||||
);
|
||||
|
||||
assert.deepStrictEqual(extractedSpanContext, {
|
||||
spanId: '6e0c63257de34c92',
|
||||
traceId: 'd4cda95b652f4a1592b449d5929fda1b',
|
||||
isRemote: true,
|
||||
traceFlags: TraceFlags.SAMPLED,
|
||||
});
|
||||
});
|
||||
|
||||
it('should extract context of a sampled span from carrier with 1 bit flag', () => {
|
||||
carrier[UBER_TRACE_ID_HEADER] =
|
||||
'9c41e35aeb6d1272:45fd2a9709dadcf1:a13699e3fb724f40:1';
|
||||
const extractedSpanContext = getExtractedSpanContext(
|
||||
jaegerHttpTracePropagator.extract(
|
||||
Context.ROOT_CONTEXT,
|
||||
carrier,
|
||||
defaultGetter
|
||||
)
|
||||
);
|
||||
|
||||
assert.deepStrictEqual(extractedSpanContext, {
|
||||
spanId: '45fd2a9709dadcf1',
|
||||
traceId: '9c41e35aeb6d1272',
|
||||
isRemote: true,
|
||||
traceFlags: TraceFlags.SAMPLED,
|
||||
});
|
||||
});
|
||||
|
||||
it('should extract context of a sampled span from UTF-8 encoded carrier', () => {
|
||||
carrier[UBER_TRACE_ID_HEADER] =
|
||||
'ac1f3dc3c2c0b06e%3A5ac292c4a11a163e%3Ac086aaa825821068%3A1';
|
||||
const extractedSpanContext = getExtractedSpanContext(
|
||||
jaegerHttpTracePropagator.extract(
|
||||
Context.ROOT_CONTEXT,
|
||||
carrier,
|
||||
defaultGetter
|
||||
)
|
||||
);
|
||||
|
||||
assert.deepStrictEqual(extractedSpanContext, {
|
||||
spanId: '5ac292c4a11a163e',
|
||||
traceId: 'ac1f3dc3c2c0b06e',
|
||||
isRemote: true,
|
||||
traceFlags: TraceFlags.SAMPLED,
|
||||
});
|
||||
});
|
||||
|
||||
it('should use custom header if provided', () => {
|
||||
carrier[customHeader] =
|
||||
'd4cda95b652f4a1592b449d5929fda1b:6e0c63257de34c92:0:01';
|
||||
const extractedSpanContext = getExtractedSpanContext(
|
||||
customJaegerHttpTracePropagator.extract(
|
||||
Context.ROOT_CONTEXT,
|
||||
carrier,
|
||||
defaultGetter
|
||||
)
|
||||
);
|
||||
|
||||
assert.deepStrictEqual(extractedSpanContext, {
|
||||
spanId: '6e0c63257de34c92',
|
||||
traceId: 'd4cda95b652f4a1592b449d5929fda1b',
|
||||
isRemote: true,
|
||||
traceFlags: TraceFlags.SAMPLED,
|
||||
});
|
||||
});
|
||||
|
||||
it('returns undefined if UBER_TRACE_ID_HEADER header is missing', () => {
|
||||
assert.deepStrictEqual(
|
||||
getExtractedSpanContext(
|
||||
jaegerHttpTracePropagator.extract(
|
||||
Context.ROOT_CONTEXT,
|
||||
carrier,
|
||||
defaultGetter
|
||||
)
|
||||
),
|
||||
undefined
|
||||
);
|
||||
});
|
||||
|
||||
it('returns undefined if UBER_TRACE_ID_HEADER header is invalid', () => {
|
||||
carrier[UBER_TRACE_ID_HEADER] = 'invalid!';
|
||||
assert.deepStrictEqual(
|
||||
getExtractedSpanContext(
|
||||
jaegerHttpTracePropagator.extract(
|
||||
Context.ROOT_CONTEXT,
|
||||
carrier,
|
||||
defaultGetter
|
||||
)
|
||||
),
|
||||
undefined
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
it('should fail gracefully on bad responses from getter', () => {
|
||||
const ctx1 = jaegerHttpTracePropagator.extract(
|
||||
Context.ROOT_CONTEXT,
|
||||
carrier,
|
||||
(c, k) => 1 // not a number
|
||||
);
|
||||
const ctx2 = jaegerHttpTracePropagator.extract(
|
||||
Context.ROOT_CONTEXT,
|
||||
carrier,
|
||||
(c, k) => [] // empty array
|
||||
);
|
||||
const ctx3 = jaegerHttpTracePropagator.extract(
|
||||
Context.ROOT_CONTEXT,
|
||||
carrier,
|
||||
(c, k) => undefined // missing value
|
||||
);
|
||||
|
||||
assert.ok(ctx1 === Context.ROOT_CONTEXT);
|
||||
assert.ok(ctx2 === Context.ROOT_CONTEXT);
|
||||
assert.ok(ctx3 === Context.ROOT_CONTEXT);
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
/*!
|
||||
* Copyright 2020, 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.
|
||||
*/
|
||||
|
||||
// This file is the webpack entry point for the browser Karma tests. It requires
|
||||
// all modules ending in "test" from the current folder and all its subfolders.
|
||||
const testsContext = require.context('.', true, /test$/);
|
||||
testsContext.keys().forEach(testsContext);
|
||||
|
||||
const srcContext = require.context('.', true, /src$/);
|
||||
srcContext.keys().forEach(srcContext);
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{
|
||||
"extends": "../tsconfig.base",
|
||||
"compilerOptions": {
|
||||
"rootDir": ".",
|
||||
"outDir": "build"
|
||||
},
|
||||
"include": [
|
||||
"src/**/*.ts",
|
||||
"test/**/*.ts"
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"rulesDirectory": ["node_modules/tslint-microsoft-contrib"],
|
||||
"extends": ["../../tslint.base.js", "./node_modules/tslint-consistent-codestyle"]
|
||||
}
|
||||
Loading…
Reference in New Issue