diff --git a/.nycrc b/.nycrc
index f8e60152fa..603b7fc56f 100644
--- a/.nycrc
+++ b/.nycrc
@@ -9,7 +9,8 @@
"karma.conf.js",
"src/platform/browser/*.ts",
"test/index-webpack.ts",
- "webpack/*.js"
+ "webpack/*.js",
+ ".eslintrc.js"
],
"all": true
}
diff --git a/examples/meta-node/client.js b/examples/meta-node/client.js
new file mode 100644
index 0000000000..e6f577ffd7
--- /dev/null
+++ b/examples/meta-node/client.js
@@ -0,0 +1,27 @@
+'use strict';
+
+// eslint-disable-next-line import/order
+const tracer = require('./tracer')('example-express-client');
+const api = require('@opentelemetry/api');
+const axios = require('axios').default;
+
+function makeRequest() {
+ const span = tracer.startSpan('client.makeRequest()', {
+ kind: api.SpanKind.CLIENT,
+ });
+
+ api.context.with(api.setSpan(api.ROOT_CONTEXT, span), async () => {
+ try {
+ const res = await axios.get('http://localhost:8080/run_test');
+ span.setStatus({ code: api.SpanStatusCode.OK });
+ console.log(res.statusText);
+ } catch (e) {
+ span.setStatus({ code: api.SpanStatusCode.ERROR, message: e.message });
+ }
+ span.end();
+ console.log('Sleeping 5 seconds before shutdown to ensure all records are flushed.');
+ setTimeout(() => { console.log('Completed.'); }, 5000);
+ });
+}
+
+makeRequest();
diff --git a/examples/meta-node/package.json b/examples/meta-node/package.json
new file mode 100644
index 0000000000..9d164e5d06
--- /dev/null
+++ b/examples/meta-node/package.json
@@ -0,0 +1,47 @@
+{
+ "name": "instrumentations-node-example",
+ "private": true,
+ "version": "0.14.0",
+ "description": "Example of using meta package for default auto instrumentations in node",
+ "main": "index.js",
+ "scripts": {
+ "lint": "eslint . --ext .js",
+ "lint:fix": "eslint . --ext .js --fix",
+ "zipkin:server": "cross-env EXPORTER=zipkin node ./server.js",
+ "zipkin:client": "cross-env EXPORTER=zipkin node ./client.js"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git+ssh://git@github.com/open-telemetry/opentelemetry-js-contrib.git"
+ },
+ "keywords": [
+ "opentelemetry",
+ "instrumentations",
+ "plugins",
+ "tracing",
+ "instrumentation"
+ ],
+ "engines": {
+ "node": ">=8.5.0"
+ },
+ "author": "OpenTelemetry Authors",
+ "license": "Apache-2.0",
+ "bugs": {
+ "url": "https://github.com/open-telemetry/opentelemetry-js-contrib/issues"
+ },
+ "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib#readme",
+ "devDependencies": {
+ "cross-env": "^6.0.0",
+ "eslint": "^7.4.0"
+ },
+ "dependencies": {
+ "@opentelemetry/api": "^0.18.0",
+ "@opentelemetry/auto-instrumentations-node": "^0.14.0",
+ "@opentelemetry/exporter-collector": "^0.18.0",
+ "@opentelemetry/instrumentation": "^0.18.0",
+ "@opentelemetry/node": "^0.18.0",
+ "@opentelemetry/tracing": "^0.18.0",
+ "axios": "^0.21.1",
+ "express": "^4.17.1"
+ }
+}
diff --git a/examples/meta-node/server.js b/examples/meta-node/server.js
new file mode 100644
index 0000000000..5aeffe6114
--- /dev/null
+++ b/examples/meta-node/server.js
@@ -0,0 +1,57 @@
+'use strict';
+
+// eslint-disable-next-line
+require('./tracer')('example-meta-node');
+
+// Require in rest of modules
+const express = require('express');
+const axios = require('axios').default;
+
+// Setup express
+const app = express();
+const PORT = 8080;
+
+const getCrudController = () => {
+ const router = express.Router();
+ const resources = [];
+ router.get('/', (req, res) => res.send(resources));
+ router.post('/', (req, res) => {
+ resources.push(req.body);
+ return res.status(201).send(req.body);
+ });
+ return router;
+};
+
+const authMiddleware = (req, res, next) => {
+ const { authorization } = req.headers;
+ if (authorization && authorization.includes('secret_token')) {
+ next();
+ } else {
+ res.sendStatus(401);
+ }
+};
+
+async function setupRoutes() {
+ app.use(express.json());
+
+ app.get('/run_test', async (req, res) => {
+ const createdCat = await axios.post(`http://localhost:${PORT}/cats`, {
+ name: 'Tom',
+ friends: [
+ 'Jerry',
+ ],
+ }, {
+ headers: {
+ Authorization: 'secret_token',
+ },
+ });
+
+ return res.status(201).send(createdCat.data);
+ });
+ app.use('/cats', authMiddleware, getCrudController());
+}
+
+setupRoutes().then(() => {
+ app.listen(PORT);
+ console.log(`Listening on http://localhost:${PORT}`);
+});
diff --git a/examples/meta-node/tracer.js b/examples/meta-node/tracer.js
new file mode 100644
index 0000000000..5bd19ee98c
--- /dev/null
+++ b/examples/meta-node/tracer.js
@@ -0,0 +1,58 @@
+'use strict';
+
+const {
+ diag, trace, DiagConsoleLogger, DiagLogLevel,
+} = require('@opentelemetry/api');
+const { NodeTracerProvider } = require('@opentelemetry/node');
+const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
+const { CollectorTraceExporter } = require('@opentelemetry/exporter-collector');
+const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
+const { registerInstrumentations } = require('@opentelemetry/instrumentation');
+
+module.exports = () => {
+ // enable diag to see all messages
+ diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ALL);
+
+ const exporter = new CollectorTraceExporter({
+ serviceName: 'basic-service',
+ });
+
+ const provider = new NodeTracerProvider();
+ provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
+ provider.register();
+
+ registerInstrumentations({
+ instrumentations: [
+ getNodeAutoInstrumentations({
+ '@opentelemetry/instrumentation-http': {
+ applyCustomAttributesOnSpan: (span) => {
+ span.setAttribute('foo2', 'bar2');
+ },
+ },
+ }),
+ // disable old plugins - this can be removed once plugins are deprecated
+ // and removed from registerInstrumentations
+ {
+ plugins: {
+ mongodb: { enabled: false, path: '@opentelemetry/plugin-mongodb' },
+ grpc: { enabled: false, path: '@opentelemetry/plugin-grpc' },
+ '@grpc/grpc-js': { enabled: false, path: '@opentelemetry/plugin-grpc-js' },
+ http: { enabled: false, path: '@opentelemetry/plugin-http' },
+ https: { enabled: false, path: '@opentelemetry/plugin-httsps' },
+ mysql: { enabled: false, path: '@opentelemetry/plugin-mysql' },
+ pg: { enabled: false, path: '@opentelemetry/plugin-pg' },
+ redis: { enabled: false, path: '@opentelemetry/plugin-redis' },
+ ioredis: { enabled: false, path: '@opentelemetry/plugin-ioredis' },
+ 'pg-pool': { enabled: false, path: '@opentelemetry/plugin-pg-pool' },
+ express: { enabled: false, path: '@opentelemetry/plugin-express' },
+ '@hapi/hapi': { enabled: false, path: '@opentelemetry/hapi-instrumentation' },
+ koa: { enabled: false, path: '@opentelemetry/koa-instrumentation' },
+ dns: { enabled: false, path: '@opentelemetry/plugin-dns' },
+ },
+ },
+ ],
+ tracerProvider: provider,
+ });
+
+ return trace.getTracer('meta-node-example');
+};
diff --git a/metapackages/auto-instrumentations-node/.eslintignore b/metapackages/auto-instrumentations-node/.eslintignore
new file mode 100644
index 0000000000..03db8f9b34
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/.eslintignore
@@ -0,0 +1,2 @@
+build
+.eslintrc.js
diff --git a/metapackages/auto-instrumentations-node/.eslintrc.js b/metapackages/auto-instrumentations-node/.eslintrc.js
new file mode 100644
index 0000000000..fe91e21049
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/.eslintrc.js
@@ -0,0 +1,8 @@
+module.exports = {
+ "env": {
+ "commonjs": true,
+ "node": true,
+ "mocha": true,
+ },
+ ...require('../../eslint.config.js')
+}
diff --git a/metapackages/auto-instrumentations-node/.npmignore b/metapackages/auto-instrumentations-node/.npmignore
new file mode 100644
index 0000000000..9505ba9450
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/.npmignore
@@ -0,0 +1,4 @@
+/bin
+/coverage
+/doc
+/test
diff --git a/metapackages/auto-instrumentations-node/LICENSE b/metapackages/auto-instrumentations-node/LICENSE
new file mode 100644
index 0000000000..261eeb9e9f
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/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/metapackages/auto-instrumentations-node/README.md b/metapackages/auto-instrumentations-node/README.md
new file mode 100644
index 0000000000..a0c60fb676
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/README.md
@@ -0,0 +1,61 @@
+#OpenTelemetry Meta Packages for Node
+[![NPM Published Version][npm-img]][npm-url]
+[![dependencies][dependencies-image]][dependencies-url]
+[![devDependencies][devDependencies-image]][devDependencies-url]
+[![Apache License][license-image]][license-url]
+
+## Installation
+
+```bash
+npm install --save @opentelemetry/auto-instrumentations-node
+```
+
+## Usage
+
+```javascript
+const { NodeTracerProvider } = require('@opentelemetry/node');
+const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
+const { CollectorTraceExporter } = require('@opentelemetry/exporter-collector');
+const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
+const { registerInstrumentations } = require('@opentelemetry/instrumentation');
+
+const exporter = new CollectorTraceExporter({
+ serviceName: 'auto-instrumentations-node',
+});
+
+const provider = new NodeTracerProvider();
+provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
+provider.register();
+
+registerInstrumentations({
+ instrumentations: [
+ getNodeAutoInstrumentations({
+ // load custom configuration for http instrumentation
+ "@opentelemetry/instrumentation-http": {
+ applyCustomAttributesOnSpan: (span)=> {
+ span.setAttribute('foo2', 'bar2');
+ },
+ },
+ }),
+ ],
+});
+
+```
+
+## Useful links
+
+- For more information on OpenTelemetry, visit:
+- For more about OpenTelemetry JavaScript:
+
+## License
+
+APACHE 2.0 - See [LICENSE][license-url] for more information.
+
+[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://david-dm.org/open-telemetry/opentelemetry-js-contrib.svg?path=packages%2Fauto-instrumentations-node
+[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fauto-instrumentations-node
+[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib.svg?path=packages%2Fauto-instrumentations-node&type=dev
+[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fauto-instrumentations-node&type=dev
+[npm-url]: https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fauto-instrumentations-node.svg
diff --git a/metapackages/auto-instrumentations-node/package.json b/metapackages/auto-instrumentations-node/package.json
new file mode 100644
index 0000000000..411eb163d4
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/package.json
@@ -0,0 +1,59 @@
+{
+ "name": "@opentelemetry/auto-instrumentations-node",
+ "version": "0.14.0",
+ "description": "Metapackage which bundles opentelemetry node core and contrib instrumentations",
+ "author": "OpenTelemetry Authors",
+ "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib#readme",
+ "license": "Apache-2.0",
+ "publishConfig": {
+ "access": "public"
+ },
+ "main": "build/src/index.js",
+ "types": "build/src/index.d.ts",
+ "repository": "open-telemetry/opentelemetry-js-contrib",
+ "scripts": {
+ "clean": "rimraf build/*",
+ "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
+ "compile": "tsc -p .",
+ "lint": "eslint . --ext .ts",
+ "lint:fix": "eslint . --ext .ts --fix",
+ "precompile": "tsc --version",
+ "prepare": "npm run compile",
+ "tdd": "yarn test -- --watch-extensions ts --watch",
+ "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.ts'",
+ "watch": "tsc -w"
+ },
+ "bugs": {
+ "url": "https://github.com/open-telemetry/opentelemetry-js-contrib/issues"
+ },
+ "devDependencies": {
+ "@types/node": "14.0.27",
+ "@types/mocha": "7.0.2",
+ "@types/sinon": "9.0.11",
+ "codecov": "3.7.2",
+ "gts": "3.1.0",
+ "mocha": "7.2.0",
+ "nyc": "15.1.0",
+ "rimraf": "3.0.2",
+ "sinon": "9.2.3",
+ "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",
+ "@opentelemetry/instrumentation-dns": "^0.14.0",
+ "@opentelemetry/instrumentation-express": "^0.14.0",
+ "@opentelemetry/instrumentation-http": "^0.18.0",
+ "@opentelemetry/instrumentation-graphql": "^0.14.0",
+ "@opentelemetry/instrumentation-grpc": "^0.18.0",
+ "@opentelemetry/instrumentation-koa": "^0.14.0",
+ "@opentelemetry/instrumentation-ioredis": "^0.14.0",
+ "@opentelemetry/instrumentation-mongodb": "^0.14.0",
+ "@opentelemetry/instrumentation-pg": "^0.14.0",
+ "@opentelemetry/instrumentation-redis": "^0.14.0"
+ }
+}
diff --git a/metapackages/auto-instrumentations-node/src/index.ts b/metapackages/auto-instrumentations-node/src/index.ts
new file mode 100644
index 0000000000..3c0c688a05
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/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 { getNodeAutoInstrumentations, InstrumentationConfigMap } from './utils';
diff --git a/metapackages/auto-instrumentations-node/src/utils.ts b/metapackages/auto-instrumentations-node/src/utils.ts
new file mode 100644
index 0000000000..2facebf623
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/src/utils.ts
@@ -0,0 +1,86 @@
+/*
+ * 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 { diag } from '@opentelemetry/api';
+import { Instrumentation } from '@opentelemetry/instrumentation';
+import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';
+import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
+import { GraphQLInstrumentation } from '@opentelemetry/instrumentation-graphql';
+import { GrpcInstrumentation } from '@opentelemetry/instrumentation-grpc';
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
+import { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis';
+import { KoaInstrumentation } from '@opentelemetry/instrumentation-koa';
+import { MongoDBInstrumentation } from '@opentelemetry/instrumentation-mongodb';
+import { PgInstrumentation } from '@opentelemetry/instrumentation-pg';
+// import { MySQLInstrumentation } from '@opentelemetry/instrumentation-mysql';
+import { RedisInstrumentation } from '@opentelemetry/instrumentation-redis';
+
+const InstrumentationMap = {
+ '@opentelemetry/instrumentation-dns': DnsInstrumentation,
+ '@opentelemetry/instrumentation-express': ExpressInstrumentation,
+ '@opentelemetry/instrumentation-http': HttpInstrumentation,
+ '@opentelemetry/instrumentation-graphql': GraphQLInstrumentation,
+ '@opentelemetry/instrumentation-grpc': GrpcInstrumentation,
+ '@opentelemetry/instrumentation-koa': KoaInstrumentation,
+ '@opentelemetry/instrumentation-ioredis': IORedisInstrumentation,
+ '@opentelemetry/instrumentation-mongodb': MongoDBInstrumentation,
+ '@opentelemetry/instrumentation-pg': PgInstrumentation,
+ // '@opentelemetry/instrumentation-mysql': MySQLInstrumentation,
+ '@opentelemetry/instrumentation-redis': RedisInstrumentation,
+};
+
+// Config types inferred automatically from the first argument of the constructor
+type ConfigArg = T extends new (...args: infer U) => unknown ? U[0] : never;
+export type InstrumentationConfigMap = {
+ [Name in keyof typeof InstrumentationMap]?: ConfigArg<
+ typeof InstrumentationMap[Name]
+ >;
+};
+
+export function getNodeAutoInstrumentations(
+ inputConfigs: InstrumentationConfigMap = {}
+): Instrumentation[] {
+ for (const name of Object.keys(inputConfigs)) {
+ if (!Object.prototype.hasOwnProperty.call(InstrumentationMap, name)) {
+ diag.error(`Provided instrumentation name "${name}" not found`);
+ continue;
+ }
+ }
+
+ const instrumentations: Instrumentation[] = [];
+
+ for (const name of Object.keys(InstrumentationMap) as Array<
+ keyof typeof InstrumentationMap
+ >) {
+ const Instance = InstrumentationMap[name];
+ // Defaults are defined by the instrumentation itself
+ const userConfig = inputConfigs[name] ?? {};
+
+ if (userConfig.enabled === false) {
+ diag.debug(`Disabling instrumentation for ${name}`);
+ continue;
+ }
+
+ try {
+ diag.debug(`Loading instrumentation for ${name}`);
+ instrumentations.push(new Instance(userConfig));
+ } catch (e) {
+ diag.error(e);
+ }
+ }
+
+ return instrumentations;
+}
diff --git a/metapackages/auto-instrumentations-node/test/utils.test.ts b/metapackages/auto-instrumentations-node/test/utils.test.ts
new file mode 100644
index 0000000000..ce934382c5
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/test/utils.test.ts
@@ -0,0 +1,103 @@
+/*
+ * 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 { diag } from '@opentelemetry/api';
+import { HttpInstrumentationConfig } from '@opentelemetry/instrumentation-http';
+import * as assert from 'assert';
+import * as sinon from 'sinon';
+import { getNodeAutoInstrumentations } from '../src';
+
+describe('utils', () => {
+ describe('getNodeAutoInstrumentations', () => {
+ it('should load default instrumentations', () => {
+ const instrumentations = getNodeAutoInstrumentations();
+ const expectedInstrumentations = [
+ '@opentelemetry/instrumentation-dns',
+ '@opentelemetry/instrumentation-express',
+ '@opentelemetry/instrumentation-http',
+ '@opentelemetry/instrumentation-graphql',
+ '@opentelemetry/instrumentation-grpc',
+ '@opentelemetry/instrumentation-koa',
+ '@opentelemetry/instrumentation-ioredis',
+ '@opentelemetry/instrumentation-mongodb',
+ // '@opentelemetry/instrumentation-mysql',
+ '@opentelemetry/instrumentation-pg',
+ '@opentelemetry/instrumentation-redis',
+ ];
+ assert.strictEqual(instrumentations.length, 10);
+ for (let i = 0, j = instrumentations.length; i < j; i++) {
+ assert.strictEqual(
+ instrumentations[i].instrumentationName,
+ expectedInstrumentations[i],
+ `Instrumentation ${expectedInstrumentations[i]}, not loaded`
+ );
+ }
+ });
+
+ it('should use user config', () => {
+ function applyCustomAttributesOnSpan() {}
+
+ const instrumentations = getNodeAutoInstrumentations({
+ '@opentelemetry/instrumentation-http': {
+ applyCustomAttributesOnSpan,
+ },
+ });
+ const instrumentation = instrumentations.find(
+ instr =>
+ instr.instrumentationName === '@opentelemetry/instrumentation-http'
+ ) as any;
+ const configHttp = instrumentation._config as HttpInstrumentationConfig;
+
+ assert.strictEqual(
+ configHttp.applyCustomAttributesOnSpan,
+ applyCustomAttributesOnSpan
+ );
+ });
+
+ it('should not return disabled instrumentation', () => {
+ const instrumentations = getNodeAutoInstrumentations({
+ '@opentelemetry/instrumentation-grpc': {
+ enabled: false,
+ },
+ });
+ const instrumentation = instrumentations.find(
+ instr =>
+ instr.instrumentationName === '@opentelemetry/instrumentation-grpc'
+ );
+ assert.strictEqual(instrumentation, undefined);
+ });
+
+ it('should show error for none existing instrumentation', () => {
+ const spy = sinon.stub(diag, 'error');
+ const name = '@opentelemetry/instrumentation-http2';
+ const instrumentations = getNodeAutoInstrumentations({
+ // @ts-expect-error verify that wrong name works
+ [name]: {
+ enabled: false,
+ },
+ });
+ const instrumentation = instrumentations.find(
+ instr => instr.instrumentationName === name
+ );
+ assert.strictEqual(instrumentation, undefined);
+
+ assert.strictEqual(
+ spy.args[0][0],
+ `Provided instrumentation name "${name}" not found`
+ );
+ });
+ });
+});
diff --git a/metapackages/auto-instrumentations-node/tsconfig.json b/metapackages/auto-instrumentations-node/tsconfig.json
new file mode 100644
index 0000000000..4078877ce6
--- /dev/null
+++ b/metapackages/auto-instrumentations-node/tsconfig.json
@@ -0,0 +1,11 @@
+{
+ "extends": "../../tsconfig.base",
+ "compilerOptions": {
+ "rootDir": ".",
+ "outDir": "build"
+ },
+ "include": [
+ "src/**/*.ts",
+ "test/**/*.ts"
+ ]
+}
diff --git a/plugins/node/opentelemetry-instrumentation-graphql/src/graphql.ts b/plugins/node/opentelemetry-instrumentation-graphql/src/graphql.ts
index c0b9a80e97..521f7c6716 100644
--- a/plugins/node/opentelemetry-instrumentation-graphql/src/graphql.ts
+++ b/plugins/node/opentelemetry-instrumentation-graphql/src/graphql.ts
@@ -65,7 +65,11 @@ export class GraphQLInstrumentation extends InstrumentationBase {
constructor(
config: GraphQLInstrumentationConfig & InstrumentationConfig = {}
) {
- super('graphql', VERSION, Object.assign({}, DEFAULT_CONFIG, config));
+ super(
+ '@opentelemetry/instrumentation-graphql',
+ VERSION,
+ Object.assign({}, DEFAULT_CONFIG, config)
+ );
}
private _getConfig(): GraphQLInstrumentationParsedConfig {
diff --git a/plugins/node/opentelemetry-instrumentation-graphql/src/index.ts b/plugins/node/opentelemetry-instrumentation-graphql/src/index.ts
index 9bdb560f36..31380edff1 100644
--- a/plugins/node/opentelemetry-instrumentation-graphql/src/index.ts
+++ b/plugins/node/opentelemetry-instrumentation-graphql/src/index.ts
@@ -15,3 +15,4 @@
*/
export * from './graphql';
+export { GraphQLInstrumentationConfig } from './types';
diff --git a/plugins/node/opentelemetry-instrumentation-graphql/src/types.ts b/plugins/node/opentelemetry-instrumentation-graphql/src/types.ts
index b3b232ef94..ee18913311 100644
--- a/plugins/node/opentelemetry-instrumentation-graphql/src/types.ts
+++ b/plugins/node/opentelemetry-instrumentation-graphql/src/types.ts
@@ -29,7 +29,7 @@ import { OTEL_GRAPHQL_DATA_SYMBOL, OTEL_PATCHED_SYMBOL } from './symbols';
export const OPERATION_NOT_SUPPORTED =
'Operation$operationName$not' + ' supported';
-export interface GraphQLInstrumentationConfig {
+export interface GraphQLInstrumentationConfig extends InstrumentationConfig {
/**
* When set to true it will not remove attributes values from schema source.
* By default all values that can be sensitive are removed and replaced
diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/src/index.ts b/plugins/node/opentelemetry-instrumentation-mongodb/src/index.ts
index 1ff498a776..e92c152120 100644
--- a/plugins/node/opentelemetry-instrumentation-mongodb/src/index.ts
+++ b/plugins/node/opentelemetry-instrumentation-mongodb/src/index.ts
@@ -15,4 +15,4 @@
*/
export * from './mongodb';
-export { MongoDbInstrumentationConfig } from './types';
+export { MongoDBInstrumentationConfig } from './types';
diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/src/mongodb.ts b/plugins/node/opentelemetry-instrumentation-mongodb/src/mongodb.ts
index c72a406442..915d8b140b 100644
--- a/plugins/node/opentelemetry-instrumentation-mongodb/src/mongodb.ts
+++ b/plugins/node/opentelemetry-instrumentation-mongodb/src/mongodb.ts
@@ -28,7 +28,7 @@ import {
MongoInternalCommand,
MongoInternalTopology,
WireProtocolInternal,
- MongoDbInstrumentationConfig,
+ MongoDBInstrumentationConfig,
CursorState,
} from './types';
import { VERSION } from './version';
@@ -49,7 +49,7 @@ const supportedVersions = ['>=3.3 <4'];
export class MongoDBInstrumentation extends InstrumentationBase<
typeof mongodb
> {
- constructor(protected _config: MongoDbInstrumentationConfig = {}) {
+ constructor(protected _config: MongoDBInstrumentationConfig = {}) {
super('@opentelemetry/instrumentation-mongodb', VERSION, _config);
}
diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/src/types.ts b/plugins/node/opentelemetry-instrumentation-mongodb/src/types.ts
index ef418e2a33..6948928d9a 100644
--- a/plugins/node/opentelemetry-instrumentation-mongodb/src/types.ts
+++ b/plugins/node/opentelemetry-instrumentation-mongodb/src/types.ts
@@ -16,7 +16,7 @@
import { InstrumentationConfig } from '@opentelemetry/instrumentation';
-export interface MongoDbInstrumentationConfig extends InstrumentationConfig {
+export interface MongoDBInstrumentationConfig extends InstrumentationConfig {
/**
* If true, additional information about query parameters and
* results will be attached (as `attributes`) to spans representing
diff --git a/plugins/node/opentelemetry-instrumentation-pg/src/pg.ts b/plugins/node/opentelemetry-instrumentation-pg/src/pg.ts
index 49221526c0..1e2cca96a3 100644
--- a/plugins/node/opentelemetry-instrumentation-pg/src/pg.ts
+++ b/plugins/node/opentelemetry-instrumentation-pg/src/pg.ts
@@ -41,7 +41,7 @@ import * as utils from './utils';
import { AttributeNames } from './enums';
import { VERSION } from './version';
-export interface PgInstrumentationConfig {
+export interface PgInstrumentationConfig extends InstrumentationConfig {
/**
* If true, additional information about query parameters and
* results will be attached (as `attributes`) to spans representing
@@ -58,7 +58,7 @@ export class PgInstrumentation extends InstrumentationBase {
static readonly BASE_SPAN_NAME = PgInstrumentation.COMPONENT + '.query';
- constructor(config: InstrumentationConfig & PgInstrumentationConfig = {}) {
+ constructor(config: PgInstrumentationConfig = {}) {
super(
'@opentelemetry/instrumentation-pg',
VERSION,