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

feat: amqplib instrumentation #892

Merged
merged 45 commits into from
Mar 14, 2022
Merged
Show file tree
Hide file tree
Changes from 40 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
8ce5b2e
feat: amqplib instrumentation
Feb 13, 2022
9541d95
Merge remote-tracking branch 'upstream/main' into amqplib
Feb 13, 2022
0d39760
chore(amqplib): lint fix
Feb 13, 2022
e633fee
chore(amqplib): add to release please
Feb 13, 2022
bea8583
docs(amqplib): add instrumentation to main README
Feb 13, 2022
8d2a9c1
chore(amqplib): set component owner
Feb 13, 2022
f6ca8e6
feat(auto-instrumentation-node): ass amqplib
Feb 13, 2022
89c4f50
fix(amqplib): no support for node8
Feb 13, 2022
6fd6feb
fix(amqplib): remove console log
Feb 13, 2022
12a95a7
feat: change hook signature with info pattern
Feb 13, 2022
86135e1
refactor(amqplib): move instrumented module version to hook
Feb 13, 2022
6dfcb12
fix(amqplib): add missing moduleVersion in publish hook
Feb 13, 2022
b67f20f
docs(amqplib): add README for instrumentation
Feb 13, 2022
3c891d7
docs(amqplib): add missing README file to git
Feb 13, 2022
61f53a6
chore(amqplib): add test all versions configuration
Feb 13, 2022
9201ed9
fix: revert husky file delete
Feb 13, 2022
6e4e11a
docs(amqplib): fix README lint
Feb 13, 2022
55aea9e
fix(auto-instrumentations-node): fix test and add new inst to README
Feb 13, 2022
2416e9c
chore(amqplib): add LICENSE
Feb 13, 2022
8a51b68
chore(amqplib): add LICENSE
Feb 13, 2022
fb3afde
refactor(amqplib): tests
Feb 13, 2022
abd1c3d
fix(amqplib): missing file
Feb 13, 2022
6c2c8e6
fix(amqplib): hooks verify paraams before setAttribute
Feb 13, 2022
352d5e6
fix(amqplib): used modified options for hook
Feb 13, 2022
eb71c75
Merge remote-tracking branch 'upstream/main' into amqplib
Feb 13, 2022
783dd52
chore(amqplib): fill copyright template
Feb 14, 2022
262b2da
fix(amqplib): check error with == null
Feb 14, 2022
30bb3c8
refactor(amqplib): set to undefined instead of delete
Feb 14, 2022
c340816
refactor(amqplib): don't use defineProperty for symbols
Feb 14, 2022
73b7935
revert(amqplib): revert package name change for testing
Feb 14, 2022
dca5504
chore(amqplib): lint fix
Feb 14, 2022
6869792
refactor(amqplib): cleanup setting config in instrumentations
Feb 14, 2022
3b44cda
chore(amqplib): move amqplib from release please manifest to config
Feb 14, 2022
4f474ed
revert(amqplib): revert release please manifest
Feb 14, 2022
cf50166
chore(amqplib): restore removed copyright word in LICENSE
Feb 14, 2022
d3ef963
fix(amqplib): use root context to extract propagation headers
Feb 14, 2022
3aa9d96
Merge remote-tracking branch 'upstream/main' into amqplib
Feb 21, 2022
59f32cc
chore(amqplib): remove codecov
Feb 21, 2022
17270b9
feat(amqplib): use performance time instead of Date
Feb 21, 2022
5481878
chore(amqplib): lint fix
Feb 21, 2022
ca8919b
Merge remote-tracking branch 'upstream/main' into amqplib
Feb 28, 2022
9daf145
chore: add amqplib to release please manifest
Feb 28, 2022
650cbe6
Merge remote-tracking branch 'upstream/main' into amqplib
Mar 13, 2022
d7df46a
fix(amqplib): rename Consumer to Consume for consistency
Mar 14, 2022
b6f85e0
Merge branch 'main' into amqplib
Mar 14, 2022
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
2 changes: 2 additions & 0 deletions .github/component_owners.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ components:
packages/opentelemetry-id-generator-aws-xray:
- NathanielRN
- willarmiros
plugins/node/instrumentation-amqplib:
- blumamir
plugins/node/instrumentation-tedious:
- rauno56
plugins/node/opentelemetry-instrumentation-aws-lambda:
Expand Down
8 changes: 8 additions & 0 deletions .github/workflows/unit-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
--ignore @opentelemetry/instrumentation-aws-sdk
--ignore @opentelemetry/instrumentation-pino
--ignore @opentelemetry/instrumentation-tedious
--ignore @opentelemetry/instrumentation-amqplib
- node: "10"
lerna-extra-args: >-
--ignore @opentelemetry/instrumentation-pino
Expand Down Expand Up @@ -81,6 +82,13 @@ jobs:
image: bitnami/cassandra:3
ports:
- 9042:9042
rabbitmq:
image: rabbitmq:3
ports:
- 22221:5672
env:
RABBITMQ_DEFAULT_USER: username
RABBITMQ_DEFAULT_PASS: password
env:
RUN_CASSANDRA_TESTS: 1
RUN_MEMCACHED_TESTS: 1
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ OpenTelemetry can collect tracing data automatically using instrumentations. Ven

### Node Instrumentations

- [@opentelemetry/instrumentation-amqplib][otel-contrib-instrumentation-amqplib]
- [@opentelemetry/instrumentation-aws-lambda][otel-contrib-instrumentation-aws-lambda]
- [@opentelemetry/instrumentation-aws-sdk][otel-contrib-instrumentation-aws-sdk]
- [@opentelemetry/instrumentation-bunyan][otel-contrib-instrumentation-bunyan]
Expand Down Expand Up @@ -160,6 +161,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[otel-instrumentation-http]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-http
[otel-instrumentation-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-xml-http-request

[otel-contrib-instrumentation-amqplib]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-amqplib
[otel-contrib-instrumentation-aws-lambda]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-lambda
[otel-contrib-instrumentation-aws-sdk]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-sdk
[otel-contrib-instrumentation-bunyan]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-bunyan
Expand Down
1 change: 1 addition & 0 deletions metapackages/auto-instrumentations-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ registerInstrumentations({

## Supported instrumentations

- [@opentelemetry/instrumentation-amqplib](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-amqplib)
- [@opentelemetry/instrumentation-aws-lambda](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-lambda)
- [@opentelemetry/instrumentation-aws-sdk](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-sdk)
- [@opentelemetry/instrumentation-bunyan](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-bunyan)
Expand Down
1 change: 1 addition & 0 deletions metapackages/auto-instrumentations-node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
},
"dependencies": {
"@opentelemetry/instrumentation": "^0.27.0",
"@opentelemetry/instrumentation-amqplib": "^0.27.0",
"@opentelemetry/instrumentation-aws-lambda": "^0.29.0",
"@opentelemetry/instrumentation-aws-sdk": "^0.5.0",
"@opentelemetry/instrumentation-bunyan": "^0.27.0",
Expand Down
2 changes: 2 additions & 0 deletions metapackages/auto-instrumentations-node/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

import { diag } from '@opentelemetry/api';
import { Instrumentation } from '@opentelemetry/instrumentation';
import { AmqplibInstrumentation } from '@opentelemetry/instrumentation-amqplib';
import { AwsLambdaInstrumentation } from '@opentelemetry/instrumentation-aws-lambda';
import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';
import { BunyanInstrumentation } from '@opentelemetry/instrumentation-bunyan';
Expand Down Expand Up @@ -45,6 +46,7 @@ import { RestifyInstrumentation } from '@opentelemetry/instrumentation-restify';
import { WinstonInstrumentation } from '@opentelemetry/instrumentation-winston';

const InstrumentationMap = {
'@opentelemetry/instrumentation-amqplib': AmqplibInstrumentation,
'@opentelemetry/instrumentation-aws-lambda': AwsLambdaInstrumentation,
'@opentelemetry/instrumentation-aws-sdk': AwsInstrumentation,
'@opentelemetry/instrumentation-bunyan': BunyanInstrumentation,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ describe('utils', () => {
it('should load default instrumentations', () => {
const instrumentations = getNodeAutoInstrumentations();
const expectedInstrumentations = [
'@opentelemetry/instrumentation-amqplib',
'@opentelemetry/instrumentation-aws-lambda',
'@opentelemetry/instrumentation-aws-sdk',
'@opentelemetry/instrumentation-bunyan',
Expand Down Expand Up @@ -53,7 +54,7 @@ describe('utils', () => {
'@opentelemetry/instrumentation-restify',
'@opentelemetry/instrumentation-winston',
];
assert.strictEqual(instrumentations.length, 27);
assert.strictEqual(instrumentations.length, 28);
for (let i = 0, j = instrumentations.length; i < j; i++) {
assert.strictEqual(
instrumentations[i].instrumentationName,
Expand Down
1 change: 1 addition & 0 deletions plugins/node/instrumentation-amqplib/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
build
7 changes: 7 additions & 0 deletions plugins/node/instrumentation-amqplib/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module.exports = {
"env": {
"mocha": true,
"node": true
},
...require('../../../eslint.config.js')
}
4 changes: 4 additions & 0 deletions plugins/node/instrumentation-amqplib/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/bin
/coverage
/doc
/test
4 changes: 4 additions & 0 deletions plugins/node/instrumentation-amqplib/.tav.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
'amqplib':
versions: ">=0.5.5"
commands:
- yarn test
201 changes: 201 additions & 0 deletions plugins/node/instrumentation-amqplib/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 [2022] 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

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.
Loading