Merge branch 'master' into undefined-null

open-telemetry · Nov 11, 2020 · 1573820 · 1573820
2 parents 2fc0108 + 894c8d8
commit 1573820
Show file tree

Hide file tree

Showing 41 changed files with 229 additions and 128 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -31,7 +31,7 @@ cache_2: &cache_2
  - packages/opentelemetry-plugin-http/node_modules
  - packages/opentelemetry-plugin-https/node_modules
  - packages/opentelemetry-exporter-collector/node_modules
- - packages/opentelemetry-plugin-xml-http-request/node_modules
+ - packages/opentelemetry-instrumentation-xml-http-request/node_modules
  - packages/opentelemetry-resource-detector-aws/node_modules
  - packages/opentelemetry-resource-detector-gcp/node_modules
  - packages/opentelemetry-resources/node_modules

diff --git a/README.md b/README.md
@@ -206,7 +206,7 @@ These plugins are hosted at <https://github.com/open-telemetry/opentelemetry-js-
 
 ##### Core
 
-- [@opentelemetry/plugin-xml-http-request][otel-plugin-xml-http-request]
+- [@opentelemetry/instrumentation-xml-http-request][otel-instrumentation-xml-http-request]
 - [@opentelemetry/plugin-fetch][otel-plugin-fetch]
 
 ##### Contrib
@@ -248,7 +248,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [otel-plugin-grpc-js]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-grpc-js
 [otel-plugin-http]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-http
 [otel-plugin-https]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-https
-[otel-plugin-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-xml-http-request
+[otel-instrumentation-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-instrumentation-xml-http-request
 
 [otel-shim-opentracing]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-shim-opentracing
 [otel-tracing]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracing

diff --git a/examples/tracer-web/examples/user-interaction/index.html b/examples/tracer-web/examples/user-interaction/index.html
@@ -21,7 +21,7 @@
 </head>
 
 <body>
- Example of using Web Tracer with UserInteractionPlugin and XMLHttpRequestPlugin with console exporter and collector exporter
+ Example of using Web Tracer with UserInteractionPlugin and XMLHttpRequestInstrumentation with console exporter and collector exporter
  <script type="text/javascript" src="user-interaction.js"></script>
  <br/>
  <button id="btnAdd" class="btnAddClass">Add button</button>

diff --git a/examples/tracer-web/examples/user-interaction/index.js b/examples/tracer-web/examples/user-interaction/index.js
@@ -1,15 +1,15 @@
 import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
 import { WebTracerProvider } from '@opentelemetry/web';
-import { XMLHttpRequestPlugin } from '@opentelemetry/plugin-xml-http-request';
 import { UserInteractionPlugin } from '@opentelemetry/plugin-user-interaction';
 import { ZoneContextManager } from '@opentelemetry/context-zone';
 import { CollectorTraceExporter } from '@opentelemetry/exporter-collector';
 import { B3Propagator } from '@opentelemetry/propagator-b3';
+import { XMLHttpRequestInstrumentation } from '@opentelemetry/instrumentation-xml-http-request';
 
 const providerWithZone = new WebTracerProvider({
  plugins: [
  new UserInteractionPlugin(),
- new XMLHttpRequestPlugin({
+ new XMLHttpRequestInstrumentation({
  ignoreUrls: [/localhost/],
  propagateTraceHeaderCorsUrls: [
  'http://localhost:8090',

diff --git a/examples/tracer-web/examples/xml-http-request/index.js b/examples/tracer-web/examples/xml-http-request/index.js
@@ -1,13 +1,13 @@
 import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
 import { WebTracerProvider } from '@opentelemetry/web';
-import { XMLHttpRequestPlugin } from '@opentelemetry/plugin-xml-http-request';
+import { XMLHttpRequestInstrumentation } from '@opentelemetry/instrumentation-xml-http-request';
 import { ZoneContextManager } from '@opentelemetry/context-zone';
 import { CollectorTraceExporter } from '@opentelemetry/exporter-collector';
 import { B3Propagator } from '@opentelemetry/propagator-b3';
 
 const providerWithZone = new WebTracerProvider({
  plugins: [
- new XMLHttpRequestPlugin({
+ new XMLHttpRequestInstrumentation({
  ignoreUrls: [/localhost:8090\/sockjs-node/],
  propagateTraceHeaderCorsUrls: [
  'https://httpbin.org/get',

diff --git a/examples/tracer-web/package.json b/examples/tracer-web/package.json
@@ -43,7 +43,7 @@
  "@opentelemetry/plugin-document-load": "^0.9.0",
  "@opentelemetry/plugin-fetch": "^0.12.0",
  "@opentelemetry/plugin-user-interaction": "^0.9.0",
- "@opentelemetry/plugin-xml-http-request": "^0.12.0",
+ "@opentelemetry/instrumentation-xml-http-request": "^0.12.0",
  "@opentelemetry/tracing": "^0.12.0",
  "@opentelemetry/web": "^0.12.0"
  },

diff --git a/metapackages/plugins-web-core/README.md b/metapackages/plugins-web-core/README.md
@@ -9,7 +9,7 @@ This package depends on all core web plugins maintained by OpenTelemetry authors
 
 ## Plugins
 
-- [@opentelemetry/plugin-xml-http-request][otel-plugin-xml-http-request]
+- [@opentelemetry/instrumentation-xml-http-request][otel-instrumentation-xml-http-request]
 
 ## Useful links
 
@@ -30,4 +30,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [npm-url]: https://www.npmjs.com/package/@opentelemetry/plugins-web-core
 [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fplugins-web-core.svg
 
-[otel-plugin-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-plugin-xml-http-request
+[otel-instrumentation-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-instrumentation-xml-http-request
diff --git a/metapackages/plugins-web-core/package.json b/metapackages/plugins-web-core/package.json
@@ -16,6 +16,6 @@
  "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
  },
  "dependencies": {
- "@opentelemetry/plugin-xml-http-request": "^0.12.0"
+ "@opentelemetry/instrumentation-xml-http-request": "^0.12.0"
  }
 }
diff --git a/packages/opentelemetry-core/src/utils/environment.ts b/packages/opentelemetry-core/src/utils/environment.ts
@@ -25,10 +25,16 @@ export interface ENVIRONMENT {
  OTEL_LOG_LEVEL?: LogLevel;
  OTEL_NO_PATCH_MODULES?: string;
  OTEL_SAMPLING_PROBABILITY?: number;
+ OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT?: number;
+ OTEL_SPAN_EVENT_COUNT_LIMIT?: number;
+ OTEL_SPAN_LINK_COUNT_LIMIT?: number;
 }
 
 const ENVIRONMENT_NUMBERS: Partial<keyof ENVIRONMENT>[] = [
  'OTEL_SAMPLING_PROBABILITY',
+ 'OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT',
+ 'OTEL_SPAN_EVENT_COUNT_LIMIT',
+ 'OTEL_SPAN_LINK_COUNT_LIMIT',
 ];
 
 /**
@@ -38,6 +44,9 @@ export const DEFAULT_ENVIRONMENT: Required<ENVIRONMENT> = {
  OTEL_NO_PATCH_MODULES: '',
  OTEL_LOG_LEVEL: LogLevel.INFO,
  OTEL_SAMPLING_PROBABILITY: 1,
+ OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT: 1000,
+ OTEL_SPAN_EVENT_COUNT_LIMIT: 1000,
+ OTEL_SPAN_LINK_COUNT_LIMIT: 1000,
 };
 
 /**
@@ -57,8 +66,15 @@ function parseNumber(
 ) {
  if (typeof values[name] !== 'undefined') {
  const value = Number(values[name] as string);
- if (!isNaN(value) && value >= min && value <= max) {
- environment[name] = value;
+
+ if (!isNaN(value)) {
+ if (value < min) {
+ environment[name] = min;
+ } else if (value > max) {
+ environment[name] = max;
+ } else {
+ environment[name] = value;
+ }
  }
  }
 }

diff --git a/packages/opentelemetry-core/test/utils/environment.test.ts b/packages/opentelemetry-core/test/utils/environment.test.ts
@@ -77,11 +77,31 @@ describe('environment', () => {
  OTEL_NO_PATCH_MODULES: 'a,b,c',
  OTEL_LOG_LEVEL: 'ERROR',
  OTEL_SAMPLING_PROBABILITY: '0.5',
+ OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT: 10,
+ OTEL_SPAN_EVENT_COUNT_LIMIT: 20,
+ OTEL_SPAN_LINK_COUNT_LIMIT: 30,
  });
  const env = getEnv();
  assert.strictEqual(env.OTEL_NO_PATCH_MODULES, 'a,b,c');
  assert.strictEqual(env.OTEL_LOG_LEVEL, LogLevel.ERROR);
  assert.strictEqual(env.OTEL_SAMPLING_PROBABILITY, 0.5);
+ assert.strictEqual(env.OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT, 10);
+ assert.strictEqual(env.OTEL_SPAN_EVENT_COUNT_LIMIT, 20);
+ assert.strictEqual(env.OTEL_SPAN_LINK_COUNT_LIMIT, 30);
+ });
+
+ it('should match invalid values to closest valid equivalent', () => {
+ mockEnvironment({
+ OTEL_SAMPLING_PROBABILITY: '-0.1',
+ });
+ const minEnv = getEnv();
+ assert.strictEqual(minEnv.OTEL_SAMPLING_PROBABILITY, 0);
+
+ mockEnvironment({
+ OTEL_SAMPLING_PROBABILITY: '1.1',
+ });
+ const maxEnv = getEnv();
+ assert.strictEqual(maxEnv.OTEL_SAMPLING_PROBABILITY, 1);
  });
 
  it('should parse OTEL_LOG_LEVEL despite casing', () => {

diff --git a/...try-plugin-xml-http-request/.eslintignore → ...umentation-xml-http-request/.eslintignore b/...try-plugin-xml-http-request/.eslintignore → ...umentation-xml-http-request/.eslintignore
diff --git a/...etry-plugin-xml-http-request/.eslintrc.js → ...rumentation-xml-http-request/.eslintrc.js b/...etry-plugin-xml-http-request/.eslintrc.js → ...rumentation-xml-http-request/.eslintrc.js
diff --git a/...emetry-plugin-xml-http-request/.npmignore → ...strumentation-xml-http-request/.npmignore b/...emetry-plugin-xml-http-request/.npmignore → ...strumentation-xml-http-request/.npmignore
diff --git a/...telemetry-plugin-xml-http-request/LICENSE → ...-instrumentation-xml-http-request/LICENSE b/...telemetry-plugin-xml-http-request/LICENSE → ...-instrumentation-xml-http-request/LICENSE
diff --git a/...lemetry-plugin-xml-http-request/README.md → ...nstrumentation-xml-http-request/README.md b/...lemetry-plugin-xml-http-request/README.md → ...nstrumentation-xml-http-request/README.md
@@ -11,25 +11,38 @@ This module provides auto instrumentation for web using XMLHttpRequest .
 ## Installation
 
 ```bash
-npm install --save @opentelemetry/plugin-xml-http-request
+npm install --save @opentelemetry/instrumentation-xml-http-request
 ```
 
 ## Usage
 
 ```js
 import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
 import { WebTracer } from '@opentelemetry/web';
-import { XMLHttpRequestPlugin } from '@opentelemetry/plugin-xml-http-request';
+import { XMLHttpRequestInstrumentation } from '@opentelemetry/instrumentation-xml-http-request';
 import { ZoneContextManager } from '@opentelemetry/context-zone';
 
+// this is still possible
 const webTracerWithZone = new WebTracer({
  contextManager: new ZoneContextManager(),
  plugins: [
- new XMLHttpRequestPlugin({
+ new XMLHttpRequestInstrumentation({
  propagateTraceHeaderCorsUrls: ['http://localhost:8090']
  })
  ]
 });
+/////////////////////////////////////////
+
+// or plugin can be also initialised separately and then set the tracer provider or meter provider
+const xmlHttpRequestInstrumentation = new XMLHttpRequestInstrumentation({
+ propagateTraceHeaderCorsUrls: ['http://localhost:8090']
+});
+const webTracerWithZone = new WebTracer({
+ contextManager: new ZoneContextManager(),
+});
+xmlHttpRequestInstrumentation.setTracerProvider(webTracerWithZone);
+/////////////////////////////////////////
+
 webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
 
 // and some test
@@ -61,9 +74,9 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [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=packages/opentelemetry-plugin-xml-http-request
-[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-xml-http-request
-[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-plugin-xml-http-request
-[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-xml-http-request&type=dev
-[npm-url]: https://www.npmjs.com/package/@opentelemetry/plugin-xml-http-request
-[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fplugin-xml-http-request.svg
+[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-instrumentation-xml-http-request
+[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-instrumentation-xml-http-request
+[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-instrumentation-xml-http-request
+[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-instrumentation-xml-http-request&type=dev
+[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-xml-http-request
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-xml-http-request.svg
diff --git a/...y-plugin-xml-http-request/images/cors.jpg → ...entation-xml-http-request/images/cors.jpg b/...y-plugin-xml-http-request/images/cors.jpg → ...entation-xml-http-request/images/cors.jpg
diff --git a/...y-plugin-xml-http-request/images/main.jpg → ...entation-xml-http-request/images/main.jpg b/...y-plugin-xml-http-request/images/main.jpg → ...entation-xml-http-request/images/main.jpg
diff --git a/...lugin-xml-http-request/images/request.jpg → ...ation-xml-http-request/images/request.jpg b/...lugin-xml-http-request/images/request.jpg → ...ation-xml-http-request/images/request.jpg
diff --git a/...try-plugin-xml-http-request/karma.conf.js → ...umentation-xml-http-request/karma.conf.js b/...try-plugin-xml-http-request/karma.conf.js → ...umentation-xml-http-request/karma.conf.js
diff --git a/...etry-plugin-xml-http-request/package.json → ...rumentation-xml-http-request/package.json b/...etry-plugin-xml-http-request/package.json → ...rumentation-xml-http-request/package.json
@@ -1,5 +1,5 @@
 {
- "name": "@opentelemetry/plugin-xml-http-request",
+ "name": "@opentelemetry/instrumentation-xml-http-request",
  "version": "0.12.0",
  "description": "OpenTelemetry XMLHttpRequest automatic instrumentation package.",
  "main": "build/src/index.js",
@@ -50,7 +50,6 @@
  "@opentelemetry/tracing": "^0.12.0",
  "@types/mocha": "8.0.2",
  "@types/node": "14.0.27",
- "@types/shimmer": "1.0.1",
  "@types/sinon": "9.0.4",
  "@types/webpack-env": "1.15.2",
  "babel-loader": "8.1.0",
@@ -77,9 +76,9 @@
  },
  "dependencies": {
  "@opentelemetry/api": "^0.12.0",
+ "@opentelemetry/instrumentation": "^0.12.0",
  "@opentelemetry/core": "^0.12.0",
  "@opentelemetry/semantic-conventions": "^0.12.0",
- "@opentelemetry/web": "^0.12.0",
- "shimmer": "^1.2.1"
+ "@opentelemetry/web": "^0.12.0"
  }
 }
diff --git a/...-xml-http-request/src/enums/EventNames.ts → ...-xml-http-request/src/enums/EventNames.ts b/...-xml-http-request/src/enums/EventNames.ts → ...-xml-http-request/src/enums/EventNames.ts
diff --git a/...etry-plugin-xml-http-request/src/index.ts → ...rumentation-xml-http-request/src/index.ts b/...etry-plugin-xml-http-request/src/index.ts → ...rumentation-xml-http-request/src/index.ts
diff --git a/...etry-plugin-xml-http-request/src/types.ts → ...rumentation-xml-http-request/src/types.ts b/...etry-plugin-xml-http-request/src/types.ts → ...rumentation-xml-http-request/src/types.ts
diff --git a/...ry-plugin-xml-http-request/src/version.ts → ...mentation-xml-http-request/src/version.ts b/...ry-plugin-xml-http-request/src/version.ts → ...mentation-xml-http-request/src/version.ts