Add configuration telemetry events #3152
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
msftrubengu
approved these changes
Apr 14, 2023
| @@ -11,6 +11,11 @@ namespace Microsoft.Management.Configuration.Processor.Exceptions | |||
| /// </summary> | |||
| internal static class ErrorCodes | |||
| { | |||
| /// <summary> | |||
| /// The module of the unit was installed, but the unit was not found. | |||
| public InvokeDscResourceException(string method, string resourceName, ModuleSpecification? module, string message, bool configurationSetSource = false) | ||
| : base(CreateMessage(method, resourceName, module, message)) | ||
| { | ||
| // The property 'Fake' cannot be found on this object. Verify that the property exists and can be set. |
There was a problem hiding this comment.
This comment seems like it should be in ContainsPropertyError
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.
Change
This change adds telemetry events from configuration actions, as well as more details to improve the error reporting (both in telemetry and to the user). The telemetry events can be disabled in code by the front end. For
winget configure, the winget setting that controls telemetry is flowed through into the configuration code.Two telemetry events are added by this change:
A new value was added to the result information to attribute any error to the appropriate portion of the overall system. The current partitioning of the blame is:
Additionally, another string was added to the result information. The intention is that the existing string (
Description) should be used for a "short", user presentable message. The new string (Details), can contain a longer value that is intended for logs or a "more details" type experience.The PowerShell processor was changed to wrap almost all exceptions into the result information object now that the source can be clearly stated there. Failures coming directly from invoking the resource are attributed to the configuration unit processing, except in the cases where we detect the signature of an invalid setting value (then the configuration set [author] is blamed). All other exceptions are treated as an internal error.
Validation
Microsoft Reviewers: Open in CodeFlow