Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add ioredis to instrumentation list #558

Merged
merged 91 commits into from
Dec 24, 2019
Merged
Show file tree
Hide file tree
Changes from 78 commits
Commits
Show all changes
91 commits
Select commit Hold shift + click to select a range
5194ce1
Add ioredis
naseemkullah Nov 21, 2019
b83c601
Merge branch 'master' into ioredis
naseemkullah Nov 21, 2019
78c8096
remove unused util
naseemkullah Nov 21, 2019
cee0a62
Merge branch 'master' into ioredis
naseemkullah Nov 21, 2019
51c5761
Console error when callback cannot be found in command object
naseemkullah Nov 22, 2019
3601d2e
fix
naseemkullah Nov 22, 2019
2d55757
Merge branch 'ioredis' of github.com:naseemkullah/opentelemetry-js in…
naseemkullah Nov 22, 2019
339d7e4
There never seems to be a this.address
naseemkullah Nov 22, 2019
81f025e
err can be made non-optional here since it is currently always passed in
naseemkullah Nov 22, 2019
9c22f7c
No address property
naseemkullah Nov 22, 2019
04210a0
Update packages
naseemkullah Nov 23, 2019
2912a72
Adjust value of DB_STATEMENT
naseemkullah Nov 23, 2019
c6547d4
Add DB_TYPE attribute
naseemkullah Nov 23, 2019
ea7dd9b
Handle async/await ioredis commands that have no cb
naseemkullah Nov 24, 2019
9646836
Fix promise handling and adjust attributes
naseemkullah Nov 25, 2019
f7a7d78
Use template literal
naseemkullah Nov 25, 2019
4bc1644
Add same comments as pg plugin for promise handling
naseemkullah Nov 25, 2019
d3bfc0b
Use endSpan function
naseemkullah Nov 25, 2019
cecbaad
Merge branch 'master' into ioredis
naseemkullah Nov 25, 2019
fe69ce9
fix: combine 2 lines into 1
naseemkullah Nov 26, 2019
ced0767
chore: update modules
naseemkullah Nov 26, 2019
407a0bc
Merge branch 'master' into ioredis
naseemkullah Nov 26, 2019
f028231
fix: tests
naseemkullah Nov 26, 2019
8e6154b
Merge branch 'ioredis' of github.com:naseemkullah/opentelemetry-js in…
naseemkullah Nov 26, 2019
fab7e83
style: rename error
naseemkullah Nov 26, 2019
5a1638b
docs: update min version
naseemkullah Nov 26, 2019
16a1f40
fix: nullish coalescing
naseemkullah Nov 26, 2019
a6b5f63
Revert "fix: nullish coalescing"
naseemkullah Nov 26, 2019
378ed8f
Merge branch 'master' into ioredis
naseemkullah Nov 26, 2019
b002cfa
fix: make DB_TYPE a const
naseemkullah Nov 28, 2019
f260d70
Merge branch 'ioredis' of github.com:naseemkullah/opentelemetry-js in…
naseemkullah Nov 28, 2019
bef1af5
fix: update links
naseemkullah Nov 28, 2019
94cda5b
fix: move ioredis to dependencies, update @types/ioredis
naseemkullah Nov 28, 2019
c872bf7
fix: add a comment about nullish coalescing
naseemkullah Nov 28, 2019
7609929
fix: move done from try/catch to finally
naseemkullah Nov 28, 2019
c62f65b
Merge branch 'master' into ioredis
naseemkullah Nov 28, 2019
b511231
fix: gts fix
naseemkullah Nov 28, 2019
09a0af3
Merge branch 'ioredis' of github.com:naseemkullah/opentelemetry-js in…
naseemkullah Nov 28, 2019
d32605c
Merge branch 'master' into ioredis
naseemkullah Nov 30, 2019
626bcc2
fix: callback type
naseemkullah Nov 30, 2019
3820fd5
style: move cb tests up
naseemkullah Nov 30, 2019
69f9043
fix: gts
naseemkullah Nov 30, 2019
e0d4bd0
fix: remove unused code
naseemkullah Nov 30, 2019
2ef5a5c
fix: update ts-node
naseemkullah Nov 30, 2019
a5ee375
fix: nested cb for cb style call tests
naseemkullah Nov 30, 2019
4771412
fix: prevent span leaking with better if statement, add else
naseemkullah Dec 2, 2019
c707c4e
Merge branch 'master' into ioredis
naseemkullah Dec 2, 2019
af7470d
fix: remove unneeded || undefined
naseemkullah Dec 5, 2019
b4ecd05
Merge branch 'master' into ioredis
naseemkullah Dec 5, 2019
540b0ca
fix: ioredis as dev dependency
naseemkullah Dec 6, 2019
75c220b
Merge branch 'master' into ioredis
naseemkullah Dec 6, 2019
8c0f1f4
fix: do not return a new promise, end span in .then handler
naseemkullah Dec 7, 2019
d6bdd0e
fix: if statement
naseemkullah Dec 7, 2019
22bc3ed
fix: guard against args not being an array
naseemkullah Dec 7, 2019
af0dfe7
fix: tests
naseemkullah Dec 7, 2019
2b68d77
Merge branch 'master' into ioredis
naseemkullah Dec 7, 2019
ea6b5f3
Update packages/opentelemetry-plugin-ioredis/README.md
naseemkullah Dec 9, 2019
afe9fd3
docs: remove sentence from Usage section
naseemkullah Dec 9, 2019
159d9d1
fix: remove unecessary check, rename functions
naseemkullah Dec 9, 2019
136d0b5
fix: rename functions
naseemkullah Dec 9, 2019
6378fb8
Merge branch 'master' into ioredis
naseemkullah Dec 12, 2019
9934327
fix: port type is number
naseemkullah Dec 12, 2019
949c9d4
docs: add link to available options
naseemkullah Dec 12, 2019
0fc75ea
fix: always convert string port to number
naseemkullah Dec 12, 2019
43b06a3
fix: improve inherit options type from ioredis types
naseemkullah Dec 13, 2019
b0c5311
fix: options always exists
naseemkullah Dec 13, 2019
c4a6c07
fix: options is always there and all we need
naseemkullah Dec 13, 2019
0728a13
test: streamify scanning
naseemkullah Dec 14, 2019
09c5386
test: lua
naseemkullah Dec 15, 2019
664cab5
test: cb tests were flawed
naseemkullah Dec 15, 2019
79fdef3
fix: trace cb invocations properly
naseemkullah Dec 15, 2019
537f193
refactor: same code handles cb and promise style invocations
naseemkullah Dec 15, 2019
0259654
fix: update packages
naseemkullah Dec 15, 2019
842a780
fix: db statement format
naseemkullah Dec 15, 2019
151b679
test: add pipeline test
naseemkullah Dec 15, 2019
2d76a4f
fix: allow arguments to be greater than 1
naseemkullah Dec 15, 2019
2b16305
fix: gts
naseemkullah Dec 16, 2019
d4a59c0
Merge branch 'master' into ioredis
naseemkullah Dec 16, 2019
2c9217c
test: trace client connection/disconnection
naseemkullah Dec 19, 2019
b5f616f
Merge branch 'master' into ioredis
naseemkullah Dec 19, 2019
3b47e26
feat: trace connection
naseemkullah Dec 19, 2019
f36bff1
Merge branch 'master' into ioredis
OlivierAlbertini Dec 20, 2019
7b3a94e
test: pubsub
naseemkullah Dec 21, 2019
1fafbd5
Merge branch 'ioredis' of github.com:naseemkullah/opentelemetry-js in…
naseemkullah Dec 21, 2019
dec624f
Merge branch 'master' into ioredis
naseemkullah Dec 21, 2019
d7af162
fix: quit instead of disconnect
naseemkullah Dec 21, 2019
37de078
Merge branch 'ioredis' of github.com:naseemkullah/opentelemetry-js in…
naseemkullah Dec 21, 2019
8585926
Merge branch 'master' into ioredis
naseemkullah Dec 24, 2019
d730512
Merge branch 'master' into ioredis
naseemkullah Dec 24, 2019
9cb26df
fix: update packages
naseemkullah Dec 24, 2019
23462da
feat: use test-utils package
naseemkullah Dec 24, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/opentelemetry-plugin-ioredis/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/bin
/coverage
/doc
/test
201 changes: 201 additions & 0 deletions packages/opentelemetry-plugin-ioredis/LICENSE
Original file line number Diff line number Diff line change
@@ -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.
61 changes: 61 additions & 0 deletions packages/opentelemetry-plugin-ioredis/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# OpenTelemetry ioredis Instrumentation for Node.js
[![Gitter chat][gitter-image]][gitter-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/node](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node) package.

## Installation

```
npm install --save @opentelemetry/plugin-ioredis
```

### Supported Versions
- `>=2.0.0`

## Usage

To load a specific plugin (**ioredis** in this case), specify it in the Node Tracer's configuration
```js
const { NodeTracer } = require('@opentelemetry/node');

const tracer = new NodeTracer({
plugins: {
ioredis: {
enabled: true,
// You may use a package name or absolute path to the file.
path: '@opentelemetry/plugin-ioredis',
}
}
});
```

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.
```javascript
const { NodeTracer } = require('@opentelemetry/node');

const tracer = new NodeTracer();
```

## 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 on [gitter][gitter-url]

## License

Apache 2.0 - See [LICENSE][license-url] for more information.

[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-plugin-ioredis
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-ioredis
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-plugin-ioredis
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-ioredis&type=dev
70 changes: 70 additions & 0 deletions packages/opentelemetry-plugin-ioredis/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"name": "@opentelemetry/plugin-ioredis",
"version": "0.2.0",
"description": "OpenTelemetry ioredis automatic instrumentation package.",
"main": "build/src/index.js",
"types": "build/src/index.d.ts",
"repository": "open-telemetry/opentelemetry-js",
"scripts": {
"test": "nyc ts-mocha -p tsconfig.json '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 yarn test",
"tdd": "yarn test -- --watch-extensions ts --watch",
"clean": "rimraf build/*",
"check": "gts check",
"precompile": "tsc --version",
"compile": "tsc -p .",
"codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
"fix": "gts fix",
"prepare": "npm run compile"
},
"keywords": [
"opentelemetry",
"ioredis",
"redis",
"nodejs",
"tracing",
"profiling",
"plugin"
],
"author": "OpenTelemetry Authors",
"license": "Apache-2.0",
"engines": {
"node": ">=8.0.0"
},
"files": [
"build/src/**/*.js",
"build/src/**/*.d.ts",
"doc",
"LICENSE",
"README.md"
],
"publishConfig": {
"access": "public"
},
"devDependencies": {
"@opentelemetry/node": "^0.3.0",
"@opentelemetry/tracing": "^0.3.0",
"@types/ioredis": "^4.14.2",
"@types/mocha": "^5.2.7",
"@types/node": "^12.12.17",
"@types/shimmer": "^1.0.1",
"codecov": "^3.6.1",
"cross-env": "^6.0.3",
"gts": "^1.1.2",
"ioredis": "^4.14.1",
naseemkullah marked this conversation as resolved.
Show resolved Hide resolved
"mocha": "^6.2.2",
"nyc": "^14.1.1",
"rimraf": "^3.0.0",
"ts-mocha": "^6.0.0",
"ts-node": "^8.5.4",
"tslint-consistent-codestyle": "^1.16.0",
"tslint-microsoft-contrib": "^6.2.0",
"typescript": "3.7.3"
},
"dependencies": {
"@opentelemetry/core": "^0.3.0",
"@opentelemetry/types": "^0.3.0",
"shimmer": "^1.2.1"
}
}
32 changes: 32 additions & 0 deletions packages/opentelemetry-plugin-ioredis/src/enums.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*!
* Copyright 2019, 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 enum AttributeNames {
// required by https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md#databases-client-calls
COMPONENT = 'component',
DB_TYPE = 'db.type',
DB_INSTANCE = 'db.instance',
DB_STATEMENT = 'db.statement',
PEER_ADDRESS = 'peer.address',
PEER_HOSTNAME = 'peer.host',

// optional
DB_USER = 'db.user',
PEER_PORT = 'peer.port',
PEER_IPV4 = 'peer.ipv4',
PEER_IPV6 = 'peer.ipv6',
PEER_SERVICE = 'peer.service',
}
17 changes: 17 additions & 0 deletions packages/opentelemetry-plugin-ioredis/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*!
* Copyright 2019, 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 * from './ioredis';
Loading