Merge branch 'main' into lizf.fix-url-parsing

open-telemetry · Jul 21, 2021 · afaf085 · afaf085
2 parents 2aa5f4e + 11719ed
commit afaf085
Show file tree

Hide file tree

Showing 67 changed files with 360 additions and 208 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,54 @@
+name: Deploy API Documentation
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+
+      - name: restore lock files
+        uses: actions/cache@master # must use unreleased master to cache multiple paths
+        id: cache
+        with:
+          # must be done before bootstrap to not include node_modules files in the cache paths
+          path: |
+            package-lock.json
+            packages/*/package-lock.json
+            benchmark/*/package-lock.json
+            backwards-compatability/*/package-lock.json
+            metapackages/*/package-lock.json
+            packages/*/package-lock.json
+            integration-tests/*/package-lock.json
+          key: ${{ runner.os }}-unit_test-${{ matrix.node_version }}-${{ hashFiles('**/package.json') }}
+      - name: Install and Build (cache miss) 🔧
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          npm install --ignore-scripts
+          npx lerna bootstrap --no-ci
+          npm run compile
+
+      - name: Install and Build (cache hit) 🔧
+        if: steps.cache.outputs.cache-hit == 'true'
+        run: |
+          npm ci --ignore-scripts
+          npx lerna bootstrap
+          npm run compile
+
+      - name: Build Docs
+        run: npm run docs
+
+      - name: Deploy Documentation 🚀
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs # The folder the action should deploy.
diff --git a/README.md b/README.md
@@ -2,10 +2,11 @@
 ---
 <p align="center">
   <strong>
-    <a href="getting-started/README.md">Getting Started<a/>
+    <a href="getting-started/README.md">Getting Started</a>
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
-    <a href="https://open-telemetry.github.io/opentelemetry-js">API Documentation<a/>
+    <a href="https://open-telemetry.github.io/opentelemetry-js-api">API Reference</a>
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
+    <a href="https://open-telemetry.github.io/opentelemetry-js">SDK Reference</a>
   </strong>
 </p>
 
@@ -28,13 +29,13 @@
 
 <p align="center">
   <strong>
-    <a href="CONTRIBUTING.md">Contributing<a/>
+    <a href="CONTRIBUTING.md">Contributing</a>
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
-    <a href="doc/development-guide.md">Development Guide<a/>
+    <a href="doc/development-guide.md">Development Guide</a>
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
-    <a href="benchmark/README.md">Benchmarks<a/>
+    <a href="benchmark/README.md">Benchmarks</a>
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
-    <a href="examples/">Examples<a/>
+    <a href="examples/">Examples</a>
   </strong>
 </p>
 

diff --git a/backwards-compatability/node12/package.json b/backwards-compatability/node12/package.json
@@ -12,7 +12,7 @@
     "@opentelemetry/tracing": "0.23.0"
   },
   "devDependencies": {
-    "@types/node": "12.20.15",
+    "@types/node": "12.20.16",
     "typescript": "4.3.5"
   },
   "author": "OpenTelemetry Authors",

diff --git a/eslint.config.js b/eslint.config.js
@@ -10,6 +10,7 @@ module.exports = {
     "project": "./tsconfig.json"
   },
   rules: {
+    "quotes": [2, "single", { "avoidEscape": true }],
     "@typescript-eslint/no-floating-promises": 2,
     "@typescript-eslint/no-this-alias": "off",
     "brace-style": ["error", "1tbs"],

diff --git a/getting-started/traced-example/package.json b/getting-started/traced-example/package.json
@@ -11,7 +11,7 @@
   "dependencies": {
     "@opentelemetry/core": "0.23.0",
     "@opentelemetry/exporter-zipkin": "0.23.0",
-    "@opentelemetry/instrumentation-express": "^0.22.0",
+    "@opentelemetry/instrumentation-express": "^0.23.0",
     "@opentelemetry/instrumentation-http": "0.23.0",
     "@opentelemetry/instrumentation": "0.23.0",
     "@opentelemetry/node": "0.23.0",

diff --git a/getting-started/ts-example/example/package.json b/getting-started/ts-example/example/package.json
@@ -9,9 +9,9 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@types/express": "4.17.12",
-    "@types/node": "14.17.4",
-    "ts-node": "10.0.0"
+    "@types/express": "4.17.13",
+    "@types/node": "14.17.5",
+    "ts-node": "10.1.0"
   },
   "dependencies": {
     "axios": "^0.21.0",

diff --git a/getting-started/ts-example/monitored-example/package.json b/getting-started/ts-example/monitored-example/package.json
@@ -9,9 +9,9 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@types/express": "4.17.12",
-    "@types/node": "14.17.4",
-    "ts-node": "10.0.0"
+    "@types/express": "4.17.13",
+    "@types/node": "14.17.5",
+    "ts-node": "10.1.0"
   },
   "dependencies": {
     "@opentelemetry/exporter-prometheus": "0.23.0",

diff --git a/getting-started/ts-example/traced-example/package.json b/getting-started/ts-example/traced-example/package.json
@@ -9,16 +9,16 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@types/express": "4.17.12",
-    "@types/node": "14.17.4",
-    "ts-node": "10.0.0"
+    "@types/express": "4.17.13",
+    "@types/node": "14.17.5",
+    "ts-node": "10.1.0"
   },
   "dependencies": {
     "@opentelemetry/core": "0.23.0",
     "@opentelemetry/exporter-zipkin": "0.23.0",
     "@opentelemetry/instrumentation": "0.23.0",
     "@opentelemetry/node": "0.23.0",
-    "@opentelemetry/instrumentation-express": "^0.22.0",
+    "@opentelemetry/instrumentation-express": "^0.23.0",
     "@opentelemetry/instrumentation-http": "0.23.0",
     "@opentelemetry/tracing": "0.23.0",
     "axios": "^0.21.0",

diff --git a/package.json b/package.json
@@ -22,9 +22,8 @@
     "codecov": "lerna run codecov",
     "codecov:browser": "lerna run codecov:browser",
     "predocs-test": "npm run docs",
-    "docs-test": "lerna run docs-test",
-    "docs": "lerna run docs",
-    "docs-deploy": "gh-pages --dist packages/opentelemetry-api/docs/out",
+    "docs": "typedoc && touch out/.nojekyll",
+    "docs-deploy": "gh-pages --dotfiles --dist docs",
     "lint": "lerna run lint",
     "lint:changed": "lerna run --concurrency 1 --stream lint --since HEAD --exclude-dependents",
     "lint:fix": "lerna run lint:fix",
@@ -48,11 +47,11 @@
   "devDependencies": {
     "@commitlint/cli": "12.1.4",
     "@commitlint/config-conventional": "12.1.4",
-    "@typescript-eslint/eslint-plugin": "4.28.1",
-    "@typescript-eslint/parser": "4.28.1",
+    "@typescript-eslint/eslint-plugin": "4.28.3",
+    "@typescript-eslint/parser": "4.28.3",
     "beautify-benchmark": "0.2.4",
     "benchmark": "2.1.4",
-    "eslint": "7.29.0",
+    "eslint": "7.30.0",
     "eslint-config-airbnb-base": "14.2.1",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.23.4",
@@ -62,6 +61,7 @@
     "lerna": "3.22.1",
     "lerna-changelog": "1.0.1",
     "markdownlint-cli": "0.27.1",
+    "typedoc": "0.21.2",
     "typescript": "4.3.5",
     "update-ts-references": "2.4.0"
   },

diff --git a/packages/opentelemetry-api-metrics/package.json b/packages/opentelemetry-api-metrics/package.json
@@ -57,9 +57,9 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.0.1",
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
-    "@types/webpack-env": "1.16.1",
+    "@types/mocha": "8.2.3",
+    "@types/node": "14.17.5",
+    "@types/webpack-env": "1.16.2",
     "codecov": "3.8.2",
     "istanbul-instrumenter-loader": "3.0.1",
     "karma": "5.2.3",

diff --git a/packages/opentelemetry-context-async-hooks/package.json b/packages/opentelemetry-context-async-hooks/package.json
@@ -41,9 +41,9 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.0.1",
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
-    "@types/shimmer": "1.0.1",
+    "@types/mocha": "8.2.3",
+    "@types/node": "14.17.5",
+    "@types/shimmer": "1.0.2",
     "codecov": "3.8.2",
     "mocha": "7.2.0",
     "nyc": "15.1.0",

diff --git a/packages/opentelemetry-context-zone-peer-dep/package.json b/packages/opentelemetry-context-zone-peer-dep/package.json
@@ -47,10 +47,10 @@
   "devDependencies": {
     "@babel/core": "7.14.6",
     "@opentelemetry/api": "^1.0.1",
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
+    "@types/mocha": "8.2.3",
+    "@types/node": "14.17.5",
     "@types/sinon": "10.0.2",
-    "@types/webpack-env": "1.16.1",
+    "@types/webpack-env": "1.16.2",
     "@types/zone.js": "0.5.12",
     "babel-loader": "8.2.2",
     "codecov": "3.8.2",

diff --git a/packages/opentelemetry-context-zone/package.json b/packages/opentelemetry-context-zone/package.json
@@ -43,10 +43,10 @@
   },
   "devDependencies": {
     "@babel/core": "7.14.6",
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
+    "@types/mocha": "8.2.3",
+    "@types/node": "14.17.5",
     "@types/sinon": "10.0.2",
-    "@types/webpack-env": "1.16.1",
+    "@types/webpack-env": "1.16.2",
     "babel-loader": "8.2.2",
     "codecov": "3.8.2",
     "karma": "5.2.3",

diff --git a/packages/opentelemetry-core/package.json b/packages/opentelemetry-core/package.json
@@ -56,11 +56,11 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.0.1",
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
-    "@types/semver": "7.3.6",
+    "@types/mocha": "8.2.3",
+    "@types/node": "14.17.5",
+    "@types/semver": "7.3.7",
     "@types/sinon": "10.0.2",
-    "@types/webpack-env": "1.16.1",
+    "@types/webpack-env": "1.16.2",
     "codecov": "3.8.2",
     "istanbul-instrumenter-loader": "3.0.1",
     "karma": "5.2.3",

diff --git a/packages/opentelemetry-exporter-collector-grpc/package.json b/packages/opentelemetry-exporter-collector-grpc/package.json
@@ -48,8 +48,8 @@
     "@babel/core": "7.14.6",
     "@opentelemetry/api": "^1.0.1",
     "@opentelemetry/api-metrics": "0.23.0",
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
+    "@types/mocha": "8.2.3",
+    "@types/node": "14.17.5",
     "@types/sinon": "10.0.2",
     "codecov": "3.8.2",
     "cpx": "1.5.0",

diff --git a/packages/opentelemetry-exporter-collector-grpc/src/CollectorExporterNodeBase.ts b/packages/opentelemetry-exporter-collector-grpc/src/CollectorExporterNodeBase.ts
@@ -26,7 +26,7 @@ import {
   ServiceClientType,
 } from './types';
 import { ServiceClient } from './types';
-import { getEnv, baggageUtils } from "@opentelemetry/core";
+import { getEnv, baggageUtils } from '@opentelemetry/core';
 
 /**
  * Collector Metric Exporter abstract base class

diff --git a/packages/opentelemetry-exporter-collector-grpc/src/CollectorMetricExporter.ts b/packages/opentelemetry-exporter-collector-grpc/src/CollectorMetricExporter.ts
@@ -23,7 +23,7 @@ import { CollectorExporterConfigNode, ServiceClientType } from './types';
 import { CollectorExporterNodeBase } from './CollectorExporterNodeBase';
 import { baggageUtils, getEnv } from '@opentelemetry/core';
 import { validateAndNormalizeUrl } from './util';
-import { Metadata } from "@grpc/grpc-js";
+import { Metadata } from '@grpc/grpc-js';
 
 const DEFAULT_COLLECTOR_URL = 'localhost:4317';
 

diff --git a/packages/opentelemetry-exporter-collector-grpc/src/CollectorTraceExporter.ts b/packages/opentelemetry-exporter-collector-grpc/src/CollectorTraceExporter.ts
@@ -23,7 +23,7 @@ import {
 import { CollectorExporterConfigNode, ServiceClientType } from './types';
 import { baggageUtils, getEnv } from '@opentelemetry/core';
 import { validateAndNormalizeUrl } from './util';
-import { Metadata } from "@grpc/grpc-js";
+import { Metadata } from '@grpc/grpc-js';
 
 const DEFAULT_COLLECTOR_URL = 'localhost:4317';
 

diff --git a/packages/opentelemetry-exporter-collector-grpc/test/helper.ts b/packages/opentelemetry-exporter-collector-grpc/test/helper.ts
@@ -410,31 +410,31 @@ export function ensureResourceIsCorrect(
   assert.deepStrictEqual(resource, {
     attributes: [
       {
-        "key": "service.name",
-        "value": {
-          "stringValue": `unknown_service:${process.argv0}`,
-          "value": "stringValue"
+        'key': 'service.name',
+        'value': {
+          'stringValue': `unknown_service:${process.argv0}`,
+          'value': 'stringValue'
         }
       },
       {
-        "key": "telemetry.sdk.language",
-        "value": {
-          "stringValue": "nodejs",
-          "value": "stringValue"
+        'key': 'telemetry.sdk.language',
+        'value': {
+          'stringValue': 'nodejs',
+          'value': 'stringValue'
         }
       },
       {
-        "key": "telemetry.sdk.name",
-        "value": {
-          "stringValue": "opentelemetry",
-          "value": "stringValue"
+        'key': 'telemetry.sdk.name',
+        'value': {
+          'stringValue': 'opentelemetry',
+          'value': 'stringValue'
         }
       },
       {
-        "key": "telemetry.sdk.version",
-        "value": {
-          "stringValue": VERSION,
-          "value": "stringValue"
+        'key': 'telemetry.sdk.version',
+        'value': {
+          'stringValue': VERSION,
+          'value': 'stringValue'
         }
       },
       {

diff --git a/packages/opentelemetry-exporter-collector-proto/package.json b/packages/opentelemetry-exporter-collector-proto/package.json
@@ -48,8 +48,8 @@
     "@babel/core": "7.14.6",
     "@opentelemetry/api": "^1.0.1",
     "@opentelemetry/api-metrics": "0.23.0",
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
+    "@types/mocha": "8.2.3",
+    "@types/node": "14.17.5",
     "@types/sinon": "10.0.2",
     "codecov": "3.8.2",
     "cpx": "1.5.0",

diff --git a/packages/opentelemetry-exporter-collector-proto/src/CollectorMetricExporter.ts b/packages/opentelemetry-exporter-collector-proto/src/CollectorMetricExporter.ts
@@ -24,7 +24,7 @@ import { ServiceClientType } from './types';
 import { CollectorExporterNodeBase } from './CollectorExporterNodeBase';
 import { getEnv, baggageUtils } from '@opentelemetry/core';
 
-const DEFAULT_COLLECTOR_URL = 'http://localhost:4317/v1/metrics';
+const DEFAULT_COLLECTOR_URL = 'http://localhost:55681/v1/metrics';
 
 /**
  * Collector Metric Exporter for Node with protobuf

diff --git a/packages/opentelemetry-exporter-collector-proto/src/CollectorTraceExporter.ts b/packages/opentelemetry-exporter-collector-proto/src/CollectorTraceExporter.ts
@@ -24,7 +24,7 @@ import {
 import { ServiceClientType } from './types';
 import { getEnv, baggageUtils } from '@opentelemetry/core';
 
-const DEFAULT_COLLECTOR_URL = 'http://localhost:4317/v1/traces';
+const DEFAULT_COLLECTOR_URL = 'http://localhost:55681/v1/traces';
 
 /**
  * Collector Trace Exporter for Node with protobuf

diff --git a/packages/opentelemetry-exporter-collector/package.json b/packages/opentelemetry-exporter-collector/package.json
@@ -55,10 +55,10 @@
   "devDependencies": {
     "@babel/core": "7.14.6",
     "@opentelemetry/api": "^1.0.1",
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
+    "@types/mocha": "8.2.3",
+    "@types/node": "14.17.5",
     "@types/sinon": "10.0.2",
-    "@types/webpack-env": "1.16.1",
+    "@types/webpack-env": "1.16.2",
     "babel-loader": "8.2.2",
     "codecov": "3.8.2",
     "cpx": "1.5.0",