@opentelemetry/instrumentation-ioredis 0.33.2 → 0.34.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/build/src/instrumentation.d.ts +2 -3
- package/build/src/instrumentation.js +1 -1
- package/build/src/instrumentation.js.map +1 -1
- package/build/src/internal-types.d.ts +15 -0
- package/build/src/internal-types.js +3 -0
- package/build/src/internal-types.js.map +1 -0
- package/build/src/types.d.ts +5 -13
- package/build/src/version.d.ts +1 -1
- package/build/src/version.js +1 -1
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@ npm install --save @opentelemetry/instrumentation-ioredis
|
|
|
17
17
|
|
|
18
18
|
### Supported Versions
|
|
19
19
|
|
|
20
|
-
- `>=2.0.0 <
|
|
20
|
+
- `>=2.0.0 <6`
|
|
21
21
|
|
|
22
22
|
## Usage
|
|
23
23
|
|
|
@@ -47,7 +47,7 @@ registerInstrumentations({
|
|
|
47
47
|
IORedis instrumentation has few options available to choose from. You can set the following:
|
|
48
48
|
|
|
49
49
|
| Options | Type | Description |
|
|
50
|
-
|
|
50
|
+
|-------------------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
|
|
51
51
|
| `dbStatementSerializer` | `DbStatementSerializer` | IORedis instrumentation will serialize db.statement using the specified function. |
|
|
52
52
|
| `requestHook` | `RedisRequestCustomAttributeFunction` (function) | Function for adding custom attributes on db request. Receives params: `span, { moduleVersion, cmdName, cmdArgs }` |
|
|
53
53
|
| `responseHook` | `RedisResponseCustomAttributeFunction` (function) | Function for adding custom attributes on db response |
|
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
import type * as ioredisTypes from 'ioredis';
|
|
2
1
|
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
|
|
3
2
|
import { IORedisInstrumentationConfig } from './types';
|
|
4
|
-
export declare class IORedisInstrumentation extends InstrumentationBase<
|
|
3
|
+
export declare class IORedisInstrumentation extends InstrumentationBase<any> {
|
|
5
4
|
constructor(_config?: IORedisInstrumentationConfig);
|
|
6
|
-
init(): InstrumentationNodeModuleDefinition<
|
|
5
|
+
init(): InstrumentationNodeModuleDefinition<any>[];
|
|
7
6
|
/**
|
|
8
7
|
* Patch send command internal to trace requests
|
|
9
8
|
*/
|
|
@@ -126,7 +126,7 @@ class IORedisInstrumentation extends instrumentation_1.InstrumentationBase {
|
|
|
126
126
|
}
|
|
127
127
|
init() {
|
|
128
128
|
return [
|
|
129
|
-
new instrumentation_1.InstrumentationNodeModuleDefinition('ioredis', ['>1 <
|
|
129
|
+
new instrumentation_1.InstrumentationNodeModuleDefinition('ioredis', ['>1', '<6'], (moduleExports, moduleVersion) => {
|
|
130
130
|
api_1.diag.debug('Applying patch for ioredis');
|
|
131
131
|
if ((0, instrumentation_1.isWrapped)(moduleExports.prototype.sendCommand)) {
|
|
132
132
|
this._unwrap(moduleExports.prototype, 'sendCommand');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../src/instrumentation.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4CAAoE;
|
|
1
|
+
{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../src/instrumentation.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4CAAoE;AACpE,oEAIwC;AAGxC,8EAG6C;AAC7C,oEAAwE;AACxE,mCAAkC;AAClC,8DAA2E;AAC3E,uCAAoC;AAEpC,MAAM,cAAc,GAAiC;IACnD,iBAAiB,EAAE,IAAI;CACxB,CAAC;AAEF,MAAa,sBAAuB,SAAQ,qCAAwB;IAClE,YAAY,UAAwC,EAAE;QACpD,KAAK,CACH,wCAAwC,EACxC,iBAAO,EACP,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,cAAc,EAAE,OAAO,CAAC,CAC3C,CAAC;QAqDI,qBAAgB,GAAG,CAAC,QAAkB,EAAE,aAAsB,EAAE,EAAE;YACxE,MAAM,eAAe,GAAG,IAAI,CAAC;YAC7B,OAAO,UAAgC,GAAoB;gBACzD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;oBACnD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;iBACxC;gBACD,MAAM,MAAM,GACV,eAAe,CAAC,SAAS,EAAkC,CAAC;gBAC9D,MAAM,qBAAqB,GACzB,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,qBAAqB,KAAI,2CAA4B,CAAC;gBAEhE,MAAM,eAAe,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,KAAK,SAAS,CAAC;gBACtE,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,iBAAiB,MAAK,IAAI,IAAI,eAAe,EAAE;oBACzD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;iBACxC;gBAED,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE;oBACtD,IAAI,EAAE,cAAQ,CAAC,MAAM;oBACrB,UAAU,EAAE;wBACV,CAAC,yCAAkB,CAAC,SAAS,CAAC,EAAE,qCAAc,CAAC,KAAK;wBACpD,CAAC,yCAAkB,CAAC,YAAY,CAAC,EAAE,qBAAqB,CACtD,GAAG,CAAC,IAAI,EACR,GAAG,CAAC,IAAI,CACT;qBACF;iBACF,CAAC,CAAC;gBAEH,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,EAAE;oBACvB,IAAA,wCAAsB,EACpB,GAAG,EAAE,CACH,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,CAAE,IAAI,EAAE;wBACzB,aAAa;wBACb,OAAO,EAAE,GAAG,CAAC,IAAI;wBACjB,OAAO,EAAE,GAAG,CAAC,IAAI;qBAClB,CAAC,EACJ,CAAC,CAAC,EAAE;wBACF,IAAI,CAAC,EAAE;4BACL,UAAI,CAAC,KAAK,CAAC,8CAA8C,EAAE,CAAC,CAAC,CAAC;yBAC/D;oBACH,CAAC,EACD,IAAI,CACL,CAAC;iBACH;gBAED,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAEpC,IAAI,CAAC,aAAa,CAAC;oBACjB,CAAC,yCAAkB,CAAC,aAAa,CAAC,EAAE,IAAI;oBACxC,CAAC,yCAAkB,CAAC,aAAa,CAAC,EAAE,IAAI;oBACxC,CAAC,yCAAkB,CAAC,oBAAoB,CAAC,EAAE,WAAW,IAAI,IAAI,IAAI,EAAE;iBACrE,CAAC,CAAC;gBAEH,IAAI;oBACF,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;oBAE/C,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC;oBAChC,uDAAuD;oBACvD,GAAG,CAAC,OAAO,GAAG,UAAU,MAAW;wBACjC,IAAA,wCAAsB,EACpB,GAAG,EAAE,WAAC,OAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,YAAY,+CAApB,MAAM,EAAiB,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA,EAAA,EAC9D,CAAC,CAAC,EAAE;4BACF,IAAI,CAAC,EAAE;gCACL,UAAI,CAAC,KAAK,CAAC,+CAA+C,EAAE,CAAC,CAAC,CAAC;6BAChE;wBACH,CAAC,EACD,IAAI,CACL,CAAC;wBAEF,IAAA,eAAO,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;wBACpB,WAAW,CAAC,MAAM,CAAC,CAAC;oBACtB,CAAC,CAAC;oBAEF,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC;oBAC9B,GAAG,CAAC,MAAM,GAAG,UAAU,GAAU;wBAC/B,IAAA,eAAO,EAAC,IAAI,EAAE,GAAG,CAAC,CAAC;wBACnB,UAAU,CAAC,GAAG,CAAC,CAAC;oBAClB,CAAC,CAAC;oBAEF,OAAO,MAAM,CAAC;iBACf;gBAAC,OAAO,KAAU,EAAE;oBACnB,IAAA,eAAO,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBACrB,MAAM,KAAK,CAAC;iBACb;YACH,CAAC,CAAC;QACJ,CAAC,CAAC;QAEM,oBAAe,GAAG,CAAC,QAAkB,EAAE,EAAE;YAC/C,MAAM,eAAe,GAAG,IAAI,CAAC;YAC7B,OAAO;gBACL,MAAM,MAAM,GACV,eAAe,CAAC,SAAS,EAAkC,CAAC;gBAC9D,MAAM,eAAe,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,KAAK,SAAS,CAAC;gBACtE,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,iBAAiB,MAAK,IAAI,IAAI,eAAe,EAAE;oBACzD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;iBACxC;gBAED,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE;oBACvD,IAAI,EAAE,cAAQ,CAAC,MAAM;oBACrB,UAAU,EAAE;wBACV,CAAC,yCAAkB,CAAC,SAAS,CAAC,EAAE,qCAAc,CAAC,KAAK;wBACpD,CAAC,yCAAkB,CAAC,YAAY,CAAC,EAAE,SAAS;qBAC7C;iBACF,CAAC,CAAC;gBACH,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAEpC,IAAI,CAAC,aAAa,CAAC;oBACjB,CAAC,yCAAkB,CAAC,aAAa,CAAC,EAAE,IAAI;oBACxC,CAAC,yCAAkB,CAAC,aAAa,CAAC,EAAE,IAAI;oBACxC,CAAC,yCAAkB,CAAC,oBAAoB,CAAC,EAAE,WAAW,IAAI,IAAI,IAAI,EAAE;iBACrE,CAAC,CAAC;gBACH,IAAI;oBACF,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;oBAC/C,IAAA,eAAO,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;oBACpB,OAAO,MAAM,CAAC;iBACf;gBAAC,OAAO,KAAU,EAAE;oBACnB,IAAA,eAAO,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBACrB,MAAM,KAAK,CAAC;iBACb;YACH,CAAC,CAAC;QACJ,CAAC,CAAC;IA3KF,CAAC;IAED,IAAI;QACF,OAAO;YACL,IAAI,qDAAmC,CACrC,SAAS,EACT,CAAC,IAAI,EAAE,IAAI,CAAC,EACZ,CAAC,aAAa,EAAE,aAAsB,EAAE,EAAE;gBACxC,UAAI,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;gBACzC,IAAI,IAAA,2BAAS,EAAC,aAAa,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;oBAClD,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;iBACtD;gBACD,IAAI,CAAC,KAAK,CACR,aAAa,CAAC,SAAS,EACvB,aAAa,EACb,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CACtC,CAAC;gBACF,IAAI,IAAA,2BAAS,EAAC,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;oBAC9C,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;iBAClD;gBACD,IAAI,CAAC,KAAK,CACR,aAAa,CAAC,SAAS,EACvB,SAAS,EACT,IAAI,CAAC,gBAAgB,EAAE,CACxB,CAAC;gBACF,OAAO,aAAa,CAAC;YACvB,CAAC,EACD,aAAa,CAAC,EAAE;gBACd,IAAI,aAAa,KAAK,SAAS;oBAAE,OAAO;gBACxC,UAAI,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;gBACzC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;gBACrD,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACnD,CAAC,CACF;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,iBAAiB,CAAC,aAAsB;QAC9C,OAAO,CAAC,QAAkB,EAAE,EAAE;YAC5B,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACxD,CAAC,CAAC;IACJ,CAAC;IAEO,gBAAgB;QACtB,OAAO,CAAC,QAAkB,EAAE,EAAE;YAC5B,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC,CAAC;IACJ,CAAC;CA0HF;AAnLD,wDAmLC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import type { Command, Redis } from 'ioredis';
|
|
3
|
+
import type * as LegacyIORedis from 'ioredis4';
|
|
4
|
+
interface LegacyIORedisCommand {
|
|
5
|
+
reject: (err: Error) => void;
|
|
6
|
+
resolve: (result: {}) => void;
|
|
7
|
+
promise: Promise<{}>;
|
|
8
|
+
args: Array<string | Buffer | number>;
|
|
9
|
+
callback: LegacyIORedis.CallbackFunction<unknown>;
|
|
10
|
+
name: string;
|
|
11
|
+
}
|
|
12
|
+
export declare type IORedisCommand = Command | LegacyIORedisCommand;
|
|
13
|
+
export declare type RedisInterface = Redis | LegacyIORedis.Redis;
|
|
14
|
+
export {};
|
|
15
|
+
//# sourceMappingURL=internal-types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"internal-types.js","sourceRoot":"","sources":["../../src/internal-types.ts"],"names":[],"mappings":""}
|
package/build/src/types.d.ts
CHANGED
|
@@ -1,15 +1,7 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import type * as ioredisTypes from 'ioredis';
|
|
3
2
|
import { InstrumentationConfig } from '@opentelemetry/instrumentation';
|
|
4
3
|
import { Span } from '@opentelemetry/api';
|
|
5
|
-
export
|
|
6
|
-
reject: (err: Error) => void;
|
|
7
|
-
resolve: (result: {}) => void;
|
|
8
|
-
promise: Promise<{}>;
|
|
9
|
-
args: Array<string | Buffer | number>;
|
|
10
|
-
callback: ioredisTypes.CallbackFunction<unknown>;
|
|
11
|
-
name: string;
|
|
12
|
-
}
|
|
4
|
+
export declare type CommandArgs = Array<string | Buffer | number | any[]>;
|
|
13
5
|
/**
|
|
14
6
|
* Function that can be used to serialize db.statement tag
|
|
15
7
|
* @param cmdName - The name of the command (eg. set, get, mset)
|
|
@@ -17,11 +9,11 @@ export interface IORedisCommand {
|
|
|
17
9
|
*
|
|
18
10
|
* @returns serialized string that will be used as the db.statement attribute.
|
|
19
11
|
*/
|
|
20
|
-
export declare type DbStatementSerializer = (cmdName:
|
|
12
|
+
export declare type DbStatementSerializer = (cmdName: string, cmdArgs: CommandArgs) => string;
|
|
21
13
|
export interface IORedisRequestHookInformation {
|
|
22
14
|
moduleVersion?: string;
|
|
23
|
-
cmdName:
|
|
24
|
-
cmdArgs:
|
|
15
|
+
cmdName: string;
|
|
16
|
+
cmdArgs: CommandArgs;
|
|
25
17
|
}
|
|
26
18
|
export interface RedisRequestCustomAttributeFunction {
|
|
27
19
|
(span: Span, requestInfo: IORedisRequestHookInformation): void;
|
|
@@ -36,7 +28,7 @@ export interface RedisRequestCustomAttributeFunction {
|
|
|
36
28
|
* The type of the response varies depending on the specific command.
|
|
37
29
|
*/
|
|
38
30
|
export interface RedisResponseCustomAttributeFunction {
|
|
39
|
-
(span: Span, cmdName:
|
|
31
|
+
(span: Span, cmdName: string, cmdArgs: CommandArgs, response: unknown): void;
|
|
40
32
|
}
|
|
41
33
|
/**
|
|
42
34
|
* Options available for the IORedis Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-ioredis#ioredis-instrumentation-options))
|
package/build/src/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.34.1";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/build/src/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@opentelemetry/instrumentation-ioredis",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.34.1",
|
|
4
4
|
"description": "OpenTelemetry ioredis automatic instrumentation package.",
|
|
5
5
|
"main": "build/src/index.js",
|
|
6
6
|
"types": "build/src/index.d.ts",
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
"devDependencies": {
|
|
53
53
|
"@opentelemetry/api": "^1.3.0",
|
|
54
54
|
"@opentelemetry/context-async-hooks": "^1.8.0",
|
|
55
|
-
"@opentelemetry/contrib-test-utils": "^0.33.
|
|
55
|
+
"@opentelemetry/contrib-test-utils": "^0.33.2",
|
|
56
56
|
"@opentelemetry/sdk-trace-base": "^1.8.0",
|
|
57
57
|
"@opentelemetry/sdk-trace-node": "^1.8.0",
|
|
58
58
|
"@types/mocha": "7.0.2",
|
|
@@ -60,21 +60,21 @@
|
|
|
60
60
|
"@types/sinon": "10.0.9",
|
|
61
61
|
"cross-env": "7.0.3",
|
|
62
62
|
"gts": "3.1.0",
|
|
63
|
-
"ioredis": "
|
|
63
|
+
"ioredis": "5.2.2",
|
|
64
64
|
"mocha": "7.2.0",
|
|
65
65
|
"nyc": "15.1.0",
|
|
66
|
-
"rimraf": "
|
|
66
|
+
"rimraf": "4.2.0",
|
|
67
67
|
"sinon": "15.0.1",
|
|
68
68
|
"test-all-versions": "5.0.1",
|
|
69
69
|
"ts-mocha": "10.0.0",
|
|
70
70
|
"typescript": "4.4.4"
|
|
71
71
|
},
|
|
72
72
|
"dependencies": {
|
|
73
|
-
"@opentelemetry/instrumentation": "^0.
|
|
74
|
-
"@opentelemetry/redis-common": "^0.
|
|
73
|
+
"@opentelemetry/instrumentation": "^0.38.0",
|
|
74
|
+
"@opentelemetry/redis-common": "^0.35.0",
|
|
75
75
|
"@opentelemetry/semantic-conventions": "^1.0.0",
|
|
76
|
-
"@types/
|
|
76
|
+
"@types/ioredis4": "npm:@types/ioredis@^4.28.10"
|
|
77
77
|
},
|
|
78
78
|
"homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-ioredis#readme",
|
|
79
|
-
"gitHead": "
|
|
79
|
+
"gitHead": "f7183016487c876829abce6437bbe71f76b7538e"
|
|
80
80
|
}
|