Track un-active instrumentation for better reporting #2016
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
blumamir
approved these changes
Dec 16, 2024
instrumentation/manager.go
Outdated
| // we need to track the instrumentation even if the load failed. | ||
| // consider a reporter which writes a persistent record for a failed/successful load | ||
| // we need to notify the reporter once that PID exists to clean up the resources | ||
| m.startTrackInstrumentation(e.PID, inst, pg, configGroup, loadErr == nil) |
There was a problem hiding this comment.
if we had an error with the Load, it means that at this point the inst is not longer relevant. We will not need to call Close or apply config to it since it's not loaded. Thus, I recommend to consider using nil instead of inst in this case so that it doesn't get called accidentally and cause hard to find bug
instrumentation/manager.go
Outdated
| // active is used to track if the instrumentation is loaded successfully or not. | ||
| // we want to track the instrumentation even if it failed to load, to be able to report the error | ||
| // and clean up the instrumentation resources and the reporter resources once the process exits. | ||
| active bool |
There was a problem hiding this comment.
consider:
Suggested change
| active bool | |
| loaded bool |
to maintain a consistent terminology with existing terms.
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.
This PR changes when the instrumentation manager tracks an instrumentation.
Once an instrumentation is initialized, we should start tracking it even if it fails to load.
The reason is, that we need to call the reporter once the process exits (so it can report/clean it) - however, if we only track the PID once the instrumentation is loaded we won't be able to invoke the reporter properly once a failed-to-load instrumentation needs to be cleaned.
Each PID we track is marked whether the instrumentation is active (loaded successfully) or not - by the inst field being nil or not.
For un-active PIDs we won't apply config updates.
In addition, in case we get an exec event on a non-active PID, we try to instrument it again. This is helpful in cases of chain-loading where the first executable is written in a language we can't instrument, while the second is valid for instrumentation.