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

[Feature Request]: Log the results of SDK resolution through a Logger #9413

Closed
baronfel opened this issue Nov 10, 2023 · 1 comment · Fixed by #9621
Closed

[Feature Request]: Log the results of SDK resolution through a Logger #9413

baronfel opened this issue Nov 10, 2023 · 1 comment · Fixed by #9621
Assignees
Labels
Feature Request help wanted Issues that the core team doesn't plan to work on, but would accept a PR for. Comment to claim. internal-team-onboarding Priority:3 Work that is nice to have triaged

Comments

@baronfel
Copy link
Member

Summary

The SdkResolverService currently logs when it is about to resolve SDKs, but it never logs the results of resolving SDKs - this can make it difficult to use binlogs to diagnose SDK resolution problems, since the only other option is to gather ETW traces, which is not always doable.

Background and Motivation

While helping @jaredpar with jaredpar/complog#73 we found this gap in the binlogs, which was a major head-scratch moment.

Proposed Feature

MSBuild should log the final results of SDK resolution to the logger in some form - ideally more than just errors would be logged because sometimes the SDK resolution result itself can be outside of what the user is expecting.

Alternative Designs

No response

@baronfel baronfel added Feature Request needs-triage Have yet to determine what bucket this goes in. labels Nov 10, 2023
@rainersigwald
Copy link
Member

I might go so far as to say that all the SDK resolution diagnostics should be preserved in the binlog, including the failure reasoning from other resolvers. This shouldn't be too noisy since they'll all be cached . . .

But even if we don't do that we should put in the binlog as much as goes into the ETW

MSBuildEventSource.Log.SdkResolverResolveSdkStop(sdkResolver.Name, sdk.Name, solutionPath, projectPath, result?.Path, result?.Success ?? false);

@AR-May AR-May added internal-team-onboarding Priority:3 Work that is nice to have help wanted Issues that the core team doesn't plan to work on, but would accept a PR for. Comment to claim. and removed needs-triage Have yet to determine what bucket this goes in. labels Nov 14, 2023
@AR-May AR-May added the triaged label Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Request help wanted Issues that the core team doesn't plan to work on, but would accept a PR for. Comment to claim. internal-team-onboarding Priority:3 Work that is nice to have triaged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants