diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 1c85dfe699..4c08b33a6a 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -16,6 +16,7 @@ jobs: path: | node_modules packages/*/node_modules + metapackages/*/node_modules plugins/node/*/node_modules plugins/web/*/node_modules propagators/*/node_modules diff --git a/README.md b/README.md index 05c41b024b..07f116bea0 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,12 @@ OpenTelemetry can collect tracing data automatically using plugins. Vendors/User - [@opentelemetry/plugin-xml-http-request][otel-plugin-xml-http-request] - [@opentelemetry/plugin-user-interaction][otel-plugin-user-interaction] +### Metapackages + +Multiple plugins may be leveraged via metapackages. + +- [@opentelemetry/plugins-node-all][otel-plugins-node-all] - all officially supported core and contrib plugins. + ## Contributing We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and @@ -101,3 +107,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [otel-plugin-user-interaction]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web/opentelemetry-plugin-user-interaction [otel-plugin-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web/opentelemetry-plugin-xml-http-request [otel-plugin-express]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-express +[otel-plugins-node-all]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/metapackages/plugins-node-all diff --git a/lerna.json b/lerna.json index 672b2cc5a3..d769977b4e 100644 --- a/lerna.json +++ b/lerna.json @@ -3,6 +3,7 @@ "npmClient": "npm", "packages": [ "packages/*", + "metapackages/*", "plugins/node/*", "plugins/web/*", "propagators/*" diff --git a/metapackages/plugins-node-all/README.md b/metapackages/plugins-node-all/README.md new file mode 100644 index 0000000000..85aadc68e6 --- /dev/null +++ b/metapackages/plugins-node-all/README.md @@ -0,0 +1,53 @@ +# OpenTelemetry Plugins Node All + +[![Gitter chat][gitter-image]][gitter-url] +[![NPM Published Version][npm-img]][npm-url] +[![dependencies][dependencies-image]][dependencies-url] +[![Apache License][license-image]][license-image] + +This package depends on all node plugins maintained by OpenTelemetry authors. +Installing it will also install all plugins. + +## Plugins + +In addition to all [node core plugins][otel-plugins-node-core], the following plugins will be installed by this package: + +- [@opentelemetry/plugin-express][otel-plugin-express] +- [@opentelemetry/plugin-ioredis][otel-plugin-ioredis] +- [@opentelemetry/plugin-mongodb][otel-plugin-mongodb] +- [@opentelemetry/plugin-mysql][otel-plugin-mysql] +- [@opentelemetry/plugin-pg-pool][otel-plugin-pg-pool] +- [@opentelemetry/plugin-pg][otel-plugin-pg] +- [@opentelemetry/plugin-redis][otel-plugin-redis] + +Note: [@opentelemetry/plugin-dns][otel-plugin-dns] is excluded by default because it requires some manual configuration to prevent infinite loops with exporters. + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us on [gitter][gitter-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg +[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=metapackages/plugins-node-core +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetryplugins-node-core +[npm-url]: https://www.npmjs.com/package/@opentelemetry/plugins-node-core +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fplugins-node-core.svg + +[otel-plugins-node-core]: https://www.npmjs.com/package/@opentelemetry/plugins-node-core + +[otel-plugin-dns]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-dns +[otel-plugin-express]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-express +[otel-plugin-ioredis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-ioredis +[otel-plugin-mongodb]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-mongodb +[otel-plugin-mysql]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-mysql +[otel-plugin-pg-pool]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-pg-pool +[otel-plugin-pg]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-pg +[otel-plugin-redis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-redis diff --git a/metapackages/plugins-node-all/package.json b/metapackages/plugins-node-all/package.json new file mode 100644 index 0000000000..764224a2f7 --- /dev/null +++ b/metapackages/plugins-node-all/package.json @@ -0,0 +1,28 @@ +{ + "name": "@opentelemetry/plugins-node-all", + "version": "0.10.2", + "description": "Metapackage which bundles opentelemetry node core and contrib plugins", + "author": "OpenTelemetry Authors", + "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme", + "license": "Apache-2.0", + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/open-telemetry/opentelemetry-js.git" + }, + "bugs": { + "url": "https://github.com/open-telemetry/opentelemetry-js/issues" + }, + "dependencies": { + "@opentelemetry/plugin-express": "0.9.0", + "@opentelemetry/plugin-ioredis": "0.9.0", + "@opentelemetry/plugin-mongodb": "0.9.0", + "@opentelemetry/plugin-mysql": "0.9.0", + "@opentelemetry/plugin-pg": "0.9.0", + "@opentelemetry/plugin-pg-pool": "0.9.0", + "@opentelemetry/plugin-redis": "0.9.0", + "@opentelemetry/plugins-node-core": "^0.10.2" + } +}