Merge pull request open-telemetry#173 from opentelemetrybot/opentelem…

…etrybot/merge-main [AutoMerge][Main] Merging staged change(s) to main
opentelemetrybot · Aug 24, 2023 · 9326e9a · 9326e9a
2 parents e6aaf97 + 69a9530
commit 9326e9a
Show file tree

Hide file tree

Showing 16 changed files with 148 additions and 65 deletions.
diff --git a/auto-merge/contrib/.release-please-manifest.json b/auto-merge/contrib/.release-please-manifest.json
@@ -1 +1 @@
-{"detectors/node/opentelemetry-resource-detector-alibaba-cloud":"0.28.1","detectors/node/opentelemetry-resource-detector-aws":"1.3.1","detectors/node/opentelemetry-resource-detector-container":"0.3.1","detectors/node/opentelemetry-resource-detector-gcp":"0.29.1","detectors/node/opentelemetry-resource-detector-github":"0.28.1","detectors/node/opentelemetry-resource-detector-instana":"0.5.1","metapackages/auto-instrumentations-node":"0.39.0","metapackages/auto-instrumentations-web":"0.33.1","packages/opentelemetry-host-metrics":"0.33.1","packages/opentelemetry-id-generator-aws-xray":"1.2.1","packages/opentelemetry-propagation-utils":"0.30.1","packages/opentelemetry-redis-common":"0.36.1","packages/opentelemetry-sql-common":"0.40.0","packages/opentelemetry-test-utils":"0.34.1","plugins/node/instrumentation-amqplib":"0.33.1","plugins/node/instrumentation-cucumber":"0.1.0","plugins/node/instrumentation-dataloader":"0.5.1","plugins/node/instrumentation-fs":"0.8.1","plugins/node/instrumentation-lru-memoizer":"0.33.1","plugins/node/instrumentation-mongoose":"0.33.1","plugins/node/instrumentation-socket.io":"0.34.1","plugins/node/instrumentation-tedious":"0.6.1","plugins/node/opentelemetry-instrumentation-aws-lambda":"0.37.0","plugins/node/opentelemetry-instrumentation-aws-sdk":"0.36.0","plugins/node/opentelemetry-instrumentation-bunyan":"0.32.1","plugins/node/opentelemetry-instrumentation-cassandra":"0.33.1","plugins/node/opentelemetry-instrumentation-connect":"0.32.1","plugins/node/opentelemetry-instrumentation-dns":"0.32.1","plugins/node/opentelemetry-instrumentation-express":"0.33.1","plugins/node/opentelemetry-instrumentation-fastify":"0.32.1","plugins/node/opentelemetry-instrumentation-generic-pool":"0.32.1","plugins/node/opentelemetry-instrumentation-graphql":"0.35.1","plugins/node/opentelemetry-instrumentation-hapi":"0.33.0","plugins/node/opentelemetry-instrumentation-ioredis":"0.35.1","plugins/node/opentelemetry-instrumentation-knex":"0.32.1","plugins/node/opentelemetry-instrumentation-koa":"0.36.0","plugins/node/opentelemetry-instrumentation-memcached":"0.32.1","plugins/node/opentelemetry-instrumentation-mongodb":"0.36.1","plugins/node/opentelemetry-instrumentation-mysql":"0.34.1","plugins/node/opentelemetry-instrumentation-mysql2":"0.34.1","plugins/node/opentelemetry-instrumentation-nestjs-core":"0.33.1","plugins/node/opentelemetry-instrumentation-net":"0.32.1","plugins/node/opentelemetry-instrumentation-pg":"0.36.1","plugins/node/opentelemetry-instrumentation-pino":"0.34.1","plugins/node/opentelemetry-instrumentation-redis":"0.35.1","plugins/node/opentelemetry-instrumentation-redis-4":"0.35.1","plugins/node/opentelemetry-instrumentation-restify":"0.34.0","plugins/node/opentelemetry-instrumentation-router":"0.33.1","plugins/node/opentelemetry-instrumentation-winston":"0.32.1","plugins/web/opentelemetry-instrumentation-document-load":"0.33.1","plugins/web/opentelemetry-instrumentation-long-task":"0.33.1","plugins/web/opentelemetry-instrumentation-user-interaction":"0.33.1","plugins/web/opentelemetry-plugin-react-load":"0.29.1","propagators/opentelemetry-propagator-aws-xray":"1.3.1","propagators/opentelemetry-propagator-grpc-census-binary":"0.27.1","propagators/opentelemetry-propagator-instana":"0.3.1","propagators/opentelemetry-propagator-ot-trace":"0.27.1"}
+{"detectors/node/opentelemetry-resource-detector-alibaba-cloud":"0.28.1","detectors/node/opentelemetry-resource-detector-aws":"1.3.1","detectors/node/opentelemetry-resource-detector-container":"0.3.1","detectors/node/opentelemetry-resource-detector-gcp":"0.29.1","detectors/node/opentelemetry-resource-detector-github":"0.28.1","detectors/node/opentelemetry-resource-detector-instana":"0.5.1","metapackages/auto-instrumentations-node":"0.39.1","metapackages/auto-instrumentations-web":"0.33.1","packages/opentelemetry-host-metrics":"0.33.1","packages/opentelemetry-id-generator-aws-xray":"1.2.1","packages/opentelemetry-propagation-utils":"0.30.1","packages/opentelemetry-redis-common":"0.36.1","packages/opentelemetry-sql-common":"0.40.0","packages/opentelemetry-test-utils":"0.34.1","plugins/node/instrumentation-amqplib":"0.33.1","plugins/node/instrumentation-cucumber":"0.1.0","plugins/node/instrumentation-dataloader":"0.5.1","plugins/node/instrumentation-fs":"0.8.1","plugins/node/instrumentation-lru-memoizer":"0.33.1","plugins/node/instrumentation-mongoose":"0.33.1","plugins/node/instrumentation-socket.io":"0.34.1","plugins/node/instrumentation-tedious":"0.6.1","plugins/node/opentelemetry-instrumentation-aws-lambda":"0.37.0","plugins/node/opentelemetry-instrumentation-aws-sdk":"0.36.0","plugins/node/opentelemetry-instrumentation-bunyan":"0.32.1","plugins/node/opentelemetry-instrumentation-cassandra":"0.33.1","plugins/node/opentelemetry-instrumentation-connect":"0.32.1","plugins/node/opentelemetry-instrumentation-dns":"0.32.1","plugins/node/opentelemetry-instrumentation-express":"0.33.1","plugins/node/opentelemetry-instrumentation-fastify":"0.32.1","plugins/node/opentelemetry-instrumentation-generic-pool":"0.32.2","plugins/node/opentelemetry-instrumentation-graphql":"0.35.1","plugins/node/opentelemetry-instrumentation-hapi":"0.33.0","plugins/node/opentelemetry-instrumentation-ioredis":"0.35.1","plugins/node/opentelemetry-instrumentation-knex":"0.32.1","plugins/node/opentelemetry-instrumentation-koa":"0.36.0","plugins/node/opentelemetry-instrumentation-memcached":"0.32.1","plugins/node/opentelemetry-instrumentation-mongodb":"0.36.1","plugins/node/opentelemetry-instrumentation-mysql":"0.34.1","plugins/node/opentelemetry-instrumentation-mysql2":"0.34.1","plugins/node/opentelemetry-instrumentation-nestjs-core":"0.33.1","plugins/node/opentelemetry-instrumentation-net":"0.32.1","plugins/node/opentelemetry-instrumentation-pg":"0.36.1","plugins/node/opentelemetry-instrumentation-pino":"0.34.1","plugins/node/opentelemetry-instrumentation-redis":"0.35.1","plugins/node/opentelemetry-instrumentation-redis-4":"0.35.1","plugins/node/opentelemetry-instrumentation-restify":"0.34.0","plugins/node/opentelemetry-instrumentation-router":"0.33.1","plugins/node/opentelemetry-instrumentation-winston":"0.32.1","plugins/web/opentelemetry-instrumentation-document-load":"0.33.1","plugins/web/opentelemetry-instrumentation-long-task":"0.33.1","plugins/web/opentelemetry-instrumentation-user-interaction":"0.33.1","plugins/web/opentelemetry-plugin-react-load":"0.29.1","propagators/opentelemetry-propagator-aws-xray":"1.3.1","propagators/opentelemetry-propagator-grpc-census-binary":"0.27.1","propagators/opentelemetry-propagator-instana":"0.3.1","propagators/opentelemetry-propagator-ot-trace":"0.27.1"}
diff --git a/auto-merge/contrib/metapackages/auto-instrumentations-node/CHANGELOG.md b/auto-merge/contrib/metapackages/auto-instrumentations-node/CHANGELOG.md
@@ -87,6 +87,12 @@
     * @opentelemetry/instrumentation-koa bumped from ^0.34.2 to ^0.34.3
     * @opentelemetry/instrumentation-redis bumped from ^0.34.3 to ^0.34.4
 
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @opentelemetry/instrumentation-generic-pool bumped from ^0.32.1 to ^0.32.2
+
 ## [0.39.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/auto-instrumentations-node-v0.38.0...auto-instrumentations-node-v0.39.0) (2023-08-14)
 
 

diff --git a/auto-merge/contrib/metapackages/auto-instrumentations-node/package.json b/auto-merge/contrib/metapackages/auto-instrumentations-node/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@opentelemetry/auto-instrumentations-node",
-  "version": "0.39.0",
+  "version": "0.39.1",
   "description": "Metapackage which bundles opentelemetry node core and contrib instrumentations",
   "author": "OpenTelemetry Authors",
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/metapackages/auto-instrumentations-node#readme",
@@ -62,7 +62,7 @@
     "@opentelemetry/instrumentation-express": "^0.33.1",
     "@opentelemetry/instrumentation-fs": "^0.8.1",
     "@opentelemetry/instrumentation-fastify": "^0.32.1",
-    "@opentelemetry/instrumentation-generic-pool": "^0.32.1",
+    "@opentelemetry/instrumentation-generic-pool": "^0.32.2",
     "@opentelemetry/instrumentation-graphql": "^0.35.1",
     "@opentelemetry/instrumentation-grpc": "^0.41.2",
     "@opentelemetry/instrumentation-hapi": "^0.33.0",

diff --git a/...ge/contrib/plugins/node/opentelemetry-instrumentation-generic-pool/CHANGELOG.md b/...ge/contrib/plugins/node/opentelemetry-instrumentation-generic-pool/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.32.2](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-generic-pool-v0.32.1...instrumentation-generic-pool-v0.32.2) (2023-08-16)
+
+
+### Bug Fixes
+
+* **generic-pool:** remove deps on types package for ts5 compatibility ([#1637](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1637)) ([651b4f8](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/651b4f8bdc18110aeafa22faa1fe2e0a49dbff91))
+
 ## [0.32.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-generic-pool-v0.32.0...instrumentation-generic-pool-v0.32.1) (2023-08-14)
 
 

diff --git a/auto-merge/contrib/plugins/node/opentelemetry-instrumentation-generic-pool/package.json b/auto-merge/contrib/plugins/node/opentelemetry-instrumentation-generic-pool/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@opentelemetry/instrumentation-generic-pool",
-  "version": "0.32.1",
+  "version": "0.32.2",
   "description": "OpenTelemetry Generic Pool automatic instrumentation package",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
@@ -49,6 +49,7 @@
     "@opentelemetry/context-async-hooks": "^1.8.0",
     "@opentelemetry/sdk-trace-base": "^1.8.0",
     "@opentelemetry/sdk-trace-node": "^1.8.0",
+    "@types/generic-pool": "^3.1.9",
     "@types/mocha": "7.0.2",
     "@types/node": "18.16.19",
     "@types/semver": "7.5.0",
@@ -62,8 +63,7 @@
   },
   "dependencies": {
     "@opentelemetry/instrumentation": "^0.41.2",
-    "@opentelemetry/semantic-conventions": "^1.0.0",
-    "@types/generic-pool": "^3.1.9"
+    "@opentelemetry/semantic-conventions": "^1.0.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-generic-pool#readme"
 }
diff --git a/...ge/contrib/plugins/node/opentelemetry-instrumentation-generic-pool/src/instrumentation.ts b/...ge/contrib/plugins/node/opentelemetry-instrumentation-generic-pool/src/instrumentation.ts
@@ -28,9 +28,7 @@ import { VERSION } from './version';
 
 const MODULE_NAME = 'generic-pool';
 
-export default class Instrumentation extends InstrumentationBase<
-  typeof genericPool
-> {
+export default class Instrumentation extends InstrumentationBase<any> {
   // only used for v2 - v2.3)
   private _isDisabled = false;
 
@@ -40,7 +38,7 @@ export default class Instrumentation extends InstrumentationBase<
 
   init() {
     return [
-      new InstrumentationNodeModuleDefinition<typeof genericPool>(
+      new InstrumentationNodeModuleDefinition<any>(
         MODULE_NAME,
         ['>=3'],
         (moduleExports, moduleVersion) => {
@@ -63,7 +61,7 @@ export default class Instrumentation extends InstrumentationBase<
           return moduleExports;
         }
       ),
-      new InstrumentationNodeModuleDefinition<typeof genericPool>(
+      new InstrumentationNodeModuleDefinition<any>(
         MODULE_NAME,
         ['^2.4'],
         (moduleExports, moduleVersion) => {

diff --git a/auto-merge/js/CHANGELOG.md b/auto-merge/js/CHANGELOG.md
@@ -15,8 +15,12 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 ### :bug: (Bug Fix)
 
+* fix(exporter-zipkin): rounding duration to the nearest int to be compliant with zipkin protocol [#4064](https://github.com/open-telemetry/opentelemetry-js/pull/4064) @n0cloud
+
 ### :books: (Refine Doc)
 
+* docs(guidelines): add dependencies guidelines [#4040](https://github.com/open-telemetry/opentelemetry-js/pull/4040)
+
 ### :house: (Internal)
 
 ## 1.15.2

diff --git a/auto-merge/js/README.md b/auto-merge/js/README.md
@@ -195,13 +195,10 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
 - [Haddas Bronfman](https://github.com/haddasbronfman), Cisco
 - [Hector Hernandez](https://github.com/hectorhdzg), Microsoft
 - [Jamie Danielson](https://github.com/JamieDanielson), Honeycomb
-- [John Bley](https://github.com/johnbley), Splunk
-- [Mark Wolff](https://github.com/markwolff), Microsoft
 - [Martin Kuba](https://github.com/martinkuba), Lightstep
 - [Matthew Wear](https://github.com/mwear), LightStep
 - [Naseem K. Ullah](https://github.com/naseemkullah), Transit
 - [Neville Wylie](https://github.com/MSNev), Microsoft
-- [Olivier Albertini](https://github.com/OlivierAlbertini), Ville de Montréal
 - [Purvi Kanal](https://github.com/pkanal), Honeycomb
 - [Svetlana Brennan](https://github.com/svetlanabrennan), New Relic
 
@@ -216,6 +213,9 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
 - [Valentin Marchaud](https://github.com/vmarchaud), Maintainer
 - [Brandon Gonzalez](https://github.com/bg451), LightStep, Approver
 - [Roch Devost](https://github.com/rochdev), DataDog, Approver
+- [John Bley](https://github.com/johnbley), Splunk, Approver
+- [Mark Wolff](https://github.com/markwolff), Microsoft, Approver
+- [Olivier Albertini](https://github.com/OlivierAlbertini), Ville de Montréal, Approver
 
 *Find more about the emeritus role in [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#emeritus-maintainerapprovertriager).*
 

diff --git a/auto-merge/js/doc/GUIDELINES.md b/auto-merge/js/doc/GUIDELINES.md
@@ -0,0 +1,35 @@
+# OpenTelemetry JS Code Contribution Guide
+
+This document outlines the essential guidelines for contributing code to the OpenTelemetry JS repository. These guidelines are designed to ensure consistency, stability, and the highest quality of code across the project.
+
+## Dependencies
+
+This section refers to `"dependencies"` and `"devDependencies"` entries in `package.json` file.
+> [!IMPORTANT]
+> Not all libraries follow [Semantic Versioning](https://semver.org/). Even those who do might occasionally introduce breaking changes due to human errors. Exceptions to the guidelines in this document MAY be granted by Approvers or Maintainers to work around this.
+
+### Development Dependencies
+
+`"devDependencies"` SHOULD be pinned to reduce the risk of autobreaking the build. Since we cannot use the `package-lock.json` file (because the libraries are distributed without it), control over the version our contributors will get is limited. By using pinned versions, we prevent potential disruptions caused by unpinned versions.
+
+**Example:** `^1.2.3` might inadvertently lead to version `1.2.6` which includes unintended breaking changes).
+
+> [!NOTE]
+> As this approach might leave our project with outdated tooling, we adopt `renovate-bot`. This automated dependency update tool proactively opens pull requests upon the release of new patch/minor/major versions. The complete configuration for renovate-bot can be found in [renovate.json](../renovate.json) file.
+
+### @opentelemetry/* dependencies
+
+All packages from the `@opentelemetry/` namespace MUST have the same pinned version, as these dependencies are automatically updated on each release by lerna.
+
+**Example:** all packages under `packages/` should consistently maintain the same version, as should those under `experimental/packages/`.
+
+An exception is granted for dependencies on `@opentelemetry/api`, which, if used by the package SHOULD NOT be included as a `dependency`. `@opentelemetry/api` SHOULD be included as a `peerDependency` instead. The version range of the `peerDependency` SHOULD reflect the minimum supported, and SHOULD NOT allow versions greater than the latest released minor version.
+
+### Third-Party Library Dependencies
+
+Packages categorized as third-party and listed under the `"dependencies"` section (e.g., @grpc/grpc-js, @grpc/proto-loader, shimmer, etc.) should remain unpinned and utilize the caret (`^`) symbol. This approach offers several advantages:
+
+* Our users could get bug fixes of those 3rd-party packages easily, without waiting for us to update our library.
+* In cases where multiple packages have dependencies on different versions of the same package, npm will opt for the most recent version, saving space and preventing potential disruptions.
+
+It's important to acknowledge that this approach does expose users to potential breaking changes arising from either human error or libraries that do not strictly follow to semver conventions. This trade-off is an inherent aspect of this approach.
diff --git a/auto-merge/js/experimental/CHANGELOG.md b/auto-merge/js/experimental/CHANGELOG.md
@@ -8,6 +8,14 @@ All notable changes to experimental packages in this project will be documented
 
 ### :boom: Breaking Change
 
+* chore(sdk-node): deprecate methods in favor of constructor options [#3996](https://github.com/open-telemetry/opentelemetry-js/pull/3996) @pichlermarc
+  * The following methods are now deprecated and will be removed in `0.43.0`
+    * `NodeSDK.configureTracerProvider()`, please use constructor options instead
+    * `NodeSDK.configureMeterProvider()`, please use constructor options instead
+    * `NodeSDK.configureLoggerProvider()`, please use constructor options instead
+    * `NodeSDK.addResource()`, please use constructor options instead
+    * `NodeSDK.detectResources()`, this is not necessary anymore, resources are now auto-detected on startup.
+
 ### :rocket: (Enhancement)
 
 ### :bug: (Bug Fix)

diff --git a/auto-merge/js/experimental/packages/opentelemetry-sdk-node/src/sdk.ts b/auto-merge/js/experimental/packages/opentelemetry-sdk-node/src/sdk.ts
@@ -178,7 +178,14 @@ export class NodeSDK {
     this._instrumentations = instrumentations;
   }
 
-  /** Set configurations required to register a NodeTracerProvider */
+  /**
+   *
+   * @deprecated Please pass {@code sampler}, {@code generalLimits}, {@code spanLimits}, {@code resource},
+   * {@code IdGenerator}, {@code spanProcessor}, {@code contextManager} and {@code textMapPropagator},
+   * to the constructor options instead.
+   *
+   * Set configurations needed to register a TracerProvider
+   */
   public configureTracerProvider(
     tracerConfig: NodeTracerConfig,
     spanProcessor: SpanProcessor,
@@ -193,7 +200,11 @@ export class NodeSDK {
     };
   }
 
-  /**Set configurations needed to register a LoggerProvider */
+  /**
+   * @deprecated Please pass {@code logRecordProcessor} to the constructor options instead.
+   *
+   * Set configurations needed to register a LoggerProvider
+   */
   public configureLoggerProvider(config: LoggerProviderConfig): void {
     // nothing is set yet, we can set config and then return
     if (this._loggerProviderConfig == null) {
@@ -217,7 +228,11 @@ export class NodeSDK {
     }
   }
 
-  /** Set configurations needed to register a MeterProvider */
+  /**
+   * @deprecated Please pass {@code views} and {@code reader} to the constructor options instead.
+   *
+   * Set configurations needed to register a MeterProvider
+   */
   public configureMeterProvider(config: MeterProviderConfig): void {
     // nothing is set yet, we can set config and return.
     if (this._meterProviderConfig == null) {
@@ -248,7 +263,12 @@ export class NodeSDK {
     }
   }
 
-  /** Detect resource attributes */
+  /**
+   * @deprecated Resources are detected automatically on {@link NodeSDK.start()}, when the {@code autoDetectResources}
+   * constructor option is set to {@code true} or left {@code undefined}.
+   *
+   * Detect resource attributes
+   */
   public detectResources(): void {
     if (this._disabled) {
       return;
@@ -261,13 +281,18 @@ export class NodeSDK {
     this.addResource(detectResourcesSync(internalConfig));
   }
 
-  /** Manually add a resource */
+  /**
+   * @deprecated Please pre-merge resources and pass them to the constructor
+   *
+   * Manually add a Resource
+   * @param resource
+   */
   public addResource(resource: IResource): void {
     this._resource = this._resource.merge(resource);
   }
 
   /**
-   * Once the SDK has been configured, call this method to construct SDK components and register them with the OpenTelemetry API.
+   * Call this method to construct SDK components and register them with the OpenTelemetry API.
    */
   public start(): void {
     if (this._disabled) {

diff --git a/auto-merge/js/selenium-tests/package.json b/auto-merge/js/selenium-tests/package.json
@@ -40,7 +40,7 @@
     "babel-loader": "8.3.0",
     "babel-polyfill": "6.26.0",
     "browserstack-local": "1.4.8",
-    "chromedriver": "114.0.3",
+    "chromedriver": "116.0.0",
     "dotenv": "16.0.0",
     "fast-safe-stringify": "2.1.1",
     "geckodriver": "3.0.1",