@opentelemetry/instrumentation-ioredis 0.25.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

package/README.md

@@ -0,0 +1,117 @@
+# OpenTelemetry ioredis Instrumentation for Node.js
+
+[![NPM Published Version][npm-img]][npm-url]
+[![dependencies][dependencies-image]][dependencies-url]
+[![devDependencies][devDependencies-image]][devDependencies-url]
+[![Apache License][license-image]][license-image]
+
+This module provides automatic instrumentation for [`ioredis`](https://github.com/luin/ioredis).
+
+For automatic instrumentation see the
+[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
+
+## Installation
+
+```sh
+npm install --save @opentelemetry/instrumentation-ioredis
+```
+
+### Supported Versions
+
+- `>=2.0.0`
+
+## Usage
+
+To load a specific instrumentation (**ioredis** in this case), specify it in the registerInstrumentations's configuration
+
+```javascript
+const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
+const {
+  IORedisInstrumentation,
+} = require('@opentelemetry/instrumentation-ioredis');
+const { registerInstrumentations } = require('@opentelemetry/instrumentation');
+
+const provider = new NodeTracerProvider();
+provider.register();
+
+registerInstrumentations({
+  instrumentations: [
+    new IORedisInstrumentation({
+      // see under for available configuration
+    }),
+  ],
+});
+```
+
+### IORedis Instrumentation Options
+
+IORedis instrumentation has few options available to choose from. You can set the following:
+
+| Options                 | Type                                              | Description                                                                                                       |
+| ----------------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| `dbStatementSerializer` | `DbStatementSerializer`                           | IORedis instrumentation will serialize db.statement using the specified function.                                 |
+| `requestHook`           | `RedisRequestCustomAttributeFunction` (function)  | Function for adding custom attributes on db request. Receives params: `span, { moduleVersion, cmdName, cmdArgs }` |
+| `responseHook`          | `RedisResponseCustomAttributeFunction` (function) | Function for adding custom attributes on db response                                                              |
+| `requireParentSpan`     | `boolean`                                         | Require parent to create ioredis span, default when unset is true                                                 |
+
+#### Custom db.statement Serializer
+
+The instrumentation serializes the whole command into a Span attribute called `db.statement`. The standard serialization format is `{cmdName} {cmdArgs.join(',')}`.
+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 skipping arguments:
+
+```javascript
+const { IORedisInstrumentation } = require('@opentelemetry/instrumentation-ioredis');
+
+const ioredisInstrumentation = new IORedisInstrumentation({
+  dbStatementSerializer: function (cmdName, cmdArgs) {
+    return cmdName;
+  },
+});
+```
+
+#### Using `requestHook`
+
+Instrumentation user can configure a custom "hook" function which will be called on every request with the relevant span and request information. User can then set custom attributes on the span or run any instrumentation-extension logic per request.
+
+Here is a simple example that adds a span attribute of `ioredis` instrumented version on each request:
+
+```javascript
+const { IORedisInstrumentation } = require('@opentelemetry/instrumentation-ioredis');
+
+const ioredisInstrumentation = new IORedisInstrumentation({
+requestHook: function (
+    span: Span,
+    requestInfo: IORedisRequestHookInformation
+  ) {
+    if (requestInfo.moduleVersion) {
+      span.setAttribute(
+        'instrumented_library.version',
+        requestInfo.moduleVersion
+      );
+    }
+  }
+});
+
+```
+
+## Useful links
+
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
+- 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
+[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-ioredis
+[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-ioredis
+[devdependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-ioredis&type=dev
+[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-ioredis&type=dev
+[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-ioredis
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-ioredis.svg

package/build/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './instrumentation';
+export { IORedisInstrumentationConfig } from './types';
+//# sourceMappingURL=index.d.ts.map

package/build/src/index.js

@@ -0,0 +1,29 @@
+"use strict";
+/*
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./instrumentation"), exports);
+//# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;AAEH,oDAAkC"}

package/build/src/instrumentation.d.ts

@@ -0,0 +1,14 @@
+import type * as ioredisTypes from 'ioredis';
+import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
+import { IORedisInstrumentationConfig } from './types';
+export declare class IORedisInstrumentation extends InstrumentationBase<typeof ioredisTypes> {
+    static readonly DB_SYSTEM = "redis";
+    constructor(_config?: IORedisInstrumentationConfig);
+    init(): InstrumentationNodeModuleDefinition<typeof ioredisTypes>[];
+    /**
+     * Patch send command internal to trace requests
+     */
+    private _patchSendCommand;
+    private _patchConnection;
+}
+//# sourceMappingURL=instrumentation.d.ts.map

package/build/src/instrumentation.js

@@ -0,0 +1,68 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IORedisInstrumentation = void 0;
+const api_1 = require("@opentelemetry/api");
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const utils_1 = require("./utils");
+const version_1 = require("./version");
+const DEFAULT_CONFIG = {
+    requireParentSpan: true,
+};
+class IORedisInstrumentation extends instrumentation_1.InstrumentationBase {
+    constructor(_config = {}) {
+        super('@opentelemetry/instrumentation-ioredis', version_1.VERSION, Object.assign({}, DEFAULT_CONFIG, _config));
+    }
+    init() {
+        return [
+            new instrumentation_1.InstrumentationNodeModuleDefinition('ioredis', ['>1 <5'], (moduleExports, moduleVersion) => {
+                api_1.diag.debug('Applying patch for ioredis');
+                if (instrumentation_1.isWrapped(moduleExports.prototype.sendCommand)) {
+                    this._unwrap(moduleExports.prototype, 'sendCommand');
+                }
+                this._wrap(moduleExports.prototype, 'sendCommand', this._patchSendCommand(moduleVersion));
+                if (instrumentation_1.isWrapped(moduleExports.prototype.connect)) {
+                    this._unwrap(moduleExports.prototype, 'connect');
+                }
+                this._wrap(moduleExports.prototype, 'connect', this._patchConnection());
+                return moduleExports;
+            }, moduleExports => {
+                if (moduleExports === undefined)
+                    return;
+                api_1.diag.debug('Removing patch for ioredis');
+                this._unwrap(moduleExports.prototype, 'sendCommand');
+                this._unwrap(moduleExports.prototype, 'connect');
+            }),
+        ];
+    }
+    /**
+     * Patch send command internal to trace requests
+     */
+    _patchSendCommand(moduleVersion) {
+        return (original) => {
+            return utils_1.traceSendCommand(this.tracer, original, this._config, moduleVersion);
+        };
+    }
+    _patchConnection() {
+        return (original) => {
+            return utils_1.traceConnection(this.tracer, original);
+        };
+    }
+}
+exports.IORedisInstrumentation = IORedisInstrumentation;
+IORedisInstrumentation.DB_SYSTEM = 'redis';
+//# sourceMappingURL=instrumentation.js.map

package/build/src/instrumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../src/instrumentation.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4CAA0C;AAE1C,oEAIwC;AAExC,mCAA4D;AAC5D,uCAAoC;AAEpC,MAAM,cAAc,GAAiC;IACnD,iBAAiB,EAAE,IAAI;CACxB,CAAC;AAEF,MAAa,sBAAuB,SAAQ,qCAE3C;IAGC,YAAY,UAAwC,EAAE;QACpD,KAAK,CACH,wCAAwC,EACxC,iBAAO,EACP,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,cAAc,EAAE,OAAO,CAAC,CAC3C,CAAC;IACJ,CAAC;IAED,IAAI;QACF,OAAO;YACL,IAAI,qDAAmC,CACrC,SAAS,EACT,CAAC,OAAO,CAAC,EACT,CAAC,aAAa,EAAE,aAAsB,EAAE,EAAE;gBACxC,UAAI,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;gBACzC,IAAI,2BAAS,CAAC,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,2BAAS,CAAC,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,wBAAgB,CACrB,IAAI,CAAC,MAAM,EACX,QAAQ,EACR,IAAI,CAAC,OAAO,EACZ,aAAa,CACd,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IAEO,gBAAgB;QACtB,OAAO,CAAC,QAAkB,EAAE,EAAE;YAC5B,OAAO,uBAAe,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChD,CAAC,CAAC;IACJ,CAAC;;AAlEH,wDAmEC;AAhEiB,gCAAS,GAAG,OAAO,CAAC"}

package/build/src/types.d.ts

@@ -0,0 +1,54 @@
+/// <reference types="node" />
+import type * as ioredisTypes from 'ioredis';
+import { InstrumentationConfig } from '@opentelemetry/instrumentation';
+import { Span } from '@opentelemetry/api';
+export interface IORedisCommand {
+    reject: (err: Error) => void;
+    resolve: (result: {}) => void;
+    promise: Promise<{}>;
+    args: Array<string | Buffer | number>;
+    callback: ioredisTypes.CallbackFunction<unknown>;
+    name: string;
+}
+/**
+ * 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 declare type DbStatementSerializer = (cmdName: IORedisCommand['name'], cmdArgs: IORedisCommand['args']) => string;
+export interface IORedisRequestHookInformation {
+    moduleVersion?: string;
+    cmdName: IORedisCommand['name'];
+    cmdArgs: IORedisCommand['args'];
+}
+export interface RedisRequestCustomAttributeFunction {
+    (span: Span, requestInfo: IORedisRequestHookInformation): void;
+}
+/**
+ * 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: IORedisCommand['name'], cmdArgs: IORedisCommand['args'], response: unknown): void;
+}
+/**
+ * Options available for the IORedis Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-ioredis#ioredis-instrumentation-options))
+ */
+export interface IORedisInstrumentationConfig extends InstrumentationConfig {
+    /** Custom serializer function for the db.statement tag */
+    dbStatementSerializer?: DbStatementSerializer;
+    /** Function for adding custom attributes on db request */
+    requestHook?: RedisRequestCustomAttributeFunction;
+    /** Function for adding custom attributes on db response */
+    responseHook?: RedisResponseCustomAttributeFunction;
+    /** Require parent to create ioredis span, default when unset is true */
+    requireParentSpan?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/src/types.js

@@ -0,0 +1,18 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG"}

package/build/src/utils.d.ts

@@ -0,0 +1,6 @@
+import type * as ioredisTypes from 'ioredis';
+import { Tracer } from '@opentelemetry/api';
+import { IORedisCommand, IORedisInstrumentationConfig } from './types';
+export declare const traceConnection: (tracer: Tracer, original: Function) => (this: ioredisTypes.Redis) => any;
+export declare const traceSendCommand: (tracer: Tracer, original: Function, config?: IORedisInstrumentationConfig | undefined, moduleVersion?: string | undefined) => (this: ioredisTypes.Redis, cmd?: IORedisCommand | undefined) => any;
+//# sourceMappingURL=utils.d.ts.map

package/build/src/utils.js

@@ -0,0 +1,124 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.traceSendCommand = exports.traceConnection = void 0;
+const api_1 = require("@opentelemetry/api");
+const _1 = require("./");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const endSpan = (span, err) => {
+    if (err) {
+        span.recordException(err);
+        span.setStatus({
+            code: api_1.SpanStatusCode.ERROR,
+            message: err.message,
+        });
+    }
+    span.end();
+};
+const traceConnection = (tracer, original) => {
+    return function () {
+        const span = tracer.startSpan('connect', {
+            kind: api_1.SpanKind.CLIENT,
+            attributes: {
+                [semantic_conventions_1.SemanticAttributes.DB_SYSTEM]: _1.IORedisInstrumentation.DB_SYSTEM,
+                [semantic_conventions_1.SemanticAttributes.DB_STATEMENT]: 'connect',
+            },
+        });
+        const { host, port } = this.options;
+        span.setAttributes({
+            [semantic_conventions_1.SemanticAttributes.NET_PEER_NAME]: host,
+            [semantic_conventions_1.SemanticAttributes.NET_PEER_PORT]: port,
+            [semantic_conventions_1.SemanticAttributes.NET_PEER_IP]: `redis://${host}:${port}`,
+        });
+        try {
+            const client = original.apply(this, arguments);
+            endSpan(span, null);
+            return client;
+        }
+        catch (error) {
+            endSpan(span, error);
+            throw error;
+        }
+    };
+};
+exports.traceConnection = traceConnection;
+const defaultDbStatementSerializer = (cmdName, cmdArgs) => Array.isArray(cmdArgs) && cmdArgs.length
+    ? `${cmdName} ${cmdArgs.join(' ')}`
+    : cmdName;
+const traceSendCommand = (tracer, original, config, moduleVersion) => {
+    const dbStatementSerializer = (config === null || config === void 0 ? void 0 : config.dbStatementSerializer) || defaultDbStatementSerializer;
+    return function (cmd) {
+        if (arguments.length < 1 || typeof cmd !== 'object') {
+            return original.apply(this, arguments);
+        }
+        const hasNoParentSpan = api_1.trace.getSpan(api_1.context.active()) === undefined;
+        if ((config === null || config === void 0 ? void 0 : config.requireParentSpan) === true && hasNoParentSpan) {
+            return original.apply(this, arguments);
+        }
+        const span = tracer.startSpan(cmd.name, {
+            kind: api_1.SpanKind.CLIENT,
+            attributes: {
+                [semantic_conventions_1.SemanticAttributes.DB_SYSTEM]: _1.IORedisInstrumentation.DB_SYSTEM,
+                [semantic_conventions_1.SemanticAttributes.DB_STATEMENT]: dbStatementSerializer(cmd.name, cmd.args),
+            },
+        });
+        if (config === null || config === void 0 ? void 0 : config.requestHook) {
+            instrumentation_1.safeExecuteInTheMiddle(() => config === null || config === void 0 ? void 0 : config.requestHook(span, {
+                moduleVersion,
+                cmdName: cmd.name,
+                cmdArgs: cmd.args,
+            }), e => {
+                if (e) {
+                    api_1.diag.error('ioredis instrumentation: request hook failed', e);
+                }
+            }, true);
+        }
+        const { host, port } = this.options;
+        span.setAttributes({
+            [semantic_conventions_1.SemanticAttributes.NET_PEER_NAME]: host,
+            [semantic_conventions_1.SemanticAttributes.NET_PEER_PORT]: port,
+            [semantic_conventions_1.SemanticAttributes.NET_PEER_IP]: `redis://${host}:${port}`,
+        });
+        try {
+            const result = original.apply(this, arguments);
+            const origResolve = cmd.resolve;
+            /* eslint-disable @typescript-eslint/no-explicit-any */
+            cmd.resolve = function (result) {
+                instrumentation_1.safeExecuteInTheMiddle(() => { var _a; return (_a = config === null || config === void 0 ? void 0 : config.responseHook) === null || _a === void 0 ? void 0 : _a.call(config, span, cmd.name, cmd.args, result); }, e => {
+                    if (e) {
+                        api_1.diag.error('ioredis instrumentation: response hook failed', e);
+                    }
+                }, true);
+                endSpan(span, null);
+                origResolve(result);
+            };
+            const origReject = cmd.reject;
+            cmd.reject = function (err) {
+                endSpan(span, err);
+                origReject(err);
+            };
+            return result;
+        }
+        catch (error) {
+            endSpan(span, error);
+            throw error;
+        }
+    };
+};
+exports.traceSendCommand = traceSendCommand;
+//# sourceMappingURL=utils.js.map

package/build/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAGH,4CAQ4B;AAM5B,yBAA4C;AAC5C,8EAAyE;AACzE,oEAAwE;AAExE,MAAM,OAAO,GAAG,CAAC,IAAU,EAAE,GAA6C,EAAE,EAAE;IAC5E,IAAI,GAAG,EAAE;QACP,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,oBAAc,CAAC,KAAK;YAC1B,OAAO,EAAE,GAAG,CAAC,OAAO;SACrB,CAAC,CAAC;KACJ;IACD,IAAI,CAAC,GAAG,EAAE,CAAC;AACb,CAAC,CAAC;AAEK,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,QAAkB,EAAE,EAAE;IACpE,OAAO;QACL,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE;YACvC,IAAI,EAAE,cAAQ,CAAC,MAAM;YACrB,UAAU,EAAE;gBACV,CAAC,yCAAkB,CAAC,SAAS,CAAC,EAAE,yBAAsB,CAAC,SAAS;gBAChE,CAAC,yCAAkB,CAAC,YAAY,CAAC,EAAE,SAAS;aAC7C;SACF,CAAC,CAAC;QACH,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAEpC,IAAI,CAAC,aAAa,CAAC;YACjB,CAAC,yCAAkB,CAAC,aAAa,CAAC,EAAE,IAAI;YACxC,CAAC,yCAAkB,CAAC,aAAa,CAAC,EAAE,IAAI;YACxC,CAAC,yCAAkB,CAAC,WAAW,CAAC,EAAE,WAAW,IAAI,IAAI,IAAI,EAAE;SAC5D,CAAC,CAAC;QACH,IAAI;YACF,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC/C,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACpB,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACrB,MAAM,KAAK,CAAC;SACb;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAzBW,QAAA,eAAe,mBAyB1B;AAEF,MAAM,4BAA4B,GAA0B,CAC1D,OAAO,EACP,OAAO,EACP,EAAE,CACF,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM;IACtC,CAAC,CAAC,GAAG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;IACnC,CAAC,CAAC,OAAO,CAAC;AAEP,MAAM,gBAAgB,GAAG,CAC9B,MAAc,EACd,QAAkB,EAClB,MAAqC,EACrC,aAAsB,EACtB,EAAE;IACF,MAAM,qBAAqB,GACzB,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,qBAAqB,KAAI,4BAA4B,CAAC;IAChE,OAAO,UAAoC,GAAoB;QAC7D,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YACnD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;SACxC;QAED,MAAM,eAAe,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,CAAC,KAAK,SAAS,CAAC;QACtE,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,iBAAiB,MAAK,IAAI,IAAI,eAAe,EAAE;YACzD,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;SACxC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE;YACtC,IAAI,EAAE,cAAQ,CAAC,MAAM;YACrB,UAAU,EAAE;gBACV,CAAC,yCAAkB,CAAC,SAAS,CAAC,EAAE,yBAAsB,CAAC,SAAS;gBAChE,CAAC,yCAAkB,CAAC,YAAY,CAAC,EAAE,qBAAqB,CACtD,GAAG,CAAC,IAAI,EACR,GAAG,CAAC,IAAI,CACT;aACF;SACF,CAAC,CAAC;QAEH,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,EAAE;YACvB,wCAAsB,CACpB,GAAG,EAAE,CACH,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,CAAE,IAAI,EAAE;gBACzB,aAAa;gBACb,OAAO,EAAE,GAAG,CAAC,IAAI;gBACjB,OAAO,EAAE,GAAG,CAAC,IAAI;aAClB,CAAC,EACJ,CAAC,CAAC,EAAE;gBACF,IAAI,CAAC,EAAE;oBACL,UAAI,CAAC,KAAK,CAAC,8CAA8C,EAAE,CAAC,CAAC,CAAC;iBAC/D;YACH,CAAC,EACD,IAAI,CACL,CAAC;SACH;QAED,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAEpC,IAAI,CAAC,aAAa,CAAC;YACjB,CAAC,yCAAkB,CAAC,aAAa,CAAC,EAAE,IAAI;YACxC,CAAC,yCAAkB,CAAC,aAAa,CAAC,EAAE,IAAI;YACxC,CAAC,yCAAkB,CAAC,WAAW,CAAC,EAAE,WAAW,IAAI,IAAI,IAAI,EAAE;SAC5D,CAAC,CAAC;QAEH,IAAI;YACF,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAE/C,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC;YAChC,uDAAuD;YACvD,GAAG,CAAC,OAAO,GAAG,UAAU,MAAW;gBACjC,wCAAsB,CACpB,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;oBACF,IAAI,CAAC,EAAE;wBACL,UAAI,CAAC,KAAK,CAAC,+CAA+C,EAAE,CAAC,CAAC,CAAC;qBAChE;gBACH,CAAC,EACD,IAAI,CACL,CAAC;gBAEF,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACpB,WAAW,CAAC,MAAM,CAAC,CAAC;YACtB,CAAC,CAAC;YAEF,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC;YAC9B,GAAG,CAAC,MAAM,GAAG,UAAU,GAAU;gBAC/B,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBACnB,UAAU,CAAC,GAAG,CAAC,CAAC;YAClB,CAAC,CAAC;YAEF,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACrB,MAAM,KAAK,CAAC;SACb;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAtFW,QAAA,gBAAgB,oBAsF3B"}

package/build/src/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.25.0";
+//# sourceMappingURL=version.d.ts.map

package/build/src/version.js

@@ -0,0 +1,21 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+// this is autogenerated file, see scripts/version-update.js
+exports.VERSION = '0.25.0';
+//# sourceMappingURL=version.js.map

package/build/src/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4DAA4D;AAC/C,QAAA,OAAO,GAAG,QAAQ,CAAC"}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@opentelemetry/instrumentation-ioredis",
+  "version": "0.25.0",
+  "description": "OpenTelemetry ioredis automatic instrumentation package.",
+  "main": "build/src/index.js",
+  "types": "build/src/index.d.ts",
+  "repository": "open-telemetry/opentelemetry-js-contrib",
+  "scripts": {
+    "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
+    "test:debug": "cross-env RUN_REDIS_TESTS_LOCAL=true ts-mocha --inspect-brk --no-timeouts -p tsconfig.json 'test/**/*.test.ts'",
+    "test:local": "cross-env RUN_REDIS_TESTS_LOCAL=true npm run test",
+    "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",
+    "precompile": "tsc --version",
+    "version:update": "node ../../../scripts/version-update.js",
+    "compile": "npm run version:update && tsc -p .",
+    "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
+    "prepare": "npm run compile"
+  },
+  "keywords": [
+    "opentelemetry",
+    "ioredis",
+    "redis",
+    "nodejs",
+    "tracing",
+    "profiling",
+    "instrumentation"
+  ],
+  "author": "OpenTelemetry Authors",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "files": [
+    "build/src/**/*.js",
+    "build/src/**/*.js.map",
+    "build/src/**/*.d.ts",
+    "doc",
+    "LICENSE",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.0.2"
+  },
+  "devDependencies": {
+    "@opentelemetry/api": "1.0.2",
+    "@opentelemetry/context-async-hooks": "0.25.0",
+    "@opentelemetry/contrib-test-utils": "^0.25.0",
+    "@opentelemetry/sdk-trace-base": "0.25.0",
+    "@opentelemetry/sdk-trace-node": "0.25.0",
+    "@types/mocha": "7.0.2",
+    "@types/node": "14.17.9",
+    "codecov": "3.8.3",
+    "cross-env": "7.0.3",
+    "gts": "3.1.0",
+    "ioredis": "4.27.7",
+    "mocha": "7.2.0",
+    "nyc": "15.1.0",
+    "rimraf": "3.0.2",
+    "test-all-versions": "5.0.1",
+    "ts-mocha": "8.0.0",
+    "typescript": "4.3.5"
+  },
+  "dependencies": {
+    "@opentelemetry/instrumentation": "^0.25.0",
+    "@opentelemetry/semantic-conventions": "^0.25.0",
+    "@types/ioredis": "4.26.6"
+  },
+  "gitHead": "fcfaeb965804d2a081f1dc8d2b82803cd51681af"
+}