use crate::event::{EventSource, SpanEvent};
use crate::ingest::IngestSource;
use crate::time::micros_to_iso8601;
use serde::Deserialize;
use std::collections::HashMap;
use std::sync::Arc;
pub struct ZipkinIngest {
max_size: usize,
grouping_attributes: Option<Vec<Arc<str>>>,
}
impl ZipkinIngest {
#[must_use]
pub const fn new(max_size: usize) -> Self {
Self {
max_size,
grouping_attributes: None,
}
}
#[must_use]
pub fn with_grouping_attributes(mut self, keys: Vec<Arc<str>>) -> Self {
self.grouping_attributes = Some(keys);
self
}
}
impl IngestSource for ZipkinIngest {
type Error = ZipkinIngestError;
fn ingest(&self, raw: &[u8]) -> Result<Vec<SpanEvent>, Self::Error> {
if raw.len() > self.max_size {
return Err(ZipkinIngestError::PayloadTooLarge {
size: raw.len(),
max: self.max_size,
});
}
let spans: Vec<ZipkinSpan> =
serde_json::from_slice(raw).map_err(ZipkinIngestError::Parse)?;
Ok(convert_zipkin_spans(
&spans,
self.grouping_attributes.as_deref(),
))
}
}
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum ZipkinIngestError {
#[error("payload too large: {size} bytes exceeds maximum of {max} bytes")]
PayloadTooLarge { size: usize, max: usize },
#[error("JSON parse error: {0}")]
Parse(#[from] serde_json::Error),
}
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
struct ZipkinSpan {
trace_id: String,
id: String,
#[serde(default)]
parent_id: Option<String>,
#[serde(default)]
name: Option<String>,
#[serde(default)]
timestamp: Option<u64>,
#[serde(default)]
duration: Option<u64>,
#[serde(default)]
kind: Option<String>,
#[serde(default)]
local_endpoint: Option<ZipkinEndpoint>,
#[serde(default)]
tags: Option<HashMap<String, String>>,
}
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
struct ZipkinEndpoint {
#[serde(default)]
service_name: Option<String>,
}
fn convert_zipkin_spans(
spans: &[ZipkinSpan],
grouping_attributes: Option<&[Arc<str>]>,
) -> Vec<SpanEvent> {
let mut span_index: HashMap<(&str, &str), &ZipkinSpan> = HashMap::new();
for span in spans.iter().filter(|s| !s.id.is_empty()) {
let key = (span.trace_id.as_str(), span.id.as_str());
match span_index.get(&key) {
Some(kept) if kept.kind.as_deref() != Some("CLIENT") => {}
_ => {
span_index.insert(key, span);
}
}
}
spans
.iter()
.filter_map(|s| convert_zipkin_span(s, &span_index, grouping_attributes))
.collect()
}
fn inbound_http_endpoint(span: &ZipkinSpan) -> Option<&str> {
let tag = |key: &str| {
span.tags
.as_ref()
.and_then(|t| t.get(key).map(String::as_str))
.filter(|s| !s.trim().is_empty())
};
tag("http.route").or_else(|| {
if span.kind.as_deref() == Some("CLIENT") {
return None;
}
tag("http.target")
.or_else(|| tag("http.url"))
.or_else(|| tag("url.full"))
})
}
fn tag_code_frame(span: &ZipkinSpan) -> Option<String> {
let tag = |key: &str| {
span.tags
.as_ref()
.and_then(|t| t.get(key).map(String::as_str))
};
let function_name = tag("code.function.name");
let function = function_name.or_else(|| tag("code.function"));
let namespace = tag("code.namespace").map(ToString::to_string).or_else(|| {
function_name
.and_then(crate::ingest::namespace_from_qualified_name)
.map(ToString::to_string)
});
crate::ingest::code_frame_endpoint(namespace.as_deref(), function)
}
fn resolve_source_endpoint(
leaf: &ZipkinSpan,
span_index: &HashMap<(&str, &str), &ZipkinSpan>,
) -> String {
let mut outermost_frame = tag_code_frame(leaf);
let mut current = leaf.parent_id.as_deref();
let mut depth = 0;
while let Some(pid) = current {
let Some(parent) = span_index.get(&(leaf.trace_id.as_str(), pid)) else {
break;
};
if let Some(route) = inbound_http_endpoint(parent) {
return route.to_string();
}
if let Some(frame) = tag_code_frame(parent) {
outermost_frame = Some(frame);
}
if depth >= crate::ingest::ANCESTOR_WALK_MAX_DEPTH {
break;
}
current = parent.parent_id.as_deref();
depth += 1;
}
outermost_frame.unwrap_or_else(|| "unknown".to_string())
}
fn convert_zipkin_span(
span: &ZipkinSpan,
span_index: &HashMap<(&str, &str), &ZipkinSpan>,
grouping_attributes: Option<&[Arc<str>]>,
) -> Option<SpanEvent> {
let tags = span.tags.as_ref();
let get_tag = |key: &str| -> Option<&str> { tags.and_then(|t| t.get(key).map(String::as_str)) };
let db_system = get_tag("db.system.name")
.or_else(|| get_tag("db.system"))
.map(str::trim)
.filter(|s| !s.is_empty())
.map(super::canonical_db_system);
if db_system.is_some_and(super::is_non_sql_db_system) {
return None;
}
let (io_kind, target) =
if let Some(stmt) = get_tag("db.statement").or_else(|| get_tag("db.query.text")) {
(super::TagIoKind::Sql, stmt.to_string())
} else {
(
super::TagIoKind::HttpOut,
get_tag("http.url")
.or_else(|| get_tag("url.full"))?
.to_string(),
)
};
let event_type = io_kind.event_type();
let operation = match io_kind {
super::TagIoKind::Sql => db_system.unwrap_or("sql").to_string(),
super::TagIoKind::HttpOut => get_tag("http.method")
.or_else(|| get_tag("http.request.method"))
.unwrap_or("GET")
.to_string(),
};
let service: Arc<str> = span
.local_endpoint
.as_ref()
.and_then(|ep| ep.service_name.as_deref())
.map_or_else(|| Arc::from(""), Arc::from);
let grouping =
crate::ingest::collect_grouping(grouping_attributes, |key| get_tag(key).map(Arc::from));
let timestamp = span.timestamp.unwrap_or(0);
let duration_us = span.duration.unwrap_or(0);
let status_code = match io_kind {
super::TagIoKind::HttpOut => get_tag("http.status_code")
.or_else(|| get_tag("http.response.status_code"))
.and_then(|s| s.parse().ok()),
super::TagIoKind::Sql => None,
};
let code_function_name = get_tag("code.function.name");
let code_function: Option<Arc<str>> = code_function_name
.or_else(|| get_tag("code.function"))
.map(Arc::from);
let code_filepath: Option<Arc<str>> = get_tag("code.file.path")
.or_else(|| get_tag("code.filepath"))
.map(Arc::from);
let code_lineno = get_tag("code.line.number")
.or_else(|| get_tag("code.lineno"))
.and_then(|s| s.parse::<u32>().ok());
let code_namespace: Option<Arc<str>> = get_tag("code.namespace").map(Arc::from).or_else(|| {
code_function_name
.and_then(crate::ingest::namespace_from_qualified_name)
.map(Arc::from)
});
let endpoint = match io_kind {
super::TagIoKind::Sql => get_tag("http.route")
.or_else(|| get_tag("http.target"))
.filter(|s| !s.trim().is_empty())
.map(ToString::to_string),
super::TagIoKind::HttpOut => None,
}
.unwrap_or_else(|| resolve_source_endpoint(span, span_index));
let method = get_tag("code.function")
.map(String::from)
.or_else(|| span.name.clone())
.unwrap_or_default();
let mut event = SpanEvent {
timestamp: micros_to_iso8601(timestamp),
trace_id: span.trace_id.clone(),
span_id: span.id.clone(),
parent_span_id: span.parent_id.clone(),
link_trace_id: None,
service,
grouping,
cloud_region: None,
event_type,
operation,
target,
duration_us,
source: EventSource { endpoint, method },
status_code,
response_size_bytes: None,
code_function,
code_filepath,
code_lineno,
code_namespace,
instrumentation_scopes: Vec::new(),
};
crate::event::sanitize_span_event(&mut event);
Some(event)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::event::EventType;
fn sample_zipkin_json() -> &'static str {
r#"[
{
"traceId": "abc123",
"id": "span-1",
"name": "OrderService::create_order",
"timestamp": 1720621921123000,
"duration": 1200,
"localEndpoint": { "serviceName": "order-svc" },
"tags": {
"db.statement": "SELECT * FROM order_item WHERE order_id = 42",
"db.system": "postgresql"
}
},
{
"traceId": "abc123",
"id": "span-2",
"parentId": "span-1",
"name": "http-call",
"timestamp": 1720621921200000,
"duration": 15000,
"localEndpoint": { "serviceName": "order-svc" },
"tags": {
"http.url": "http://user-svc:5000/api/users/123",
"http.method": "GET",
"http.status_code": "200"
}
},
{
"traceId": "abc123",
"id": "span-3",
"name": "internal-processing",
"timestamp": 1720621921300000,
"duration": 500,
"localEndpoint": { "serviceName": "order-svc" },
"tags": {
"internal.type": "processing"
}
}
]"#
}
#[test]
fn namespaces_are_extracted_from_span_tags() {
let json = r#"[{
"traceId": "t1",
"id": "s1",
"name": "query",
"timestamp": 1720621921123000,
"duration": 1200,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"db.statement": "SELECT 1",
"service.namespace": "payments",
"k8s.namespace.name": "prod-eu"
}
}]"#;
let events = ZipkinIngest::new(64 * 1024)
.ingest(json.as_bytes())
.unwrap();
let captured: Vec<(&str, &str)> = events[0]
.grouping
.iter()
.map(|g| (g.key.as_ref(), g.value.as_ref()))
.collect();
assert_eq!(
captured,
vec![
("k8s.namespace.name", "prod-eu"),
("service.namespace", "payments"),
],
"both values are kept, config order, Kubernetes first"
);
assert_eq!(events[0].grouping_value(), Some("prod-eu"));
}
#[test]
fn parses_zipkin_export() {
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(sample_zipkin_json().as_bytes()).unwrap();
assert_eq!(events.len(), 2, "non-IO span should be skipped");
}
#[test]
fn sql_span_maps_correctly() {
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(sample_zipkin_json().as_bytes()).unwrap();
let sql = events
.iter()
.find(|e| e.event_type == EventType::Sql)
.unwrap();
assert_eq!(sql.trace_id, "abc123");
assert_eq!(sql.span_id, "span-1");
assert_eq!(&*sql.service, "order-svc");
assert_eq!(sql.operation, "postgresql");
assert_eq!(sql.target, "SELECT * FROM order_item WHERE order_id = 42");
assert_eq!(sql.duration_us, 1200);
assert!(sql.parent_span_id.is_none());
assert_eq!(sql.timestamp, "2024-07-10T14:32:01.123Z");
}
#[test]
fn http_span_maps_correctly() {
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(sample_zipkin_json().as_bytes()).unwrap();
let http = events
.iter()
.find(|e| e.event_type == EventType::HttpOut)
.unwrap();
assert_eq!(http.trace_id, "abc123");
assert_eq!(http.span_id, "span-2");
assert_eq!(http.operation, "GET");
assert_eq!(http.target, "http://user-svc:5000/api/users/123");
assert_eq!(http.duration_us, 15000);
assert_eq!(http.status_code, Some(200));
assert_eq!(http.parent_span_id.as_deref(), Some("span-1"));
}
#[test]
fn non_sql_datastore_span_is_dropped() {
let json = r#"[
{
"traceId": "t1", "id": "s1",
"localEndpoint": { "serviceName": "svc" },
"tags": { "db.system": "redis", "db.statement": "GET user:123" }
},
{
"traceId": "t1", "id": "s2",
"localEndpoint": { "serviceName": "svc" },
"tags": { "db.system": "postgresql", "db.statement": "SELECT 1" }
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert_eq!(events.len(), 1);
assert_eq!(events[0].event_type, EventType::Sql);
assert_eq!(events[0].operation, "postgresql");
}
#[test]
fn db_system_alias_is_canonicalized() {
let json = r#"[
{
"traceId": "t1", "id": "s1",
"localEndpoint": { "serviceName": "svc" },
"tags": { "db.system": "postgres", "db.statement": "SELECT 1" }
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert_eq!(events.len(), 1);
assert_eq!(events[0].event_type, EventType::Sql);
assert_eq!(events[0].operation, "postgresql");
}
#[test]
fn stable_db_system_name_non_sql_is_dropped() {
let json = r#"[
{
"traceId": "t1", "id": "s1",
"localEndpoint": { "serviceName": "svc" },
"tags": { "db.system.name": "aws.dynamodb", "db.statement": "GET key" }
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert!(events.is_empty());
}
#[test]
fn rejects_oversized_payload() {
let ingest = ZipkinIngest::new(10);
let result = ingest.ingest(sample_zipkin_json().as_bytes());
assert!(result.is_err());
}
#[test]
fn malformed_json_not_array() {
let json = r#"{"traceId": "t1"}"#;
let ingest = ZipkinIngest::new(1_048_576);
assert!(ingest.ingest(json.as_bytes()).is_err());
}
#[test]
fn malformed_json_missing_trace_id() {
let json = r#"[{"id": "s1"}]"#;
let ingest = ZipkinIngest::new(1_048_576);
assert!(ingest.ingest(json.as_bytes()).is_err());
}
#[test]
fn malformed_json_missing_span_id() {
let json = r#"[{"traceId": "t1"}]"#;
let ingest = ZipkinIngest::new(1_048_576);
assert!(ingest.ingest(json.as_bytes()).is_err());
}
#[test]
fn empty_array_produces_no_events() {
let json = "[]";
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert!(events.is_empty());
}
#[test]
fn missing_optional_fields_handled() {
let json = r#"[{"traceId": "t1", "id": "s1", "tags": {"db.statement": "SELECT 1"}}]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert_eq!(events.len(), 1);
assert_eq!(events[0].duration_us, 0);
assert_eq!(&*events[0].service, "");
assert!(events[0].parent_span_id.is_none());
}
#[test]
fn no_tags_skips_span() {
let json = r#"[{"traceId": "t1", "id": "s1"}]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert!(events.is_empty());
}
#[test]
fn empty_tags_skips_span() {
let json = r#"[{"traceId": "t1", "id": "s1", "tags": {}}]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert!(events.is_empty());
}
#[test]
fn zero_timestamp_and_duration() {
let json = r#"[{"traceId": "t1", "id": "s1", "timestamp": 0, "duration": 0, "tags": {"db.statement": "SELECT 1"}}]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert_eq!(events[0].timestamp, "1970-01-01T00:00:00.000Z");
assert_eq!(events[0].duration_us, 0);
}
#[test]
fn parent_span_http_route_takes_precedence_over_http_target() {
let json = r#"[
{
"traceId": "t1",
"id": "s1",
"name": "query",
"timestamp": 1720621921123000,
"duration": 500,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"db.statement": "SELECT 1",
"db.system": "postgresql",
"http.route": "POST /api/orders/{id}",
"http.target": "/api/orders/42"
}
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert_eq!(events.len(), 1);
assert_eq!(events[0].source.endpoint, "POST /api/orders/{id}");
}
#[test]
fn http_target_used_only_when_route_absent() {
let json = r#"[
{
"traceId": "t1",
"id": "s1",
"name": "query",
"timestamp": 1720621921123000,
"duration": 500,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"db.statement": "SELECT 1",
"db.system": "postgresql",
"http.target": "/api/orders/42"
}
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert_eq!(events.len(), 1);
assert_eq!(events[0].source.endpoint, "/api/orders/42");
}
#[test]
fn code_frame_used_when_no_http_tag() {
let json = r#"[
{
"traceId": "t1",
"id": "s1",
"name": "query",
"timestamp": 1720621921123000,
"duration": 500,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"db.statement": "SELECT 1",
"db.system": "postgresql",
"code.function.name": "com.foo.PurgeJob.execute"
}
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert_eq!(events.len(), 1);
assert_eq!(events[0].source.endpoint, "com.foo.PurgeJob.execute");
}
#[test]
fn endpoint_resolves_through_ancestors() {
let json = r#"[
{
"traceId": "t1",
"id": "s1",
"name": "post /api/orders",
"kind": "SERVER",
"timestamp": 1720621921123000,
"duration": 5000,
"localEndpoint": { "serviceName": "svc" },
"tags": { "http.route": "POST /api/orders" }
},
{
"traceId": "t1",
"id": "s2",
"parentId": "s1",
"name": "get",
"kind": "CLIENT",
"timestamp": 1720621921123100,
"duration": 3000,
"localEndpoint": { "serviceName": "svc" },
"tags": { "http.url": "https://partner.example/v1/pay" }
},
{
"traceId": "t1",
"id": "s3",
"parentId": "s2",
"name": "query",
"timestamp": 1720621921123200,
"duration": 500,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"db.statement": "SELECT 1",
"db.system": "postgresql"
}
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
let sql = events
.iter()
.find(|e| e.event_type == EventType::Sql)
.expect("sql leaf present");
assert_eq!(sql.source.endpoint, "POST /api/orders");
}
#[test]
fn shared_span_keeps_the_server_half() {
let json = r#"[
{
"traceId": "t1",
"id": "s1",
"kind": "SERVER",
"name": "post /api/orders",
"timestamp": 1720621921123000,
"duration": 5000,
"localEndpoint": { "serviceName": "svc" },
"tags": { "http.route": "POST /api/orders" }
},
{
"traceId": "t1",
"id": "s1",
"kind": "CLIENT",
"shared": true,
"name": "post /api/orders",
"timestamp": 1720621921122000,
"duration": 6000,
"localEndpoint": { "serviceName": "caller" },
"tags": { "http.url": "https://svc-b/api/orders" }
},
{
"traceId": "t1",
"id": "s2",
"parentId": "s1",
"name": "query",
"timestamp": 1720621921123200,
"duration": 500,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"db.statement": "SELECT 1",
"db.system": "postgresql"
}
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
let sql = events
.iter()
.find(|e| e.event_type == EventType::Sql)
.expect("sql leaf present");
assert_eq!(sql.source.endpoint, "POST /api/orders");
}
#[test]
fn outbound_span_does_not_take_its_own_http_target() {
let json = r#"[
{
"traceId": "t1",
"id": "s1",
"kind": "SERVER",
"name": "post /api/orders",
"timestamp": 1720621921123000,
"duration": 5000,
"localEndpoint": { "serviceName": "svc" },
"tags": { "http.route": "POST /api/orders" }
},
{
"traceId": "t1",
"id": "s2",
"parentId": "s1",
"kind": "CLIENT",
"name": "get",
"timestamp": 1720621921123200,
"duration": 500,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"http.url": "https://partner.example/v1/pay",
"http.target": "/v1/pay"
}
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
let out = events
.iter()
.find(|e| e.event_type == EventType::HttpOut)
.expect("outbound event present");
assert_eq!(out.source.endpoint, "POST /api/orders");
assert_eq!(out.target, "https://partner.example/v1/pay");
}
#[test]
fn endpoint_falls_back_to_unknown_not_empty() {
let json = r#"[
{
"traceId": "t1",
"id": "s1",
"name": "query",
"timestamp": 1720621921123000,
"duration": 500,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"db.statement": "SELECT 1",
"db.system": "postgresql"
}
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert_eq!(events[0].source.endpoint, "unknown");
}
#[test]
fn stable_semconv_tags() {
let json = r#"[
{
"traceId": "t1",
"id": "s1",
"name": "query",
"timestamp": 1720621921123000,
"duration": 500,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"db.query.text": "SELECT 1",
"db.system": "mysql"
}
},
{
"traceId": "t1",
"id": "s2",
"name": "fetch",
"timestamp": 1720621921200000,
"duration": 1000,
"localEndpoint": { "serviceName": "svc" },
"tags": {
"url.full": "http://api/items",
"http.request.method": "POST",
"http.response.status_code": "201"
}
}
]"#;
let ingest = ZipkinIngest::new(1_048_576);
let events = ingest.ingest(json.as_bytes()).unwrap();
assert_eq!(events.len(), 2);
let sql = &events[0];
assert_eq!(sql.target, "SELECT 1");
assert_eq!(sql.operation, "mysql");
let http = &events[1];
assert_eq!(http.target, "http://api/items");
assert_eq!(http.operation, "POST");
assert_eq!(http.status_code, Some(201));
}
}