add comments and refactor

nikhilsinhaparseable · nikhilsinhaparseable · commit b628649ce885 · 2025-04-21T23:05:02.000-04:00
diff --git a/src/otel/logs.rs b/src/otel/logs.rs
@@ -23,9 +23,9 @@ use opentelemetry_proto::tonic::logs::v1::SeverityNumber;
 use serde_json::Map;
 use serde_json::Value;
 
+use super::otel_utils::add_other_attributes_if_not_empty;
 use super::otel_utils::collect_json_from_values;
 use super::otel_utils::convert_epoch_nano_to_timestamp;
-use super::otel_utils::fetch_attributes_string;
 use super::otel_utils::insert_attributes;
 use super::otel_utils::merge_attributes_in_json;
 
@@ -107,13 +107,7 @@ pub fn flatten_log_record(log_record: &LogRecord) -> Map<String, Value> {
     );
 
     // Add the `other_attributes` to the log record json
-    if !other_attributes.is_empty() {
-        let other_attributes = fetch_attributes_string(&other_attributes);
-        log_record_json.insert(
-            "other_attributes".to_string(),
-            Value::String(other_attributes),
-        );
-    }
+    add_other_attributes_if_not_empty(&mut log_record_json, &other_attributes);
 
     log_record_json
 }
diff --git a/src/otel/metrics.rs b/src/otel/metrics.rs
@@ -24,7 +24,7 @@ use opentelemetry_proto::tonic::metrics::v1::{
 use serde_json::{Map, Value};
 
 use super::otel_utils::{
-    convert_epoch_nano_to_timestamp, fetch_attributes_string, insert_attributes,
+    add_other_attributes_if_not_empty, convert_epoch_nano_to_timestamp, insert_attributes,
     insert_number_if_some, merge_attributes_in_json,
 };
 
@@ -83,13 +83,7 @@ fn flatten_exemplar(exemplars: &[Exemplar]) -> Vec<Map<String, Value>> {
                     }
                 }
             }
-            if !other_attributes.is_empty() {
-                let other_attributes = fetch_attributes_string(&other_attributes);
-                exemplar_json.insert(
-                    "other_attributes".to_string(),
-                    Value::String(other_attributes),
-                );
-            }
+            add_other_attributes_if_not_empty(&mut exemplar_json, &other_attributes);
             exemplar_json
         })
         .collect()
@@ -131,11 +125,8 @@ fn flatten_number_data_points(data_points: &[NumberDataPoint]) -> Vec<Map<String
                         data_point_json.insert(key, value);
                     }
                 }
-            } else if !other_attributes.is_empty() {
-                data_point_json.insert(
-                    "other_attributes".to_string(),
-                    Value::String(fetch_attributes_string(&other_attributes)),
-                );
+            } else {
+                add_other_attributes_if_not_empty(&mut data_point_json, &other_attributes);
             }
 
             data_point_json.extend(flatten_data_point_flags(data_point.flags));
@@ -270,11 +261,8 @@ fn flatten_histogram(histogram: &Histogram) -> Vec<Map<String, Value>> {
                     data_point_json.insert(key, value);
                 }
             }
-        } else if !other_attributes.is_empty() {
-            data_point_json.insert(
-                "other_attributes".to_string(),
-                Value::String(fetch_attributes_string(&other_attributes)),
-            );
+        } else {
+            add_other_attributes_if_not_empty(&mut data_point_json, &other_attributes);
         }
 
         data_point_json.extend(flatten_data_point_flags(data_point.flags));
@@ -372,11 +360,8 @@ fn flatten_exp_histogram(exp_histogram: &ExponentialHistogram) -> Vec<Map<String
                     data_point_json.insert(key, value);
                 }
             }
-        } else if !other_attributes.is_empty() {
-            data_point_json.insert(
-                "other_attributes".to_string(),
-                Value::String(fetch_attributes_string(&other_attributes)),
-            );
+        } else {
+            add_other_attributes_if_not_empty(&mut data_point_json, &other_attributes);
         }
 
         data_points_json.push(data_point_json);
@@ -460,12 +445,7 @@ fn flatten_summary(summary: &Summary) -> Vec<Map<String, Value>> {
             ),
         );
 
-        if !other_attributes.is_empty() {
-            data_point_json.insert(
-                "other_attributes".to_string(),
-                Value::String(fetch_attributes_string(&other_attributes)),
-            );
-        }
+        add_other_attributes_if_not_empty(&mut data_point_json, &other_attributes);
 
         data_points_json.push(data_point_json);
     }
diff --git a/src/otel/otel_utils.rs b/src/otel/otel_utils.rs
@@ -22,6 +22,8 @@ use opentelemetry_proto::tonic::common::v1::{
 };
 use serde_json::{Map, Value};
 
+/// Prefixes of attribute keys that should be preserved as individual fields in flattened output.
+/// Other attributes will be collected in a separate JSON object under `other_attributes`.
 const KNOWN_ATTRIBUTES_PREFIX: [&str; 6] = ["http", "url", "service", "os", "host", "telemetry"];
 
 // Value can be one of types - String, Bool, Int, Double, ArrayValue, AnyValue, KeyValueList, Byte
@@ -73,6 +75,9 @@ pub fn collect_json_from_value(key: &String, value: OtelValue) -> Map<String, Va
     value_json
 }
 
+/// Recursively converts an ArrayValue into a JSON Value
+/// This handles nested array values and key-value lists by recursively
+/// converting them to JSON
 fn collect_json_from_array_value(array_value: ArrayValue) -> Value {
     let mut json_array = Vec::new();
     for value in array_value.values {
@@ -107,6 +112,9 @@ fn collect_json_from_array_value(array_value: ArrayValue) -> Value {
     Value::Array(json_array)
 }
 
+/// Recursively converts an OpenTelemetry KeyValueList into a JSON Map
+/// The function iterates through the key-value pairs in the list
+/// and collects their JSON representations into a single Map
 fn collect_json_from_key_value_list(key_value_list: KeyValueList) -> Map<String, Value> {
     let mut kv_list_json: Map<String, Value> = Map::new();
     for key_value in key_value_list.values {
@@ -273,3 +281,16 @@ pub fn fetch_attributes_string(attributes: &Map<String, Value>) -> String {
         }
     }
 }
+
+/// add `other_attributes` to the JSON object
+/// if `other_attributes` is not empty
+/// and return the JSON object
+pub fn add_other_attributes_if_not_empty(
+    json: &mut Map<String, Value>,
+    other_attributes: &Map<String, Value>,
+) {
+    if !other_attributes.is_empty() {
+        let attrs_str = fetch_attributes_string(other_attributes);
+        json.insert("other_attributes".to_string(), Value::String(attrs_str));
+    }
+}
diff --git a/src/otel/traces.rs b/src/otel/traces.rs
@@ -24,9 +24,9 @@ use opentelemetry_proto::tonic::trace::v1::Status;
 use opentelemetry_proto::tonic::trace::v1::TracesData;
 use serde_json::{Map, Value};
 
+use super::otel_utils::add_other_attributes_if_not_empty;
 use super::otel_utils::convert_epoch_nano_to_timestamp;
 use super::otel_utils::fetch_attributes_from_json;
-use super::otel_utils::fetch_attributes_string;
 use super::otel_utils::insert_attributes;
 use super::otel_utils::merge_attributes_in_json;
 
@@ -159,13 +159,7 @@ fn flatten_events(events: &[Event]) -> Vec<Map<String, Value>> {
                 Value::Number(event.dropped_attributes_count.into()),
             );
 
-            if !other_attributes.is_empty() {
-                let other_attributes = fetch_attributes_string(&other_attributes);
-                event_json.insert(
-                    "other_attributes".to_string(),
-                    Value::String(other_attributes),
-                );
-            }
+            add_other_attributes_if_not_empty(&mut event_json, &other_attributes);
             event_json
         })
         .collect()
@@ -195,13 +189,7 @@ fn flatten_links(links: &[Link]) -> Vec<Map<String, Value>> {
                 Value::Number(link.dropped_attributes_count.into()),
             );
 
-            if !other_attributes.is_empty() {
-                let other_attributes = fetch_attributes_string(&other_attributes);
-                link_json.insert(
-                    "other_attributes".to_string(),
-                    Value::String(other_attributes),
-                );
-            }
+            add_other_attributes_if_not_empty(&mut link_json, &other_attributes);
             link_json
         })
         .collect()
@@ -354,8 +342,7 @@ fn flatten_span_record(span_record: &Span) -> Vec<Map<String, Value>> {
         for (key, value) in &links_other_attributes {
             other_attributes.insert(key.clone(), value.clone());
         }
-        let attrs_str = fetch_attributes_string(&other_attributes);
-        span_record_json.insert("other_attributes".to_string(), Value::String(attrs_str));
+        add_other_attributes_if_not_empty(&mut span_record_json, &other_attributes);
     }
     span_record_json.insert(
         "span_dropped_links_count".to_string(),

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ use opentelemetry_proto::tonic::metrics::v1::{`
`24`	`24`	`use serde_json::{Map, Value};`
`25`	`25`
`26`	`26`	`use super::otel_utils::{`
`27`		`- convert_epoch_nano_to_timestamp, fetch_attributes_string, insert_attributes,`
	`27`	`+ add_other_attributes_if_not_empty, convert_epoch_nano_to_timestamp, insert_attributes,`
`28`	`28`	`insert_number_if_some, merge_attributes_in_json,`
`29`	`29`	`};`
`30`	`30`
`@@ -83,13 +83,7 @@ fn flatten_exemplar(exemplars: &[Exemplar]) -> Vec<Map<String, Value>> {`
`83`	`83`	`}`
`84`	`84`	`}`
`85`	`85`	`}`
`86`		`- if !other_attributes.is_empty() {`
`87`		`- let other_attributes = fetch_attributes_string(&other_attributes);`
`88`		`- exemplar_json.insert(`
`89`		`- "other_attributes".to_string(),`
`90`		`- Value::String(other_attributes),`
`91`		`- );`
`92`		`- }`
	`86`	`+ add_other_attributes_if_not_empty(&mut exemplar_json, &other_attributes);`
`93`	`87`	`exemplar_json`
`94`	`88`	`})`
`95`	`89`	`.collect()`
`@@ -131,11 +125,8 @@ fn flatten_number_data_points(data_points: &[NumberDataPoint]) -> Vec<Map<String`
`131`	`125`	`data_point_json.insert(key, value);`
`132`	`126`	`}`
`133`	`127`	`}`
`134`		`- } else if !other_attributes.is_empty() {`
`135`		`- data_point_json.insert(`
`136`		`- "other_attributes".to_string(),`
`137`		`- Value::String(fetch_attributes_string(&other_attributes)),`
`138`		`- );`
	`128`	`+ } else {`
	`129`	`+ add_other_attributes_if_not_empty(&mut data_point_json, &other_attributes);`
`139`	`130`	`}`
`140`	`131`
`141`	`132`	`data_point_json.extend(flatten_data_point_flags(data_point.flags));`
`@@ -270,11 +261,8 @@ fn flatten_histogram(histogram: &Histogram) -> Vec<Map<String, Value>> {`
`270`	`261`	`data_point_json.insert(key, value);`
`271`	`262`	`}`
`272`	`263`	`}`
`273`		`- } else if !other_attributes.is_empty() {`
`274`		`- data_point_json.insert(`
`275`		`- "other_attributes".to_string(),`
`276`		`- Value::String(fetch_attributes_string(&other_attributes)),`
`277`		`- );`
	`264`	`+ } else {`
	`265`	`+ add_other_attributes_if_not_empty(&mut data_point_json, &other_attributes);`
`278`	`266`	`}`
`279`	`267`
`280`	`268`	`data_point_json.extend(flatten_data_point_flags(data_point.flags));`
`@@ -372,11 +360,8 @@ fn flatten_exp_histogram(exp_histogram: &ExponentialHistogram) -> Vec<Map<String`
`372`	`360`	`data_point_json.insert(key, value);`
`373`	`361`	`}`
`374`	`362`	`}`
`375`		`- } else if !other_attributes.is_empty() {`
`376`		`- data_point_json.insert(`
`377`		`- "other_attributes".to_string(),`
`378`		`- Value::String(fetch_attributes_string(&other_attributes)),`
`379`		`- );`
	`363`	`+ } else {`
	`364`	`+ add_other_attributes_if_not_empty(&mut data_point_json, &other_attributes);`
`380`	`365`	`}`
`381`	`366`
`382`	`367`	`data_points_json.push(data_point_json);`
`@@ -460,12 +445,7 @@ fn flatten_summary(summary: &Summary) -> Vec<Map<String, Value>> {`
`460`	`445`	`),`
`461`	`446`	`);`
`462`	`447`
`463`		`- if !other_attributes.is_empty() {`
`464`		`- data_point_json.insert(`
`465`		`- "other_attributes".to_string(),`
`466`		`- Value::String(fetch_attributes_string(&other_attributes)),`
`467`		`- );`
`468`		`- }`
	`448`	`+ add_other_attributes_if_not_empty(&mut data_point_json, &other_attributes);`
`469`	`449`
`470`	`450`	`data_points_json.push(data_point_json);`
`471`	`451`	`}`