From aaf47484cea6a002c222ee95c8ed4e9f63b92de6 Mon Sep 17 00:00:00 2001 From: Amir Blum Date: Sat, 18 May 2024 06:58:59 +0300 Subject: [PATCH 1/4] docs: enhanced description for instrumentations in package.json (#2202) * docs: enhanced description for instrumentations in package.json * docs: also apply to new instrumentation kafkajs --- GUIDELINES.md | 24 +++++++++++++++++++ .../node/instrumentation-amqplib/package.json | 2 +- .../instrumentation-cucumber/package.json | 2 +- .../instrumentation-dataloader/package.json | 2 +- plugins/node/instrumentation-fs/package.json | 2 +- .../node/instrumentation-kafkajs/package.json | 2 +- .../instrumentation-lru-memoizer/package.json | 2 +- .../instrumentation-mongoose/package.json | 2 +- .../instrumentation-runtime-node/package.json | 2 +- .../instrumentation-socket.io/package.json | 2 +- .../node/instrumentation-tedious/package.json | 2 +- .../node/instrumentation-undici/package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 2 +- 43 files changed, 66 insertions(+), 42 deletions(-) diff --git a/GUIDELINES.md b/GUIDELINES.md index 04bc219b14..69c3fe283a 100644 --- a/GUIDELINES.md +++ b/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 `` " +``` + +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 ``. 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. diff --git a/plugins/node/instrumentation-amqplib/package.json b/plugins/node/instrumentation-amqplib/package.json index 6634aad6bd..9910feedae 100644 --- a/plugins/node/instrumentation-amqplib/package.json +++ b/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", diff --git a/plugins/node/instrumentation-cucumber/package.json b/plugins/node/instrumentation-cucumber/package.json index ee4b117fd0..2c0c17df13 100644 --- a/plugins/node/instrumentation-cucumber/package.json +++ b/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", diff --git a/plugins/node/instrumentation-dataloader/package.json b/plugins/node/instrumentation-dataloader/package.json index 5a4ef1ea76..08bdd706a7 100644 --- a/plugins/node/instrumentation-dataloader/package.json +++ b/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", diff --git a/plugins/node/instrumentation-fs/package.json b/plugins/node/instrumentation-fs/package.json index 3d41437cbb..9585a038d6 100644 --- a/plugins/node/instrumentation-fs/package.json +++ b/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", diff --git a/plugins/node/instrumentation-kafkajs/package.json b/plugins/node/instrumentation-kafkajs/package.json index 7e6ff384e1..52dffe870a 100644 --- a/plugins/node/instrumentation-kafkajs/package.json +++ b/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", diff --git a/plugins/node/instrumentation-lru-memoizer/package.json b/plugins/node/instrumentation-lru-memoizer/package.json index da739ec93e..6040807233 100644 --- a/plugins/node/instrumentation-lru-memoizer/package.json +++ b/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", diff --git a/plugins/node/instrumentation-mongoose/package.json b/plugins/node/instrumentation-mongoose/package.json index e67c4b4aa5..dc130c0c01 100644 --- a/plugins/node/instrumentation-mongoose/package.json +++ b/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", diff --git a/plugins/node/instrumentation-runtime-node/package.json b/plugins/node/instrumentation-runtime-node/package.json index 1d0759a869..dab1da13a3 100644 --- a/plugins/node/instrumentation-runtime-node/package.json +++ b/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", diff --git a/plugins/node/instrumentation-socket.io/package.json b/plugins/node/instrumentation-socket.io/package.json index 7ec6a4e6b2..78c0d886f3 100644 --- a/plugins/node/instrumentation-socket.io/package.json +++ b/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", diff --git a/plugins/node/instrumentation-tedious/package.json b/plugins/node/instrumentation-tedious/package.json index 4474df3657..82ca565cc3 100644 --- a/plugins/node/instrumentation-tedious/package.json +++ b/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", diff --git a/plugins/node/instrumentation-undici/package.json b/plugins/node/instrumentation-undici/package.json index d644222a56..90503fd16a 100644 --- a/plugins/node/instrumentation-undici/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json b/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json index 425b3860b4..dd36bec2fc 100644 --- a/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-aws-sdk/package.json b/plugins/node/opentelemetry-instrumentation-aws-sdk/package.json index 0500a453ef..b0f973354c 100644 --- a/plugins/node/opentelemetry-instrumentation-aws-sdk/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-bunyan/package.json b/plugins/node/opentelemetry-instrumentation-bunyan/package.json index e9721696df..a1f07c2fdd 100644 --- a/plugins/node/opentelemetry-instrumentation-bunyan/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-cassandra/package.json b/plugins/node/opentelemetry-instrumentation-cassandra/package.json index 73ffc747d6..f8fd12f1b4 100644 --- a/plugins/node/opentelemetry-instrumentation-cassandra/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-connect/package.json b/plugins/node/opentelemetry-instrumentation-connect/package.json index 07e97d8ced..096c7c2717 100644 --- a/plugins/node/opentelemetry-instrumentation-connect/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-dns/package.json b/plugins/node/opentelemetry-instrumentation-dns/package.json index e43d0f8a44..5549781d25 100644 --- a/plugins/node/opentelemetry-instrumentation-dns/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-express/package.json b/plugins/node/opentelemetry-instrumentation-express/package.json index 63ada7f239..489873a6d3 100644 --- a/plugins/node/opentelemetry-instrumentation-express/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-fastify/package.json b/plugins/node/opentelemetry-instrumentation-fastify/package.json index f8ab73c62d..056185aab4 100644 --- a/plugins/node/opentelemetry-instrumentation-fastify/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-generic-pool/package.json b/plugins/node/opentelemetry-instrumentation-generic-pool/package.json index 637560de0b..47178ec699 100644 --- a/plugins/node/opentelemetry-instrumentation-generic-pool/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-graphql/package.json b/plugins/node/opentelemetry-instrumentation-graphql/package.json index bdcb66cc6e..30bcec5c80 100644 --- a/plugins/node/opentelemetry-instrumentation-graphql/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-hapi/package.json b/plugins/node/opentelemetry-instrumentation-hapi/package.json index f0f454b0dc..497cedd37d 100644 --- a/plugins/node/opentelemetry-instrumentation-hapi/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-ioredis/package.json b/plugins/node/opentelemetry-instrumentation-ioredis/package.json index a8a4e57d5e..cf3760eeb6 100644 --- a/plugins/node/opentelemetry-instrumentation-ioredis/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-knex/package.json b/plugins/node/opentelemetry-instrumentation-knex/package.json index b88ab6dc6e..7705439ef1 100644 --- a/plugins/node/opentelemetry-instrumentation-knex/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-koa/package.json b/plugins/node/opentelemetry-instrumentation-koa/package.json index e9bf3f472e..bd5f6c13f1 100644 --- a/plugins/node/opentelemetry-instrumentation-koa/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-memcached/package.json b/plugins/node/opentelemetry-instrumentation-memcached/package.json index bf47bf5d4a..7f07d8249e 100644 --- a/plugins/node/opentelemetry-instrumentation-memcached/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/package.json b/plugins/node/opentelemetry-instrumentation-mongodb/package.json index a0e9f36e85..6c78e98aa8 100644 --- a/plugins/node/opentelemetry-instrumentation-mongodb/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-mysql/package.json b/plugins/node/opentelemetry-instrumentation-mysql/package.json index 7c8a6bec9e..f15ee457c2 100644 --- a/plugins/node/opentelemetry-instrumentation-mysql/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-mysql2/package.json b/plugins/node/opentelemetry-instrumentation-mysql2/package.json index 7ae9310af3..4c046988bd 100644 --- a/plugins/node/opentelemetry-instrumentation-mysql2/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-nestjs-core/package.json b/plugins/node/opentelemetry-instrumentation-nestjs-core/package.json index cf31974c6b..444581907f 100644 --- a/plugins/node/opentelemetry-instrumentation-nestjs-core/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-net/package.json b/plugins/node/opentelemetry-instrumentation-net/package.json index b109a1c7c9..aa8a79ae53 100644 --- a/plugins/node/opentelemetry-instrumentation-net/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-pg/package.json b/plugins/node/opentelemetry-instrumentation-pg/package.json index d12a2348e5..18c0de2ca1 100644 --- a/plugins/node/opentelemetry-instrumentation-pg/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-pino/package.json b/plugins/node/opentelemetry-instrumentation-pino/package.json index 7cf0afeec6..49b263b9ca 100644 --- a/plugins/node/opentelemetry-instrumentation-pino/package.json +++ b/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", diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/package.json b/plugins/node/opentelemetry-instrumentation-redis-4/package.json index 23d061c895..8aa653b1af 100644 --- a/plugins/node/opentelemetry-instrumentation-redis-4/package.json +++ b/plugins/node/opentelemetry-instrumentation-redis-4/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/instrumentation-redis-4", "version": "0.39.0", - "description": "Automatic OpenTelemetry instrumentation for redis package version 4", + "description": "OpenTelemetry instrumentation for `redis` v4 database client for Redis", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js-contrib", diff --git a/plugins/node/opentelemetry-instrumentation-redis/package.json b/plugins/node/opentelemetry-instrumentation-redis/package.json index 4515a23f3d..89560460e9 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/package.json +++ b/plugins/node/opentelemetry-instrumentation-redis/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/instrumentation-redis", "version": "0.39.1", - "description": "Automatic OpenTelemetry instrumentation for redis package version 2 and 3", + "description": "OpenTelemetry instrumentation for `redis` v2 and v3 database client for Redis", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js-contrib", diff --git a/plugins/node/opentelemetry-instrumentation-restify/package.json b/plugins/node/opentelemetry-instrumentation-restify/package.json index 1113783ecc..54b5f1ec7a 100644 --- a/plugins/node/opentelemetry-instrumentation-restify/package.json +++ b/plugins/node/opentelemetry-instrumentation-restify/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/instrumentation-restify", "version": "0.38.0", - "description": "OpenTelemetry restify automatic instrumentation package", + "description": "OpenTelemetry instrumentation for `restify` http web application framework", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js-contrib", diff --git a/plugins/node/opentelemetry-instrumentation-router/package.json b/plugins/node/opentelemetry-instrumentation-router/package.json index 7ea1a851e9..d9b5c2e621 100644 --- a/plugins/node/opentelemetry-instrumentation-router/package.json +++ b/plugins/node/opentelemetry-instrumentation-router/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/instrumentation-router", "version": "0.37.0", - "description": "OpenTelemetry Router automatic instrumentation package", + "description": "OpenTelemetry instrumentation for `router` http middleware router", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js-contrib", diff --git a/plugins/node/opentelemetry-instrumentation-winston/package.json b/plugins/node/opentelemetry-instrumentation-winston/package.json index ecfd90546c..54d31f1d8c 100644 --- a/plugins/node/opentelemetry-instrumentation-winston/package.json +++ b/plugins/node/opentelemetry-instrumentation-winston/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/instrumentation-winston", "version": "0.37.0", - "description": "OpenTelemetry instrumentation for winston", + "description": "OpenTelemetry instrumentation for `winston` logger", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js-contrib", diff --git a/plugins/web/opentelemetry-instrumentation-document-load/package.json b/plugins/web/opentelemetry-instrumentation-document-load/package.json index f849a1de3d..18c9a8cdda 100644 --- a/plugins/web/opentelemetry-instrumentation-document-load/package.json +++ b/plugins/web/opentelemetry-instrumentation-document-load/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/instrumentation-document-load", "version": "0.38.0", - "description": "OpenTelemetry document-load automatic instrumentation package.", + "description": "OpenTelemetry instrumentation for document load operations in browser applications", "main": "build/src/index.js", "module": "build/esm/index.js", "esnext": "build/esnext/index.js", diff --git a/plugins/web/opentelemetry-instrumentation-long-task/package.json b/plugins/web/opentelemetry-instrumentation-long-task/package.json index 8e74d81397..1ec090c37c 100644 --- a/plugins/web/opentelemetry-instrumentation-long-task/package.json +++ b/plugins/web/opentelemetry-instrumentation-long-task/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/instrumentation-long-task", "version": "0.38.0", - "description": "OpenTelemetry long task API automatic instrumentation package.", + "description": "OpenTelemetry instrumentation for long task Web API", "main": "build/src/index.js", "module": "build/esm/index.js", "esnext": "build/esnext/index.js", diff --git a/plugins/web/opentelemetry-instrumentation-user-interaction/package.json b/plugins/web/opentelemetry-instrumentation-user-interaction/package.json index d51c3877ea..46268e890c 100644 --- a/plugins/web/opentelemetry-instrumentation-user-interaction/package.json +++ b/plugins/web/opentelemetry-instrumentation-user-interaction/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/instrumentation-user-interaction", "version": "0.38.0", - "description": "OpenTelemetry UserInteraction automatic instrumentation package.", + "description": "OpenTelemetry instrumentation for user interactions as click events in a web application", "main": "build/src/index.js", "module": "build/esm/index.js", "esnext": "build/esnext/index.js", diff --git a/plugins/web/opentelemetry-plugin-react-load/package.json b/plugins/web/opentelemetry-plugin-react-load/package.json index 17da70c813..c1a8de2382 100644 --- a/plugins/web/opentelemetry-plugin-react-load/package.json +++ b/plugins/web/opentelemetry-plugin-react-load/package.json @@ -1,7 +1,7 @@ { "name": "@opentelemetry/plugin-react-load", "version": "0.30.1", - "description": "OpenTelemetry React loading automatic instrumentation package.", + "description": "OpenTelemetry instrumentation for React class component lifecycle methods", "main": "build/src/index.js", "module": "build/esm/index.js", "esnext": "build/esnext/index.js", From 4a6403979417e5c6bddef98b77b7647c56e63876 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Fri, 17 May 2024 21:19:31 -0700 Subject: [PATCH 2/4] docs: fix a typo (#2222) --- .../node/opentelemetry-resource-detector-github/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/detectors/node/opentelemetry-resource-detector-github/README.md b/detectors/node/opentelemetry-resource-detector-github/README.md index 31cdf85839..5bab37dacb 100644 --- a/detectors/node/opentelemetry-resource-detector-github/README.md +++ b/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 From aabd6aae5015ba61f6bb9578b67c5ea8c4b50f66 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Fri, 17 May 2024 21:20:44 -0700 Subject: [PATCH 3/4] chore: fix some package dirs in component_owners metadata (#2221) --- .github/component_owners.yml | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/component_owners.yml b/.github/component_owners.yml index 0565ca3edf..065b03703b 100644 --- a/.github/component_owners.yml +++ b/.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 @@ -113,7 +113,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 +128,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 +143,6 @@ components: - obecny plugins/web/opentelemetry-plugin-react-load: - martinkuba - propagators/opentelemetry-propagator-grpc-census-binary: [] - # Unmaintained? propagators/opentelemetry-propagator-instana: - basti1302 - kirrg001 From 5ecab2cf903fe56ab83ee7f43bd5b0d4bbaa4ba1 Mon Sep 17 00:00:00 2001 From: Marylia Gutierrez Date: Sat, 18 May 2024 02:15:38 -0400 Subject: [PATCH 4/4] docs(detector-alibaba): add details about semantic conventions (#2130) * docs(detector-alibaba): add details about semantic conventions Add details about semantic conventions verion used. * remove sem conv from title --------- Co-authored-by: Amir Blum --- .../opentelemetry-resource-detector-alibaba-cloud/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md b/detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md index a8e8c40882..687558b444 100644 --- a/detectors/node/opentelemetry-resource-detector-alibaba-cloud/README.md +++ b/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).