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(auto-instrumentations-node): improved readme #563

Merged
merged 2 commits into from Jul 11, 2021

Conversation

CptSchnitz
Copy link
Contributor

Which problem is this PR solving?

Short description of the changes

  • Added a summary of what the package does to the readme.
  • Added a list of instrumentations the package loads to the readme.
  • Fixed the example so it uses resource instead of serviceName.

@CptSchnitz CptSchnitz requested a review from a team as a code owner July 5, 2021 18:24
@vmarchaud vmarchaud requested a review from a team July 5, 2021 18:36
@codecov
Copy link

codecov bot commented Jul 5, 2021

Codecov Report

Merging #563 (ee32d5d) into main (52b46aa) will increase coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #563      +/-   ##
==========================================
+ Coverage   94.74%   94.77%   +0.02%     
==========================================
  Files         176      179       +3     
  Lines       10647    10921     +274     
  Branches     1018     1086      +68     
==========================================
+ Hits        10088    10350     +262     
- Misses        559      571      +12     
Impacted Files Coverage Δ
...ry-instrumentation-user-interaction/src/version.ts 100.00% <0.00%> (ø)
...ation-user-interaction/src/enums/AttributeNames.ts 100.00% <0.00%> (ø)
...umentation-user-interaction/src/instrumentation.ts 95.48% <0.00%> (ø)

Copy link
Member

@obecny obecny left a comment

Choose a reason for hiding this comment

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

lgtm, just please replace double quotes with single quotes

metapackages/auto-instrumentations-node/README.md Outdated Show resolved Hide resolved
metapackages/auto-instrumentations-node/README.md Outdated Show resolved Hide resolved
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 6, 2021

CLA Signed

The committers are authorized under a signed CLA.

@CptSchnitz
Copy link
Contributor Author

CptSchnitz commented Jul 9, 2021

@obecny looks like the unit test failed because of a timeout.

@vmarchaud vmarchaud added documentation Improvements or additions to documentation document and removed documentation Improvements or additions to documentation labels Jul 11, 2021
@vmarchaud vmarchaud merged commit 83c7fa3 into open-telemetry:main Jul 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants