add metadata yaml generation #866
Merged
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #866 +/- ##
=======================================
Coverage 86.22% 86.22%
=======================================
Files 19 19
Lines 668 668
Branches 153 153
=======================================
Hits 576 576
Misses 92 92 ☔ View full report in Codecov by Sentry. |
theletterf
suggested changes
Jan 10, 2024
There was a problem hiding this comment.
Great! There are a few things that need addressing:
-
There seem to be a lack of indentation for certain items. For example, items inside each first level object are not indented. Not sure if this would pose a problem to YAML parsers, but I'd much rather have indentation for readability and browsing purposes.
The same indentation issues appears in nested items, such as the dependencies within the resource detectors. -
There is no first level
instrumentations:object — keys start right after the settings. -
No resource attribute information nor dependencies info, but I think it's OK for the latter to just resort to npm, especially if there are MANY dependencies. WDYT?
-
To preserve the same structure used by .NET, please rename the name key in settings to env.
With this, I think we'd already have an useful artifact for testing.
Should have better indenting now and verified it's parseable.
Fixed
Added resource detectors, I can add the dependency list for sure, but is there an actual need for it? Should they be first level dependencies?
Done! |
|
@seemk Could we try with adding them as first-level deps and see what comes out? If it's not too much work, that is. |
Added first level dependencies, the output is now |
|
Seems reasonable! Let's go with it. |
mhennoch
approved these changes
Jan 19, 2024
@theletterf You need to approve as well in this case |
theletterf
approved these changes
Jan 22, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
If possible the instrumentation target library versions are taken from dependency READMEs (however in the future a better mechanism is needed to gather these automatically, something to discuss in the JS sig).
Example yaml can be seen at https://github.com/signalfx/splunk-otel-js/actions/runs/7474145786/artifacts/1159275535