Issue #1303: Add debug information in metadata.debug field (#1308)

#### Related Issue: #1303 #### Description of changes: Add new `debug` attribute as a string array. Add `debug` attribute to `metadata` object. See related issue for motivation. --------- Signed-off-by: Rajas Panat <[email protected]> Co-authored-by: Rajas <[email protected]>
ocsf · Jan 14, 2025 · 4ceac5d · 4ceac5d
1 parent d28e9c2
commit 4ceac5d
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -81,6 +81,8 @@ Thankyou! -->
     1. Added `sbom`, `author`, `related_component`, `relationship`, `relationship_id` and `software_component` to support SBOMs. #1262
     1. Added `related_events_count` as an `int_t`. #1271
     1. Added `event_uid` as a `string_t`. #1312
+    1. Added `debug` attribute as a `string_t` array, used in the `metadata` object. #1308
+
 * #### Objects
     1. Added `environment_variable` object. #1172, #1288
     1. Added `advisory` object. #1176
@@ -95,6 +97,7 @@ Thankyou! -->
     1. Added `software_component` and `sbom` objects. #1262
     1. Added `drive_type` and `drive_type_id` objects. #1287
     1. Added `cpu_architecture` and `cpu_architecture_id` objects. #1278
+
 * ### Profiles
     1. Added `incident` profile. #1293
 
@@ -172,7 +175,7 @@ Thankyou! -->
     1. Added `name` to `script` object. #1284
     1. Relax requirement of `fingerprints` in `certificate` object. #1302
     1. Added `event_uid` to the `logger` object. #1312
-
+    1. Added `debug` attribute to `metadata` object. #1308
 
 ### Bugfixes
 1. Added sibling definition to `confidence_id` in dictionary, accurately associating `confidence` as its sibling. #1180

diff --git a/dictionary.json b/dictionary.json
@@ -1441,6 +1441,12 @@
       "description": "Decision/outcome of the authorization mechanism (e.g. Approved, Denied)",
       "type": "string_t"
     },
+    "debug": {
+      "caption": "Debug Information",
+      "description": "Debug information about non-fatal issues with this OCSF event. Each issue is a line in this string array.",
+      "type": "string_t",
+      "is_array": true
+    },
     "delay": {
       "caption": "Root Delay",
       "description": "The total round-trip delay to the reference clock in milliseconds.",

diff --git a/objects/metadata.json b/objects/metadata.json
@@ -11,6 +11,9 @@
     "correlation_uid": {
       "requirement": "optional"
     },
+    "debug": {
+      "requirement": "optional"
+    },
     "event_code": {
       "requirement": "optional"
     },