@opentelemetry/instrumentation - npm Package Compare versions

Comparing version 0.19.0 to 0.19.1-alpha.11

package.json

 {
   "name": "@opentelemetry/instrumentation",
-  "version": "0.19.0",
+  "version": "0.19.1-alpha.11+2afcc7c9",
   "description": "Base class for node which OpenTelemetry instrumentation modules extend",
@@ -9,2 +9,3 @@ "author": "OpenTelemetry Authors",
   "main": "build/src/index.js",
+  "module": "build/esm/index.js",
   "types": "build/src/index.d.ts",
@@ -20,5 +21,9 @@ "publishConfig": {
     "./src/platform/index.ts": "./src/platform/browser/index.ts",
+    "./build/esm/platform/index.js": "./build/esm/platform/browser/index.js",
     "./build/src/platform/index.js": "./build/src/platform/browser/index.js"
   },
   "files": [
+    "build/esm/**/*.js",
+    "build/esm/**/*.js.map",
+    "build/esm/**/*.d.ts",
     "build/src/**/*.js",
@@ -32,4 +37,4 @@ "build/src/**/*.js.map",
   "scripts": {
-    "compile": "tsc --build",
-    "clean": "tsc --build --clean",
+    "compile": "tsc --build tsconfig.json tsconfig.esm.json",
+    "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json",
     "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
@@ -45,3 +50,3 @@ "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
     "version": "node ../../scripts/version-update.js",
-    "watch": "tsc --build --watch"
+    "watch": "tsc --build --watch tsconfig.json tsconfig.esm.json"
   },
@@ -61,3 +66,3 @@ "keywords": [
   "dependencies": {
-    "@opentelemetry/api-metrics": "0.19.0",
+    "@opentelemetry/api-metrics": "^0.19.1-alpha.11+2afcc7c9",
     "require-in-the-middle": "^5.0.3",
@@ -71,7 +76,7 @@ "semver": "^7.3.2",
   "devDependencies": {
-    "@babel/core": "7.13.15",
+    "@babel/core": "7.14.0",
     "@opentelemetry/api": "^1.0.0-rc.0",
     "@types/mocha": "8.2.2",
-    "@types/node": "14.14.37",
-    "@types/semver": "7.3.4",
+    "@types/node": "14.14.43",
+    "@types/semver": "7.3.5",
     "@types/shimmer": "1.0.1",
@@ -95,3 +100,3 @@ "@types/sinon": "9.0.11",
     "sinon": "10.0.0",
-    "ts-loader": "8.1.0",
+    "ts-loader": "8.2.0",
     "ts-mocha": "8.0.0",
@@ -104,3 +109,3 @@ "ts-node": "9.1.1",
   },
-  "gitHead": "0c15999dccd377294a03cf7d36085216d6e8c5c1"
+  "gitHead": "2afcc7c90d93bac4fa9180f4fd312ed01370b2b5"
 }

README.md

@@ -112,3 +112,3 @@ # OpenTelemetry Instrumentation for web and node
 const myPLugin = new MyPlugin();
-myPLugin.setTracerProvider(provider); // this is optional
+myPLugin.setTracerProvider(provider); // this is optional, only if global TracerProvider shouldn't be used
 myPLugin.setMeterProvider(meterProvider); // this is optional
@@ -155,4 +155,4 @@ myPLugin.enable();
 const myPLugin = new MyPlugin();
-myPLugin.setTracerProvider(provider);
-myPLugin.setMeterProvider(meterProvider);
+myPLugin.setTracerProvider(provider); // this is optional, only if global TracerProvider shouldn't be used
+myPLugin.setMeterProvider(meterProvider); // this is optional, only if global MeterProvider shouldn't be used
 myPLugin.enable();
@@ -226,3 +226,4 @@ // or use Auto Loader
   ],
-  tracerProvider: tracerProvider,
+  //tracerProvider: tracerProvider, // optional, only if global TracerProvider shouldn't be used
+  //meterProvider: meterProvider, // optional, only if global MeterProvider shouldn't be used
 });
@@ -255,6 +256,15 @@
   ],
-  tracerProvider: tracerProvider,
+  //tracerProvider: tracerProvider, // optional, only if global TracerProvider shouldn't be used
+  //meterProvider: meterProvider, // optional, only if global MeterProvider shouldn't be used
 });
 ```
 
+## Selection of the used TracerProvider/MeterProvider
+
+The `registerInstrumentations()` API allows to specify which `TracerProvider` and/or `MeterProvider` to use by the given options object.
+If nothing is specified the global registered provider is used. Usually this is what most users want therefore it's recommended to keep this default.
+
+There might be usecase where someone has the need for more providers within an application. Please note that special care must be takes in such setups
+to avoid leaking information from one provider to the other because there are a lot places where e.g. the global `ContextManager` or `Propagator` is used.
+
 ## License
@@ -261,0 +271,0 @@

New alerts

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

122500

74.43%

Number of package files

99

94.12%

Lines of code

1808

103.6%

Number of lines in readme file

284

3.65%

Worsened metrics

Number of low supply chain risk alerts

2

100%

Number of medium supply chain risk alerts

1

Infinity%

Dependency changes

• + Added

  @opentelemetry/api@0.20.0
  (transitive)

• + Added

  @opentelemetry/api-metrics@0.19.1-alpha.43
  (transitive)

• - Removed

  @opentelemetry/api-metrics@0.19.0
  (transitive)

• Updated

  @opentelemetry/api-metrics@^0.19.1-alpha.11+2afcc7c9