Merge branch 'main' into esbuild-plugin

Author: drewcorlin1

.github/component_owners.yml

@@ -17,6 +17,8 @@ components:
   detectors/node/opentelemetry-resource-detector-instana:
     - basti1302
     - kirrg001
+  incubator/opentelemetry-sampler-aws-xray:
+    - carolabadeer
   metapackages/auto-instrumentations-node:
     - dyladan
     - pichlermarc
@@ -36,8 +38,6 @@ components:
     - legendecas
   packages/opentelemetry-id-generator-aws-xray:
     - carolabadeer
-  packages/opentelemetry-sampler-aws-xray:
-    - carolabadeer
   packages/opentelemetry-propagation-utils:
     - dyladan
     - pichlermarc
@@ -60,6 +60,8 @@ components:
     - henrinormak
   plugins/node/instrumentation-fs:
     - rauno56
+  plugins/node/instrumentation-kafkajs:
+    - seemk
   plugins/node/instrumentation-lru-memoizer:
     - blumamir
   plugins/node/instrumentation-mongoose:
@@ -113,7 +115,7 @@ components:
     - rauno56
   plugins/node/opentelemetry-instrumentation-net:
     - seemk
-  plugins/node/opentelemetry-instrumentation-runtime-node:
+  plugins/node/instrumentation-runtime-node:
     - d4nyll
   plugins/node/opentelemetry-instrumentation-pg:
     - maryliag
@@ -128,7 +130,7 @@ components:
     - rauno56
   plugins/node/opentelemetry-instrumentation-router:
     - rauno56
-  plugins/node/opentelemetry-instrumentation-undici:
+  plugins/node/instrumentation-undici:
     - david-luna
     - trentm
   plugins/node/opentelemetry-instrumentation-winston:
@@ -143,8 +145,6 @@ components:
     - obecny
   plugins/web/opentelemetry-plugin-react-load:
     - martinkuba
-  propagators/opentelemetry-propagator-grpc-census-binary: []
-    # Unmaintained?
   propagators/opentelemetry-propagator-instana:
     - basti1302
     - kirrg001

.github/markdown-lint.yml

@@ -0,0 +1,5 @@
+# MD004 - Unordered list style
+# This rule is triggered when the symbols used in the document for unordered list items do not match the configured unordered list style
+# * Item 1 // Error: Unordered list style [Expected: dash; Actual: asterisk]
+MD004:
+  style: dash

.github/workflows/lint.yml

@@ -19,6 +19,7 @@ jobs:
       - name: Lint markdown files
         uses: avto-dev/markdown-lint@v1
         with:
+          config: '.github/markdown-lint.yml'
           ignore: "./**/CHANGELOG.md"
           args: "./**/*.md"
 

.github/workflows/release-please.yml

@@ -24,7 +24,7 @@ jobs:
         run: |
           npm ci
 
-      - uses: google-github-actions/release-please-action@v4
+      - uses: googleapis/release-please-action@f3969c04a4ec81d7a9aa4010d84ae6a7602f86a7 # v4.1.1
         id: release
         with:
           token: ${{secrets.RELEASE_PR_TOKEN}}

.github/workflows/test-all-versions.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ["14", "16", "18.18.2"]
+        node: ["14", "16", "18", "20"]
     runs-on: ubuntu-latest
     services:
       mongo:

.github/workflows/unit-test.yml

@@ -9,9 +9,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ["14", "16", "18.18.2"]
+        node: ["14", "16", "18", "20"]
         include:
-            - node: 18.18.2
+            - node: 18
               code-coverage: true
     runs-on: ubuntu-latest
     services:

.release-please-manifest.json

@@ -1,14 +1,14 @@
 {
   "detectors/node/opentelemetry-resource-detector-alibaba-cloud": "0.28.9",
-  "detectors/node/opentelemetry-resource-detector-aws": "1.4.2",
+  "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-github": "0.28.2",
   "detectors/node/opentelemetry-resource-detector-instana": "0.9.0",
-  "metapackages/auto-instrumentations-node": "0.46.0",
+  "metapackages/auto-instrumentations-node": "0.46.1",
   "metapackages/auto-instrumentations-web": "0.39.0",
-  "packages/baggage-span-processor": "0.1.0",
+  "packages/baggage-span-processor": "0.2.0",
   "packages/esbuild-plugin-node": "0.1.0",
   "packages/opentelemetry-host-metrics": "0.35.1",
   "packages/opentelemetry-id-generator-aws-xray": "1.2.2",
@@ -21,19 +21,20 @@
   "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.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.0",
+  "plugins/node/opentelemetry-instrumentation-connect": "0.36.1",
   "plugins/node/opentelemetry-instrumentation-dns": "0.36.1",
-  "plugins/node/opentelemetry-instrumentation-express": "0.38.0",
+  "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",
@@ -58,7 +59,6 @@
   "plugins/web/opentelemetry-instrumentation-long-task": "0.38.0",
   "plugins/web/opentelemetry-instrumentation-user-interaction": "0.38.0",
   "plugins/web/opentelemetry-plugin-react-load": "0.30.1",
-  "propagators/opentelemetry-propagator-grpc-census-binary": "0.27.2",
   "propagators/opentelemetry-propagator-instana": "0.3.2",
   "propagators/opentelemetry-propagator-ot-trace": "0.27.2"
 }

GUIDELINES.md

@@ -197,3 +197,27 @@ Instrumentation may add additional patch/unpatch messages for specific functions
 - In situations where the patch logic is not trivial and it helps to specify patch events in the right context and nuances. `aws-lambda` logs additional properties extracted from the lambda framework and exposes them for troubleshooting.
 
 The cases above are not covered by the base class and offer additional context to the user troubleshooting an issue with the instrumentation.
+
+## package.json
+
+### Description
+
+Instrumentation should include a `description` field in the `package.json` file. The description targets human readers and is an opportunity to communicate the use case for the instrumented package and its semconv namespace. It should help users know whether the package fits their application, which is especially helpful if the package has a shortened or obscure name.
+
+The description should be written with this format when applicable:
+
+```text
+"OpenTelemetry instrumentation for `<instrumented-package-name>` <package short description>"
+```
+
+For example:
+
+```text
+"OpenTelemetry instrumentation for `express` http framework"
+"OpenTelemetry instrumentation for `winston` logger"
+"OpenTelemetry instrumentation for `redis` database client for Redis"
+```
+
+If the package is consumed directly, the description should state the package name in `<instrumented-package-name>`. Tools like `nestjs` and `aws-lambda` are examples of packages that are consumed indirectly.
+
+A short description should follow the package name, like "http framework", "logger", "database client for X", "messaging client", etc as appropriate in each case. It is preferable to use the semconv namespace semantics that are emitted by this instrumentation (`http`, `database`, `messaging`, `rpc`, `net`) to give quick context for the scope of the instrumentation.

README.md

@@ -42,10 +42,10 @@ A repository for OpenTelemetry JavaScript contributions that are not part of the
 
 This project includes:
 
-* [Instrumentations & other plugins](./plugins),
-* [Metapackages](./metapackages),
-* [Context Propagators](./propagators),
-* [Resource Detectors](./detectors).
+- [Instrumentations & other plugins](./plugins),
+- [Metapackages](./metapackages),
+- [Context Propagators](./propagators),
+- [Resource Detectors](./detectors).
 
 **Instrumentations**: OpenTelemetry can collect tracing data automatically using instrumentations. Vendors/Users can also create and use their own.
 
@@ -59,9 +59,9 @@ Stability level for components in this repository follow the definitions in [CON
 
 Packages in this repository have a variable range of support for Node.JS and browser versions which for each package depend on
 
-* the activeness of the owners of those packages,
-* used techniques or runtime features and
-* in the case of the auto-instrumentations, the supported runtime versions for the underlying package.
+- the activeness of the owners of those packages,
+- used techniques or runtime features and
+- in the case of the auto-instrumentations, the supported runtime versions for the underlying package.
 
 See the `README.md` files and the `engines` field in the `package.json` files for the respective packages for support information about that package.
 
@@ -79,9 +79,9 @@ We'd love your help! Use tags [up-for-grabs][up-for-grabs-issues] and [good firs
 
 ## Useful links
 
-* For more information on OpenTelemetry, visit [OpenTelemetry.io](https://opentelemetry.io/)
-* For help or feedback on this project, join us in [GitHub Discussions][discussions-url] or in [Slack](https://cloud-native.slack.com/archives/C01NL1GRPQR)
-* For more 3rd party components for JS as well as other languages, check [OpenTelemetry Registry](https://opentelemetry.io/registry/)
+- For more information on OpenTelemetry, visit [OpenTelemetry.io](https://opentelemetry.io/)
+- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] or in [Slack](https://cloud-native.slack.com/archives/C01NL1GRPQR)
+- For more 3rd party components for JS as well as other languages, check [OpenTelemetry Registry](https://opentelemetry.io/registry/)
 
 ## License
 

RELEASING.md

@@ -9,15 +9,15 @@ For posterity, or in the event of any failures with release-please, the process
 
 Manual Release Process Steps:
 
-* [Update to latest locally](#update-to-latest-locally)
-* [Create a new branch](#create-a-new-branch)
-* [Prepare each package for release](#prepare-each-package-for-release)
-* [Use the Changelog to create a GitHub Release](#use-the-changelog-to-create-a-github-release)
-* [Create a new PR](#create-a-new-pr)
-* [Merge and pull](#merge-and-pull)
-* [Publish all packages](#publish-all-packages)
-* [Publish the GitHub Release](#publish-the-github-release)
-* [Update CHANGELOG](#update-changelog)
+- [Update to latest locally](#update-to-latest-locally)
+- [Create a new branch](#create-a-new-branch)
+- [Prepare each package for release](#prepare-each-package-for-release)
+- [Use the Changelog to create a GitHub Release](#use-the-changelog-to-create-a-github-release)
+- [Create a new PR](#create-a-new-pr)
+- [Merge and pull](#merge-and-pull)
+- [Publish all packages](#publish-all-packages)
+- [Publish the GitHub Release](#publish-the-github-release)
+- [Update CHANGELOG](#update-changelog)
 
 ## Update to latest locally
 
@@ -31,9 +31,9 @@ Create a new branch called `x.y.z-proposal` from the current commit.
 
 Decide on the next `major.minor.patch` release number based on [semver](http://semver.org/) guidelines.
 
-* Use `npm install` command to initialize all package directories
-* Use `lerna publish --skip-npm --no-git-tag-version --no-push` to bump the version in all `package.json`
-* Use `npm run bootstrap` to generate latest `version.ts` files
+- Use `npm install` command to initialize all package directories
+- Use `lerna publish --skip-npm --no-git-tag-version --no-push` to bump the version in all `package.json`
+- Use `npm run bootstrap` to generate latest `version.ts` files
 
 ## Use the Changelog to create a GitHub Release
 
@@ -58,10 +58,10 @@ It will print something like:
 ## Unreleased (2018-05-24)
 
 #### :bug: Bug Fix
-* [#198](https://github.com/my-org/my-repo/pull/198) Avoid an infinite loop ([@helpful-hacker](https://github.com/helpful-hacker))
+- [#198](https://github.com/my-org/my-repo/pull/198) Avoid an infinite loop ([@helpful-hacker](https://github.com/helpful-hacker))
 
 #### :house: Internal
-* [#183](https://github.com/my-org/my-repo/pull/183) Standardize error messages ([@careful-coder](https://github.com/careful-coder))
+- [#183](https://github.com/my-org/my-repo/pull/183) Standardize error messages ([@careful-coder](https://github.com/careful-coder))
 
 #### Commiters: 2
 - Helpful Hacker ([@helpful-hacker](https://github.com/helpful-hacker))
@@ -112,10 +112,10 @@ Publish the GitHub release, ensuring that the tag points to the newly landed com
 
 ## Update CHANGELOG
 
-* After releasing is done, update the [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-js/blob/main/CHANGELOG.md) and start new Unreleased label.
-* Create a new commit with the exact title: `Post Release: update CHANGELOG.md`.
-* Go through PR review and merge it to GitHub main branch.
+- After releasing is done, update the [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-js/blob/main/CHANGELOG.md) and start new Unreleased label.
+- Create a new commit with the exact title: `Post Release: update CHANGELOG.md`.
+- Go through PR review and merge it to GitHub main branch.
 
 ## Known Issues
 
-* The `examples/` and `getting-started/` folders are not part of lerna packages, we need to manually bump the version in `package.json`.
+- The `examples/` and `getting-started/` folders are not part of lerna packages, we need to manually bump the version in `package.json`.