Merge branch 'main' into typeorm-instrumentation

.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
@@ -34,8 +36,6 @@ components:
     - legendecas
   packages/opentelemetry-id-generator-aws-xray:
     - carolabadeer
-  packages/opentelemetry-sampler-aws-xray:
-    - carolabadeer
   packages/opentelemetry-propagation-utils:
     - dyladan
     - pichlermarc
@@ -115,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
@@ -130,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:
@@ -145,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

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.

detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md

@@ -28,6 +28,8 @@ const tracerProvider = new NodeTracerProvider({ resource });
 
 ## Available detectors
 
+This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
+
 ### Alibaba Cloud Ecs Detector
 
 Populates `cloud` and `host` for processes running on [Alibaba Cloud ECS](https://www.alibabacloud.com/product/ecs). More info about Alibaba Instance Identities can be found [here](https://www.alibabacloud.com/help/en/ecs/user-guide/use-instance-identities).

detectors/node/opentelemetry-resource-detector-github/README.md

@@ -22,8 +22,7 @@ npm install --save @opentelemetry/resource-detector-github
 ## Usage
 
 ```js
-
-const { gitHubDetector } = require('@opentelemetry/opentelemetry-resource-detector-github')
+const { gitHubDetector } = require('@opentelemetry/resource-detector-github')
 
 async function run() {
   // Initialize GitHub Resource Detector

plugins/node/instrumentation-amqplib/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-amqplib",
   "version": "0.37.0",
-  "description": "OpenTelemetry automatic instrumentation for the `amqplib` package",
+  "description": "OpenTelemetry instrumentation for the `amqplib` messaging client for RabbitMQ",
   "keywords": [
     "amqplib",
     "opentelemetry",

plugins/node/instrumentation-cucumber/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-cucumber",
   "version": "0.6.0",
-  "description": "OpenTelemetry cucumber automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `@cucumber/cucumber` automated tests runner",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/instrumentation-dataloader/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-dataloader",
   "version": "0.9.0",
-  "description": "OpenTelemetry instrumentation for dataloader",
+  "description": "OpenTelemetry instrumentation for `dataloader` data fetching layer",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/instrumentation-fs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-fs",
   "version": "0.12.0",
-  "description": "OpenTelemetry automatic instrumentation package for fs",
+  "description": "OpenTelemetry instrumentation for `node:fs` file system interactions module",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/instrumentation-kafkajs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-kafkajs",
   "version": "0.0.1",
-  "description": "OpenTelemetry automatic instrumentation package for kafkajs",
+  "description": "OpenTelemetry instrumentation for `kafkajs` messaging client for Apache Kafka",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/instrumentation-lru-memoizer/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-lru-memoizer",
   "version": "0.37.0",
-  "description": "OpenTelemetry automatic instrumentation package for lru-memoizer",
+  "description": "OpenTelemetry instrumentation for `lru-memoizer` function memoization using lru-cache",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/instrumentation-mongoose/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-mongoose",
   "version": "0.38.1",
-  "description": "OpenTelemetry automatic instrumentation package for mongoose",
+  "description": "OpenTelemetry instrumentation for `mongoose` database object data modeling (ODM) library for MongoDB",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/instrumentation-runtime-node/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-runtime-node",
   "version": "0.4.0",
-  "description": "OpenTelemetry Node.js Performance measurement API automatic instrumentation package",
+  "description": "OpenTelemetry instrumentation for Node.js Performance measurement API",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/instrumentation-socket.io/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-socket.io",
   "version": "0.39.0",
-  "description": "OpenTelemetry automatic instrumentation package for socket.io",
+  "description": "OpenTelemetry instrumentation for `socket.io` messaging server implementation for Socket.IO communication",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/instrumentation-tedious/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-tedious",
   "version": "0.10.1",
-  "description": "OpenTelemetry instrumentation for `tedious`",
+  "description": "OpenTelemetry instrumentation for `tedious` database client for Microsoft SQL Server",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/instrumentation-undici/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-undici",
   "version": "0.2.0",
-  "description": "OpenTelemetry instrumentation for undici and Node.js fetch().",
+  "description": "OpenTelemetry instrumentation for `undici` http client and Node.js fetch()",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-aws-lambda/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-aws-lambda",
   "version": "0.41.1",
-  "description": "OpenTelemetry AWS Lambda automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for AWS Lambda function invocations",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-aws-sdk/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-aws-sdk",
   "version": "0.41.0",
-  "description": "OpenTelemetry automatic instrumentation for the `aws-sdk` package",
+  "description": "OpenTelemetry instrumentation for `aws-sdk` and `@aws-sdk/client-*` clients for various AWS services",
   "keywords": [
     "aws",
     "aws-sdk",

plugins/node/opentelemetry-instrumentation-bunyan/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-bunyan",
   "version": "0.38.0",
-  "description": "OpenTelemetry instrumentation for bunyan",
+  "description": "OpenTelemetry instrumentation for `bunyan` logger",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-cassandra/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-cassandra-driver",
   "version": "0.38.0",
-  "description": "OpenTelemetry instrumentation for cassandra-driver",
+  "description": "OpenTelemetry instrumentation for `cassandra-driver` database client library for Apache Cassandra",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-connect/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-connect",
   "version": "0.36.1",
-  "description": "OpenTelemetry connect automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `connect` http middleware framework",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-dns/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-dns",
   "version": "0.36.1",
-  "description": "OpenTelemetry dns automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `node:dns` name resolution module",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-express/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-express",
   "version": "0.39.0",
-  "description": "OpenTelemetry express automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `express` http web application framework",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-fastify/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-fastify",
   "version": "0.36.1",
-  "description": "OpenTelemetry fastify automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `fastify` http web application framework",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-generic-pool/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-generic-pool",
   "version": "0.36.0",
-  "description": "OpenTelemetry Generic Pool automatic instrumentation package",
+  "description": "OpenTelemetry instrumentation for `generic-pool` resource pool for managing expensive resources",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-graphql/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-graphql",
   "version": "0.40.0",
-  "description": "OpenTelemetry @opentelemetry/instrumentation-graphql automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `graphql` gql query language and runtime for GraphQL",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-hapi/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-hapi",
   "version": "0.38.0",
-  "description": "OpenTelemetry Hapi automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `@hapi/hapi` http web application framework",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-ioredis/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-ioredis",
   "version": "0.40.0",
-  "description": "OpenTelemetry ioredis automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `ioredis` database redis client for Redis",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-ioredis/src/types.ts

@@ -55,7 +55,7 @@ export interface RedisResponseCustomAttributeFunction {
 }
 
 /**
- * Options available for the IORedis Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-ioredis#ioredis-instrumentation-options))
+ * Options available for the IORedis Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-ioredis/README.md#ioredis-instrumentation-options))
  */
 export interface IORedisInstrumentationConfig extends InstrumentationConfig {
   /** Custom serializer function for the db.statement tag */

plugins/node/opentelemetry-instrumentation-knex/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-knex",
   "version": "0.36.1",
-  "description": "OpenTelemetry Knex automatic instrumentation package",
+  "description": "OpenTelemetry instrumentation for `knex` database SQL query builder",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-koa/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-koa",
   "version": "0.40.0",
-  "description": "OpenTelemetry Koa automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `koa` http web application framework",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-memcached/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-memcached",
   "version": "0.36.0",
-  "description": "OpenTelemetry memcached automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `memcached` database client for memcached",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-mongodb/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-mongodb",
   "version": "0.43.0",
-  "description": "OpenTelemetry mongodb automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `mongodb` database client for MongoDB",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-mysql/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-mysql",
   "version": "0.38.1",
-  "description": "OpenTelemetry mysql automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `mysql` database client for MySQL",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-mysql2/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-mysql2",
   "version": "0.38.1",
-  "description": "OpenTelemetry mysql2 automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `mysql2` database client for MySQL",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-nestjs-core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-nestjs-core",
   "version": "0.37.1",
-  "description": "OpenTelemetry NestJS automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for NestJS server side applications framework",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-net/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-net",
   "version": "0.36.0",
-  "description": "OpenTelemetry net module automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `node:net` network API module",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-pg/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-pg",
   "version": "0.41.0",
-  "description": "OpenTelemetry postgres automatic instrumentation package.",
+  "description": "OpenTelemetry instrumentation for `pg` and `pg-pool` database client for PostgreSQL",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",

plugins/node/opentelemetry-instrumentation-pino/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opentelemetry/instrumentation-pino",
   "version": "0.39.0",
-  "description": "OpenTelemetry instrumentation for pino",
+  "description": "OpenTelemetry instrumentation for `pino` logger",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "repository": "open-telemetry/opentelemetry-js-contrib",