Skip to content

Commit 3ca2df4

Browse files
naseemkullahdyladanOlivierAlbertini
committed
Add ioredis (#558)
* Add ioredis * remove unused util * Console error when callback cannot be found in command object * fix * There never seems to be a this.address * err can be made non-optional here since it is currently always passed in * No address property * Update packages * Adjust value of DB_STATEMENT * Add DB_TYPE attribute * Handle async/await ioredis commands that have no cb * Fix promise handling and adjust attributes * Use template literal * Add same comments as pg plugin for promise handling * Use endSpan function * fix: combine 2 lines into 1 * chore: update modules * fix: tests * style: rename error * docs: update min version * fix: nullish coalescing * Revert "fix: nullish coalescing" This reverts commit 16a1f40. * fix: make DB_TYPE a const * fix: update links * fix: move ioredis to dependencies, update @types/ioredis * fix: add a comment about nullish coalescing * fix: move done from try/catch to finally * fix: gts fix * fix: callback type * style: move cb tests up * fix: gts * fix: remove unused code * fix: update ts-node * fix: nested cb for cb style call tests * fix: prevent span leaking with better if statement, add else * fix: remove unneeded || undefined * fix: ioredis as dev dependency * fix: do not return a new promise, end span in .then handler * fix: if statement * fix: guard against args not being an array * fix: tests * Update packages/opentelemetry-plugin-ioredis/README.md Reword sentence to read better Co-Authored-By: Daniel Dyla <[email protected]> * docs: remove sentence from Usage section * fix: remove unecessary check, rename functions * fix: rename functions * fix: port type is number * docs: add link to available options * fix: always convert string port to number * fix: improve inherit options type from ioredis types * fix: options always exists * fix: options is always there and all we need * test: streamify scanning * test: lua * test: cb tests were flawed * fix: trace cb invocations properly * refactor: same code handles cb and promise style invocations * fix: update packages * fix: db statement format * test: add pipeline test * fix: allow arguments to be greater than 1 * fix: gts * test: trace client connection/disconnection * feat: trace connection * test: pubsub * fix: quit instead of disconnect * fix: update packages * feat: use test-utils package Co-authored-by: Daniel Dyla <[email protected]> Co-authored-by: Olivier Albertini <[email protected]>
1 parent 67d2256 commit 3ca2df4

File tree

12 files changed

+1147
-0
lines changed

12 files changed

+1147
-0
lines changed

‎packages/opentelemetry-plugin-ioredis/.npmignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/bin
2+
/coverage
3+
/doc
4+
/test

‎packages/opentelemetry-plugin-ioredis/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/opentelemetry-plugin-ioredis/README.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# OpenTelemetry ioredis Instrumentation for Node.js
2+
[![Gitter chat][gitter-image]][gitter-url]
3+
[![dependencies][dependencies-image]][dependencies-url]
4+
[![devDependencies][devDependencies-image]][devDependencies-url]
5+
[![Apache License][license-image]][license-image]
6+
7+
This module provides automatic instrumentation for [`ioredis`](https://github.com/luin/ioredis).
8+
9+
For automatic instrumentation see the
10+
[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node) package.
11+
12+
## Installation
13+
14+
```
15+
npm install --save @opentelemetry/plugin-ioredis
16+
```
17+
18+
### Supported Versions
19+
- `>=2.0.0`
20+
21+
## Usage
22+
23+
To load a specific plugin (**ioredis** in this case), specify it in the Node Tracer's configuration
24+
```js
25+
const { NodeTracer } = require('@opentelemetry/node');
26+
27+
const tracer = new NodeTracer({
28+
plugins: {
29+
ioredis: {
30+
enabled: true,
31+
// You may use a package name or absolute path to the file.
32+
path: '@opentelemetry/plugin-ioredis',
33+
}
34+
}
35+
});
36+
```
37+
38+
To load all the [supported plugins](https://github.com/open-telemetry/opentelemetry-js#plugins), use below approach. Each plugin is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing plugins for unused modules.
39+
```javascript
40+
const { NodeTracer } = require('@opentelemetry/node');
41+
42+
const tracer = new NodeTracer();
43+
```
44+
45+
## Useful links
46+
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
47+
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
48+
- For help or feedback on this project, join us on [gitter][gitter-url]
49+
50+
## License
51+
52+
Apache 2.0 - See [LICENSE][license-url] for more information.
53+
54+
[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg
55+
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
56+
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE
57+
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
58+
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-plugin-ioredis
59+
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-ioredis
60+
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-plugin-ioredis
61+
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-ioredis&type=dev

‎packages/opentelemetry-plugin-ioredis/package.json‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
{
2+
"name": "@opentelemetry/plugin-ioredis",
3+
"version": "0.3.1",
4+
"description": "OpenTelemetry ioredis automatic instrumentation package.",
5+
"main": "build/src/index.js",
6+
"types": "build/src/index.d.ts",
7+
"repository": "open-telemetry/opentelemetry-js",
8+
"scripts": {
9+
"test": "nyc ts-mocha -p tsconfig.json 'test/**/*.ts'",
10+
"test:debug": "cross-env RUN_REDIS_TESTS_LOCAL=true ts-mocha --inspect-brk --no-timeouts -p tsconfig.json 'test/**/*.test.ts'",
11+
"test:local": "cross-env RUN_REDIS_TESTS_LOCAL=true yarn test",
12+
"tdd": "yarn test -- --watch-extensions ts --watch",
13+
"clean": "rimraf build/*",
14+
"check": "gts check",
15+
"precompile": "tsc --version",
16+
"compile": "tsc -p .",
17+
"codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
18+
"fix": "gts fix",
19+
"prepare": "npm run compile"
20+
},
21+
"keywords": [
22+
"opentelemetry",
23+
"ioredis",
24+
"redis",
25+
"nodejs",
26+
"tracing",
27+
"profiling",
28+
"plugin"
29+
],
30+
"author": "OpenTelemetry Authors",
31+
"license": "Apache-2.0",
32+
"engines": {
33+
"node": ">=8.0.0"
34+
},
35+
"files": [
36+
"build/src/**/*.js",
37+
"build/src/**/*.d.ts",
38+
"doc",
39+
"LICENSE",
40+
"README.md"
41+
],
42+
"publishConfig": {
43+
"access": "public"
44+
},
45+
"devDependencies": {
46+
"@opentelemetry/node": "^0.3.1",
47+
"@opentelemetry/test-utils": "^0.3.1",
48+
"@opentelemetry/tracing": "^0.3.1",
49+
"@types/ioredis": "^4.14.3",
50+
"@types/mocha": "^5.2.7",
51+
"@types/node": "^13.1.0",
52+
"@types/shimmer": "^1.0.1",
53+
"codecov": "^3.6.1",
54+
"cross-env": "^6.0.3",
55+
"gts": "^1.1.2",
56+
"ioredis": "^4.14.1",
57+
"mocha": "^6.2.2",
58+
"nyc": "^15.0.0",
59+
"rimraf": "^3.0.0",
60+
"ts-mocha": "^6.0.0",
61+
"ts-node": "^8.5.4",
62+
"tslint-consistent-codestyle": "^1.16.0",
63+
"tslint-microsoft-contrib": "^6.2.0",
64+
"typescript": "3.7.4"
65+
},
66+
"dependencies": {
67+
"@opentelemetry/core": "^0.3.1",
68+
"@opentelemetry/types": "^0.3.1",
69+
"shimmer": "^1.2.1"
70+
}
71+
}

‎packages/opentelemetry-plugin-ioredis/src/enums.ts‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/*!
2+
* Copyright 2019, OpenTelemetry Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
export enum AttributeNames {
18+
// required by https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md#databases-client-calls
19+
COMPONENT = 'component',
20+
DB_TYPE = 'db.type',
21+
DB_INSTANCE = 'db.instance',
22+
DB_STATEMENT = 'db.statement',
23+
PEER_ADDRESS = 'peer.address',
24+
PEER_HOSTNAME = 'peer.host',
25+
26+
// optional
27+
DB_USER = 'db.user',
28+
PEER_PORT = 'peer.port',
29+
PEER_IPV4 = 'peer.ipv4',
30+
PEER_IPV6 = 'peer.ipv6',
31+
PEER_SERVICE = 'peer.service',
32+
}

‎packages/opentelemetry-plugin-ioredis/src/index.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/*!
2+
* Copyright 2019, OpenTelemetry Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
export * from './ioredis';

0 commit comments

Comments
 (0)