Fix JSON escaping in task details log metadata

CHANGELOG.md

@@ -50,6 +50,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Fix ShardSearchFailure in transport-grpc ([#20641](https://github.com/opensearch-project/OpenSearch/pull/20641))
 - Fix TLS cert hot-reload for Arrow Flight transport ([#20732](https://github.com/opensearch-project/OpenSearch/pull/20732))
 - Fix misleading heap usage cancellation message in SearchBackpressureService ([#20779](https://github.com/opensearch-project/OpenSearch/pull/20779))
+- Fix task details JSON logs with nested JSON in metadata are not properly escaped ([#20802](https://github.com/opensearch-project/OpenSearch/pull/20802))
 - Delegate getMin/getMax methods for ExitableTerms ([#20775](https://github.com/opensearch-project/OpenSearch/pull/20775))
 - Fix terms lookup subquery fetch limit reading from non-existent index setting instead of cluster `max_clause_count` ([#20823](https://github.com/opensearch-project/OpenSearch/pull/20823))
 - Fix array_index_out_of_bounds_exception with wildcard and aggregations ([#20842](https://github.com/opensearch-project/OpenSearch/pull/20842))

qa/logging-config/src/test/java/org/opensearch/common/logging/OpenSearchJsonLayoutTests.java

@@ -122,8 +122,8 @@ public void testLayoutWithAdditionalFields() {
                 "\"cluster.name\": \"${sys:opensearch.logs.cluster_name}\", " +
                 "\"node.name\": \"%node_name\", " +
                 "\"message\": \"%notEmpty{%enc{%marker}{JSON} }%enc{%.-10000m}{JSON}\"" +
-                "%notEmpty{, \"x-opaque-id\": \"%OpenSearchMessageField{x-opaque-id}\"}" +
-                "%notEmpty{, \"someOtherField\": \"%OpenSearchMessageField{someOtherField}\"}" +
+                "%notEmpty{, \"x-opaque-id\": \"%enc{%OpenSearchMessageField{x-opaque-id}}{JSON}\"}" +
+                "%notEmpty{, \"someOtherField\": \"%enc{%OpenSearchMessageField{someOtherField}}{JSON}\"}" +
                 "%notEmpty{, %node_and_cluster_id }" +
                 "%exceptionAsJson }" + System.lineSeparator()));
     }
@@ -143,7 +143,7 @@ public void testLayoutWithAdditionalFieldOverride() {
                 "\"component\": \"%c{1.}\", " +
                 "\"cluster.name\": \"${sys:opensearch.logs.cluster_name}\", " +
                 "\"node.name\": \"%node_name\"" +
-                "%notEmpty{, \"message\": \"%OpenSearchMessageField{message}\"}" +
+                "%notEmpty{, \"message\": \"%enc{%OpenSearchMessageField{message}}{JSON}\"}" +
                 "%notEmpty{, %node_and_cluster_id }" +
                 "%exceptionAsJson }" + System.lineSeparator()));
     }

server/src/main/java/org/opensearch/common/logging/OpenSearchJsonLayout.java

@@ -133,7 +133,7 @@ private String pattern(String type, String[] opensearchMessageFields, int maxMes
         map.put("message", inQuotes("%notEmpty{%enc{%marker}{JSON} }%enc{" + messageFormat + "}{JSON}"));
 
         for (String key : opensearchMessageFields) {
-            map.put(key, inQuotes("%OpenSearchMessageField{" + key + "}"));
+            map.put(key, inQuotes("%enc{%OpenSearchMessageField{" + key + "}}{JSON}"));
         }
         return createPattern(map, Stream.of(opensearchMessageFields).collect(Collectors.toSet()));
     }

server/src/test/java/org/opensearch/tasks/consumer/SearchShardTaskDetailsLogMessageTests.java

@@ -58,4 +58,21 @@ public void testTaskDetailsLogHasJsonFields() {
             equalTo("{0=[{cpu_time_in_nanos=100, memory_in_bytes=100}, stats_type=worker_stats, is_active=true, threadId=0]}")
         );
     }
+
+    public void testTaskDetailsLogWithJsonMetadata() {
+        String jsonMetadata = "{\"query\":{\"match_all\":{}},\"size\":10}";
+        SearchShardTask task = new SearchShardTask(
+            1,
+            "transport",
+            "indices:data/read/search[phase/query]",
+            "test",
+            null,
+            Collections.singletonMap(Task.X_OPAQUE_ID, "my_id"),
+            () -> jsonMetadata
+        );
+        SearchShardTaskDetailsLogMessage p = new SearchShardTaskDetailsLogMessage(task);
+
+        // Verify that metadata with JSON content is stored correctly
+        assertThat(p.getValueFor("metadata"), equalTo(jsonMetadata));
+    }
 }