Send unit telemetry on success (microsoft#4720)

JohnMcPMS · web-flow · commit af80a400aab7 · 2024-08-08T15:10:09.000-07:00
## Change
Write the `ConfigUnitRun` event on success as well, which helps us
better understand the configuration units in use.
diff --git a/src/Microsoft.Management.Configuration.UnitTests/Tests/ConfigurationProcessorTelemetryTests.cs b/src/Microsoft.Management.Configuration.UnitTests/Tests/ConfigurationProcessorTelemetryTests.cs
@@ -50,7 +50,8 @@ public void Telemetry_NoUnitEventOnSuccess()
 
             GetConfigurationUnitSettingsResult result = testObjects.Processor.GetUnitSettings(testObjects.Unit);
 
-            Assert.Empty(this.EventSink.Events);
+            Assert.Single(this.EventSink.Events);
+            Assert.Equal(TelemetryEvent.ConfigUnitRunName, this.EventSink.Events[0].Name);
         }
 
         /// <summary>
diff --git a/src/Microsoft.Management.Configuration/Telemetry/Telemetry.cpp b/src/Microsoft.Management.Configuration/Telemetry/Telemetry.cpp
@@ -263,12 +263,12 @@ namespace winrt::Microsoft::Management::Configuration::implementation
         std::string_view action,
         const IConfigurationUnitResultInformation& resultInformation) const noexcept try
     {
-        // We only want to send telemetry for failures of publicly available units.
-        if (!IsTelemetryEnabled() || SUCCEEDED(static_cast<int32_t>(resultInformation.ResultCode())))
+        if (!IsTelemetryEnabled())
         {
             return;
         }
 
+        // We only want to send telemetry for publicly available units.
         IConfigurationUnitProcessorDetails details = unit.Details();
         if (!details || !details.IsPublic())
         {

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,8 @@ public void Telemetry_NoUnitEventOnSuccess()`
`50`	`50`
`51`	`51`	`GetConfigurationUnitSettingsResult result = testObjects.Processor.GetUnitSettings(testObjects.Unit);`
`52`	`52`
`53`		`- Assert.Empty(this.EventSink.Events);`
	`53`	`+ Assert.Single(this.EventSink.Events);`
	`54`	`+ Assert.Equal(TelemetryEvent.ConfigUnitRunName, this.EventSink.Events[0].Name);`
`54`	`55`	`}`
`55`	`56`
`56`	`57`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -263,12 +263,12 @@ namespace winrt::Microsoft::Management::Configuration::implementation`
`263`	`263`	`std::string_view action,`
`264`	`264`	`const IConfigurationUnitResultInformation& resultInformation) const noexcept try`
`265`	`265`	`{`
`266`		`- // We only want to send telemetry for failures of publicly available units.`
`267`		`- if (!IsTelemetryEnabled() \|\| SUCCEEDED(static_cast<int32_t>(resultInformation.ResultCode())))`
	`266`	`+ if (!IsTelemetryEnabled())`
`268`	`267`	`{`
`269`	`268`	`return;`
`270`	`269`	`}`
`271`	`270`
	`271`	`+ // We only want to send telemetry for publicly available units.`
`272`	`272`	`IConfigurationUnitProcessorDetails details = unit.Details();`
`273`	`273`	`if (!details \|\| !details.IsPublic())`
`274`	`274`	`{`