diff --git a/packages/opentelemetry-shim-opentracing/.npmignore b/packages/opentelemetry-shim-opentracing/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/packages/opentelemetry-shim-opentracing/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/packages/opentelemetry-shim-opentracing/LICENSE b/packages/opentelemetry-shim-opentracing/LICENSE new file mode 100644 index 0000000000..56d2e3b82d --- /dev/null +++ b/packages/opentelemetry-shim-opentracing/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 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 + + 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/opentelemetry-shim-opentracing/README.md b/packages/opentelemetry-shim-opentracing/README.md new file mode 100644 index 0000000000..061a90a35d --- /dev/null +++ b/packages/opentelemetry-shim-opentracing/README.md @@ -0,0 +1,20 @@ +# OpenTracing shim +[![Gitter chat][gitter-image]][gitter-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] + +OpenTracing shim allows existing OpenTracing instrumentation to report to OpenTelemetry + +## 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-basic-tracer +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-basic-tracer +[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-basic-tracer +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-basic-tracer&type=dev diff --git a/packages/opentelemetry-shim-opentracing/package.json b/packages/opentelemetry-shim-opentracing/package.json new file mode 100644 index 0000000000..80333586b9 --- /dev/null +++ b/packages/opentelemetry-shim-opentracing/package.json @@ -0,0 +1,58 @@ +{ + "name": "@opentelemetry/shim-opentracing", + "version": "0.0.1", + "description": "OpenTracing to OpenTelemetry shim", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js", + "scripts": { + "test": "nyc ts-mocha -p tsconfig.json test/**/*.ts", + "tdd": "yarn test -- --watch-extensions ts --watch", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", + "clean": "rimraf build/*", + "check": "gts check", + "compile": "tsc -p .", + "fix": "gts fix", + "posttest": "yarn run check" + }, + "keywords": [ + "opentelemetry", + "nodejs", + "tracing", + "profiling" + ], + "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": "^5.2.7", + "@types/node": "^12.6.9", + "@opentelemetry/basic-tracer": "^0.0.1", + "@opentelemetry/scope-base": "^0.0.1", + "codecov": "^3.5.0", + "gts": "^1.1.0", + "mocha": "^6.2.0", + "nyc": "^14.1.1", + "ts-mocha": "^6.0.0", + "ts-node": "^8.3.0", + "typescript": "^3.5.3", + "tslint-microsoft-contrib": "^6.2.0", + "tslint-consistent-codestyle": "^1.15.1" + }, + "dependencies": { + "@opentelemetry/types": "^0.0.1", + "@opentelemetry/core": "^0.0.1", + "opentracing": "^0.14.4" + } +} diff --git a/packages/opentelemetry-shim-opentracing/src/index.ts b/packages/opentelemetry-shim-opentracing/src/index.ts new file mode 100644 index 0000000000..7f4e715ee0 --- /dev/null +++ b/packages/opentelemetry-shim-opentracing/src/index.ts @@ -0,0 +1,17 @@ +/** + * 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. + */ + +export { TracerShim } from './shim'; diff --git a/packages/opentelemetry-shim-opentracing/src/shim.ts b/packages/opentelemetry-shim-opentracing/src/shim.ts new file mode 100644 index 0000000000..57f16d883b --- /dev/null +++ b/packages/opentelemetry-shim-opentracing/src/shim.ts @@ -0,0 +1,295 @@ +/** + * 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. + */ + +import * as types from '@opentelemetry/types'; +import { NoopLogger } from '@opentelemetry/core'; +import * as opentracing from 'opentracing'; + +function translateReferences( + references: opentracing.Reference[] +): types.Link[] { + const links: types.Link[] = []; + for (const reference of references) { + const context = reference.referencedContext(); + if (context instanceof SpanContextShim) { + links.push({ + spanContext: (context as SpanContextShim).getSpanContext(), + attributes: { 'span.kind': reference.type }, + }); + } + } + return links; +} + +function translateSpanOptions( + options: opentracing.SpanOptions +): types.SpanOptions { + const opts: types.SpanOptions = { + startTime: options.startTime, + }; + + // because there's no `Links` in SpanOptions, we set them in `TracerShim.startSpan()` + if (options.childOf) { + if (options.childOf instanceof SpanShim) { + opts.parent = (options.childOf as SpanShim).getSpan(); + } else if (options.childOf instanceof SpanContextShim) { + opts.parent = (options.childOf as SpanContextShim).getSpanContext(); + } + } + return opts; +} + +/** + * SpanContextShim wraps a {@link types.SpanContext} and implements the + * OpenTracing span context API. + */ +export class SpanContextShim extends opentracing.SpanContext { + private readonly _spanContext: types.SpanContext; + + constructor(spanContext: types.SpanContext) { + super(); + this._spanContext = spanContext; + } + + /** + * Returns the underlying {@link types.SpanContext} + */ + getSpanContext(): types.SpanContext { + return this._spanContext; + } + + /** + * Returns the trace ID as a string. + */ + toTraceId(): string { + return this._spanContext.traceId; + } + + /** + * Returns the span ID as a string. + */ + toSpanId(): string { + return this._spanContext.spanId; + } +} + +/** + * TracerShim wraps a {@link types.Tracer} and implements the + * OpenTracing tracer API. + */ +export class TracerShim extends opentracing.Tracer { + private readonly _tracer: types.Tracer; + private readonly _logger: types.Logger; + + constructor(tracer: types.Tracer, logger?: types.Logger) { + super(); + + this._tracer = tracer; + this._logger = logger || new NoopLogger(); + } + + startSpan( + name: string, + options: opentracing.SpanOptions = {} + ): opentracing.Span { + const span = this._tracer.startSpan(name, translateSpanOptions(options)); + + if (options.tags) { + span.setAttributes(options.tags); + } + + if (options.references) { + const links = translateReferences(options.references); + for (const link of links) { + span.addLink(link.spanContext, link.attributes); + } + } + + return new SpanShim(this, span); + } + + _inject( + spanContext: opentracing.SpanContext, + format: string, + carrier: unknown + ): void { + const opentelemSpanContext: types.SpanContext = (spanContext as SpanContextShim).getSpanContext(); + switch (format) { + // tslint:disable-next-line:no-switch-case-fall-through + case opentracing.FORMAT_HTTP_HEADERS: + case opentracing.FORMAT_TEXT_MAP: + this._tracer + .getHttpTextFormat() + .inject(opentelemSpanContext, format, carrier); + return; + case opentracing.FORMAT_BINARY: + this._logger.warn( + 'OpentracingShim.inject() does not support FORMAT_BINARY' + ); + // @todo: Implement binary format + return; + default: + } + } + + _extract(format: string, carrier: unknown): opentracing.SpanContext | null { + switch (format) { + // tslint:disable-next-line:no-switch-case-fall-through + case opentracing.FORMAT_HTTP_HEADERS: + case opentracing.FORMAT_TEXT_MAP: + const context = this._tracer + .getHttpTextFormat() + .extract(format, carrier); + if (!context) { + return null; + } + return new SpanContextShim(context); + case opentracing.FORMAT_BINARY: + // @todo: Implement binary format + this._logger.warn( + 'OpentracingShim.extract() does not support FORMAT_BINARY' + ); + return null; + default: + } + return null; + } +} + +/** + * SpanShim wraps an {@link types.Span} and implements the OpenTracing Span API + * around it. + * @todo: Out of band baggage propagation is not currently supported. + */ +export class SpanShim extends opentracing.Span { + // _span is the original OpenTelemetry span that we are wrapping with + // an opentracing interface. + private readonly _span: types.Span; + private readonly _contextShim: SpanContextShim; + private readonly _tracerShim: TracerShim; + + constructor(tracerShim: TracerShim, span: types.Span) { + super(); + this._span = span; + this._contextShim = new SpanContextShim(span.context()); + this._tracerShim = tracerShim; + } + + /** + * Returns a reference to the Span's context. + * + * @returns a {@link SpanContextShim} containing the underlying context. + */ + context(): opentracing.SpanContext { + return this._contextShim; + } + + /** + * Returns the {@link opentracing.Tracer} that created the span. + */ + tracer(): opentracing.Tracer { + return this._tracerShim; + } + + /** + * Updates the underlying span's name. + * + * @param name the Span name. + */ + setOperationName(name: string): this { + this._span.updateName(name); + return this; + } + + /** + * Finishes the span. Once the span is finished, no new updates can be applied + * to the span. + * + * @param finishTime An optional timestamp to explicitly set the span's end time. + */ + finish(finishTime?: number): void { + this._span.end(finishTime); + } + + /** + * Logs an event with an optional payload. + * @param eventName name of the event. + * @param payload an arbitrary object to be attached to the event. + */ + logEvent(eventName: string, payload?: unknown): void { + let attrs: types.Attributes = {}; + if (payload) { + attrs = { payload }; + } + this._span.addEvent(eventName, attrs); + } + + /** + * Logs a set of key value pairs. Since OpenTelemetry only supports events, + * the KV pairs are used as attributes on an event named "log". + */ + log(keyValuePairs: { [key: string]: unknown }, timestamp?: number): this { + // @todo: Handle timestamp + this._span.addEvent('log', keyValuePairs); + return this; + } + + /** + * Adds a set of tags to the span. + * @param keyValueMap set of KV pairs representing tags + */ + addTags(keyValueMap: { [key: string]: unknown }): this { + this._span.setAttributes(keyValueMap); + return this; + } + + /** + * Sets a tag on the span, updating the value if the key is already present + * on the span. + * @param key key for the tag + * @param value value for the tag + */ + setTag(key: string, value: unknown): this { + if ( + key === opentracing.Tags.ERROR && + (value === true || value === 'true') + ) { + this._span.setStatus({ code: types.CanonicalCode.UNKNOWN }); + return this; + } + + this._span.setAttribute(key, value); + return this; + } + + getBaggageItem(key: string): string | undefined { + // TODO: should this go into the context? + return undefined; + } + + setBaggageItem(key: string, value: string): this { + // TODO: should this go into the context? + return this; + } + + /* + * Returns the underlying {@link types.Span} that the shim + * is wrapping. + */ + getSpan(): types.Span { + return this._span; + } +} diff --git a/packages/opentelemetry-shim-opentracing/test/Shim.test.ts b/packages/opentelemetry-shim-opentracing/test/Shim.test.ts new file mode 100644 index 0000000000..2c7f64e02b --- /dev/null +++ b/packages/opentelemetry-shim-opentracing/test/Shim.test.ts @@ -0,0 +1,191 @@ +/** + * 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. + */ + +import * as assert from 'assert'; +import * as opentracing from 'opentracing'; +import { BasicTracer, Span } from '@opentelemetry/basic-tracer'; +import { NoopScopeManager } from '@opentelemetry/scope-base'; +import { TracerShim, SpanShim, SpanContextShim } from '../src/shim'; +import { INVALID_SPAN_CONTEXT, timeInputToHrTime } from '@opentelemetry/core'; +import { performance } from 'perf_hooks'; + +describe('OpenTracing Shim', () => { + const tracer = new BasicTracer({ + scopeManager: new NoopScopeManager(), + }); + const shimTracer: opentracing.Tracer = new TracerShim(tracer); + opentracing.initGlobalTracer(shimTracer); + + describe('TracerShim', () => { + let span: opentracing.Span; + let context: opentracing.SpanContext; + + beforeEach(() => { + span = shimTracer.startSpan('my-span'); + context = span.context(); + }); + + describe('propagation', () => { + it('injects/extracts a span object', () => { + const carrier: { [key: string]: unknown } = {}; + shimTracer.inject(span, opentracing.FORMAT_HTTP_HEADERS, carrier); + const extractedContext = shimTracer.extract( + opentracing.FORMAT_HTTP_HEADERS, + carrier + ); + assert.ok(extractedContext !== null); + assert.strictEqual(context.toTraceId(), extractedContext!.toTraceId()); + assert.strictEqual(context.toSpanId(), extractedContext!.toSpanId()); + }); + + it('injects/extracts HTTP carriers', () => { + const carrier: { [key: string]: unknown } = {}; + shimTracer.inject(context, opentracing.FORMAT_HTTP_HEADERS, carrier); + const extractedContext = shimTracer.extract( + opentracing.FORMAT_HTTP_HEADERS, + carrier + ); + assert.ok(extractedContext !== null); + assert.strictEqual(context.toTraceId(), extractedContext!.toTraceId()); + assert.strictEqual(context.toSpanId(), extractedContext!.toSpanId()); + }); + + it('injects/extracts TextMap carriers', () => { + const carrier: { [key: string]: unknown } = {}; + shimTracer.inject(context, opentracing.FORMAT_TEXT_MAP, carrier); + const extractedContext = shimTracer.extract( + opentracing.FORMAT_TEXT_MAP, + carrier + ); + assert.ok(extractedContext !== null); + assert.strictEqual(context.toTraceId(), extractedContext!.toTraceId()); + assert.strictEqual(context.toSpanId(), extractedContext!.toSpanId()); + }); + + it('injects/extracts Binary carriers', () => { + /* const carrier = new Array(); */ + /* shimTracer.inject(context, opentracing.FORMAT_BINARY, carrier); */ + /* const extractedContext = shimTracer.extract(opentracing.FORMAT_BINARY, { buffer: new Uint8Array(carrier)}); */ + /* assert.strictEqual(context.toSpanId(), extractedContext.toSpanId()) */ + }); + }); + + it('creates parent/child relationship using a span object', () => { + const childSpan = shimTracer.startSpan('other-span', { + childOf: span, + }) as SpanShim; + assert.strictEqual( + (childSpan.getSpan() as Span).parentSpanId, + context.toSpanId() + ); + assert.strictEqual( + childSpan.context().toTraceId(), + span.context().toTraceId() + ); + }); + + it('creates parent/child relationship using a context object', () => { + const childSpan = shimTracer.startSpan('other-span', { + childOf: context, + }) as SpanShim; + assert.strictEqual( + (childSpan.getSpan() as Span).parentSpanId, + context.toSpanId() + ); + assert.strictEqual( + childSpan.context().toTraceId(), + span.context().toTraceId() + ); + }); + + it('translates span options correctly', () => { + const now = performance.now(); + const opentracingOptions: opentracing.SpanOptions = { + startTime: now, + tags: { key: 'value', count: 1 }, + references: [opentracing.followsFrom(context)], + }; + span = shimTracer.startSpan('my-span', opentracingOptions); + + const otSpan = (span as SpanShim).getSpan() as Span; + + assert.strictEqual(otSpan.links.length, 1); + assert.deepStrictEqual(otSpan.startTime, timeInputToHrTime(now)); + assert.deepStrictEqual(otSpan.attributes, opentracingOptions.tags); + }); + }); + + describe('SpanContextShim', () => { + it('returns the correct context', () => { + const shim = new SpanContextShim(INVALID_SPAN_CONTEXT); + assert.strictEqual(shim.getSpanContext(), INVALID_SPAN_CONTEXT); + assert.strictEqual(shim.toTraceId(), INVALID_SPAN_CONTEXT.traceId); + assert.strictEqual(shim.toSpanId(), INVALID_SPAN_CONTEXT.spanId); + }); + }); + + describe('span', () => { + let span: SpanShim; + let otSpan: Span; + + beforeEach(() => { + span = shimTracer.startSpan('my-span', { + startTime: performance.now(), + }) as SpanShim; + otSpan = (span as SpanShim).getSpan() as Span; + }); + + it('sets tags', () => { + span.setTag('hello', 'world'); + assert.strictEqual(otSpan.attributes.hello, 'world'); + + span.addTags({ hello: 'stars', from: 'earth' }); + assert.strictEqual(otSpan.attributes.hello, 'stars'); + assert.strictEqual(otSpan.attributes.from, 'earth'); + }); + + it('logs KV pairs', () => { + const kvLogs = { key: 'value', error: 'not a valid span' }; + span.log(kvLogs); + assert.strictEqual(otSpan.events[0].name, 'log'); + assert.strictEqual(otSpan.events[0].attributes, kvLogs); + }); + + it('logs an event with a payload', () => { + const payload = { user: 'payload', request: 1 }; + span.logEvent('some log', payload); + assert.strictEqual(otSpan.events[0].name, 'some log'); + assert.deepStrictEqual(otSpan.events[0].attributes, { payload }); + }); + + it('updates the name', () => { + assert.strictEqual(otSpan.name, 'my-span'); + span.setOperationName('your-span'); + assert.strictEqual(otSpan.name, 'your-span'); + }); + + it('sets explicit end timestamp', () => { + const now = performance.now(); + span.finish(now); + assert.deepStrictEqual(otSpan.endTime, timeInputToHrTime(now)); + }); + + it('can set and retrieve baggage', () => { + span.setBaggageItem('baggage', 'item'); + // TODO: baggage + }); + }); +}); diff --git a/packages/opentelemetry-shim-opentracing/tsconfig.json b/packages/opentelemetry-shim-opentracing/tsconfig.json new file mode 100644 index 0000000000..a2042cd68b --- /dev/null +++ b/packages/opentelemetry-shim-opentracing/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} diff --git a/packages/opentelemetry-shim-opentracing/tslint.json b/packages/opentelemetry-shim-opentracing/tslint.json new file mode 100644 index 0000000000..0b1a202be7 --- /dev/null +++ b/packages/opentelemetry-shim-opentracing/tslint.json @@ -0,0 +1,4 @@ +{ + "rulesDirectory": ["node_modules/tslint-microsoft-contrib"], + "extends": ["../../tslint.base.js", "./node_modules/tslint-consistent-codestyle"] +}