Merge branch 'main' into feat/sdk-env-propagators

open-telemetry · Apr 10, 2021 · a3291b3 · a3291b3
2 parents c824634 + 031b0f4
commit a3291b3
Show file tree

Hide file tree

Showing 260 changed files with 2,868 additions and 13,405 deletions.
diff --git a/README.md b/README.md
@@ -185,7 +185,7 @@ Maintainers ([@open-telemetry/js-maintainers](https://github.com/orgs/open-telem
 
 | Package                                | Description                                                                                                                                                                                                                                                  |
 |----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [@opentelemetry/tracing][otel-tracing] | This module provides a full control over instrumentation and span creation. It doesn't load [`async_hooks`](https://nodejs.org/api/async_hooks.html) or any instrumentation plugin by default. It is intended for use both on the server and in the browser. |
+| [@opentelemetry/tracing][otel-tracing] | This module provides a full control over instrumentation and span creation. It doesn't load [`async_hooks`](https://nodejs.org/api/async_hooks.html) or any instrumentation by default. It is intended for use both on the server and in the browser.        |
 | [@opentelemetry/metrics][otel-metrics] | This module provides instruments and meters for reporting of time series data.                                                                                                                                                                               |
 | [@opentelemetry/node][otel-node]       | This module provides automatic tracing for Node.js applications. It is intended for use on the server only.                                                                                                                                                  |
 | [@opentelemetry/web][otel-web]         | This module provides automated instrumentation and tracing for Web applications. It is intended for use in the browser only.                                                                                                                                 |
@@ -196,34 +196,32 @@ OpenTelemetry is vendor-agnostic and can upload data to any backend with various
 
 See the [OpenTelemetry registry](https://opentelemetry.io/registry/?s=node.js) for a list of exporters available.
 
-### Instrumentations & Plugins
+### Instrumentations
 
 OpenTelemetry can collect tracing data automatically using instrumentations. Vendors/Users can also create and use their own. Currently, OpenTelemetry supports automatic tracing for:
 
-#### Node Instrumentations & Plugins
+#### Node Instrumentations
 
 ##### Core
 
-- [@opentelemetry/instrumentation-grpc][otel-instrumentation-grpc] previous [@opentelemetry/plugin-grpc][otel-plugin-grpc]
-- [@opentelemetry/plugin-grpc-js][otel-plugin-grpc-js]
-- [@opentelemetry/instrumentation-http][otel-instrumentation-http] previous [@opentelemetry/plugin-http][otel-plugin-http] and [@opentelemetry/plugin-https][otel-plugin-https]
+- [@opentelemetry/instrumentation-grpc][otel-instrumentation-grpc]
+- [@opentelemetry/instrumentation-http][otel-instrumentation-http]
 
 ##### Contrib
 
 These plugins are hosted at <https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node>
 
-- [@opentelemetry/plugin-mongodb][otel-contrib-plugin-mongodb]
-- [@opentelemetry/plugin-mysql][otel-contrib-plugin-mysql]
-- [@opentelemetry/plugin-pg][otel-contrib-plugin-pg]
-- [@opentelemetry/plugin-pg-pool][otel-contrib-plugin-pg-pool]
-- [@opentelemetry/plugin-redis][otel-contrib-plugin-redis]
-- [@opentelemetry/plugin-ioredis][otel-contrib-plugin-ioredis]
-- [@opentelemetry/plugin-express][otel-contrib-plugin-express]
-- [@opentelemetry/plugin-dns][otel-contrib-plugin-dns]
+- [@opentelemetry/instrumentation-mongodb][otel-contrib-instrumentation-mongodb]
+- [@opentelemetry/instrumentation-mysql][otel-contrib-instrumentation-mysql]
+- [@opentelemetry/instrumentation-pg][otel-contrib-instrumentation-pg]
+- [@opentelemetry/instrumentation-redis][otel-contrib-instrumentation-redis]
+- [@opentelemetry/instrumentation-ioredis][otel-contrib-instrumentation-ioredis]
+- [@opentelemetry/instrumentation-express][otel-contrib-instrumentation-express]
+- [@opentelemetry/instrumentation-dns][otel-contrib-instrumentation-dns]
 - [@opentelemetry/instrumentation-hapi][otel-contrib-instrumentation-hapi]
 - [@opentelemetry/instrumentation-koa][otel-contrib-instrumentation-koa]
 
-#### Web Plugins
+#### Web Instrumentations
 
 ##### Core
 
@@ -232,7 +230,7 @@ These plugins are hosted at <https://github.com/open-telemetry/opentelemetry-js-
 
 ##### Contrib
 
-These plugins are hosted at <https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web>
+These instrumentations are hosted at <https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web>
 
 - [@opentelemetry/instrumentation-document-load][otel-contrib-instrumentation-document-load]
 - [@opentelemetry/instrumentation-user-interaction][otel-contrib-instrumentation-user-interaction]
@@ -247,6 +245,10 @@ To request automatic tracing support for a module not on this list, please [file
 
 ## Upgrade guidelines
 
+### 0.19.0 to 1.0.0-rc.0
+
+- All plugins have been removed in favor of instrumentations.
+
 ### 0.18.0 to 0.19.0
 
 - The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header endcoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [readme](./packages/opentelemetry-propagator-b3/readme.md) for full details and usage.
@@ -415,11 +417,6 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [otel-metrics]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-metrics
 [otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node
 
-[otel-plugin-grpc]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-plugin-grpc
-[otel-plugin-grpc-js]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-plugin-grpc-js
-[otel-plugin-http]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-plugin-http
-[otel-plugin-https]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-plugin-https
-
 [otel-instrumentation-fetch]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-fetch
 [otel-instrumentation-grpc]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-grpc
 [otel-instrumentation-http]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-http
@@ -432,14 +429,13 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [otel-core]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-core
 [generate-api-documentation]: https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md#generating-api-documentation
 
-[otel-contrib-plugin-dns]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-dns
-[otel-contrib-plugin-ioredis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-ioredis
-[otel-contrib-plugin-mongodb]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-mongodb
-[otel-contrib-plugin-mysql]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-mysql
-[otel-contrib-plugin-pg-pool]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-pg-pool
-[otel-contrib-plugin-pg]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-pg
-[otel-contrib-plugin-redis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-redis
-[otel-contrib-plugin-express]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-plugin-express
+[otel-contrib-instrumentation-dns]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-dns
+[otel-contrib-instrumentation-ioredis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-ioredis
+[otel-contrib-instrumentation-mongodb]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-mongodb
+[otel-contrib-instrumentation-mysql]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-mysql
+[otel-contrib-instrumentation-pg]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-pg
+[otel-contrib-instrumentation-redis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-redis
+[otel-contrib-instrumentation-express]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-express
 [otel-contrib-instrumentation-user-interaction]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web/opentelemetry-instrumentation-user-interaction
 [otel-contrib-instrumentation-document-load]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web/opentelemetry-instrumentation-document-load
 [otel-contrib-instrumentation-hapi]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-hapi

diff --git a/doc/instrumentation-guide.md b/doc/instrumentation-guide.md
@@ -1,52 +1,11 @@
 # Instrumentation Developer Guide
 
-We provide out-of-the-box instrumentations for many popular frameworks and libraries by using an instrumentation system (see [builtin instrumentations][builtin-instrumentations]), and provide a means for developers to create their own.
+A detailed explained guide how to instrument a package is available at [instrumentation package][base-instrumentation]
 
-We strongly recommended to create a dedicated package for newly added plugin, example: `@opentelemetry/plugin-xxx`.
+For more comprehensive examples please refer to the [HTTP instrumentation][http-instrumentation] or [gRPC instrumentation][grpc-instrumentation] for node
+and [XMLHttpRequest instrumentation][xhr-instrumentation] for web.
 
-Each plugin must extend the abstract class [BasePlugin][base-plugin] implementing the below methods:
-
-- `patch`: A function describing how the module exports for a given file should be modified.
-
-- `unpatch`: A function describing how the module exports for a given file should be unpatched. This should generally mirror the logic in `patch`; for example, if `patch` wraps a method, `unpatch` should unwrap it.
-
-The core `PluginLoader` class is responsible for loading the instrumented plugins that use a patch mechanism to enable automatic tracing for specific target modules. In order to load new plugin, it should export `plugin` identifier.
-
-```typescript
-export const plugin = new HttpPlugin(...);
-```
-
-> Example of simple module plugin created and used in the tests.
-<https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-node/test/instrumentation/node_modules/%40opentelemetry/plugin-simple-module/simple-module.js>
-
-After the plugin is created, it must be added in the [list of default supported plugins][DEFAULT_INSTRUMENTATION_PLUGINS].
-
-```typescript
-export const DEFAULT_INSTRUMENTATION_PLUGINS: Plugins = {
-  http: {
-    enabled: true,
-    path: '@opentelemetry/plugin-http',
-  },
-  grpc: {
-    enabled: true,
-    path: '@opentelemetry/plugin-grpc',
-  },
-  // [ADD NEW PLUGIN HERE]
-  xxx: {
-    enabled: true,
-    // You may use a package name or absolute path to the file.
-    path: '@opentelemetry/plugin-xxx',
-  }
-};
-```
-
-We recommend using [`shimmer`][shimmer] to modify function properties on objects.
-
-Please refer to the [HTTP instrumentation][http-plugin] or [gRPC instrumentation][grpc-plugin] for more comprehensive examples.
-
-[shimmer]: https://github.com/othiym23/shimmer
-[builtin-instrumentations]: https://github.com/open-telemetry/opentelemetry-js#instrumentations&plugins
-[base-plugin]: https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-core/src/platform/node/BasePlugin.ts
-[http-plugin]: https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-plugin-http/src/http.ts#L44
-[grpc-plugin]: https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-plugin-grpc/src/grpc.ts#L52
-[DEFAULT_INSTRUMENTATION_PLUGINS]: https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-node/src/config.ts#L29
+[base-instrumentation]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation
+[http-instrumentation]: https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-instrumentation-http/src/http.ts#L59
+[grpc-instrumentation]: https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts#L28
+[xhr-instrumentation]: https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts#L71
diff --git a/examples/grpc-js/package.json b/examples/grpc-js/package.json
@@ -33,8 +33,8 @@
     "@opentelemetry/exporter-jaeger": "^0.18.2",
     "@opentelemetry/exporter-zipkin": "^0.18.2",
     "@opentelemetry/instrumentation": "^0.18.2",
+    "@opentelemetry/instrumentation-grpc": "^0.18.2",
     "@opentelemetry/node": "^0.18.2",
-    "@opentelemetry/plugin-grpc-js": "^0.18.2",
     "@opentelemetry/tracing": "^0.18.2",
     "google-protobuf": "^3.9.2"
   },

diff --git a/examples/grpc-js/tracer.js b/examples/grpc-js/tracer.js
@@ -6,28 +6,15 @@ const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
+const { GrpcInstrumentation } = require('@opentelemetry/instrumentation-grpc');
 
 const EXPORTER = process.env.EXPORTER || '';
 
 module.exports = (serviceName) => {
   const provider = new NodeTracerProvider();
   registerInstrumentations({
     instrumentations: [
-      {
-        plugins: {
-          '@grpc/grpc-js': {
-            enabled: true,
-            path: '@opentelemetry/plugin-grpc-js',
-            // // when boostraping with lerna for testing purposes
-            // path: `${__dirname}/../../packages/opentelemetry-plugin-grpc-js/build/src`
-          },
-          // // when boostraping with lerna for testing purposes
-          // 'http': {
-          //   enabled: true,
-          //   path: `${__dirname}/../../packages/opentelemetry-plugin-http/build/src`
-          // },
-        },
-      },
+      new GrpcInstrumentation(),
     ],
     tracerProvider: provider,
   });

diff --git a/examples/grpc/package.json b/examples/grpc/package.json
@@ -32,8 +32,8 @@
     "@opentelemetry/exporter-jaeger": "^0.18.2",
     "@opentelemetry/exporter-zipkin": "^0.18.2",
     "@opentelemetry/instrumentation": "^0.18.2",
+    "@opentelemetry/instrumentation-grpc": "^0.18.2",
     "@opentelemetry/node": "^0.18.2",
-    "@opentelemetry/plugin-grpc": "^0.18.2",
     "@opentelemetry/tracing": "^0.18.2",
     "google-protobuf": "^3.9.2",
     "grpc": "^1.23.3",

diff --git a/examples/grpc/tracer.js b/examples/grpc/tracer.js
@@ -6,24 +6,17 @@ const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
+const { GrpcInstrumentation } = require('@opentelemetry/instrumentation-grpc');
 
 const EXPORTER = process.env.EXPORTER || '';
 
 module.exports = (serviceName) => {
   const provider = new NodeTracerProvider();
   registerInstrumentations({
     tracerProvider: provider,
-    // // when boostraping with lerna for testing purposes
-    // instrumentations: [
-    //   {
-    //     plugins: {
-    //       grpc: {
-    //         enabled: true,
-    //         path: `${__dirname}/../../packages/opentelemetry-plugin-grpc/build/src`
-    //       }
-    //     }
-    //   }
-    // ],
+    instrumentations: [
+      new GrpcInstrumentation(),
+    ],
   });
 
   let exporter;

diff --git a/examples/http/package.json b/examples/http/package.json
@@ -32,8 +32,8 @@
     "@opentelemetry/exporter-jaeger": "^0.18.2",
     "@opentelemetry/exporter-zipkin": "^0.18.2",
     "@opentelemetry/instrumentation": "^0.18.2",
+    "@opentelemetry/instrumentation-http": "^0.18.2",
     "@opentelemetry/node": "^0.18.2",
-    "@opentelemetry/plugin-http": "^0.18.2",
     "@opentelemetry/tracing": "^0.18.2"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme",

diff --git a/examples/http/tracer.js b/examples/http/tracer.js
@@ -6,6 +6,7 @@ const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
+const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
 
 const EXPORTER = process.env.EXPORTER || '';
 
@@ -14,16 +15,9 @@ module.exports = (serviceName) => {
   registerInstrumentations({
     tracerProvider: provider,
     // // when boostraping with lerna for testing purposes
-    // instrumentations: [
-    //   {
-    //     plugins: {
-    //       http: {
-    //         enabled: true,
-    //         path: `${__dirname}/../../packages/opentelemetry-plugin-http/build/src`
-    //       }
-    //     }
-    //   }
-    // ],
+    instrumentations: [
+      new HttpInstrumentation(),
+    ],
   });
 
   let exporter;

diff --git a/examples/https/package.json b/examples/https/package.json
@@ -33,8 +33,8 @@
     "@opentelemetry/exporter-jaeger": "^0.18.2",
     "@opentelemetry/exporter-zipkin": "^0.18.2",
     "@opentelemetry/instrumentation": "^0.18.2",
+    "@opentelemetry/instrumentation-http": "^0.18.2",
     "@opentelemetry/node": "^0.18.2",
-    "@opentelemetry/plugin-https": "^0.18.2",
     "@opentelemetry/tracing": "^0.18.2"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme",

diff --git a/examples/https/tracer.js b/examples/https/tracer.js
@@ -6,6 +6,7 @@ const { NodeTracerProvider } = require('@opentelemetry/node');
 const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
+const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
 
 const EXPORTER = process.env.EXPORTER || '';
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
@@ -15,17 +16,9 @@ module.exports = (serviceName) => {
   const provider = new NodeTracerProvider();
   registerInstrumentations({
     tracerProvider: provider,
-    // when boostraping with lerna for testing purposes
-    // instrumentations: [
-    //   {
-    //     plugins: {
-    //       https: {
-    //         enabled: true,
-    //         path: `${__dirname}/../../packages/opentelemetry-plugin-https/build/src`
-    //       }
-    //     }
-    //   }
-    // ],
+    instrumentations: [
+      new HttpInstrumentation(),
+    ],
   });
 
   if (EXPORTER.toLowerCase().startsWith('z')) {