From a608af6213afbb5d2d50e301ba87df5e28b2bd66 Mon Sep 17 00:00:00 2001 From: Siim Kallas Date: Sun, 11 Apr 2021 15:26:42 +0300 Subject: [PATCH 1/7] feat: add bunyan instrumentation --- .../.eslintignore | 1 + .../.eslintrc.js | 7 + .../.npmignore | 4 + .../LICENSE | 201 ++++++++++++++++++ .../README.md | 71 +++++++ .../package.json | 69 ++++++ .../src/bunyan.ts | 101 +++++++++ .../src/index.ts | 17 ++ .../src/types.ts | 25 +++ .../src/version.ts | 18 ++ .../test/bunyan.test.ts | 169 +++++++++++++++ .../tsconfig.json | 11 + 12 files changed, 694 insertions(+) create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/.eslintignore create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/.eslintrc.js create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/.npmignore create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/LICENSE create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/README.md create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/package.json create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/src/index.ts create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/src/types.ts create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/src/version.ts create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts create mode 100644 plugins/node/opentelemetry-instrumentation-bunyan/tsconfig.json diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/.eslintignore b/plugins/node/opentelemetry-instrumentation-bunyan/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/.eslintignore @@ -0,0 +1 @@ +build diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-bunyan/.eslintrc.js new file mode 100644 index 0000000000..6aeb0710ef --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js'), +} diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/.npmignore b/plugins/node/opentelemetry-instrumentation-bunyan/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/LICENSE b/plugins/node/opentelemetry-instrumentation-bunyan/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/README.md b/plugins/node/opentelemetry-instrumentation-bunyan/README.md new file mode 100644 index 0000000000..04188d9a6f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/README.md @@ -0,0 +1,71 @@ +# OpenTelemetry instrumentation for bunyan + +[![NPM Published Version][npm-img]][npm-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] + +This module provides injection of trace context to [`bunyan`](https://www.npmjs.com/package/bunyan). + +## Installation + +```bash +npm install --save @opentelemetry/instrumentation-bunyan +``` + +## Usage + +```js +const { NodeTracerProvider } = require('@opentelemetry/node'); +const { BunyanInstrumentation } = require('@opentelemetry/instrumentation-bunyan'); +const { registerInstrumentations } = require('@opentelemetry/instrumentation'); + +const provider = new NodeTracerProvider(); +provider.register(); + +registerInstrumentations({ + instrumentations: [ + new BunyanInstrumentation({ + // Optional hook to insert additional context to bunyan records. + // Called after trace context is added to the record. + logHook: (record, span) => { + record['resource.service.name'] = provider.resource.attributes['service.name']; + }, + }), + // other instrumentations + ], + tracerProvider: provider, +}); + +bunyan.createLogger({ name: 'example' }).info('foo'); +// {"name":"example","msg":"foo","trace_id":"e21c7a95fff34e04f77c7bd518779621","span_id":"b7589a981fde09f4","trace_flags":"01", ...} +``` + +### Fields added to bunyan records + +For the current active span, the following will be added to the bunyan record: +* `trace_id` +* `span_id` +* `trace_flags` + +When no span context is active or the span context is invalid, injection is skipped. + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-bunyan +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-bunyan +[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-bunyan&type=dev +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-bunyan&type=dev +[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-bunyan +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-bunyan.svg diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/package.json b/plugins/node/opentelemetry-instrumentation-bunyan/package.json new file mode 100644 index 0000000000..4e5c046903 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/package.json @@ -0,0 +1,69 @@ +{ + "name": "@opentelemetry/instrumentation-bunyan", + "version": "0.15.0", + "description": "OpenTelemetry instrumentation for bunyan", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "tdd": "npm run test -- --watch-extensions ts --watch", + "clean": "rimraf build/*", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", + "precompile": "tsc --version", + "prepare": "npm run compile", + "version:update": "node ../../../scripts/version-update.js", + "compile": "npm run version:update && tsc -p ." + }, + "keywords": [ + "opentelemetry", + "logging", + "nodejs", + "tracing", + "profiling", + "instrumentation" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.5.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/context-async-hooks": "0.18.2", + "@opentelemetry/core": "0.18.2", + "@opentelemetry/node": "0.18.2", + "@opentelemetry/tracing": "0.18.2", + "@types/mocha": "7.0.2", + "@types/node": "14.0.27", + "@types/sinon": "9.0.4", + "@types/bunyan": "1.8.6", + "bunyan": "1.8.15", + "codecov": "3.7.2", + "gts": "3.1.0", + "mocha": "7.2.0", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "sinon": "9.0.2", + "ts-mocha": "8.0.0", + "ts-node": "9.0.0", + "tslint-consistent-codestyle": "1.16.0", + "tslint-microsoft-contrib": "6.2.0", + "typescript": "4.1.3" + }, + "dependencies": { + "@opentelemetry/api": "^0.18.0", + "@opentelemetry/instrumentation": "^0.18.0" + } +} diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts new file mode 100644 index 0000000000..52327f5b31 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts @@ -0,0 +1,101 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { context, getSpan, isSpanContextValid } from '@opentelemetry/api'; +import { + InstrumentationBase, + InstrumentationNodeModuleDefinition, + isWrapped, +} from '@opentelemetry/instrumentation'; +import { BunyanInstrumentationConfig } from './types'; +import { VERSION } from './version'; +import type * as BunyanLogger from 'bunyan'; + +function defaultHook() {} + +export class BunyanInstrumentation extends InstrumentationBase< + typeof BunyanLogger +> { + constructor(config: BunyanInstrumentationConfig = { logHook: defaultHook }) { + super('@opentelemetry/instrumentation-bunyan', VERSION, config); + } + + protected init() { + return [ + new InstrumentationNodeModuleDefinition( + 'bunyan', + ['*'], + logger => { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const proto = logger.prototype as any; + if (isWrapped(proto['_emit'])) { + this._unwrap(proto, '_emit'); + } + + this._wrap( + proto, + '_emit', + // eslint-disable-next-line @typescript-eslint/no-explicit-any + this._getPatchedEmit() as any + ); + return logger; + }, + logger => { + if (logger === undefined) return; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + this._unwrap(logger.prototype as any, '_emit'); + } + ), + ]; + } + + getConfig(): BunyanInstrumentationConfig { + return this._config; + } + + setConfig(config: BunyanInstrumentationConfig) { + this._config = Object.assign({ logHook: defaultHook }, config); + } + + private _getPatchedEmit() { + return (original: (...args: unknown[]) => void) => { + const instrumentation = this; + return function patchedEmit(this: BunyanLogger, ...args: unknown[]) { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const record = args[0] as any; + const span = getSpan(context.active()); + + if (!span) { + return original.apply(this, args); + } + + const spanContext = span.context(); + + if (!isSpanContextValid(spanContext)) { + return original.apply(this, args); + } + + record['trace_id'] = spanContext.traceId; + record['span_id'] = spanContext.spanId; + record['trace_flags'] = `0${spanContext.traceFlags.toString(16)}`; + + instrumentation.getConfig().logHook!(record, span); + + return original.apply(this, args); + }; + }; + } +} diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/src/index.ts b/plugins/node/opentelemetry-instrumentation-bunyan/src/index.ts new file mode 100644 index 0000000000..b6907638a1 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/src/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export * from './bunyan'; diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/src/types.ts b/plugins/node/opentelemetry-instrumentation-bunyan/src/types.ts new file mode 100644 index 0000000000..425277acb3 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/src/types.ts @@ -0,0 +1,25 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { Span } from '@opentelemetry/api'; +import { InstrumentationConfig } from '@opentelemetry/instrumentation'; + +// eslint-disable-next-line @typescript-eslint/no-explicit-any +export type LogHookFunction = (record: Record, span: Span) => void; + +export interface BunyanInstrumentationConfig extends InstrumentationConfig { + logHook?: LogHookFunction; +} diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/src/version.ts b/plugins/node/opentelemetry-instrumentation-bunyan/src/version.ts new file mode 100644 index 0000000000..1e4172026f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/src/version.ts @@ -0,0 +1,18 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// this is autogenerated file, see scripts/version-update.js +export const VERSION = '0.15.0'; diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts b/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts new file mode 100644 index 0000000000..421b6a3fa1 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts @@ -0,0 +1,169 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { + InMemorySpanExporter, + SimpleSpanProcessor, +} from '@opentelemetry/tracing'; +import { + context, + getSpan, + setSpan, + NoopTracerProvider, +} from '@opentelemetry/api'; +import { NodeTracerProvider } from '@opentelemetry/node'; +import { isWrapped } from '@opentelemetry/instrumentation'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; +import * as assert from 'assert'; +import * as Logger from 'bunyan'; +import * as sinon from 'sinon'; +import { Writable } from 'stream'; +import { BunyanInstrumentation } from '../src/bunyan'; + +const memoryExporter = new InMemorySpanExporter(); +const provider = new NodeTracerProvider(); +const tracer = provider.getTracer('default'); +provider.addSpanProcessor(new SimpleSpanProcessor(memoryExporter)); +context.setGlobalContextManager(new AsyncHooksContextManager()); + +describe('BunyanInstrumentation', () => { + let logger: Logger; + let stream; + let writeSpy: sinon.SinonSpy; + let instrumentation: BunyanInstrumentation; + + before(() => { + instrumentation = new BunyanInstrumentation(); + require('bunyan'); + assert.ok(isWrapped((Logger.prototype as any)['_emit'])); + }); + + describe('enabled instrumentation', () => { + beforeEach(() => { + instrumentation.setConfig({ enabled: true }); + stream = new Writable(); + stream._write = () => {}; + writeSpy = sinon.spy(stream, 'write'); + logger = Logger.createLogger({ name: 'test', stream }); + }); + + it('injects span context to records', () => { + const span = tracer.startSpan('abc'); + context.with(setSpan(context.active(), span), () => { + const { traceId, spanId, traceFlags } = span.context(); + logger.info('foo'); + sinon.assert.calledOnce(writeSpy); + const record = JSON.parse(writeSpy.firstCall.args[0].toString()); + assert.strictEqual(record['trace_id'], traceId); + assert.strictEqual(record['span_id'], spanId); + assert.strictEqual( + record['trace_flags'], + `0${traceFlags.toString(16)}` + ); + // Sanity check the message is unchanged + assert.strictEqual('foo', record['msg']); + }); + }); + + it('calls the users log hook', () => { + const span = tracer.startSpan('abc'); + instrumentation.setConfig({ + enabled: true, + logHook: record => { + record['resource.service.name'] = 'test-service'; + }, + }); + context.with(setSpan(context.active(), span), () => { + logger.info('foo'); + sinon.assert.calledOnce(writeSpy); + const record = JSON.parse(writeSpy.firstCall.args[0].toString()); + assert.strictEqual(record['resource.service.name'], 'test-service'); + }); + }); + + it('does not inject span context if no span is active', () => { + logger.info('foo'); + assert.strictEqual(getSpan(context.active()), undefined); + sinon.assert.calledOnce(writeSpy); + const record = JSON.parse(writeSpy.firstCall.args[0].toString()); + assert.strictEqual(record['trace_id'], undefined); + assert.strictEqual(record['span_id'], undefined); + assert.strictEqual(record['trace_flags'], undefined); + assert.strictEqual('foo', record['msg']); + }); + + it('does not inject span context if span context is invalid', () => { + const noopTracer = new NoopTracerProvider().getTracer('noop'); + const span = noopTracer.startSpan('noop'); + context.with(setSpan(context.active(), span), () => { + logger.info('foo'); + sinon.assert.calledOnce(writeSpy); + const record = JSON.parse(writeSpy.firstCall.args[0].toString()); + assert.strictEqual(record['trace_id'], undefined); + assert.strictEqual(record['span_id'], undefined); + assert.strictEqual(record['trace_flags'], undefined); + assert.strictEqual('foo', record['msg']); + }); + }); + }); + + describe('disabled instrumentation', () => { + before(() => { + instrumentation.disable(); + }); + + after(() => { + instrumentation.enable(); + }); + + beforeEach(() => { + stream = new Writable(); + stream._write = () => {}; + writeSpy = sinon.spy(stream, 'write'); + logger = Logger.createLogger({ name: 'test', stream }); + }); + + it('does not inject span context', () => { + const span = tracer.startSpan('abc'); + context.with(setSpan(context.active(), span), () => { + logger.info('foo'); + sinon.assert.calledOnce(writeSpy); + const record = JSON.parse(writeSpy.firstCall.args[0].toString()); + assert.strictEqual(record['trace_id'], undefined); + assert.strictEqual(record['span_id'], undefined); + assert.strictEqual(record['trace_flags'], undefined); + // Sanity check the message is unchanged + assert.strictEqual('foo', record['msg']); + }); + }); + + it('does not call log hook', () => { + const span = tracer.startSpan('abc'); + instrumentation.setConfig({ + enabled: false, + logHook: record => { + record['resource.service.name'] = 'test-service'; + }, + }); + context.with(setSpan(context.active(), span), () => { + logger.info('foo'); + sinon.assert.calledOnce(writeSpy); + const record = JSON.parse(writeSpy.firstCall.args[0].toString()); + assert.strictEqual(record['resource.service.name'], undefined); + }); + }); + }); +}); diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/tsconfig.json b/plugins/node/opentelemetry-instrumentation-bunyan/tsconfig.json new file mode 100644 index 0000000000..28be80d266 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-bunyan/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} From 0f04bcb09337a0d33222ace106d2f79bad9ff97f Mon Sep 17 00:00:00 2001 From: Siim Kallas Date: Mon, 12 Apr 2021 14:37:31 +0300 Subject: [PATCH 2/7] fix: don't propagate exceptions from log hook --- .../src/bunyan.ts | 15 +++++++++++++-- .../test/bunyan.test.ts | 19 +++++++++++++++++++ 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts index 52327f5b31..84e5af8636 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts +++ b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts @@ -14,11 +14,12 @@ * limitations under the License. */ -import { context, getSpan, isSpanContextValid } from '@opentelemetry/api'; +import { context, diag, getSpan, isSpanContextValid } from '@opentelemetry/api'; import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped, + safeExecuteInTheMiddle, } from '@opentelemetry/instrumentation'; import { BunyanInstrumentationConfig } from './types'; import { VERSION } from './version'; @@ -92,7 +93,17 @@ export class BunyanInstrumentation extends InstrumentationBase< record['span_id'] = spanContext.spanId; record['trace_flags'] = `0${spanContext.traceFlags.toString(16)}`; - instrumentation.getConfig().logHook!(record, span); + safeExecuteInTheMiddle( + () => { + instrumentation.getConfig().logHook!(record, span); + }, + err => { + if (err) { + diag.error('bunyan instrumentation: error calling logHook', err); + } + }, + true + ); return original.apply(this, args); }; diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts b/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts index 421b6a3fa1..a3315e1d24 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts +++ b/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts @@ -118,6 +118,25 @@ describe('BunyanInstrumentation', () => { assert.strictEqual('foo', record['msg']); }); }); + + it('does not propagate exceptions from user hooks', () => { + const span = tracer.startSpan('abc'); + instrumentation.setConfig({ + enabled: true, + logHook: () => { + throw new Error('Oops'); + }, + }); + context.with(setSpan(context.active(), span), () => { + const { traceId, spanId } = span.context(); + logger.info('foo'); + sinon.assert.calledOnce(writeSpy); + const record = JSON.parse(writeSpy.firstCall.args[0].toString()); + assert.strictEqual(record['trace_id'], traceId); + assert.strictEqual(record['span_id'], spanId); + assert.strictEqual('foo', record['msg']); + }); + }); }); describe('disabled instrumentation', () => { From 313b1527048ff8b96a8dd642bc2c2f2c19db8b9e Mon Sep 17 00:00:00 2001 From: Siim Kallas Date: Tue, 13 Apr 2021 13:13:55 +0300 Subject: [PATCH 3/7] refactor: simplify code, fix consistency issues --- .../README.md | 2 +- .../src/bunyan.ts | 47 ++++++++++++------- .../src/types.ts | 2 +- .../test/bunyan.test.ts | 4 +- 4 files changed, 33 insertions(+), 22 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/README.md b/plugins/node/opentelemetry-instrumentation-bunyan/README.md index 04188d9a6f..0934242650 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/README.md +++ b/plugins/node/opentelemetry-instrumentation-bunyan/README.md @@ -5,7 +5,7 @@ [![devDependencies][devDependencies-image]][devDependencies-url] [![Apache License][license-image]][license-image] -This module provides injection of trace context to [`bunyan`](https://www.npmjs.com/package/bunyan). +This module provides automatic instrumentation for injection of trace context to [`bunyan`](https://www.npmjs.com/package/bunyan). ## Installation diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts index 84e5af8636..e078a4f602 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts +++ b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts @@ -14,7 +14,13 @@ * limitations under the License. */ -import { context, diag, getSpan, isSpanContextValid } from '@opentelemetry/api'; +import { + context, + diag, + getSpan, + isSpanContextValid, + Span, +} from '@opentelemetry/api'; import { InstrumentationBase, InstrumentationNodeModuleDefinition, @@ -25,12 +31,10 @@ import { BunyanInstrumentationConfig } from './types'; import { VERSION } from './version'; import type * as BunyanLogger from 'bunyan'; -function defaultHook() {} - export class BunyanInstrumentation extends InstrumentationBase< typeof BunyanLogger > { - constructor(config: BunyanInstrumentationConfig = { logHook: defaultHook }) { + constructor(config: BunyanInstrumentationConfig = {}) { super('@opentelemetry/instrumentation-bunyan', VERSION, config); } @@ -68,15 +72,13 @@ export class BunyanInstrumentation extends InstrumentationBase< } setConfig(config: BunyanInstrumentationConfig) { - this._config = Object.assign({ logHook: defaultHook }, config); + this._config = config; } private _getPatchedEmit() { return (original: (...args: unknown[]) => void) => { const instrumentation = this; return function patchedEmit(this: BunyanLogger, ...args: unknown[]) { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - const record = args[0] as any; const span = getSpan(context.active()); if (!span) { @@ -89,24 +91,33 @@ export class BunyanInstrumentation extends InstrumentationBase< return original.apply(this, args); } + const record = args[0] as Record; record['trace_id'] = spanContext.traceId; record['span_id'] = spanContext.spanId; record['trace_flags'] = `0${spanContext.traceFlags.toString(16)}`; - safeExecuteInTheMiddle( - () => { - instrumentation.getConfig().logHook!(record, span); - }, - err => { - if (err) { - diag.error('bunyan instrumentation: error calling logHook', err); - } - }, - true - ); + instrumentation._callHook(span, record); return original.apply(this, args); }; }; } + + private _callHook(span: Span, record: Record) { + const hook = this.getConfig().logHook; + + if (!hook) { + return; + } + + safeExecuteInTheMiddle( + () => hook(span, record), + err => { + if (err) { + diag.error('bunyan instrumentation: error calling logHook', err); + } + }, + true + ); + } } diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/src/types.ts b/plugins/node/opentelemetry-instrumentation-bunyan/src/types.ts index 425277acb3..1e1559b463 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/src/types.ts +++ b/plugins/node/opentelemetry-instrumentation-bunyan/src/types.ts @@ -18,7 +18,7 @@ import { Span } from '@opentelemetry/api'; import { InstrumentationConfig } from '@opentelemetry/instrumentation'; // eslint-disable-next-line @typescript-eslint/no-explicit-any -export type LogHookFunction = (record: Record, span: Span) => void; +export type LogHookFunction = (span: Span, record: Record) => void; export interface BunyanInstrumentationConfig extends InstrumentationConfig { logHook?: LogHookFunction; diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts b/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts index a3315e1d24..5074ee351a 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts +++ b/plugins/node/opentelemetry-instrumentation-bunyan/test/bunyan.test.ts @@ -82,7 +82,7 @@ describe('BunyanInstrumentation', () => { const span = tracer.startSpan('abc'); instrumentation.setConfig({ enabled: true, - logHook: record => { + logHook: (_span, record) => { record['resource.service.name'] = 'test-service'; }, }); @@ -173,7 +173,7 @@ describe('BunyanInstrumentation', () => { const span = tracer.startSpan('abc'); instrumentation.setConfig({ enabled: false, - logHook: record => { + logHook: (_span, record) => { record['resource.service.name'] = 'test-service'; }, }); From 83c8c171281deff2cf3b141617738c7cc261f55a Mon Sep 17 00:00:00 2001 From: Siim Kallas Date: Tue, 13 Apr 2021 20:39:29 +0300 Subject: [PATCH 4/7] chore: tidy package.json --- .../package.json | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/package.json b/plugins/node/opentelemetry-instrumentation-bunyan/package.json index 4e5c046903..f539196a37 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/package.json +++ b/plugins/node/opentelemetry-instrumentation-bunyan/package.json @@ -6,16 +6,16 @@ "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js-contrib", "scripts": { - "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", - "tdd": "npm run test -- --watch-extensions ts --watch", "clean": "rimraf build/*", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", + "compile": "npm run version:update && tsc -p .", "lint": "eslint . --ext .ts", "lint:fix": "eslint . --ext .ts --fix", - "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", "precompile": "tsc --version", "prepare": "npm run compile", - "version:update": "node ../../../scripts/version-update.js", - "compile": "npm run version:update && tsc -p ." + "tdd": "npm run test -- --watch-extensions ts --watch", + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "version:update": "node ../../../scripts/version-update.js" }, "keywords": [ "opentelemetry", @@ -23,7 +23,8 @@ "nodejs", "tracing", "profiling", - "instrumentation" + "instrumentation", + "bunyan" ], "author": "OpenTelemetry Authors", "license": "Apache-2.0", From 10963541b882811c55512e925088483b28310101 Mon Sep 17 00:00:00 2001 From: Siim Kallas Date: Tue, 13 Apr 2021 20:48:32 +0300 Subject: [PATCH 5/7] refactor: use typeof for hook check --- plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts index e078a4f602..da20bc38bc 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts +++ b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts @@ -106,7 +106,7 @@ export class BunyanInstrumentation extends InstrumentationBase< private _callHook(span: Span, record: Record) { const hook = this.getConfig().logHook; - if (!hook) { + if (typeof hook !== 'function') { return; } From f1426979dc83e65e7d3c7b11cd753abfd6286778 Mon Sep 17 00:00:00 2001 From: Siim Kallas Date: Wed, 14 Apr 2021 09:53:43 +0300 Subject: [PATCH 6/7] fix: add a version check for bunyan --- plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts index da20bc38bc..310f969127 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts +++ b/plugins/node/opentelemetry-instrumentation-bunyan/src/bunyan.ts @@ -42,7 +42,7 @@ export class BunyanInstrumentation extends InstrumentationBase< return [ new InstrumentationNodeModuleDefinition( 'bunyan', - ['*'], + ['<2.0'], logger => { // eslint-disable-next-line @typescript-eslint/no-explicit-any const proto = logger.prototype as any; From 2d0309e726baaf3d71804fe09560946edb0f7dd6 Mon Sep 17 00:00:00 2001 From: Siim Kallas Date: Wed, 14 Apr 2021 10:35:40 +0300 Subject: [PATCH 7/7] fix: readme example --- plugins/node/opentelemetry-instrumentation-bunyan/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/README.md b/plugins/node/opentelemetry-instrumentation-bunyan/README.md index 0934242650..6ed824a4b5 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/README.md +++ b/plugins/node/opentelemetry-instrumentation-bunyan/README.md @@ -28,7 +28,7 @@ registerInstrumentations({ new BunyanInstrumentation({ // Optional hook to insert additional context to bunyan records. // Called after trace context is added to the record. - logHook: (record, span) => { + logHook: (span, record) => { record['resource.service.name'] = provider.resource.attributes['service.name']; }, }),