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

Add missing references to instrumented packages #1416

Merged

Conversation

NathanielRN
Copy link
Contributor

Description

I'm not sure what this list is for, but it seemed like an incomplete list of the packages for which we have instrumentation for. Added the missing packages (aiohttp-client, aiopg, sklearn, system-metrics) according to those packages in the Contrib repo!

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Unit tests cover this change

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
    - [] Unit tests have been added
    - [ ] Documentation has been updated

@NathanielRN NathanielRN requested review from a team, toumorokoshi and lzchen and removed request for a team November 25, 2020 04:34
@toumorokoshi
Copy link
Member

toumorokoshi commented Nov 25, 2020

Looking through it, I agree the code isn't documented enough to tell you what it's for.

Conceptually, I believe this is part of a tool that looks at installed packages, and handles installing the appropriate instrumentations for you.

This helps for those who prefer to turn on as much instrumentation as possible, and don't want to go through the manual process of combing through the libraries they use to figure out the instrumentations.

Would you mind adding a comment to document the purpose of that list? it'll help the next contributor answer that question.

@@ -25,6 +25,8 @@

# target library to desired instrumentor path/versioned package name
instrumentations = {
"aiohttp-client": "opentelemetry-instrumentation-aiohttp-client>=0.15b0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you add the comment I asked above this, maybe right below the imports?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet that is super helpful! Added a comment :)

Copy link
Member

@toumorokoshi toumorokoshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM because the change is good, but adding the comment would be great!

Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the comment and the missing instrumentations. If you can remove the system-metrics from the list, we can get this merged right away

@codeboten codeboten merged commit 07b8945 into open-telemetry:master Nov 25, 2020
@NathanielRN NathanielRN deleted the update-bootstrap-packages branch November 25, 2020 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants