Skip to content

add span_parents to span components format #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ken Jiang (knjiang) merged 2 commits into from
Apr 15, 2026
Merged

add span_parents to span components format #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0ba748
add span_parents to span components format
knjiang Apr 15, 2026
7acd2a3
fix linting
knjiang Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/log_queue/queue.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ impl LogQueueCore {
merge_paths: None,
span_id,
root_span_id,
span_parents: None,
span_parents: span_components.span_parents.clone(),
destination,
org_id,
org_name,
Expand Down Expand Up @@ -470,6 +470,7 @@ impl LogQueueCore {
compute_object_metadata_args,
span_id: parent_span_id,
root_span_id: parent_root_span_id,
span_parents: _,
propagated_event: _,
}) => {
let span_parents = Some(vec![parent_span_id]);
Expand Down Expand Up @@ -804,7 +805,9 @@ impl LogQueueCore {
is_merge: if payload.is_merge { Some(true) } else { None },
merge_paths: None,
root_span_id,
span_parents: None,
span_parents: span_components
.as_ref()
.and_then(|components| components.span_parents.clone()),
destination,
org_id: payload.org_id,
org_name: payload.org_name,
Expand Down
8 changes: 8 additions & 0 deletions src/span.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,10 @@ impl<S: SpanSubmitter> SpanHandle<S> {
Some(ParentSpanInfo::FullSpan { root_span_id, .. }) => Some(root_span_id.clone()),
_ => Some(inner.span_id.clone()),
};
let span_parents = match &self.parent_info {
Some(ParentSpanInfo::FullSpan { span_id, .. }) => Some(vec![span_id.clone()]),
_ => None,
};

let compute_object_metadata_args = if object_id.is_none() {
inherited_compute_object_metadata_args.or_else(|| {
Expand All @@ -500,6 +504,7 @@ impl<S: SpanSubmitter> SpanHandle<S> {
row_id: Some(inner.row_id.clone()),
span_id: Some(inner.span_id.clone()),
root_span_id,
span_parents,
propagated_event: inner.propagated_event.clone(),
})
}
Expand Down Expand Up @@ -876,6 +881,7 @@ mod tests {
span_id: "parent-span-id".to_string(),
root_span_id: "root-span-id".to_string(),
compute_object_metadata_args: None,
span_parents: None,
propagated_event: Some(parent_propagated),
};

Expand Down Expand Up @@ -924,6 +930,7 @@ mod tests {
span_id: "span-456".to_string(),
root_span_id: "root-789".to_string(),
compute_object_metadata_args: None,
span_parents: None,
propagated_event: Some(propagated),
};

Expand All @@ -940,6 +947,7 @@ mod tests {
event.get("test_key").and_then(|v| v.as_str()),
Some("test_value")
);
assert_eq!(exported.span_parents, Some(vec!["span-456".to_string()]));
}

#[tokio::test]
Expand Down
81 changes: 81 additions & 0 deletions src/span_components.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ pub struct SpanComponents {
#[serde(skip_serializing_if = "Option::is_none")]
pub root_span_id: Option<String>,

/// Direct parent span IDs for this span.
#[serde(skip_serializing_if = "Option::is_none")]
pub span_parents: Option<Vec<String>>,

/// Event data to propagate to child spans (e.g., prompt versions, metadata)
#[serde(skip_serializing_if = "Option::is_none")]
pub propagated_event: Option<Map<String, Value>>,
Expand All @@ -85,6 +89,7 @@ impl SpanComponents {
row_id: None,
span_id: None,
root_span_id: None,
span_parents: None,
propagated_event: None,
}
}
Expand Down Expand Up @@ -194,6 +199,12 @@ impl SpanComponents {
if let Some(ref event) = self.propagated_event {
json_obj.insert("propagated_event".to_string(), Value::Object(event.clone()));
}
if let Some(ref span_parents) = self.span_parents {
json_obj.insert(
"span_parents".to_string(),
Value::Array(span_parents.iter().cloned().map(Value::String).collect()),
);
}

if !json_obj.is_empty() {
let json_str = serde_json::to_string(&json_obj).unwrap();
Expand Down Expand Up @@ -365,6 +376,25 @@ impl SpanComponents {
root_span_id: json_obj
.remove("root_span_id")
.and_then(|v| v.as_str().map(String::from)),
span_parents: match json_obj.remove("span_parents") {
None => None,
Some(Value::Array(values)) => Some(
values
.into_iter()
.map(|value| match value {
Value::String(value) => Ok(value),
_ => Err(BraintrustError::InvalidConfig(
"span_parents must be an array of strings".to_string(),
)),
})
.collect::<Result<Vec<_>>>()?,
),
Some(_) => {
return Err(BraintrustError::InvalidConfig(
"span_parents must be an array of strings".to_string(),
))
}
},
propagated_event: json_obj
.remove("propagated_event")
.and_then(|v| v.as_object().cloned()),
Expand Down Expand Up @@ -404,6 +434,7 @@ impl SpanComponents {
compute_object_metadata_args: self.compute_object_metadata_args.clone(),
span_id,
root_span_id,
span_parents: self.span_parents.clone(),
propagated_event: self.propagated_event.clone(),
})
}
Expand All @@ -417,6 +448,7 @@ impl SpanComponents {
compute_object_metadata_args,
span_id,
root_span_id,
span_parents,
propagated_event,
} => Some(Self {
object_type: *object_type,
Expand All @@ -425,6 +457,7 @@ impl SpanComponents {
row_id: None,
span_id: Some(span_id.clone()),
root_span_id: Some(root_span_id.clone()),
span_parents: span_parents.clone(),
propagated_event: propagated_event.clone(),
}),
_ => None,
Expand Down Expand Up @@ -529,6 +562,7 @@ mod tests {
components.object_id = Some("550e8400-e29b-41d4-a716-446655440000".to_string());
components.span_id = Some("0123456789abcdef".to_string());
components.root_span_id = Some("0123456789abcdef0123456789abcdef".to_string());
components.span_parents = Some(vec!["parent-a".to_string()]);

let encoded = components.to_str();
let decoded = SpanComponents::parse(&encoded).unwrap();
Expand All @@ -537,6 +571,7 @@ mod tests {
assert_eq!(decoded.object_id, components.object_id);
assert_eq!(decoded.span_id, components.span_id);
assert_eq!(decoded.root_span_id, components.root_span_id);
assert_eq!(decoded.span_parents, components.span_parents);
}

#[test]
Expand Down Expand Up @@ -584,6 +619,7 @@ mod tests {
components.object_id = Some("project-123".to_string());
components.span_id = Some("span-456".to_string());
components.root_span_id = Some("root-789".to_string());
components.span_parents = Some(vec!["parent-a".to_string()]);

let mut propagated = Map::new();
propagated.insert(
Expand All @@ -600,13 +636,15 @@ mod tests {
object_id,
span_id,
root_span_id,
span_parents,
propagated_event,
..
} => {
assert_eq!(object_type, SpanObjectType::ProjectLogs);
assert_eq!(object_id, Some("project-123".to_string()));
assert_eq!(span_id, "span-456");
assert_eq!(root_span_id, "root-789");
assert_eq!(span_parents, Some(vec!["parent-a".to_string()]));
assert!(propagated_event.is_some());
let event = propagated_event.unwrap();
assert_eq!(
Expand All @@ -629,6 +667,7 @@ mod tests {
span_id: "span-456".to_string(),
root_span_id: "root-789".to_string(),
compute_object_metadata_args: None,
span_parents: Some(vec!["parent-a".to_string()]),
propagated_event: Some(propagated),
};

Expand All @@ -638,6 +677,48 @@ mod tests {
assert_eq!(components.object_id, Some("exp-123".to_string()));
assert_eq!(components.span_id, Some("span-456".to_string()));
assert_eq!(components.root_span_id, Some("root-789".to_string()));
assert_eq!(components.span_parents, Some(vec!["parent-a".to_string()]));
assert!(components.propagated_event.is_some());
}

#[test]
fn test_parse_v3_json_remainder_preserves_span_parents() {
let payload = serde_json::json!({
"object_type": SpanObjectType::ProjectLogs as u8,
"object_id": "project-123",
"row_id": "row-123",
"span_id": "span-123",
"root_span_id": "root-123",
"span_parents": ["parent-a"],
});
let encoded = BASE64.encode(
[
vec![ENCODING_VERSION_V3, SpanObjectType::ProjectLogs as u8, 0],
serde_json::to_vec(&payload).unwrap(),
]
.concat(),
);

let decoded = SpanComponents::parse(&encoded).unwrap();

assert_eq!(decoded.span_parents, Some(vec!["parent-a".to_string()]));
}

#[test]
fn test_parse_rejects_invalid_span_parents() {
let payload = serde_json::json!({
"object_type": SpanObjectType::ProjectLogs as u8,
"span_parents": [123],
});
let encoded = BASE64.encode(
[
vec![ENCODING_VERSION_V4, SpanObjectType::ProjectLogs as u8, 0],
serde_json::to_vec(&payload).unwrap(),
]
.concat(),
);

let err = SpanComponents::parse(&encoded).unwrap_err();
assert!(matches!(err, BraintrustError::InvalidConfig(_)));
}
}
16 changes: 14 additions & 2 deletions src/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,8 @@ pub enum ParentSpanInfo {
span_id: String,
root_span_id: String,
#[serde(skip_serializing_if = "Option::is_none")]
span_parents: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
propagated_event: Option<Map<String, Value>>,
},
}
Expand Down Expand Up @@ -876,6 +878,7 @@ mod tests {
span_id: "span-1".to_string(),
root_span_id: "root-1".to_string(),
compute_object_metadata_args: None,
span_parents: Some(vec!["parent-1".to_string()]),
propagated_event: None,
};

Expand All @@ -884,6 +887,7 @@ mod tests {

// SpanObjectType serializes as u8 for wire compatibility
assert_eq!(obj.get("object_type").unwrap(), 1);
assert_eq!(obj.get("span_parents").unwrap(), &json!(["parent-1"]));
}

#[test]
Expand All @@ -894,15 +898,21 @@ mod tests {
"object_type": 1,
"object_id": "exp-123",
"span_id": "span-1",
"root_span_id": "root-1"
"root_span_id": "root-1",
"span_parents": ["parent-1"]
}
});

let parent: ParentSpanInfo = serde_json::from_value(json).unwrap();

match parent {
ParentSpanInfo::FullSpan { object_type, .. } => {
ParentSpanInfo::FullSpan {
object_type,
span_parents,
..
} => {
assert_eq!(object_type, SpanObjectType::Experiment);
assert_eq!(span_parents, Some(vec!["parent-1".to_string()]));
}
_ => panic!("Expected FullSpan variant"),
}
Expand All @@ -916,6 +926,7 @@ mod tests {
span_id: "span-1".to_string(),
root_span_id: "root-1".to_string(),
compute_object_metadata_args: None,
span_parents: Some(vec!["parent-1".to_string()]),
propagated_event: Some(Map::from_iter([(
"metrics".to_string(),
json!({ "foo": 0.1 }),
Expand All @@ -928,6 +939,7 @@ mod tests {
obj.get("propagated_event").unwrap(),
&json!({ "metrics": { "foo": 0.1 } })
);
assert_eq!(obj.get("span_parents").unwrap(), &json!(["parent-1"]));
}

#[test]
Expand Down
Loading
Loading