diff --git a/.github/component-label-map.yml b/.github/component-label-map.yml index d5d893aae2..66e0743da3 100644 --- a/.github/component-label-map.yml +++ b/.github/component-label-map.yml @@ -210,12 +210,6 @@ pkg:instrumentation-redis: - plugins/node/opentelemetry-instrumentation-redis/** - packages/opentelemetry-test-utils/** - packages/opentelemetry-redis-common/** -pkg:instrumentation-redis-4: - - changed-files: - - any-glob-to-any-file: - - plugins/node/opentelemetry-instrumentation-redis-4/** - - packages/opentelemetry-test-utils/** - - packages/opentelemetry-redis-common/** pkg:instrumentation-restify: - changed-files: - any-glob-to-any-file: diff --git a/.github/component_owners.yml b/.github/component_owners.yml index e21c924fef..24dfd4ff9b 100644 --- a/.github/component_owners.yml +++ b/.github/component_owners.yml @@ -132,8 +132,6 @@ components: - maryliag plugins/node/opentelemetry-instrumentation-pino: - seemk - plugins/node/opentelemetry-instrumentation-redis-4: - - blumamir plugins/node/opentelemetry-instrumentation-redis: - blumamir plugins/node/opentelemetry-instrumentation-restify: [] diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 4c811c3413..6c664982a6 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -54,7 +54,6 @@ "plugins/node/opentelemetry-instrumentation-pg": "0.54.0", "plugins/node/opentelemetry-instrumentation-pino": "0.49.0", "plugins/node/opentelemetry-instrumentation-redis": "0.49.1", - "plugins/node/opentelemetry-instrumentation-redis-4": "0.49.0", "plugins/node/opentelemetry-instrumentation-restify": "0.48.1", "plugins/node/opentelemetry-instrumentation-router": "0.47.0", "plugins/node/opentelemetry-instrumentation-winston": "0.47.0", diff --git a/metapackages/auto-instrumentations-node/package.json b/metapackages/auto-instrumentations-node/package.json index f13f47b463..abd48457e4 100644 --- a/metapackages/auto-instrumentations-node/package.json +++ b/metapackages/auto-instrumentations-node/package.json @@ -82,7 +82,6 @@ "@opentelemetry/instrumentation-pg": "^0.54.0", "@opentelemetry/instrumentation-pino": "^0.49.0", "@opentelemetry/instrumentation-redis": "^0.49.1", - "@opentelemetry/instrumentation-redis-4": "^0.49.0", "@opentelemetry/instrumentation-restify": "^0.48.1", "@opentelemetry/instrumentation-router": "^0.47.0", "@opentelemetry/instrumentation-runtime-node": "^0.16.0", diff --git a/metapackages/auto-instrumentations-node/src/utils.ts b/metapackages/auto-instrumentations-node/src/utils.ts index 82d552695a..eea8d06869 100644 --- a/metapackages/auto-instrumentations-node/src/utils.ts +++ b/metapackages/auto-instrumentations-node/src/utils.ts @@ -49,8 +49,7 @@ import { NetInstrumentation } from '@opentelemetry/instrumentation-net'; import { OracleInstrumentation } from '@opentelemetry/instrumentation-oracledb'; import { PgInstrumentation } from '@opentelemetry/instrumentation-pg'; import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino'; -import { RedisInstrumentation as RedisInstrumentationV2 } from '@opentelemetry/instrumentation-redis'; -import { RedisInstrumentation as RedisInstrumentationV4 } from '@opentelemetry/instrumentation-redis-4'; +import { RedisInstrumentation } from '@opentelemetry/instrumentation-redis'; import { RestifyInstrumentation } from '@opentelemetry/instrumentation-restify'; import { RouterInstrumentation } from '@opentelemetry/instrumentation-router'; import { RuntimeNodeInstrumentation } from '@opentelemetry/instrumentation-runtime-node'; @@ -128,8 +127,7 @@ const InstrumentationMap = { '@opentelemetry/instrumentation-oracledb': OracleInstrumentation, '@opentelemetry/instrumentation-pg': PgInstrumentation, '@opentelemetry/instrumentation-pino': PinoInstrumentation, - '@opentelemetry/instrumentation-redis': RedisInstrumentationV2, - '@opentelemetry/instrumentation-redis-4': RedisInstrumentationV4, + '@opentelemetry/instrumentation-redis': RedisInstrumentation, '@opentelemetry/instrumentation-restify': RestifyInstrumentation, '@opentelemetry/instrumentation-router': RouterInstrumentation, '@opentelemetry/instrumentation-runtime-node': RuntimeNodeInstrumentation, diff --git a/package-lock.json b/package-lock.json index 32016c260b..72da5233c0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -309,7 +309,6 @@ "@opentelemetry/instrumentation-pg": "^0.54.0", "@opentelemetry/instrumentation-pino": "^0.49.0", "@opentelemetry/instrumentation-redis": "^0.49.1", - "@opentelemetry/instrumentation-redis-4": "^0.49.0", "@opentelemetry/instrumentation-restify": "^0.48.1", "@opentelemetry/instrumentation-router": "^0.47.0", "@opentelemetry/instrumentation-runtime-node": "^0.16.0", @@ -8218,10 +8217,6 @@ "resolved": "plugins/node/opentelemetry-instrumentation-redis", "link": true }, - "node_modules/@opentelemetry/instrumentation-redis-4": { - "resolved": "plugins/node/opentelemetry-instrumentation-redis-4", - "link": true - }, "node_modules/@opentelemetry/instrumentation-restify": { "resolved": "plugins/node/opentelemetry-instrumentation-restify", "link": true @@ -8683,71 +8678,6 @@ "streamx": "^2.15.0" } }, - "node_modules/@redis/bloom": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@redis/bloom/-/bloom-1.0.2.tgz", - "integrity": "sha512-EBw7Ag1hPgFzdznK2PBblc1kdlj5B5Cw3XwI9/oG7tSn85/HKy3X9xHy/8tm/eNXJYHLXHJL/pkwBpFMVVefkw==", - "dev": true, - "peerDependencies": { - "@redis/client": "^1.0.0" - } - }, - "node_modules/@redis/client": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@redis/client/-/client-1.1.0.tgz", - "integrity": "sha512-xO9JDIgzsZYDl3EvFhl6LC52DP3q3GCMUer8zHgKV6qSYsq1zB+pZs9+T80VgcRogrlRYhi4ZlfX6A+bHiBAgA==", - "dev": true, - "dependencies": { - "cluster-key-slot": "1.1.0", - "generic-pool": "3.8.2", - "yallist": "4.0.0" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/@redis/client/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true - }, - "node_modules/@redis/graph": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@redis/graph/-/graph-1.0.1.tgz", - "integrity": "sha512-oDE4myMCJOCVKYMygEMWuriBgqlS5FqdWerikMoJxzmmTUErnTRRgmIDa2VcgytACZMFqpAOWDzops4DOlnkfQ==", - "dev": true, - "peerDependencies": { - "@redis/client": "^1.0.0" - } - }, - "node_modules/@redis/json": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@redis/json/-/json-1.0.3.tgz", - "integrity": "sha512-4X0Qv0BzD9Zlb0edkUoau5c1bInWSICqXAGrpwEltkncUwcxJIGEcVryZhLgb0p/3PkKaLIWkjhHRtLe9yiA7Q==", - "dev": true, - "peerDependencies": { - "@redis/client": "^1.0.0" - } - }, - "node_modules/@redis/search": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/@redis/search/-/search-1.0.6.tgz", - "integrity": "sha512-pP+ZQRis5P21SD6fjyCeLcQdps+LuTzp2wdUbzxEmNhleighDDTD5ck8+cYof+WLec4csZX7ks+BuoMw0RaZrA==", - "dev": true, - "peerDependencies": { - "@redis/client": "^1.0.0" - } - }, - "node_modules/@redis/time-series": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@redis/time-series/-/time-series-1.0.3.tgz", - "integrity": "sha512-OFp0q4SGrTH0Mruf6oFsHGea58u8vS/iI5+NpYdicaM+7BgqBZH8FFvNZ8rYYLrUO/QRqMq72NpXmxLVNcdmjA==", - "dev": true, - "peerDependencies": { - "@redis/client": "^1.0.0" - } - }, "node_modules/@rollup/plugin-commonjs": { "version": "26.0.3", "resolved": "https://registry.npmjs.org/@rollup/plugin-commonjs/-/plugin-commonjs-26.0.3.tgz", @@ -10712,15 +10642,6 @@ "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", "dev": true }, - "node_modules/@types/redis": { - "version": "2.8.32", - "resolved": "https://registry.npmjs.org/@types/redis/-/redis-2.8.32.tgz", - "integrity": "sha512-7jkMKxcGq9p242exlbsVzuJb57KqHRhNl4dHoQu2Y5v9bCAbtIXXH0R3HleSQW4CTOqpHIYUW3t6tpUj4BVQ+w==", - "dev": true, - "dependencies": { - "@types/node": "*" - } - }, "node_modules/@types/resolve": { "version": "1.20.2", "resolved": "https://registry.npmjs.org/@types/resolve/-/resolve-1.20.2.tgz", @@ -26663,30 +26584,23 @@ } }, "node_modules/redis": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/redis/-/redis-3.1.2.tgz", - "integrity": "sha512-grn5KoZLr/qrRQVwoSkmzdbw6pwF+/rwODtrOr6vuBRiR/f3rjSTGupbF90Zpqm2oenix8Do6RV7pYEkGwlKkw==", + "version": "4.7.1", + "resolved": "https://registry.npmjs.org/redis/-/redis-4.7.1.tgz", + "integrity": "sha512-S1bJDnqLftzHXHP8JsT5II/CtHWQrASX5K96REjWjlmWKrviSOLWmM7QnRLstAWsu1VBBV1ffV6DzCvxNP0UJQ==", "dev": true, + "license": "MIT", + "workspaces": [ + "./packages/*" + ], "dependencies": { - "denque": "^1.5.0", - "redis-commands": "^1.7.0", - "redis-errors": "^1.2.0", - "redis-parser": "^3.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/node-redis" + "@redis/bloom": "1.2.0", + "@redis/client": "1.6.1", + "@redis/graph": "1.1.1", + "@redis/json": "1.0.7", + "@redis/search": "1.2.0", + "@redis/time-series": "1.1.0" } }, - "node_modules/redis-commands": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/redis-commands/-/redis-commands-1.7.0.tgz", - "integrity": "sha512-nJWqw3bTFy21hX/CPKHth6sfhZbdiHP6bTawSgQBlKOVRG7EZkfHbbHwQJnrE4vsQf0CMNE+3gJ4Fmm16vdVlQ==", - "dev": true - }, "node_modules/redis-errors": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/redis-errors/-/redis-errors-1.2.0.tgz", @@ -26708,15 +26622,98 @@ "node": ">=4" } }, - "node_modules/redis/node_modules/denque": { - "version": "1.5.1", - "resolved": "https://registry.npmjs.org/denque/-/denque-1.5.1.tgz", - "integrity": "sha512-XwE+iZ4D6ZUB7mfYRMb5wByE8L74HCn30FBN7sWnXksWc1LO1bPDl67pBR9o/kC4z/xSNAwkMYcGgqDV3BE3Hw==", + "node_modules/redis/node_modules/@redis/bloom": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@redis/bloom/-/bloom-1.2.0.tgz", + "integrity": "sha512-HG2DFjYKbpNmVXsa0keLHp/3leGJz1mjh09f2RLGGLQZzSHpkmZWuwJbAvo3QcRY8p80m5+ZdXZdYOSBLlp7Cg==", "dev": true, + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" + } + }, + "node_modules/redis/node_modules/@redis/client": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/@redis/client/-/client-1.6.1.tgz", + "integrity": "sha512-/KCsg3xSlR+nCK8/8ZYSknYxvXHwubJrU82F3Lm1Fp6789VQ0/3RJKfsmRXjqfaTA++23CvC3hqmqe/2GEt6Kw==", + "dev": true, + "license": "MIT", + "dependencies": { + "cluster-key-slot": "1.1.2", + "generic-pool": "3.9.0", + "yallist": "4.0.0" + }, "engines": { - "node": ">=0.10" + "node": ">=14" + } + }, + "node_modules/redis/node_modules/@redis/graph": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@redis/graph/-/graph-1.1.1.tgz", + "integrity": "sha512-FEMTcTHZozZciLRl6GiiIB4zGm5z5F3F6a6FZCyrfxdKOhFlGkiAqlexWMBzCi4DcRoyiOsuLfW+cjlGWyExOw==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" } }, + "node_modules/redis/node_modules/@redis/json": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/@redis/json/-/json-1.0.7.tgz", + "integrity": "sha512-6UyXfjVaTBTJtKNG4/9Z8PSpKE6XgSyEb8iwaqDcy+uKrd/DGYHTWkUdnQDyzm727V7p21WUMhsqz5oy65kPcQ==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" + } + }, + "node_modules/redis/node_modules/@redis/search": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@redis/search/-/search-1.2.0.tgz", + "integrity": "sha512-tYoDBbtqOVigEDMAcTGsRlMycIIjwMCgD8eR2t0NANeQmgK/lvxNAvYyb6bZDD4frHRhIHkJu2TBRvB0ERkOmw==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" + } + }, + "node_modules/redis/node_modules/@redis/time-series": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@redis/time-series/-/time-series-1.1.0.tgz", + "integrity": "sha512-c1Q99M5ljsIuc4YdaCwfUEXsofakb9c8+Zse2qxTadu8TalLXuAESzLvFAvNVbkmSlvlzIQOLpBCmWI9wTOt+g==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "@redis/client": "^1.0.0" + } + }, + "node_modules/redis/node_modules/cluster-key-slot": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/cluster-key-slot/-/cluster-key-slot-1.1.2.tgz", + "integrity": "sha512-RMr0FhtfXemyinomL4hrWcYJxmX6deFdCxpJzhDttxgO1+bcCnkk+9drydLVDmAMG7NE6aN/fl4F7ucU/90gAA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/redis/node_modules/generic-pool": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/generic-pool/-/generic-pool-3.9.0.tgz", + "integrity": "sha512-hymDOu5B53XvN4QT9dBmZxPX4CWhBPPLguTZ9MMFeFa/Kg0xWVfylOVNlJji/E7yTZWFd/q9GO5TxDLq156D7g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/redis/node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true, + "license": "ISC" + }, "node_modules/reflect-metadata": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.2.tgz", @@ -33777,42 +33774,9 @@ "@opentelemetry/sdk-trace-node": "^2.0.0", "@types/mocha": "10.0.10", "@types/node": "18.18.14", - "@types/redis": "2.8.32", - "cross-env": "7.0.3", - "nyc": "17.1.0", - "redis": "3.1.2", - "rimraf": "5.0.10", - "test-all-versions": "6.1.0", - "typescript": "5.0.4" - }, - "engines": { - "node": "^18.19.0 || >=20.6.0" - }, - "peerDependencies": { - "@opentelemetry/api": "^1.3.0" - } - }, - "plugins/node/opentelemetry-instrumentation-redis-4": { - "name": "@opentelemetry/instrumentation-redis-4", - "version": "0.49.0", - "license": "Apache-2.0", - "dependencies": { - "@opentelemetry/instrumentation": "^0.202.0", - "@opentelemetry/redis-common": "^0.37.0", - "@opentelemetry/semantic-conventions": "^1.27.0" - }, - "devDependencies": { - "@opentelemetry/api": "^1.3.0", - "@opentelemetry/context-async-hooks": "^2.0.0", - "@opentelemetry/contrib-test-utils": "^0.48.0", - "@opentelemetry/core": "^2.0.0", - "@opentelemetry/sdk-trace-base": "^2.0.0", - "@opentelemetry/sdk-trace-node": "^2.0.0", - "@types/mocha": "10.0.10", - "@types/node": "18.18.14", "cross-env": "7.0.3", "nyc": "17.1.0", - "redis": "4.1.0", + "redis": "^4.7.1", "rimraf": "5.0.10", "test-all-versions": "6.1.0", "typescript": "5.0.4" @@ -33824,20 +33788,6 @@ "@opentelemetry/api": "^1.3.0" } }, - "plugins/node/opentelemetry-instrumentation-redis-4/node_modules/redis": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/redis/-/redis-4.1.0.tgz", - "integrity": "sha512-5hvJ8wbzpCCiuN1ges6tx2SAh2XXCY0ayresBmu40/SGusWHFW86TAlIPpbimMX2DFHOX7RN34G2XlPA1Z43zg==", - "dev": true, - "dependencies": { - "@redis/bloom": "1.0.2", - "@redis/client": "1.1.0", - "@redis/graph": "1.0.1", - "@redis/json": "1.0.3", - "@redis/search": "1.0.6", - "@redis/time-series": "1.0.3" - } - }, "plugins/node/opentelemetry-instrumentation-restify": { "name": "@opentelemetry/instrumentation-restify", "version": "0.48.1", @@ -39915,7 +39865,6 @@ "@opentelemetry/instrumentation-pg": "^0.54.0", "@opentelemetry/instrumentation-pino": "^0.49.0", "@opentelemetry/instrumentation-redis": "^0.49.1", - "@opentelemetry/instrumentation-redis-4": "^0.49.0", "@opentelemetry/instrumentation-restify": "^0.48.1", "@opentelemetry/instrumentation-router": "^0.47.0", "@opentelemetry/instrumentation-runtime-node": "^0.16.0", @@ -41172,53 +41121,14 @@ "@opentelemetry/semantic-conventions": "^1.27.0", "@types/mocha": "10.0.10", "@types/node": "18.18.14", - "@types/redis": "2.8.32", "cross-env": "7.0.3", "nyc": "17.1.0", - "redis": "3.1.2", + "redis": "^4.7.1", "rimraf": "5.0.10", "test-all-versions": "6.1.0", "typescript": "5.0.4" } }, - "@opentelemetry/instrumentation-redis-4": { - "version": "file:plugins/node/opentelemetry-instrumentation-redis-4", - "requires": { - "@opentelemetry/api": "^1.3.0", - "@opentelemetry/context-async-hooks": "^2.0.0", - "@opentelemetry/contrib-test-utils": "^0.48.0", - "@opentelemetry/core": "^2.0.0", - "@opentelemetry/instrumentation": "^0.202.0", - "@opentelemetry/redis-common": "^0.37.0", - "@opentelemetry/sdk-trace-base": "^2.0.0", - "@opentelemetry/sdk-trace-node": "^2.0.0", - "@opentelemetry/semantic-conventions": "^1.27.0", - "@types/mocha": "10.0.10", - "@types/node": "18.18.14", - "cross-env": "7.0.3", - "nyc": "17.1.0", - "redis": "4.1.0", - "rimraf": "5.0.10", - "test-all-versions": "6.1.0", - "typescript": "5.0.4" - }, - "dependencies": { - "redis": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/redis/-/redis-4.1.0.tgz", - "integrity": "sha512-5hvJ8wbzpCCiuN1ges6tx2SAh2XXCY0ayresBmu40/SGusWHFW86TAlIPpbimMX2DFHOX7RN34G2XlPA1Z43zg==", - "dev": true, - "requires": { - "@redis/bloom": "1.0.2", - "@redis/client": "1.1.0", - "@redis/graph": "1.0.1", - "@redis/json": "1.0.3", - "@redis/search": "1.0.6", - "@redis/time-series": "1.0.3" - } - } - } - }, "@opentelemetry/instrumentation-restify": { "version": "file:plugins/node/opentelemetry-instrumentation-restify", "requires": { @@ -42526,60 +42436,6 @@ } } }, - "@redis/bloom": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@redis/bloom/-/bloom-1.0.2.tgz", - "integrity": "sha512-EBw7Ag1hPgFzdznK2PBblc1kdlj5B5Cw3XwI9/oG7tSn85/HKy3X9xHy/8tm/eNXJYHLXHJL/pkwBpFMVVefkw==", - "dev": true, - "requires": {} - }, - "@redis/client": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@redis/client/-/client-1.1.0.tgz", - "integrity": "sha512-xO9JDIgzsZYDl3EvFhl6LC52DP3q3GCMUer8zHgKV6qSYsq1zB+pZs9+T80VgcRogrlRYhi4ZlfX6A+bHiBAgA==", - "dev": true, - "requires": { - "cluster-key-slot": "1.1.0", - "generic-pool": "3.8.2", - "yallist": "4.0.0" - }, - "dependencies": { - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true - } - } - }, - "@redis/graph": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@redis/graph/-/graph-1.0.1.tgz", - "integrity": "sha512-oDE4myMCJOCVKYMygEMWuriBgqlS5FqdWerikMoJxzmmTUErnTRRgmIDa2VcgytACZMFqpAOWDzops4DOlnkfQ==", - "dev": true, - "requires": {} - }, - "@redis/json": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@redis/json/-/json-1.0.3.tgz", - "integrity": "sha512-4X0Qv0BzD9Zlb0edkUoau5c1bInWSICqXAGrpwEltkncUwcxJIGEcVryZhLgb0p/3PkKaLIWkjhHRtLe9yiA7Q==", - "dev": true, - "requires": {} - }, - "@redis/search": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/@redis/search/-/search-1.0.6.tgz", - "integrity": "sha512-pP+ZQRis5P21SD6fjyCeLcQdps+LuTzp2wdUbzxEmNhleighDDTD5ck8+cYof+WLec4csZX7ks+BuoMw0RaZrA==", - "dev": true, - "requires": {} - }, - "@redis/time-series": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@redis/time-series/-/time-series-1.0.3.tgz", - "integrity": "sha512-OFp0q4SGrTH0Mruf6oFsHGea58u8vS/iI5+NpYdicaM+7BgqBZH8FFvNZ8rYYLrUO/QRqMq72NpXmxLVNcdmjA==", - "dev": true, - "requires": {} - }, "@rollup/plugin-commonjs": { "version": "26.0.3", "resolved": "https://registry.npmjs.org/@rollup/plugin-commonjs/-/plugin-commonjs-26.0.3.tgz", @@ -44158,15 +44014,6 @@ } } }, - "@types/redis": { - "version": "2.8.32", - "resolved": "https://registry.npmjs.org/@types/redis/-/redis-2.8.32.tgz", - "integrity": "sha512-7jkMKxcGq9p242exlbsVzuJb57KqHRhNl4dHoQu2Y5v9bCAbtIXXH0R3HleSQW4CTOqpHIYUW3t6tpUj4BVQ+w==", - "dev": true, - "requires": { - "@types/node": "*" - } - }, "@types/resolve": { "version": "1.20.2", "resolved": "https://registry.npmjs.org/@types/resolve/-/resolve-1.20.2.tgz", @@ -56371,31 +56218,85 @@ } }, "redis": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/redis/-/redis-3.1.2.tgz", - "integrity": "sha512-grn5KoZLr/qrRQVwoSkmzdbw6pwF+/rwODtrOr6vuBRiR/f3rjSTGupbF90Zpqm2oenix8Do6RV7pYEkGwlKkw==", + "version": "4.7.1", + "resolved": "https://registry.npmjs.org/redis/-/redis-4.7.1.tgz", + "integrity": "sha512-S1bJDnqLftzHXHP8JsT5II/CtHWQrASX5K96REjWjlmWKrviSOLWmM7QnRLstAWsu1VBBV1ffV6DzCvxNP0UJQ==", "dev": true, "requires": { - "denque": "^1.5.0", - "redis-commands": "^1.7.0", - "redis-errors": "^1.2.0", - "redis-parser": "^3.0.0" + "@redis/bloom": "1.2.0", + "@redis/client": "1.6.1", + "@redis/graph": "1.1.1", + "@redis/json": "1.0.7", + "@redis/search": "1.2.0", + "@redis/time-series": "1.1.0" }, "dependencies": { - "denque": { - "version": "1.5.1", - "resolved": "https://registry.npmjs.org/denque/-/denque-1.5.1.tgz", - "integrity": "sha512-XwE+iZ4D6ZUB7mfYRMb5wByE8L74HCn30FBN7sWnXksWc1LO1bPDl67pBR9o/kC4z/xSNAwkMYcGgqDV3BE3Hw==", + "@redis/bloom": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@redis/bloom/-/bloom-1.2.0.tgz", + "integrity": "sha512-HG2DFjYKbpNmVXsa0keLHp/3leGJz1mjh09f2RLGGLQZzSHpkmZWuwJbAvo3QcRY8p80m5+ZdXZdYOSBLlp7Cg==", + "dev": true, + "requires": {} + }, + "@redis/client": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/@redis/client/-/client-1.6.1.tgz", + "integrity": "sha512-/KCsg3xSlR+nCK8/8ZYSknYxvXHwubJrU82F3Lm1Fp6789VQ0/3RJKfsmRXjqfaTA++23CvC3hqmqe/2GEt6Kw==", + "dev": true, + "requires": { + "cluster-key-slot": "1.1.2", + "generic-pool": "3.9.0", + "yallist": "4.0.0" + } + }, + "@redis/graph": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@redis/graph/-/graph-1.1.1.tgz", + "integrity": "sha512-FEMTcTHZozZciLRl6GiiIB4zGm5z5F3F6a6FZCyrfxdKOhFlGkiAqlexWMBzCi4DcRoyiOsuLfW+cjlGWyExOw==", + "dev": true, + "requires": {} + }, + "@redis/json": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/@redis/json/-/json-1.0.7.tgz", + "integrity": "sha512-6UyXfjVaTBTJtKNG4/9Z8PSpKE6XgSyEb8iwaqDcy+uKrd/DGYHTWkUdnQDyzm727V7p21WUMhsqz5oy65kPcQ==", + "dev": true, + "requires": {} + }, + "@redis/search": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@redis/search/-/search-1.2.0.tgz", + "integrity": "sha512-tYoDBbtqOVigEDMAcTGsRlMycIIjwMCgD8eR2t0NANeQmgK/lvxNAvYyb6bZDD4frHRhIHkJu2TBRvB0ERkOmw==", + "dev": true, + "requires": {} + }, + "@redis/time-series": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@redis/time-series/-/time-series-1.1.0.tgz", + "integrity": "sha512-c1Q99M5ljsIuc4YdaCwfUEXsofakb9c8+Zse2qxTadu8TalLXuAESzLvFAvNVbkmSlvlzIQOLpBCmWI9wTOt+g==", + "dev": true, + "requires": {} + }, + "cluster-key-slot": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/cluster-key-slot/-/cluster-key-slot-1.1.2.tgz", + "integrity": "sha512-RMr0FhtfXemyinomL4hrWcYJxmX6deFdCxpJzhDttxgO1+bcCnkk+9drydLVDmAMG7NE6aN/fl4F7ucU/90gAA==", + "dev": true + }, + "generic-pool": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/generic-pool/-/generic-pool-3.9.0.tgz", + "integrity": "sha512-hymDOu5B53XvN4QT9dBmZxPX4CWhBPPLguTZ9MMFeFa/Kg0xWVfylOVNlJji/E7yTZWFd/q9GO5TxDLq156D7g==", + "dev": true + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", "dev": true } } }, - "redis-commands": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/redis-commands/-/redis-commands-1.7.0.tgz", - "integrity": "sha512-nJWqw3bTFy21hX/CPKHth6sfhZbdiHP6bTawSgQBlKOVRG7EZkfHbbHwQJnrE4vsQf0CMNE+3gJ4Fmm16vdVlQ==", - "dev": true - }, "redis-errors": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/redis-errors/-/redis-errors-1.2.0.tgz", diff --git a/packages/opentelemetry-redis-common/README.md b/packages/opentelemetry-redis-common/README.md index bb8de2d704..95ba85ac60 100644 --- a/packages/opentelemetry-redis-common/README.md +++ b/packages/opentelemetry-redis-common/README.md @@ -4,4 +4,3 @@ This is an internal utils package used for the different redis instrumentations: 1. ioredis 2. redis -3. redis-4 diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/.eslintignore b/plugins/node/opentelemetry-instrumentation-redis-4/.eslintignore deleted file mode 100644 index 378eac25d3..0000000000 --- a/plugins/node/opentelemetry-instrumentation-redis-4/.eslintignore +++ /dev/null @@ -1 +0,0 @@ -build diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-redis-4/.eslintrc.js deleted file mode 100644 index f756f4488b..0000000000 --- a/plugins/node/opentelemetry-instrumentation-redis-4/.eslintrc.js +++ /dev/null @@ -1,7 +0,0 @@ -module.exports = { - "env": { - "mocha": true, - "node": true - }, - ...require('../../../eslint.config.js') -} diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/.tav.yml b/plugins/node/opentelemetry-instrumentation-redis-4/.tav.yml deleted file mode 100644 index 8890082e4c..0000000000 --- a/plugins/node/opentelemetry-instrumentation-redis-4/.tav.yml +++ /dev/null @@ -1,7 +0,0 @@ -redis: - versions: - include: "^4.0.0" - # "4.6.9" was a bad release that accidentally broke node v14 support. - exclude: "4.6.9" - mode: latest-minors - commands: npm run test diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/CHANGELOG.md b/plugins/node/opentelemetry-instrumentation-redis-4/CHANGELOG.md deleted file mode 100644 index d9ad35a265..0000000000 --- a/plugins/node/opentelemetry-instrumentation-redis-4/CHANGELOG.md +++ /dev/null @@ -1,479 +0,0 @@ -# Changelog - -## [0.49.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.48.0...instrumentation-redis-4-v0.49.0) (2025-06-02) - - -### Features - -* **deps:** update deps matching '@opentelemetry/*' ([#2871](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2871)) ([d33c6f2](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/d33c6f232a3c5673e618fa62692d2d3bbfe4c0fc)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.47.0 to ^0.48.0 - -## [0.48.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.47.0...instrumentation-redis-4-v0.48.0) (2025-05-15) - - -### Features - -* **deps:** update deps matching '@opentelemetry/*' ([#2828](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2828)) ([59c2a4c](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/59c2a4c002992518da2d91b4ceb24f8479ad2346)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.46.0 to ^0.47.0 - -## [0.47.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.46.1...instrumentation-redis-4-v0.47.0) (2025-03-18) - - -### ⚠ BREAKING CHANGES - -* chore!: Update to 2.x and 0.200.x @opentelemetry/* packages from opentelemetry-js.git per [2.x upgrade guide](https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/upgrade-to-2.x.md) - * The minimum supported Node.js has been raised to ^18.19.0 || >=20.6.0. This means that support for Node.js 14 and 16 has been dropped. - * The minimum supported TypeScript version has been raised to 5.0.4. - * The compilation target for transpiled TypeScript has been raised to ES2022 (from ES2017). - -### Bug Fixes - -* **deps:** update otel core experimental to ^0.57.2 ([#2716](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2716)) ([d2a9a20](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/d2a9a20f1cd8c46c842e18490a4eba36fd71c2da)) - - -### Miscellaneous Chores - -* update to JS SDK 2.x ([#2738](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2738)) ([7fb4ba3](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/7fb4ba3bc36dc616bd86375cfd225722b850d0d5)) - - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/redis-common bumped from ^0.36.2 to ^0.37.0 - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.45.1 to ^0.46.0 - -## [0.46.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.46.0...instrumentation-redis-4-v0.46.1) (2025-02-19) - - -### Bug Fixes - -* **deps:** update otel core experimental to ^0.57.1 ([#2687](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2687)) ([5e20fe2](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/5e20fe2f450a1be4ea100e8a6d196e33ccff0cda)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.45.0 to ^0.45.1 - -## [0.46.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.45.0...instrumentation-redis-4-v0.46.0) (2024-12-18) - - -### Features - -* **deps:** update deps matching '@opentelemetry/*' ([#2608](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2608)) ([aa46705](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/aa46705d2fd1bd5ee6d763ac8cd73a7630889d34)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.44.0 to ^0.45.0 - -## [0.45.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.44.0...instrumentation-redis-4-v0.45.0) (2024-12-04) - - -### Features - -* **deps:** update deps matching '@opentelemetry/*' ([#2582](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2582)) ([5df02cb](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/5df02cbb35681d2b5cce359dda7b023d7bf339f2)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.43.0 to ^0.44.0 - -## [0.44.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.43.0...instrumentation-redis-4-v0.44.0) (2024-11-18) - - -### Features - -* **deps:** update deps matching '@opentelemetry/*' ([#2535](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2535)) ([5223a6c](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/5223a6ca10c5930cf2753271e1e670ae682d6d9c)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.42.0 to ^0.43.0 - -## [0.43.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.42.1...instrumentation-redis-4-v0.43.0) (2024-10-25) - - -### Features - -* update "@opentelemetry/*" dependencies to 1.27.0/0.54.0 ([2822511](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/2822511a8acffb875ebd67ff2cf95980a9ddc01e)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.41.0 to ^0.42.0 - -## [0.42.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.42.0...instrumentation-redis-4-v0.42.1) (2024-10-08) - - -### Bug Fixes - -* **instrumentation-redis-4:** avoid diag.error spam when configured client URL is the empty string ([#2399](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2399)) ([ec3b9c8](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/ec3b9c87aa2c79dc8cdcb4023df71dcafc6f08a4)), closes [#2389](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2389) - -## [0.42.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.41.1...instrumentation-redis-4-v0.42.0) (2024-09-02) - - -### Features - -* update deps matching "@opentelemetry/" ([9fa058e](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/9fa058ebb919de4e2a4e1af95b3c792c6ea962ac)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.40.0 to ^0.41.0 - -## [0.41.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.41.0...instrumentation-redis-4-v0.41.1) (2024-08-27) - - -### Bug Fixes - -* **instrumentation-redis-4:** avoid crash from incorrect this._diag ref ([#2397](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2397)) ([de7a6cb](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/de7a6cb77e643ed0de82e514510089fba5ae0405)), closes [#2389](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2389) - -## [0.41.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.40.0...instrumentation-redis-4-v0.41.0) (2024-07-03) - - -### ⚠ BREAKING CHANGES - -* standardize supported versions and set upper bound limit ([#2196](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2196)) - -### Bug Fixes - -* standardize supported versions and set upper bound limit ([#2196](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2196)) ([01c28ae](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/01c28ae016ed32f9968e52bc91e3e3700dcef82e)) - -## [0.40.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.39.0...instrumentation-redis-4-v0.40.0) (2024-06-06) - - -### Features - -* update otel core dependencies ([#2257](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2257)) ([71c15d5](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/71c15d597276773c19c16c1117b8d151892e5366)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.39.0 to ^0.40.0 - -## [0.39.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.38.0...instrumentation-redis-4-v0.39.0) (2024-04-25) - - -### Features - -* **deps:** update otel-js to 0.51.0 ([80cbee7](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/80cbee73130c65c8ccd78384485a7be8d2a4a84b)) -* remove generic type from instrumentations ([80cbee7](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/80cbee73130c65c8ccd78384485a7be8d2a4a84b)) - - -### Bug Fixes - -* revert modifications to Apache license ([#2105](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2105)) ([4590c8d](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/4590c8df184bbcb9bd67ce1111df9f25f865ccf2)) - - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/redis-common bumped from ^0.36.1 to ^0.36.2 - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.38.0 to ^0.39.0 - -## [0.38.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.37.0...instrumentation-redis-4-v0.38.0) (2024-04-03) - - -### Features - -* **deps:** update otel-js to 1.23.0/0.50.0 ([#2076](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2076)) ([d5f079b](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/d5f079b3992395dcfb3b791c9fdaeefd6d6526f8)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.37.0 to ^0.38.0 - -## [0.37.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.36.0...instrumentation-redis-4-v0.37.0) (2024-03-06) - - -### Features - -* **deps:** update otel-js to 1.22.0/0.49.1 ([edc426b](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/edc426b348bc5f45ff6816bcd5ea7473251a05df)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0 - -## [0.36.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.35.6...instrumentation-redis-4-v0.36.0) (2024-01-29) - - -### Features - -* **deps:** update otel-js to 1.21.0/0.48.0 ([9624486](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/96244869d0fe22e6006fa6ef5e54839e06afb99d)) - - -### Bug Fixes - -* **instrumentation-redis-4:** fix multi.exec() instrumentation for redis >=4.6.12 ([#1904](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1904)) ([fce7d3b](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/fce7d3b5e478ff7525c9ffe99e59bf35f8c06207)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.1 to ^0.36.0 - -## [0.35.6](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.35.5...instrumentation-redis-4-v0.35.6) (2024-01-04) - - -### Bug Fixes - -* **deps:** update otel core experimental ([#1866](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1866)) ([9366543](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/9366543f5572e1e976ce176ddeb0b438f6c16c45)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.35.0 to ^0.35.1 - -## [0.35.4](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.35.3...instrumentation-redis-4-v0.35.4) (2023-11-13) - - -### Bug Fixes - -* **deps:** update otel core experimental to v0.45.0 ([#1779](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1779)) ([7348635](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/734863562c25cd0497aa3f51eccb2bf8bbd5e711)) -* **deps:** update otel core experimental to v0.45.1 ([#1781](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1781)) ([7f420e2](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/7f420e25a8d396c83fd38101088434210705e365)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.2 to ^0.34.3 - -## [0.35.3](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.35.2...instrumentation-redis-4-v0.35.3) (2023-10-13) - - -### Bug Fixes - -* **instrumentation-redis-4:** avoid shimmer warning by only wrapping multi/MULTI if they exist ([#1729](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1729)) ([247a81c](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/247a81c047264ba638abb9a2ef2ca14801094040)) -* **instrumentation-redis-4:** fix unhandledRejection in client.multi(...) handling ([#1730](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1730)) ([d953531](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/d95353179279e3cf35ec37b6ca18f1e920691e16)) - -## [0.35.2](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.35.1...instrumentation-redis-4-v0.35.2) (2023-10-10) - - -### Bug Fixes - -* **deps:** update otel core experimental to v0.43.0 ([#1676](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1676)) ([deb9aa4](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/deb9aa441dc7d2b0fd5ec11b41c934a1e93134fd)) -* **deps:** update otel core experimental to v0.44.0 ([#1725](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1725)) ([540a0d1](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/540a0d1ff5641522abba560d59a298084f786630)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.1 to ^0.34.2 - -## [0.35.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.35.0...instrumentation-redis-4-v0.35.1) (2023-08-14) - - -### Bug Fixes - -* **deps:** update otel core experimental to v0.41.2 ([#1628](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1628)) ([4f11245](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/4f1124524aee565c3cfbf3975aa5d3d039377621)) -* **redis-4:** omit credentials from db.connection_string span attribute ([#1562](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1562)) ([ccf1efe](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/ccf1efe0cf8f144ab0d0aab490dfff499bd3158e)) -* Revert "feat(minification): Add importHelpers and tslib as a dependency ([#1545](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1545))" ([#1611](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1611)) ([e5bca5f](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/e5bca5fe5b27adc59c8de8fe4087d38b69d93bd4)) - - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/redis-common bumped from ^0.36.0 to ^0.36.1 - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.34.0 to ^0.34.1 - -## [0.35.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.34.6...instrumentation-redis-4-v0.35.0) (2023-07-12) - - -### Features - -* **minification:** Add importHelpers and tslib as a dependency ([#1545](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1545)) ([65f612e](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/65f612e35c4d67b9935dc3a9155588b35d915482)) - - -### Bug Fixes - -* **deps:** update otel core experimental to ^0.41.0 ([#1566](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1566)) ([84a2377](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/84a2377845c313f0ca68b4de7f3e7a464be68885)) - - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/redis-common bumped from ^0.35.1 to ^0.36.0 - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.4 to ^0.34.0 - -## [0.34.6](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.34.5...instrumentation-redis-4-v0.34.6) (2023-06-12) - - -### Bug Fixes - -* **deps:** update otel core experimental to ^0.40.0 ([#1527](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1527)) ([4e18a46](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/4e18a46396eb2f06e86790dbbd68075c4c2dc83b)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.3 to ^0.33.4 - -## [0.34.5](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.34.4...instrumentation-redis-4-v0.34.5) (2023-05-16) - - -### Bug Fixes - -* **deps:** update otel core experimental to ^0.39.1 ([#1493](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1493)) ([8ef95bc](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/8ef95bccc2d03302089f256f3d0ee091869b4c44)) -* **eslint-config:** replace gts with prettier and eslint ([#1439](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1439)) ([2571c37](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/2571c371be1b5738442200cab2415b6a04c32aab)) - - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/redis-common bumped from ^0.35.0 to ^0.35.1 - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.2 to ^0.33.3 - -## [0.34.4](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.34.3...instrumentation-redis-4-v0.34.4) (2023-04-25) - - -### Bug Fixes - -* **deps:** update otel core experimental to ^0.38.0 ([#1468](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1468)) ([565a2b2](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/565a2b2c6fde88af3f5401ef6a5a9643d0d66349)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.1 to ^0.33.2 - -## [0.34.2](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.34.1...instrumentation-redis-4-v0.34.2) (2023-02-07) - - -### Bug Fixes - -* **deps:** update otel core experimental to ^0.35.1 ([#1358](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1358)) ([ff109b7](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/ff109b77928cc9a139a21c63d6b54399bb017fa4)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.33.0 to ^0.33.1 - -## [0.34.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.34.0...instrumentation-redis-4-v0.34.1) (2022-12-20) - - -### Bug Fixes - -* **redis-4:** add support to new version of redis ([#1324](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1324)) ([378f130](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/378f130befb2bd8be42d367b9db5ae9329d57b5e)) -* **redis:** serialize non sensitive arguments into db.statement attribute ([#1299](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1299)) ([092a250](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/092a2509bcf884e1b997e0eaec3a6ca02cfd2058)) - - -### Dependencies - -* The following workspace dependencies were updated - * dependencies - * @opentelemetry/redis-common bumped from ^0.33.0 to ^0.34.0 - -## [0.34.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.33.1...instrumentation-redis-4-v0.34.0) (2022-11-16) - - -### Features - -* update experimental deps to `^0.34.0`, core deps to `^1.8.0`, api to `^1.3.0` ([#1278](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1278)) ([e9fe8e1](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/e9fe8e13e34f54e96c50525cadeb74ac048c5624)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.32.0 to ^0.33.0 - -## [0.33.1](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.33.0...instrumentation-redis-4-v0.33.1) (2022-11-02) - - -### Bug Fixes - -* separate public and internal types for all instrumentations ([#1251](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1251)) ([e72ea58](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/e72ea58cfb888a90590970f63d3a042a8ea3aaf2)) - -## [0.33.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.32.0...instrumentation-redis-4-v0.33.0) (2022-09-15) - - -### Features - -* add redis 4 connect span ([#1125](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1125)) ([dbf37fb](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/dbf37fb99b9168ebd0febc0da0ec21c0082e9967)) - -## [0.32.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.31.0...instrumentation-redis-4-v0.32.0) (2022-09-02) - - -### Features - -* update experimental Otel deps to ^0.31.0 ([#1096](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1096)) ([4c8843b](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/4c8843be14896d1159a622c07eb3a049401ccba1)) -* update experimental Otel deps to ^0.32.0 ([#1143](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1143)) ([6fb1911](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/6fb191139aed2ca763300dcf9adb51121a88f97e)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.31.0 to ^0.32.0 - -## [0.31.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.30.0...instrumentation-redis-4-v0.31.0) (2022-06-08) - - -### Features - -* update core dependencies stable ^1.3.1 experimental ^0.29.2 ([141b155](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/141b155e344980b51264e26b26c117b2113bcef6)) - - -### Dependencies - -* The following workspace dependencies were updated - * devDependencies - * @opentelemetry/contrib-test-utils bumped from ^0.30.0 to ^0.31.0 - -## [0.30.0](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/instrumentation-redis-4-v0.29.0...instrumentation-redis-4-v0.30.0) (2022-05-25) - - -### Features - -* **instrumentation-redis:** add support for redis@^4.0.0 ([#982](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/982)) ([1da0216](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/1da0216180de694c15ec356d476f465811757ae4)) -* upstream mocha instrumentation testing plugin from ext-js [#621](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/621) ([#669](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/669)) ([a5170c4](https://github.com/open-telemetry/opentelemetry-js-contrib/commit/a5170c494706a2bec3ba51e59966d0ca8a41d00e)) diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/LICENSE b/plugins/node/opentelemetry-instrumentation-redis-4/LICENSE deleted file mode 100644 index 261eeb9e9f..0000000000 --- a/plugins/node/opentelemetry-instrumentation-redis-4/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/README.md b/plugins/node/opentelemetry-instrumentation-redis-4/README.md index a8e9449d4b..80407ca373 100644 --- a/plugins/node/opentelemetry-instrumentation-redis-4/README.md +++ b/plugins/node/opentelemetry-instrumentation-redis-4/README.md @@ -1,103 +1,6 @@ -# OpenTelemetry redis Instrumentation for Node.js +# OpenTelemetry redis v4 Instrumentation for Node.js -[![NPM Published Version][npm-img]][npm-url] -[![Apache License][license-image]][license-image] +> ⚠️ **DEPRECATED**: The `@opentelemetry/instrumentation-redis-4` (note the "-4" suffix) instrumentation is deprecated. The support for `redis@4` instrumentation is now part of `@opentelemetry/instrumentation-redis` (as of v0.50.0). Please use it instead. -This module provides automatic instrumentation for the [`redis@^4.0.0`](https://github.com/NodeRedis/node_redis) module, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle. +The source code for this instrumentation has been moved to the "../opentelemetry-instrumentation-redis/" package. Use [the "instrumentation-redis-4-v0.49.0" git tag to see the package source code for the last release (v0.49.0)](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/instrumentation-redis-4-v0.49.0/plugins/node/opentelemetry-instrumentation-redis-4). -If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience. - -Compatible with OpenTelemetry JS API and SDK `1.0+`. - -## Installation - -```bash -npm install --save @opentelemetry/instrumentation-redis-4 -``` - -### Supported Versions - -- [`redis`](https://www.npmjs.com/package/redis) versions `>=4.0.0` - -For versions `redis@^2.6.0` and `redis@^3.0.0`, please use `@opentelemetry/instrumentation-redis` - -## Usage - -OpenTelemetry Redis Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with [redis](https://www.npmjs.com/package/redis). - -To load a specific instrumentation (**redis** in this case), specify it in the registerInstrumentations' configuration - -```javascript -const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node'); -const { RedisInstrumentation } = require('@opentelemetry/instrumentation-redis-4'); -const { registerInstrumentations } = require('@opentelemetry/instrumentation'); - -const provider = new NodeTracerProvider(); -provider.register(); - -registerInstrumentations({ - instrumentations: [ - new RedisInstrumentation(), - ], -}) -``` - -### Redis Instrumentation Options - -Redis instrumentation has a few options available to choose from. You can set the following: - -| Options | Type | Description | -| ----------------------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `dbStatementSerializer` | `DbStatementSerializer` (function) | Redis instrumentation will serialize the command to the `db.statement` attribute using the specified function. | -| `responseHook` | `RedisResponseCustomAttributeFunction` (function) | Function for adding custom attributes on db response. Receives params: `span, cmdName, cmdArgs, response` | -| `requireParentSpan` | `boolean` | Require parent to create redis span, default when unset is false. | - -#### Custom `db.statement` Serializer - -The instrumentation serializes the command into a Span attribute called `db.statement`. The standard serialization format attempts to be as informative as possible while avoiding the export of potentially sensitive data. The number of serialized arguments depends on the specific command, see the configuration -list in `@opentelemetry/redis-common`. - -It is also possible to define a custom serialization function. The function -will receive the command name and arguments and must return a string. - -Here is a simple example to serialize the command name and all command arguments. -Notice that it might capture sensitive data and big payloads: - -```javascript -const { RedisInstrumentation } = require('@opentelemetry/instrumentation-redis'); -const redisInstrumentation = new RedisInstrumentation({ - dbStatementSerializer: function (cmdName, cmdArgs) { - return [cmdName, ...cmdArgs].join(" "); - }, -}); -``` - -## Semantic Conventions - -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) - -Attributes collected: - -| Attribute | Short Description | -| ---------------------- | ---------------------------------------------------------------------------- | -| `db.connection_string` | The connection string used to connect to the database (without credentials). | -| `db.statement` | The database statement being executed. | -| `db.system` | An identifier for the database management system (DBMS) product being used. | -| `net.peer.name` | Remote hostname or similar, see note below. | -| `net.peer.port` | Remote port number. | - -## Useful links - -- For more information on OpenTelemetry, visit: -- For more about OpenTelemetry JavaScript: -- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] - -## License - -Apache 2.0 - See [LICENSE][license-url] for more information. - -[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions -[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE -[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat -[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-redis-4 -[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-redis-4.svg diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/package.json b/plugins/node/opentelemetry-instrumentation-redis-4/package.json deleted file mode 100644 index 86afcfe46b..0000000000 --- a/plugins/node/opentelemetry-instrumentation-redis-4/package.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "name": "@opentelemetry/instrumentation-redis-4", - "version": "0.49.0", - "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", - "scripts": { - "test": "nyc mocha --require '@opentelemetry/contrib-test-utils' 'test/redis.test.ts'", - "test:debug": "cross-env RUN_REDIS_TESTS_LOCAL=true mocha --inspect-brk --no-timeouts test/redis.test.ts", - "test:local": "cross-env RUN_REDIS_TESTS_LOCAL=true npm run test", - "test:docker:run": "docker run --rm -d --name otel-redis -p 63790:6379 redis:alpine", - "test:docker:stop": "docker stop otel-redis", - "test-all-versions": "tav", - "test-all-versions:local": "cross-env RUN_REDIS_TESTS_LOCAL=true npm run test-all-versions", - "tdd": "npm run test -- --watch-extensions ts --watch", - "clean": "rimraf build/*", - "lint": "eslint . --ext .ts", - "lint:fix": "eslint . --ext .ts --fix", - "lint:readme": "node ../../../scripts/lint-readme.js", - "version:update": "node ../../../scripts/version-update.js", - "setup:dev": "nx run-many -t compile -p @opentelemetry/instrumentation-redis-4", - "compile": "tsc -p .", - "prepublishOnly": "npm run compile" - }, - "keywords": [ - "instrumentation", - "nodejs", - "opentelemetry", - "profiling", - "redis", - "tracing" - ], - "author": "OpenTelemetry Authors", - "license": "Apache-2.0", - "engines": { - "node": "^18.19.0 || >=20.6.0" - }, - "files": [ - "build/src/**/*.js", - "build/src/**/*.js.map", - "build/src/**/*.d.ts" - ], - "publishConfig": { - "access": "public" - }, - "peerDependencies": { - "@opentelemetry/api": "^1.3.0" - }, - "devDependencies": { - "@opentelemetry/api": "^1.3.0", - "@opentelemetry/context-async-hooks": "^2.0.0", - "@opentelemetry/contrib-test-utils": "^0.48.0", - "@opentelemetry/core": "^2.0.0", - "@opentelemetry/sdk-trace-base": "^2.0.0", - "@opentelemetry/sdk-trace-node": "^2.0.0", - "@types/mocha": "10.0.10", - "@types/node": "18.18.14", - "cross-env": "7.0.3", - "nyc": "17.1.0", - "redis": "4.1.0", - "rimraf": "5.0.10", - "test-all-versions": "6.1.0", - "typescript": "5.0.4" - }, - "dependencies": { - "@opentelemetry/instrumentation": "^0.202.0", - "@opentelemetry/redis-common": "^0.37.0", - "@opentelemetry/semantic-conventions": "^1.27.0" - }, - "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-redis-4#readme" -} diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/src/index.ts b/plugins/node/opentelemetry-instrumentation-redis-4/src/index.ts deleted file mode 100644 index 50c62a0ebc..0000000000 --- a/plugins/node/opentelemetry-instrumentation-redis-4/src/index.ts +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright The OpenTelemetry Authors - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -export { RedisInstrumentation } from './instrumentation'; -export type { - DbStatementSerializer, - RedisInstrumentationConfig, - RedisResponseCustomAttributeFunction, -} from './types'; diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/src/types.ts b/plugins/node/opentelemetry-instrumentation-redis-4/src/types.ts deleted file mode 100644 index e15141a22e..0000000000 --- a/plugins/node/opentelemetry-instrumentation-redis-4/src/types.ts +++ /dev/null @@ -1,59 +0,0 @@ -/* - * Copyright The OpenTelemetry Authors - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import { Span } from '@opentelemetry/api'; -import { InstrumentationConfig } from '@opentelemetry/instrumentation'; - -/** - * Function that can be used to serialize db.statement tag - * @param cmdName - The name of the command (eg. set, get, mset) - * @param cmdArgs - Array of arguments passed to the command - * - * @returns serialized string that will be used as the db.statement attribute. - */ -export type DbStatementSerializer = ( - cmdName: string, - cmdArgs: Array -) => string; - -/** - * Function that can be used to add custom attributes to span on response from redis server - * @param span - The span created for the redis command, on which attributes can be set - * @param cmdName - The name of the command (eg. set, get, mset) - * @param cmdArgs - Array of arguments passed to the command - * @param response - The response object which is returned to the user who called this command. - * Can be used to set custom attributes on the span. - * The type of the response varies depending on the specific command. - */ -export interface RedisResponseCustomAttributeFunction { - ( - span: Span, - cmdName: string, - cmdArgs: Array, - response: unknown - ): void; -} - -export interface RedisInstrumentationConfig extends InstrumentationConfig { - /** Custom serializer function for the db.statement tag */ - dbStatementSerializer?: DbStatementSerializer; - - /** Function for adding custom attributes on db response */ - responseHook?: RedisResponseCustomAttributeFunction; - - /** Require parent to create redis span, default when unset is false */ - requireParentSpan?: boolean; -} diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/tsconfig.json b/plugins/node/opentelemetry-instrumentation-redis-4/tsconfig.json deleted file mode 100644 index 28be80d266..0000000000 --- a/plugins/node/opentelemetry-instrumentation-redis-4/tsconfig.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "extends": "../../../tsconfig.base", - "compilerOptions": { - "rootDir": ".", - "outDir": "build" - }, - "include": [ - "src/**/*.ts", - "test/**/*.ts" - ] -} diff --git a/plugins/node/opentelemetry-instrumentation-redis/.tav.yml b/plugins/node/opentelemetry-instrumentation-redis/.tav.yml index 81020bc78f..12aa469538 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/.tav.yml +++ b/plugins/node/opentelemetry-instrumentation-redis/.tav.yml @@ -1,5 +1,11 @@ redis: - versions: - include: '>=2.6.0 <4' - mode: latest-minors - commands: npm run test + - versions: + include: '>=2.6.0 <4' + mode: latest-minors + commands: npm run test-v2-v3 + - versions: + include: '>=4 <5' + # "4.6.9" was a bad release that accidentally broke node v14 support. + exclude: "4.6.9" + mode: latest-minors + commands: npm test diff --git a/plugins/node/opentelemetry-instrumentation-redis/README.md b/plugins/node/opentelemetry-instrumentation-redis/README.md index b5c9f1cdc1..b2827e72f4 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/README.md +++ b/plugins/node/opentelemetry-instrumentation-redis/README.md @@ -3,7 +3,7 @@ [![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image] -This module provides automatic instrumentation for the [`redis`](https://github.com/NodeRedis/node_redis) module versions `>=2.6.0 <4`, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle. +This module provides automatic instrumentation for the [`redis`](https://github.com/NodeRedis/node_redis) module versions `>=2.6.0 <5`, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle. If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience. @@ -17,9 +17,7 @@ npm install --save @opentelemetry/instrumentation-redis ### Supported Versions -- [`redis`](https://www.npmjs.com/package/redis) versions `>=2.6.0 <4` - -For versions `redis@^4.0.0`, please use `@opentelemetry/instrumentation-redis-4` +- [`redis`](https://www.npmjs.com/package/redis) versions `>=2.6.0 <5` ## Usage diff --git a/plugins/node/opentelemetry-instrumentation-redis/package.json b/plugins/node/opentelemetry-instrumentation-redis/package.json index 7b10d34084..ec9cbeb8e5 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/package.json +++ b/plugins/node/opentelemetry-instrumentation-redis/package.json @@ -1,12 +1,13 @@ { "name": "@opentelemetry/instrumentation-redis", "version": "0.49.1", - "description": "OpenTelemetry instrumentation for `redis` v2 and v3 database client for Redis", + "description": "OpenTelemetry instrumentation for `redis` database client for Redis", "main": "build/src/index.js", "types": "build/src/index.d.ts", "repository": "open-telemetry/opentelemetry-js-contrib", "scripts": { - "test": "nyc mocha 'test/**/*.test.ts'", + "test-v2-v3": "nyc mocha --require '@opentelemetry/contrib-test-utils' 'test/v2-v3/*.test.ts'", + "test": "nyc mocha --require '@opentelemetry/contrib-test-utils' 'test/v4/*.test.ts'", "test:debug": "cross-env RUN_REDIS_TESTS_LOCAL=true mocha --inspect-brk --no-timeouts 'test/**/*.test.ts'", "test:local": "cross-env RUN_REDIS_TESTS_LOCAL=true npm run test", "test:docker:run": "docker run --rm -d --name otel-redis -p 63790:6379 redis:alpine", @@ -55,10 +56,9 @@ "@opentelemetry/sdk-trace-node": "^2.0.0", "@types/mocha": "10.0.10", "@types/node": "18.18.14", - "@types/redis": "2.8.32", "cross-env": "7.0.3", "nyc": "17.1.0", - "redis": "3.1.2", + "redis": "^4.7.1", "rimraf": "5.0.10", "test-all-versions": "6.1.0", "typescript": "5.0.4" diff --git a/plugins/node/opentelemetry-instrumentation-redis/src/index.ts b/plugins/node/opentelemetry-instrumentation-redis/src/index.ts index 8aee6d3cd5..1cce49e0f1 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/src/index.ts +++ b/plugins/node/opentelemetry-instrumentation-redis/src/index.ts @@ -14,10 +14,9 @@ * limitations under the License. */ -export { RedisInstrumentation } from './instrumentation'; +export { RedisInstrumentation } from './redis'; export type { DbStatementSerializer, - RedisCommand, RedisInstrumentationConfig, RedisResponseCustomAttributeFunction, } from './types'; diff --git a/plugins/node/opentelemetry-instrumentation-redis/src/redis.ts b/plugins/node/opentelemetry-instrumentation-redis/src/redis.ts new file mode 100644 index 0000000000..14c2003dce --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-redis/src/redis.ts @@ -0,0 +1,85 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import { InstrumentationBase } from '@opentelemetry/instrumentation'; +import { RedisInstrumentationConfig } from './types'; +/** @knipignore */ +import { PACKAGE_NAME, PACKAGE_VERSION } from './version'; +import { RedisInstrumentationV2_V3 } from './v2-v3/instrumentation'; +import { TracerProvider } from '@opentelemetry/api'; +import { RedisInstrumentationV4 } from './v4/instrumentation'; + +const DEFAULT_CONFIG: RedisInstrumentationConfig = { + requireParentSpan: false, +}; + +// Wrapper RedisInstrumentation that address all supported versions +export class RedisInstrumentation extends InstrumentationBase { + private instrumentationV2_V3: RedisInstrumentationV2_V3; + private instrumentationV4: RedisInstrumentationV4; + + // this is used to bypass a flaw in the base class constructor, which is calling + // member functions before the constructor has a chance to fully initialize the member variables. + private initialized = false; + + constructor(config: RedisInstrumentationConfig = {}) { + const resolvedConfig = { ...DEFAULT_CONFIG, ...config }; + super(PACKAGE_NAME, PACKAGE_VERSION, resolvedConfig); + + this.instrumentationV2_V3 = new RedisInstrumentationV2_V3(this.getConfig()); + this.instrumentationV4 = new RedisInstrumentationV4(this.getConfig()); + this.initialized = true; + } + + override setConfig(config: RedisInstrumentationConfig = {}) { + const newConfig = { ...DEFAULT_CONFIG, ...config }; + super.setConfig(newConfig); + if (!this.initialized) { + return; + } + + this.instrumentationV2_V3.setConfig(newConfig); + this.instrumentationV4.setConfig(newConfig); + } + + override init() {} + + override setTracerProvider(tracerProvider: TracerProvider) { + super.setTracerProvider(tracerProvider); + if (!this.initialized) { + return; + } + this.instrumentationV2_V3.setTracerProvider(tracerProvider); + this.instrumentationV4.setTracerProvider(tracerProvider); + } + + override enable() { + super.enable(); + if (!this.initialized) { + return; + } + this.instrumentationV2_V3.enable(); + this.instrumentationV4.enable(); + } + + override disable() { + super.disable(); + if (!this.initialized) { + return; + } + this.instrumentationV2_V3.disable(); + this.instrumentationV4.disable(); + } +} diff --git a/plugins/node/opentelemetry-instrumentation-redis/src/types.ts b/plugins/node/opentelemetry-instrumentation-redis/src/types.ts index 32276281b4..e15141a22e 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/src/types.ts +++ b/plugins/node/opentelemetry-instrumentation-redis/src/types.ts @@ -17,16 +17,6 @@ import { Span } from '@opentelemetry/api'; import { InstrumentationConfig } from '@opentelemetry/instrumentation'; -// exported from -// https://github.com/redis/node-redis/blob/v3.1.2/lib/command.js -export interface RedisCommand { - command: string; - args: string[]; - buffer_args: boolean; - callback: (err: Error | null, reply: unknown) => void; - call_on_write: boolean; -} - /** * Function that can be used to serialize db.statement tag * @param cmdName - The name of the command (eg. set, get, mset) @@ -35,8 +25,8 @@ export interface RedisCommand { * @returns serialized string that will be used as the db.statement attribute. */ export type DbStatementSerializer = ( - cmdName: RedisCommand['command'], - cmdArgs: RedisCommand['args'] + cmdName: string, + cmdArgs: Array ) => string; /** @@ -51,8 +41,8 @@ export type DbStatementSerializer = ( export interface RedisResponseCustomAttributeFunction { ( span: Span, - cmdName: RedisCommand['command'], - cmdArgs: RedisCommand['args'], + cmdName: string, + cmdArgs: Array, response: unknown ): void; } diff --git a/plugins/node/opentelemetry-instrumentation-redis/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-redis/src/v2-v3/instrumentation.ts similarity index 91% rename from plugins/node/opentelemetry-instrumentation-redis/src/instrumentation.ts rename to plugins/node/opentelemetry-instrumentation-redis/src/v2-v3/instrumentation.ts index 545b4622f7..3e1cf09f19 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/src/instrumentation.ts +++ b/plugins/node/opentelemetry-instrumentation-redis/src/v2-v3/instrumentation.ts @@ -25,10 +25,10 @@ import { getTracedCreateClient, getTracedCreateStreamTrace, } from './utils'; -import { RedisCommand, RedisInstrumentationConfig } from './types'; +import { RedisInstrumentationConfig } from '../types'; /** @knipignore */ -import { PACKAGE_NAME, PACKAGE_VERSION } from './version'; -import { RedisPluginClientTypes } from './internal-types'; +import { PACKAGE_NAME, PACKAGE_VERSION } from '../version'; +import type { RedisCommand, RedisPluginClientTypes } from './internal-types'; import { SpanKind, context, trace } from '@opentelemetry/api'; import { DBSYSTEMVALUES_REDIS, @@ -40,19 +40,11 @@ import { } from '@opentelemetry/semantic-conventions'; import { defaultDbStatementSerializer } from '@opentelemetry/redis-common'; -const DEFAULT_CONFIG: RedisInstrumentationConfig = { - requireParentSpan: false, -}; - -export class RedisInstrumentation extends InstrumentationBase { +export class RedisInstrumentationV2_V3 extends InstrumentationBase { static readonly COMPONENT = 'redis'; constructor(config: RedisInstrumentationConfig = {}) { - super(PACKAGE_NAME, PACKAGE_VERSION, { ...DEFAULT_CONFIG, ...config }); - } - - override setConfig(config: RedisInstrumentationConfig = {}) { - super.setConfig({ ...DEFAULT_CONFIG, ...config }); + super(PACKAGE_NAME, PACKAGE_VERSION, config); } protected init() { @@ -136,7 +128,7 @@ export class RedisInstrumentation extends InstrumentationBase void; + call_on_write: boolean; +} + +// Exported from "@types/redis@2.8.32". +export type Callback = (err: Error | null, reply: T) => void; diff --git a/plugins/node/opentelemetry-instrumentation-redis/src/utils.ts b/plugins/node/opentelemetry-instrumentation-redis/src/v2-v3/utils.ts similarity index 85% rename from plugins/node/opentelemetry-instrumentation-redis/src/utils.ts rename to plugins/node/opentelemetry-instrumentation-redis/src/v2-v3/utils.ts index 15df6043bf..456ebf9fe4 100644 --- a/plugins/node/opentelemetry-instrumentation-redis/src/utils.ts +++ b/plugins/node/opentelemetry-instrumentation-redis/src/v2-v3/utils.ts @@ -14,7 +14,6 @@ * limitations under the License. */ -import type * as redisTypes from 'redis'; import { context, Span, SpanStatusCode } from '@opentelemetry/api'; import { EventEmitter } from 'events'; @@ -29,14 +28,14 @@ export const endSpan = (span: Span, err?: Error | null) => { }; export const getTracedCreateClient = (original: Function) => { - return function createClientTrace(this: redisTypes.RedisClient) { - const client: redisTypes.RedisClient = original.apply(this, arguments); + return function createClientTrace(this: any) { + const client = original.apply(this, arguments); return context.bind(context.active(), client); }; }; export const getTracedCreateStreamTrace = (original: Function) => { - return function create_stream_trace(this: redisTypes.RedisClient) { + return function create_stream_trace(this: any) { if (!Object.prototype.hasOwnProperty.call(this, 'stream')) { Object.defineProperty(this, 'stream', { get() { diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-redis/src/v4/instrumentation.ts similarity index 96% rename from plugins/node/opentelemetry-instrumentation-redis-4/src/instrumentation.ts rename to plugins/node/opentelemetry-instrumentation-redis/src/v4/instrumentation.ts index cbbbb0aab1..38f444ca17 100644 --- a/plugins/node/opentelemetry-instrumentation-redis-4/src/instrumentation.ts +++ b/plugins/node/opentelemetry-instrumentation-redis/src/v4/instrumentation.ts @@ -29,9 +29,9 @@ import { } from '@opentelemetry/instrumentation'; import { getClientAttributes } from './utils'; import { defaultDbStatementSerializer } from '@opentelemetry/redis-common'; -import { RedisInstrumentationConfig } from './types'; +import { RedisInstrumentationConfig } from '../types'; /** @knipignore */ -import { PACKAGE_NAME, PACKAGE_VERSION } from './version'; +import { PACKAGE_NAME, PACKAGE_VERSION } from '../version'; import { SEMATTRS_DB_STATEMENT } from '@opentelemetry/semantic-conventions'; import type { MultiErrorReply } from './internal-types'; @@ -48,19 +48,11 @@ interface MutliCommandInfo { commandArgs: Array; } -const DEFAULT_CONFIG: RedisInstrumentationConfig = { - requireParentSpan: false, -}; - -export class RedisInstrumentation extends InstrumentationBase { +export class RedisInstrumentationV4 extends InstrumentationBase { static readonly COMPONENT = 'redis'; constructor(config: RedisInstrumentationConfig = {}) { - super(PACKAGE_NAME, PACKAGE_VERSION, { ...DEFAULT_CONFIG, ...config }); - } - - override setConfig(config: RedisInstrumentationConfig = {}) { - super.setConfig({ ...DEFAULT_CONFIG, ...config }); + super(PACKAGE_NAME, PACKAGE_VERSION, config); } protected init() { @@ -339,7 +331,7 @@ export class RedisInstrumentation extends InstrumentationBase { - const provider = new NodeTracerProvider({ - spanProcessors: [new SimpleSpanProcessor(memoryExporter)], - }); - const tracer = provider.getTracer('external'); - let redis: typeof redisTypes; +describe('redis v2-v3', () => { + let redis: any; const shouldTestLocal = process.env.RUN_REDIS_TESTS_LOCAL; const shouldTest = process.env.RUN_REDIS_TESTS || shouldTestLocal; - - let contextManager: AsyncLocalStorageContextManager; - beforeEach(() => { - contextManager = new AsyncLocalStorageContextManager().enable(); - context.setGlobalContextManager(contextManager); - // set the default tracer provider before each test - // specific ones can override it to assert certain things - instrumentation.setTracerProvider(provider); - }); - - afterEach(() => { - context.disable(); - }); + const tracer = trace.getTracer('external'); before(function () { // needs to be "function" to have MochaContext "this" context @@ -103,8 +80,6 @@ describe('redis@2.x', () => { } redis = require('redis'); - instrumentation.setTracerProvider(provider); - instrumentation.enable(); }); after(() => { @@ -116,7 +91,7 @@ describe('redis@2.x', () => { describe('#createClient()', () => { it('should propagate the current span to event handlers', done => { const span = tracer.startSpan('test span'); - let client: redisTypes.RedisClient; + let client: any; const readyHandler = () => { assert.strictEqual(trace.getSpan(context.active()), span); client.quit(done); @@ -135,21 +110,21 @@ describe('redis@2.x', () => { }); describe('#send_internal_message()', () => { - let client: redisTypes.RedisClient; + let client: any; const REDIS_OPERATIONS: Array<{ description: string; command: string; args: string[]; expectedDbStatement: string; - method: (cb: redisTypes.Callback) => unknown; + method: (cb: Callback) => unknown; }> = [ { description: 'insert', command: 'hset', args: ['hash', 'random', 'random'], expectedDbStatement: 'hash random [1 other arguments]', - method: (cb: redisTypes.Callback) => + method: (cb: Callback) => client.hset('hash', 'random', 'random', cb), }, { @@ -157,21 +132,20 @@ describe('redis@2.x', () => { command: 'get', args: ['test'], expectedDbStatement: 'test', - method: (cb: redisTypes.Callback) => - client.get('test', cb), + method: (cb: Callback) => client.get('test', cb), }, { description: 'delete', command: 'del', args: ['test'], expectedDbStatement: 'test', - method: (cb: redisTypes.Callback) => client.del('test', cb), + method: (cb: Callback) => client.del('test', cb), }, ]; before(done => { client = redis.createClient(URL); - client.on('error', err => { + client.on('error', (err: any) => { done(err); }); client.on('ready', done); @@ -179,7 +153,7 @@ describe('redis@2.x', () => { beforeEach(done => { client.set('test', 'data', () => { - memoryExporter.reset(); + testUtils.resetMemoryExporter(); done(); }); }); @@ -190,7 +164,7 @@ describe('redis@2.x', () => { afterEach(done => { client.del('hash', () => { - memoryExporter.reset(); + testUtils.resetMemoryExporter(); done(); }); }); @@ -206,9 +180,9 @@ describe('redis@2.x', () => { context.with(trace.setSpan(context.active(), span), () => { operation.method((err, _result) => { assert.ifError(err); - assert.strictEqual(memoryExporter.getFinishedSpans().length, 1); + assert.strictEqual(testUtils.getTestSpans().length, 1); span.end(); - const endedSpans = memoryExporter.getFinishedSpans(); + const endedSpans = testUtils.getTestSpans(); assert.strictEqual(endedSpans.length, 2); assert.strictEqual( endedSpans[0].name, @@ -239,40 +213,18 @@ describe('redis@2.x', () => { }); }); - describe('Removing instrumentation', () => { - before(() => { - instrumentation.disable(); - }); - - REDIS_OPERATIONS.forEach(operation => { - it(`should not create a child span for ${operation.description}`, done => { - const span = tracer.startSpan('test span'); - context.with(trace.setSpan(context.active(), span), () => { - operation.method((err, _) => { - assert.ifError(err); - assert.strictEqual(memoryExporter.getFinishedSpans().length, 0); - span.end(); - const endedSpans = memoryExporter.getFinishedSpans(); - assert.strictEqual(endedSpans.length, 1); - assert.strictEqual(endedSpans[0], span); - done(); - }); - }); - }); - }); - }); - describe('dbStatementSerializer config', () => { - const dbStatementSerializer = (cmdName: string, cmdArgs: string[]) => { + const dbStatementSerializer = ( + cmdName: string, + cmdArgs: Array + ) => { return Array.isArray(cmdArgs) && cmdArgs.length ? `${cmdName} ${cmdArgs.join(' ')}` : cmdName; }; - before(() => { - instrumentation.disable(); + beforeEach(() => { instrumentation.setConfig({ dbStatementSerializer }); - instrumentation.enable(); }); REDIS_OPERATIONS.forEach(operation => { @@ -282,7 +234,7 @@ describe('redis@2.x', () => { operation.method((err, _) => { assert.ifError(err); span.end(); - const endedSpans = memoryExporter.getFinishedSpans(); + const endedSpans = testUtils.getTestSpans(); assert.strictEqual(endedSpans.length, 2); const expectedStatement = dbStatementSerializer( operation.command, @@ -306,23 +258,21 @@ describe('redis@2.x', () => { const responseHook: RedisResponseCustomAttributeFunction = ( span: Span, _cmdName: string, - _cmdArgs: string[], + _cmdArgs: Array, response: unknown ) => { span.setAttribute(dataFieldName, new String(response).toString()); }; - before(() => { - instrumentation.disable(); + beforeEach(() => { instrumentation.setConfig({ responseHook }); - instrumentation.enable(); }); REDIS_OPERATIONS.forEach(operation => { it(`should apply responseHook for operation ${operation.description}`, done => { operation.method((err, reply) => { assert.ifError(err); - const endedSpans = memoryExporter.getFinishedSpans(); + const endedSpans = testUtils.getTestSpans(); assert.strictEqual( endedSpans[0].attributes[dataFieldName], new String(reply).toString() @@ -337,23 +287,21 @@ describe('redis@2.x', () => { const badResponseHook: RedisResponseCustomAttributeFunction = ( _span: Span, _cmdName: string, - _cmdArgs: string[], + _cmdArgs: Array, _response: unknown ) => { throw 'Some kind of error'; }; - before(() => { - instrumentation.disable(); + beforeEach(() => { instrumentation.setConfig({ responseHook: badResponseHook }); - instrumentation.enable(); }); REDIS_OPERATIONS.forEach(operation => { it(`should not fail because of responseHook error for operation ${operation.description}`, done => { operation.method((err, _reply) => { assert.ifError(err); - const endedSpans = memoryExporter.getFinishedSpans(); + const endedSpans = testUtils.getTestSpans(); assert.strictEqual(endedSpans.length, 1); done(); }); @@ -363,19 +311,19 @@ describe('redis@2.x', () => { }); describe('requireParentSpan config', () => { - before(() => { - instrumentation.disable(); + beforeEach(() => { instrumentation.setConfig({ requireParentSpan: true }); - instrumentation.enable(); }); REDIS_OPERATIONS.forEach(operation => { it(`should not create span without parent span for operation ${operation.description}`, done => { - operation.method((err, _) => { - assert.ifError(err); - const endedSpans = memoryExporter.getFinishedSpans(); - assert.strictEqual(endedSpans.length, 0); - done(); + context.with(ROOT_CONTEXT, () => { + operation.method((err, _) => { + assert.ifError(err); + const endedSpans = testUtils.getTestSpans(); + assert.strictEqual(endedSpans.length, 0); + done(); + }); }); }); @@ -384,7 +332,7 @@ describe('redis@2.x', () => { context.with(trace.setSpan(context.active(), span), () => { operation.method((err, _) => { assert.ifError(err); - const endedSpans = memoryExporter.getFinishedSpans(); + const endedSpans = testUtils.getTestSpans(); assert.strictEqual(endedSpans.length, 1); done(); }); @@ -392,36 +340,5 @@ describe('redis@2.x', () => { }); }); }); - - describe('setTracerProvider', () => { - before(() => { - instrumentation.disable(); - instrumentation.setConfig({}); - instrumentation.enable(); - }); - - it('should use new tracer provider after setTracerProvider is called', done => { - const testSpecificMemoryExporter = new InMemorySpanExporter(); - const spanProcessor = new SimpleSpanProcessor( - testSpecificMemoryExporter - ); - const tracerProvider = new NodeTracerProvider({ - spanProcessors: [spanProcessor], - }); - - // key point of this test, setting new tracer provider and making sure - // new spans use it. - instrumentation.setTracerProvider(tracerProvider); - - client.set('test', 'value-with-new-tracer-provider', err => { - assert.ifError(err); - // assert that the span was exported by the new tracer provider - // which is using the test specific span processor - const spans = testSpecificMemoryExporter.getFinishedSpans(); - assert.strictEqual(spans.length, 1); - done(); - }); - }); - }); }); }); diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/test/redis.test.ts b/plugins/node/opentelemetry-instrumentation-redis/test/v4/redis.test.ts similarity index 96% rename from plugins/node/opentelemetry-instrumentation-redis-4/test/redis.test.ts rename to plugins/node/opentelemetry-instrumentation-redis/test/v4/redis.test.ts index d6d86d93c8..01927c1df5 100644 --- a/plugins/node/opentelemetry-instrumentation-redis-4/test/redis.test.ts +++ b/plugins/node/opentelemetry-instrumentation-redis/test/v4/redis.test.ts @@ -14,13 +14,13 @@ * limitations under the License. */ -import { diag, DiagLogLevel } from '@opentelemetry/api'; +import { diag, DiagLogLevel, ROOT_CONTEXT } from '@opentelemetry/api'; import { getTestSpans, registerInstrumentationTesting, } from '@opentelemetry/contrib-test-utils'; -import { RedisInstrumentation } from '../src'; -import type { MultiErrorReply } from '../src/internal-types'; +import { RedisInstrumentation } from '../../src'; +import type { MultiErrorReply } from '../../src/v4/internal-types'; import * as assert from 'assert'; import { @@ -35,7 +35,8 @@ const instrumentation = registerInstrumentationTesting( new RedisInstrumentation() ); -import { createClient, WatchError } from 'redis'; +import { createClient } from 'redis'; +import type { RedisClientType } from 'redis'; import { Span, SpanKind, @@ -51,10 +52,10 @@ import { SEMATTRS_NET_PEER_NAME, SEMATTRS_NET_PEER_PORT, } from '@opentelemetry/semantic-conventions'; -import { RedisResponseCustomAttributeFunction } from '../src/types'; +import { RedisResponseCustomAttributeFunction } from '../../src/types'; import { hrTimeToMilliseconds, suppressTracing } from '@opentelemetry/core'; -describe('redis@^4.0.0', () => { +describe('redis v4', () => { before(function () { // needs to be "function" to have MochaContext "this" context if (!shouldTest) { @@ -75,7 +76,7 @@ describe('redis@^4.0.0', () => { } }); - let client: any; + let client: RedisClientType; beforeEach(async () => { client = createClient({ @@ -444,7 +445,7 @@ describe('redis@^4.0.0', () => { await client.multi().get(watchedKey).exec(); assert.fail('expected WatchError to be thrown and caught in try/catch'); } catch (error) { - assert.ok(error instanceof WatchError); + assert.ok(error instanceof Error); } // All the multi spans' status are set to ERROR. @@ -604,9 +605,11 @@ describe('redis@^4.0.0', () => { instrumentation.setConfig({ requireParentSpan: true }); // no parent span => no redis span - const res = await client.set('key', 'value'); - assert.strictEqual(res, 'OK'); // verify we did not screw up the normal functionality - assert.ok(getTestSpans().length === 0); + context.with(ROOT_CONTEXT, async () => { + const res = await client.set('key', 'value'); + assert.strictEqual(res, 'OK'); // verify we did not screw up the normal functionality + assert.ok(getTestSpans().length === 0); + }); // has ambient span => redis span const span = trace.getTracer('test').startSpan('test span'); diff --git a/plugins/node/opentelemetry-instrumentation-redis-4/test/utils.ts b/plugins/node/opentelemetry-instrumentation-redis/test/v4/utils.ts similarity index 100% rename from plugins/node/opentelemetry-instrumentation-redis-4/test/utils.ts rename to plugins/node/opentelemetry-instrumentation-redis/test/v4/utils.ts diff --git a/release-please-config.json b/release-please-config.json index 9bbf8c8763..c876839294 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -61,7 +61,6 @@ "plugins/node/opentelemetry-instrumentation-pg": {}, "plugins/node/opentelemetry-instrumentation-pino": {}, "plugins/node/opentelemetry-instrumentation-redis": {}, - "plugins/node/opentelemetry-instrumentation-redis-4": {}, "plugins/node/opentelemetry-instrumentation-restify": {}, "plugins/node/opentelemetry-instrumentation-router": {}, "plugins/node/opentelemetry-instrumentation-winston": {},