Merge branch 'main' into fix/deploy-docs

open-telemetry · Oct 18, 2023 · 6bc9f8b · 6bc9f8b
2 parents 4f94a66 + 00e78ef
commit 6bc9f8b
Show file tree

Hide file tree

Showing 58 changed files with 295 additions and 99 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,8 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 ### :rocket: (Enhancement)
 
+* feat(metrics): prototype experimental advice support [#3876](https://github.com/open-telemetry/opentelemetry-js/pull/3876) @legendecas
+
 ### :bug: (Bug Fix)
 
 ### :books: (Refine Doc)

diff --git a/api/CHANGELOG.md b/api/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+### :rocket: (Enhancement)
+
+* feat(metrics): prototype experimental advice support [#3876](https://github.com/open-telemetry/opentelemetry-js/pull/3876) @legendecas
+
 ## 1.6.0
 
 ### :bug: (Bug Fix)

diff --git a/api/package.json b/api/package.json
@@ -63,7 +63,7 @@
   "devDependencies": {
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack": "4.41.34",
     "@types/webpack-env": "1.16.3",
     "codecov": "3.8.3",

diff --git a/api/src/index.ts b/api/src/index.ts
@@ -51,6 +51,7 @@ export {
   ObservableUpDownCounter,
   UpDownCounter,
   BatchObservableCallback,
+  MetricAdvice,
   MetricAttributes,
   MetricAttributeValue,
   ObservableCallback,

diff --git a/api/src/metrics/Metric.ts b/api/src/metrics/Metric.ts
@@ -18,6 +18,18 @@ import { Attributes, AttributeValue } from '../common/Attributes';
 import { Context } from '../context/types';
 import { BatchObservableResult, ObservableResult } from './ObservableResult';
 
+/**
+ * Advisory options influencing aggregation configuration parameters.
+ * @experimental
+ */
+export interface MetricAdvice {
+  /**
+   * Hint the explicit bucket boundaries for SDK if the metric is been
+   * aggregated with a HistogramAggregator.
+   */
+  explicitBucketBoundaries?: number[];
+}
+
 /**
  * Options needed for metric creation
  */
@@ -39,6 +51,12 @@ export interface MetricOptions {
    * @default {@link ValueType.DOUBLE}
    */
   valueType?: ValueType;
+
+  /**
+   * The advice influencing aggregation configuration parameters.
+   * @experimental
+   */
+  advice?: MetricAdvice;
 }
 
 /** The Type of value. It describes how the data is reported. */

diff --git a/experimental/packages/exporter-logs-otlp-grpc/package.json b/experimental/packages/exporter-logs-otlp-grpc/package.json
@@ -56,7 +56,7 @@
     "@opentelemetry/resources": "1.17.1",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cpx": "1.5.0",
     "cross-var": "1.1.0",

diff --git a/experimental/packages/exporter-logs-otlp-http/package.json b/experimental/packages/exporter-logs-otlp-http/package.json
@@ -76,7 +76,7 @@
     "@opentelemetry/resources": "1.17.1",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-loader": "8.3.0",
     "babel-plugin-istanbul": "6.1.1",

diff --git a/experimental/packages/exporter-logs-otlp-proto/package.json b/experimental/packages/exporter-logs-otlp-proto/package.json
@@ -67,7 +67,7 @@
     "@opentelemetry/api": "1.6.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "babel-plugin-istanbul": "6.1.1",
     "codecov": "3.8.3",
     "cpx": "1.5.0",

diff --git a/experimental/packages/exporter-trace-otlp-grpc/package.json b/experimental/packages/exporter-trace-otlp-grpc/package.json
@@ -53,7 +53,7 @@
     "@opentelemetry/otlp-exporter-base": "0.44.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cpx": "1.5.0",
     "cross-var": "1.1.0",

diff --git a/experimental/packages/exporter-trace-otlp-http/package.json b/experimental/packages/exporter-trace-otlp-http/package.json
@@ -67,7 +67,7 @@
     "@opentelemetry/api": "1.6.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-loader": "8.3.0",
     "babel-plugin-istanbul": "6.1.1",

diff --git a/experimental/packages/exporter-trace-otlp-proto/package.json b/experimental/packages/exporter-trace-otlp-proto/package.json
@@ -66,7 +66,7 @@
     "@opentelemetry/api": "1.6.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "babel-plugin-istanbul": "6.1.1",
     "codecov": "3.8.3",
     "cpx": "1.5.0",

diff --git a/experimental/packages/opentelemetry-browser-detector/package.json b/experimental/packages/opentelemetry-browser-detector/package.json
@@ -57,7 +57,7 @@
     "@opentelemetry/api": "1.6.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "babel-plugin-istanbul": "6.1.1",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",

diff --git a/experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/package.json b/experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/package.json
@@ -52,7 +52,7 @@
     "@opentelemetry/api": "1.6.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cpx": "1.5.0",
     "cross-var": "1.1.0",

diff --git a/experimental/packages/opentelemetry-exporter-metrics-otlp-http/package.json b/experimental/packages/opentelemetry-exporter-metrics-otlp-http/package.json
@@ -67,7 +67,7 @@
     "@opentelemetry/api": "1.6.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-loader": "8.3.0",
     "babel-plugin-istanbul": "6.1.1",

diff --git a/experimental/packages/opentelemetry-exporter-metrics-otlp-proto/package.json b/experimental/packages/opentelemetry-exporter-metrics-otlp-proto/package.json
@@ -59,7 +59,7 @@
     "@opentelemetry/api": "1.6.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cpx": "1.5.0",
     "cross-var": "1.1.0",

diff --git a/experimental/packages/opentelemetry-exporter-prometheus/package.json b/experimental/packages/opentelemetry-exporter-prometheus/package.json
@@ -47,7 +47,7 @@
     "@opentelemetry/semantic-conventions": "1.17.1",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
     "lerna": "7.1.5",

diff --git a/experimental/packages/opentelemetry-instrumentation-fetch/package.json b/experimental/packages/opentelemetry-instrumentation-fetch/package.json
@@ -61,7 +61,7 @@
     "@opentelemetry/sdk-trace-base": "1.17.1",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-loader": "8.3.0",
     "babel-plugin-istanbul": "6.1.1",

diff --git a/experimental/packages/opentelemetry-instrumentation-grpc/package.json b/experimental/packages/opentelemetry-instrumentation-grpc/package.json
@@ -60,7 +60,7 @@
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
     "@types/semver": "7.5.3",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
     "lerna": "7.1.5",

diff --git a/experimental/packages/opentelemetry-instrumentation-http/package.json b/experimental/packages/opentelemetry-instrumentation-http/package.json
@@ -54,14 +54,14 @@
     "@types/node": "18.6.5",
     "@types/request-promise-native": "1.0.19",
     "@types/semver": "7.5.3",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/superagent": "4.1.19",
     "axios": "1.5.1",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
     "lerna": "7.1.5",
     "mocha": "10.2.0",
-    "nock": "13.3.3",
+    "nock": "13.3.4",
     "nyc": "15.1.0",
     "request": "2.88.2",
     "request-promise-native": "1.0.9",

diff --git a/experimental/packages/opentelemetry-instrumentation-xml-http-request/package.json b/experimental/packages/opentelemetry-instrumentation-xml-http-request/package.json
@@ -61,7 +61,7 @@
     "@opentelemetry/sdk-trace-base": "1.17.1",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-loader": "8.3.0",
     "babel-plugin-istanbul": "6.1.1",

diff --git a/experimental/packages/opentelemetry-instrumentation/package.json b/experimental/packages/opentelemetry-instrumentation/package.json
@@ -87,7 +87,7 @@
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
     "@types/semver": "7.5.3",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-loader": "8.3.0",
     "babel-plugin-istanbul": "6.1.1",

diff --git a/experimental/packages/opentelemetry-sdk-node/package.json b/experimental/packages/opentelemetry-sdk-node/package.json
@@ -65,11 +65,11 @@
   "devDependencies": {
     "@opentelemetry/api": "1.6.0",
     "@opentelemetry/context-async-hooks": "1.17.1",
-    "@opentelemetry/exporter-jaeger": "1.17.0",
+    "@opentelemetry/exporter-jaeger": "1.17.1",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
     "@types/semver": "7.5.3",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
     "lerna": "7.1.5",

diff --git a/experimental/packages/otlp-exporter-base/package.json b/experimental/packages/otlp-exporter-base/package.json
@@ -68,7 +68,7 @@
     "@opentelemetry/api": "1.6.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "babel-plugin-istanbul": "6.1.1",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",

diff --git a/experimental/packages/otlp-grpc-exporter-base/package.json b/experimental/packages/otlp-grpc-exporter-base/package.json
@@ -55,7 +55,7 @@
     "@opentelemetry/sdk-trace-base": "1.17.1",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cpx": "1.5.0",
     "cross-var": "1.1.0",

diff --git a/experimental/packages/otlp-proto-exporter-base/package.json b/experimental/packages/otlp-proto-exporter-base/package.json
@@ -63,7 +63,7 @@
     "@opentelemetry/api": "1.6.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
     "lerna": "7.1.5",

diff --git a/experimental/packages/sdk-logs/package.json b/experimental/packages/sdk-logs/package.json
@@ -77,7 +77,7 @@
     "@opentelemetry/api-logs": "0.44.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "babel-plugin-istanbul": "6.1.1",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",

diff --git a/experimental/packages/shim-opencensus/package.json b/experimental/packages/shim-opencensus/package.json
@@ -54,7 +54,7 @@
     "@opentelemetry/sdk-trace-base": "1.17.1",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
     "lerna": "7.1.5",

diff --git a/package.json b/package.json
@@ -71,7 +71,7 @@
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-prettier": "5.0.0",
+    "eslint-plugin-prettier": "5.0.1",
     "gh-pages": "6.0.0",
     "lerna": "7.1.5",
     "@lerna/legacy-package-management": "7.1.5",

diff --git a/packages/opentelemetry-context-zone-peer-dep/package.json b/packages/opentelemetry-context-zone-peer-dep/package.json
@@ -57,7 +57,7 @@
     "@opentelemetry/api": ">=1.0.0 <1.7.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "@types/zone.js": "0.5.12",
     "babel-loader": "8.3.0",

diff --git a/packages/opentelemetry-context-zone/package.json b/packages/opentelemetry-context-zone/package.json
@@ -53,7 +53,7 @@
     "@babel/core": "7.22.20",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-loader": "8.3.0",
     "codecov": "3.8.3",

diff --git a/packages/opentelemetry-core/package.json b/packages/opentelemetry-core/package.json
@@ -67,7 +67,7 @@
     "@opentelemetry/api": ">=1.0.0 <1.7.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-plugin-istanbul": "6.1.1",
     "codecov": "3.8.3",

diff --git a/packages/opentelemetry-exporter-jaeger/package.json b/packages/opentelemetry-exporter-jaeger/package.json
@@ -48,12 +48,12 @@
     "@opentelemetry/resources": "1.17.1",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
     "lerna": "7.1.5",
     "mocha": "10.2.0",
-    "nock": "13.3.3",
+    "nock": "13.3.4",
     "nyc": "15.1.0",
     "sinon": "15.1.2",
     "ts-mocha": "10.0.0",

diff --git a/packages/opentelemetry-exporter-zipkin/package.json b/packages/opentelemetry-exporter-zipkin/package.json
@@ -64,7 +64,7 @@
     "@opentelemetry/api": "^1.0.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-loader": "8.3.0",
     "babel-plugin-istanbul": "6.1.1",
@@ -78,7 +78,7 @@
     "karma-webpack": "4.0.2",
     "lerna": "7.1.5",
     "mocha": "10.2.0",
-    "nock": "13.3.3",
+    "nock": "13.3.4",
     "nyc": "15.1.0",
     "sinon": "15.1.2",
     "ts-loader": "8.4.0",

diff --git a/packages/opentelemetry-propagator-jaeger/package.json b/packages/opentelemetry-propagator-jaeger/package.json
@@ -57,7 +57,7 @@
     "@opentelemetry/api": ">=1.0.0 <1.7.0",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-plugin-istanbul": "6.1.1",
     "codecov": "3.8.3",

diff --git a/packages/opentelemetry-resources/package.json b/packages/opentelemetry-resources/package.json
@@ -65,7 +65,7 @@
     "@opentelemetry/resources_1.9.0": "npm:@opentelemetry/[email protected]",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
@@ -78,7 +78,7 @@
     "karma-webpack": "4.0.2",
     "lerna": "7.1.5",
     "mocha": "10.2.0",
-    "nock": "13.3.3",
+    "nock": "13.3.4",
     "nyc": "15.1.0",
     "sinon": "15.1.2",
     "ts-mocha": "10.0.0",

diff --git a/packages/opentelemetry-sdk-trace-base/package.json b/packages/opentelemetry-sdk-trace-base/package.json
@@ -69,7 +69,7 @@
     "@opentelemetry/resources_1.9.0": "npm:@opentelemetry/[email protected]",
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "@types/webpack-env": "1.16.3",
     "babel-plugin-istanbul": "6.1.1",
     "codecov": "3.8.3",

diff --git a/packages/opentelemetry-sdk-trace-node/package.json b/packages/opentelemetry-sdk-trace-node/package.json
@@ -51,7 +51,7 @@
     "@types/mocha": "10.0.2",
     "@types/node": "18.6.5",
     "@types/semver": "7.5.3",
-    "@types/sinon": "10.0.18",
+    "@types/sinon": "10.0.19",
     "codecov": "3.8.3",
     "cross-var": "1.1.0",
     "lerna": "7.1.5",