Added ResultString to StatusTrace event (#1213)

* Added ResultString to StatusTrace event

* updated TelemetryTest::ProcessStatusTraceEvent

* addressed comments

Author: AhmedBM

src/common/telemetry/Telemetry.h

@@ -167,6 +167,7 @@ static inline void OSConfigGetElapsedTime(int64_t* elapsed_us_var)
         const char* _timestamp = GetFormattedTime();                                                                                                   \
         int64_t _elapsed_us = 0;                                                                                                                       \
         const char* _distroName = OSConfigTelemetryGetCachedOsName();                                                                                  \
+        const char* _resultString = strerror(status);                                                                                                  \
         OSConfigGetElapsedTime(&_elapsed_us);                                                                                                          \
         telemetry_json = FormatAllocateString(                                                                                                         \
             "{"                                                                                                                                        \
@@ -178,6 +179,7 @@ static inline void OSConfigGetElapsedTime(int64_t* elapsed_us_var)
             "\"RuleCodename\":\"%s\","                                                                                                                 \
             "\"CallingFunctionName\":\"%s\","                                                                                                          \
             "\"ResultCode\":\"%d\","                                                                                                                   \
+            "\"ResultString\":\"%s\","                                                                                                                 \
             "\"ScenarioName\":\"%s\","                                                                                                                 \
             "\"Microseconds\":\"%" PRId64                                                                                                              \
             "\","                                                                                                                                      \
@@ -186,7 +188,7 @@ static inline void OSConfigGetElapsedTime(int64_t* elapsed_us_var)
             "\"Version\":\"%s\""                                                                                                                       \
             "}",                                                                                                                                       \
             _timestamp ? _timestamp : TELEMETRY_NOTFOUND_STRING, __FILE__, line, __func__, _ruleCodename ? _ruleCodename : TELEMETRY_NOTFOUND_STRING,  \
-            (callingFunctionName) ? (callingFunctionName) : TELEMETRY_NOTFOUND_STRING, status, _scenarioName, _elapsed_us,                             \
+            (callingFunctionName) ? (callingFunctionName) : TELEMETRY_NOTFOUND_STRING, status, _resultString, _scenarioName, _elapsed_us,              \
             _distroName ? _distroName : TELEMETRY_NOTFOUND_STRING, _correlationId ? _correlationId : TELEMETRY_NOTFOUND_STRING, OSCONFIG_VERSION);     \
         if (NULL != telemetry_json)                                                                                                                    \
         {                                                                                                                                              \

src/common/telemetry/lib/ParameterSets.hpp

@@ -34,7 +34,7 @@ const std::set<std::string> RULE_COMPLETE_OPTIONAL_PARAMS = {
 
 // StatusTrace
 const std::set<std::string> STATUS_TRACE_REQUIRED_PARAMS = {
-    "FileName", "LineNumber", "ScenarioName", "FunctionName", "RuleCodename", "CallingFunctionName", "Microseconds", "ResultCode"};
+    "FileName", "LineNumber", "ScenarioName", "FunctionName", "RuleCodename", "CallingFunctionName", "Microseconds", "ResultCode", "ResultString"};
 const std::set<std::string> STATUS_TRACE_OPTIONAL_PARAMS = {
     // No optional params for now
 };

src/common/telemetry/lib/tests/TelemetryTests.cpp

@@ -137,7 +137,7 @@ TEST_F(TelemetryTest, ProcessBaselineRunMissingTimestampEvent)
 
 TEST_F(TelemetryTest, ProcessStatusTraceEvent)
 {
-    std::string realEvent = R"({"EventName":"StatusTrace","Timestamp":"2025-10-17 22:52:56+0000","FileName":"/workspaces/azure-osconfig/src/common/asb/Asb.c","LineNumber":"1109","FunctionName":"AsbShutdown","RuleCodename":"auditEnsureSmbWithSambaIsDisabled","CallingFunctionName":"TestingStatusTrace","ResultCode":"0","ScenarioName":"TestingScenario","Microseconds":"101807","DistroName":"CentOS","CorrelationId":"","Version":"1.0.5.20251017-g03b36b7d"})";
+    std::string realEvent = R"({"EventName":"StatusTrace","Timestamp":"2025-10-17 22:52:56+0000","FileName":"/workspaces/azure-osconfig/src/common/asb/Asb.c","LineNumber":"1109","FunctionName":"AsbShutdown","RuleCodename":"auditEnsureSmbWithSambaIsDisabled","CallingFunctionName":"TestingStatusTrace","ResultCode":"0","ResultString":"OK","ScenarioName":"TestingScenario","Microseconds":"101807","DistroName":"CentOS","CorrelationId":"","Version":"1.0.5.20251017-g03b36b7d"})";
     ASSERT_TRUE(CreateTestJsonFile(realEvent));
     Telemetry::TelemetryManager telemetryManager(false, std::chrono::seconds(1));
     EXPECT_TRUE(telemetryManager.ProcessJsonFile(m_testJsonFile));