docs(instrumentation-fs): update readme #2779
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
pkg:instrumentation-fs
pkg-status:unmaintained
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2779 +/- ##
==========================================
+ Coverage 89.45% 89.50% +0.04%
==========================================
Files 174 174
Lines 8318 8318
Branches 1591 1591
==========================================
+ Hits 7441 7445 +4
+ Misses 877 873 -4 🚀 New features to boost your workflow:
|
pichlermarc
added
the
has:sponsor
trentm
reviewed
Apr 2, 2025
Contributor
trentm
left a comment
trentm
left a comment
There was a problem hiding this comment.
Sigh. It looks like our over-zealous linting of the READMEs is not happy about the different language being used here:
/home/runner/work/opentelemetry-js-contrib/opentelemetry-js-contrib/scripts/lint-readme.js:72
throw new Error(
^
Error: README.md dist text is not valid. Please add the following text to the README.md file:
If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`[https://www.npmjs.com/package/@opentelemetry/sdk-node`)](https://www.npmjs.com/package/@opentelemetry/sdk-node%60)) for the most seamless instrumentation experience.
Compatible with OpenTelemetry JS API and SDK `1.0+`.
We'll want to relax that lint error in that script.
…ing auto-instrumentations-node This is no longer a valid assumption. The 'fs' instrumentation, for example, is no longer a default part of auto-instrumentations-node.
Contributor
Done in commit 80b1da6. |
trentm
changed the title
Co-authored-by: Trent Mick <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue that will be fixed: #2775
Which problem is this PR solving?
--The README contained outdated usage instructions and compatibility details.
Short description of the changes
fsinstrumentation.@opentelemetry/auto-instrumentations-node.1.3+and Node.js>=18.