Merge remote-tracking branch 'upstream/main' into feature/config-link…

…s-amqp-plugin

.github/ISSUE_TEMPLATE/plugin_request.md → .github/ISSUE_TEMPLATE/instrumentation_request.md

@@ -5,9 +5,7 @@ labels: instrumentation-request
 ---
 
 <!--
-**NB:** Before opening an instrumentation request against this repo, consider whether the instrumentation should/could be implemented in the [other OpenTelemetry client libraries](https://github.com/open-telemetry/). If so, please [open an issue on opentelemetry-specification](https://github.com/open-telemetry/opentelemetry-specification/issues/new) first.
-
-You are welcome to try to build your own instrumentation. If you do, please let us know if you have any questions/feedback.
+**NB:** Before opening an instrumentation request against this repo, please read [the contributing guidelines for new instrumentation](../../CONTRIBUTING.md#new-instrumentation).
 -->
 
 ### Is your instrumentation request related to a problem? Please describe
@@ -20,11 +18,22 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
 
 
 ### Do you expect this instrumentation to be commonly used?
+
 Weekly Downloads:
 
 ### What version of instrumentation are you interested in using?
+
 Versions:
 
+### Code Owners
+
+<!--
+New Instrumentation requests need at least 2 code-owners that will maintain the instrumentation long-term.
+-->
+
+- Owner 1
+- Owner 2
+
 ### Additional context
 <!--
 Add any other context or screenshots about the instrumentation request here. Is there a reference you could point for the well-defined lifecycle methods?

.github/workflows/lint.yml

@@ -15,14 +15,9 @@ jobs:
         with:
           node-version: 18
           cache: 'npm'
-
-      - name: Lint markdown files
-        uses: avto-dev/markdown-lint@v1
-        with:
-          config: '.github/markdown-lint.yml'
-          ignore: "./**/CHANGELOG.md"
-          args: "./**/*.md"
-
       - run: npm ci
       - name: Lint
-        run: npm run lint
+        run: |
+          npm run lint
+          npm run lint:markdown
+          npm run lint:readme

.markdownlint-cli2.jsonc

@@ -0,0 +1,17 @@
+// https://github.com/DavidAnson/markdownlint-cli2#markdownlint-cli2jsonc
+{
+  "config": {
+    // https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases
+    "MD013": false,
+    "MD024": false,
+    "MD033": false,
+    "MD041": false,
+    // MD004/ul-style. We prefer dash, but generated CHANGELOG.md files use
+    // asterisk. The default "consistent" is a good compromise.
+    "MD004": { "style": "consistent" },
+    "MD012": false // no-multiple-blanks; disabled because common in CHANGELOG.md files
+  },
+  "gitignore": true,
+  "noBanner": true,
+  "noProgress": true
+}

.release-please-manifest.json

@@ -1,62 +1,62 @@
 {
-  "detectors/node/opentelemetry-resource-detector-alibaba-cloud": "0.28.9",
-  "detectors/node/opentelemetry-resource-detector-aws": "1.5.0",
-  "detectors/node/opentelemetry-resource-detector-azure": "0.2.7",
-  "detectors/node/opentelemetry-resource-detector-container": "0.3.9",
-  "detectors/node/opentelemetry-resource-detector-gcp": "0.29.9",
+  "detectors/node/opentelemetry-resource-detector-alibaba-cloud": "0.28.10",
+  "detectors/node/opentelemetry-resource-detector-aws": "1.5.1",
+  "detectors/node/opentelemetry-resource-detector-azure": "0.2.9",
+  "detectors/node/opentelemetry-resource-detector-container": "0.3.11",
+  "detectors/node/opentelemetry-resource-detector-gcp": "0.29.10",
   "detectors/node/opentelemetry-resource-detector-github": "0.28.2",
-  "detectors/node/opentelemetry-resource-detector-instana": "0.9.0",
-  "metapackages/auto-instrumentations-node": "0.46.1",
-  "metapackages/auto-instrumentations-web": "0.39.0",
-  "packages/baggage-span-processor": "0.2.0",
-  "packages/opentelemetry-host-metrics": "0.35.1",
+  "detectors/node/opentelemetry-resource-detector-instana": "0.10.0",
+  "metapackages/auto-instrumentations-node": "0.47.1",
+  "metapackages/auto-instrumentations-web": "0.40.0",
+  "packages/baggage-span-processor": "0.3.1",
+  "packages/opentelemetry-host-metrics": "0.35.2",
   "packages/opentelemetry-id-generator-aws-xray": "1.2.2",
-  "packages/opentelemetry-propagation-utils": "0.30.9",
+  "packages/opentelemetry-propagation-utils": "0.30.10",
   "packages/opentelemetry-redis-common": "0.36.2",
   "packages/opentelemetry-sql-common": "0.40.1",
-  "packages/opentelemetry-test-utils": "0.39.0",
-  "packages/winston-transport": "0.3.0",
-  "plugins/node/instrumentation-amqplib": "0.37.0",
-  "plugins/node/instrumentation-cucumber": "0.6.0",
-  "plugins/node/instrumentation-dataloader": "0.9.0",
-  "plugins/node/instrumentation-fs": "0.12.0",
-  "plugins/node/instrumentation-kafkajs": "0.0.1",
-  "plugins/node/instrumentation-lru-memoizer": "0.37.0",
-  "plugins/node/instrumentation-mongoose": "0.38.1",
-  "plugins/node/instrumentation-runtime-node": "0.4.0",
-  "plugins/node/instrumentation-socket.io": "0.39.0",
-  "plugins/node/instrumentation-tedious": "0.10.1",
-  "plugins/node/instrumentation-undici": "0.2.0",
-  "plugins/node/opentelemetry-instrumentation-aws-lambda": "0.41.1",
-  "plugins/node/opentelemetry-instrumentation-aws-sdk": "0.41.0",
-  "plugins/node/opentelemetry-instrumentation-bunyan": "0.38.0",
-  "plugins/node/opentelemetry-instrumentation-cassandra": "0.38.0",
-  "plugins/node/opentelemetry-instrumentation-connect": "0.36.1",
-  "plugins/node/opentelemetry-instrumentation-dns": "0.36.1",
-  "plugins/node/opentelemetry-instrumentation-express": "0.39.0",
-  "plugins/node/opentelemetry-instrumentation-fastify": "0.36.1",
-  "plugins/node/opentelemetry-instrumentation-generic-pool": "0.36.0",
-  "plugins/node/opentelemetry-instrumentation-graphql": "0.40.0",
-  "plugins/node/opentelemetry-instrumentation-hapi": "0.38.0",
-  "plugins/node/opentelemetry-instrumentation-ioredis": "0.40.0",
-  "plugins/node/opentelemetry-instrumentation-knex": "0.36.1",
-  "plugins/node/opentelemetry-instrumentation-koa": "0.40.0",
-  "plugins/node/opentelemetry-instrumentation-memcached": "0.36.0",
-  "plugins/node/opentelemetry-instrumentation-mongodb": "0.43.0",
-  "plugins/node/opentelemetry-instrumentation-mysql": "0.38.1",
-  "plugins/node/opentelemetry-instrumentation-mysql2": "0.38.1",
-  "plugins/node/opentelemetry-instrumentation-nestjs-core": "0.37.1",
-  "plugins/node/opentelemetry-instrumentation-net": "0.36.0",
-  "plugins/node/opentelemetry-instrumentation-pg": "0.41.0",
-  "plugins/node/opentelemetry-instrumentation-pino": "0.39.0",
-  "plugins/node/opentelemetry-instrumentation-redis": "0.39.1",
-  "plugins/node/opentelemetry-instrumentation-redis-4": "0.39.0",
-  "plugins/node/opentelemetry-instrumentation-restify": "0.38.0",
-  "plugins/node/opentelemetry-instrumentation-router": "0.37.0",
-  "plugins/node/opentelemetry-instrumentation-winston": "0.37.0",
-  "plugins/web/opentelemetry-instrumentation-document-load": "0.38.0",
-  "plugins/web/opentelemetry-instrumentation-long-task": "0.38.0",
-  "plugins/web/opentelemetry-instrumentation-user-interaction": "0.38.0",
+  "packages/opentelemetry-test-utils": "0.40.0",
+  "packages/winston-transport": "0.4.0",
+  "plugins/node/instrumentation-amqplib": "0.38.0",
+  "plugins/node/instrumentation-cucumber": "0.7.0",
+  "plugins/node/instrumentation-dataloader": "0.10.0",
+  "plugins/node/instrumentation-fs": "0.13.0",
+  "plugins/node/instrumentation-kafkajs": "0.1.0",
+  "plugins/node/instrumentation-lru-memoizer": "0.38.0",
+  "plugins/node/instrumentation-mongoose": "0.39.0",
+  "plugins/node/instrumentation-runtime-node": "0.5.0",
+  "plugins/node/instrumentation-socket.io": "0.40.0",
+  "plugins/node/instrumentation-tedious": "0.11.0",
+  "plugins/node/instrumentation-undici": "0.3.0",
+  "plugins/node/opentelemetry-instrumentation-aws-lambda": "0.42.0",
+  "plugins/node/opentelemetry-instrumentation-aws-sdk": "0.42.0",
+  "plugins/node/opentelemetry-instrumentation-bunyan": "0.39.0",
+  "plugins/node/opentelemetry-instrumentation-cassandra": "0.39.0",
+  "plugins/node/opentelemetry-instrumentation-connect": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-dns": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-express": "0.40.1",
+  "plugins/node/opentelemetry-instrumentation-fastify": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-generic-pool": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-graphql": "0.41.0",
+  "plugins/node/opentelemetry-instrumentation-hapi": "0.39.0",
+  "plugins/node/opentelemetry-instrumentation-ioredis": "0.41.0",
+  "plugins/node/opentelemetry-instrumentation-knex": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-koa": "0.41.0",
+  "plugins/node/opentelemetry-instrumentation-memcached": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-mongodb": "0.45.0",
+  "plugins/node/opentelemetry-instrumentation-mysql": "0.39.0",
+  "plugins/node/opentelemetry-instrumentation-mysql2": "0.39.0",
+  "plugins/node/opentelemetry-instrumentation-nestjs-core": "0.38.0",
+  "plugins/node/opentelemetry-instrumentation-net": "0.37.0",
+  "plugins/node/opentelemetry-instrumentation-pg": "0.42.0",
+  "plugins/node/opentelemetry-instrumentation-pino": "0.40.0",
+  "plugins/node/opentelemetry-instrumentation-redis": "0.40.0",
+  "plugins/node/opentelemetry-instrumentation-redis-4": "0.40.0",
+  "plugins/node/opentelemetry-instrumentation-restify": "0.39.0",
+  "plugins/node/opentelemetry-instrumentation-router": "0.38.0",
+  "plugins/node/opentelemetry-instrumentation-winston": "0.38.0",
+  "plugins/web/opentelemetry-instrumentation-document-load": "0.39.0",
+  "plugins/web/opentelemetry-instrumentation-long-task": "0.39.0",
+  "plugins/web/opentelemetry-instrumentation-user-interaction": "0.39.0",
   "plugins/web/opentelemetry-plugin-react-load": "0.30.1",
   "propagators/opentelemetry-propagator-instana": "0.3.2",
   "propagators/opentelemetry-propagator-ot-trace": "0.27.2"

CHANGELOG.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable -->
 # CHANGELOG
 
 As of v0.25.1 (2022-01-24) changelog content has moved to separate CHANGELOG.md files for each package. Use [this search for a list of all CHANGELOG.md files in this repo](https://github.com/search?q=repo%3Aopen-telemetry%2Fopentelemetry-js-contrib+path%3A**%2FCHANGELOG.md&type=code).

CONTRIBUTING.md

@@ -26,6 +26,7 @@ We'd love your help!
 - [Contributing Vendor Components](#contributing-vendor-components)
   - [Adding a New Vendor Component](#adding-a-new-vendor-component)
   - [Removing Vendor Components](#removing-vendor-components)
+- [New Instrumentation](#new-instrumentation)
 
 ## Development Quick Start
 
@@ -150,7 +151,7 @@ With the exception of the stable status, it is up to each individual [component
 A component may only be marked stable with the approval of a member of @open-telemetry/javascript-maintainers; see the definition of stable below for more details.
 
 A Pull Request modifying components in any stage of the lifecycle is subject to the
-[Pull Request Merge Requirements](#pull-request-merge-requirements).
+[Pull Request Merge Guidelines](#pull-request-merge-guidelines).
 
 ### Unreleased
 
@@ -232,6 +233,38 @@ please ping ([@open-telemetry/javascript-approvers](https://github.com/orgs/open
 - New or changed functionality is documented if appropriate
 - Substantial changes should not be merged within 24 hours of opening in order to allow reviewers from all time zones to have a chance to review
 
+## New Instrumentation
+
+**Do not submit pull requests for new instrumentation without reading the following.**
+
+This project is dedicated to promoting the development of quality instrumentation using OpenTelemetry.
+To achieve this goal, we recognize that the instrumentation needs to be written using the best practices of OpenTelemetry, but also by developers that understand the package they are instrumenting.
+Additionally, the produced instrumentation needs to be maintained and evolved.
+
+The size of the OpenTelemetry JavaScript developer community is not large enough to support an ever-growing amount of instrumentation.
+Therefore, to reach our goal, we have the following recommendations for where instrumentation packages should live.
+
+1. Native to the instrumented package
+2. A dedicated public repository
+3. Here in the opentelemetry-js-contrib repository
+
+If possible, OpenTelemetry instrumentation should be included in the instrumented package.
+This will ensure the instrumentation reaches all package users, and is continuously maintained by developers that understand the package.
+
+If instrumentation cannot be directly included in the package it is instrumenting, it should be hosted in a dedicated public repository owned by its maintainer(s).
+This will appropriately assign maintenance responsibilities for the instrumentation and ensure these maintainers have the needed privilege to maintain the code.
+
+The last place instrumentation should be hosted is here in this repository.
+Maintaining instrumentation here hampers the development of OpenTelemetry for JavaScript and therefore should be avoided.
+When instrumentation cannot be included in a target package and there is good reason to not host it in a separate and dedicated repository an [instrumentation request](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/new/choose) should be filed.
+Note that new instrumentation needs at least two contributors assigned to it as code-owners.  It is the responsibility
+of the requesting party to reach out and find code-owners for the proposed instrumentation. The instrumentation request
+needs to be accepted before any pull requests for the instrumentation can be considered for merging.
+
+Regardless of where instrumentation is hosted, it needs to be discoverable.
+The [OpenTelemetry registry](https://opentelemetry.io/registry/) exists to ensure that instrumentation is discoverable.
+You can find out how to add instrumentation to the registry [here](https://github.com/open-telemetry/opentelemetry.io#adding-a-project-to-the-opentelemetry-registry).
+
 ## Contributing Vendor Components
 
 This repo is generally meant for hosting components that work with popular open-source frameworks and tools. However, it is also possible to contribute components specific to a 3rd party vendor in this repo.