[PROF-7440] Report status of timeline feature as internal metadata #3040
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
…s in it During review of #2927, @marcotc did point out that getting the internal metadata information from the `Datadog::Profiling::Component` to the `Flush` object was quite a lot of changes. As I'm preparing to add a second entry to `internal_metadata`, I'm refactoring this code to try to change it so that fewer components need to be touched when we want to add more stuff.
This is a refactor in preparation for adding more internal metadata entries, but hopefully do so in a way that avoids needing to touch a lot of internal classes each time.
This is one more step in a refactor in preparation for adding more internal metadata. By having the `Exporter` receive the `internal_metadata` as a opaque hash it cares nothing about, we can easily add more entries directly in the `Profiling::Component` without needing to touch a lot of classes.
This is the last step of the refactor in preparation for adding more internal metadata. By having the `build_profiler_exporter` receive the `internal_metadata` hash directly, we now only need to modify the creation of the `internal_metadata` hash to be able to propagate more information.
Codecov Report
@@ Coverage Diff @@
## master #3040 +/- ##
=======================================
Coverage 98.12% 98.12%
=======================================
Files 1322 1322
Lines 74648 74654 +6
Branches 3403 3403
=======================================
+ Hits 73247 73257 +10
+ Misses 1401 1397 -4
... and 3 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
**What does this PR do?**: This PR adds support for reporting the status of the timeline feature together with profiles, via the internal metadata field. I ended up doing a bunch of refactoring to make it easier to adds new reported fields as internal metadata; it may be easier to review this PR commit-by-commit. **Motivation**: While this feature is off-by-default, having this internal metadata makes it easier to spot profiles that have/don't have this data without actually opening them up in the UX. **Additional Notes**: N/A **How to test the change?**: This change includes test coverage. It's possible internally at Datadog to see this information in profile listings (ping me if you'd like to know more).
ivoanjo
force-pushed
the
ivoanjo/expose-timeline-enabled
branch
from
bd6b14f
to
c4a52f0
Compare
TonyCTHsu
approved these changes
Aug 11, 2023
|
Thanks Tony for the review 🙇 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?:
This PR adds support for reporting the status of the timeline feature together with profiles, via the internal metadata field.
I ended up doing a bunch of refactoring to make it easier to adds new reported fields as internal metadata; it may be easier to review this PR commit-by-commit.
Motivation:
While this feature is off-by-default, having this internal metadata makes it easier to spot profiles that have/don't have this data without actually opening them up in the UX.
Additional Notes:
N/A
How to test the change?:
This change includes test coverage. It's possible internally at Datadog to see this information in profile listings (ping me if you'd like to know more).