only return root spans for jaeger http api (#5358)

trinity-1686a · fmassot · commit 5df401509ed9 · 2024-09-02T09:30:13.000+02:00
* only return root spans for jaeger http api

* fix rest api tests
diff --git a/quickwit/quickwit-jaeger/src/lib.rs b/quickwit/quickwit-jaeger/src/lib.rs
@@ -193,6 +193,7 @@ impl JaegerService {
         operation_name: &'static str,
         request_start: Instant,
         index_id_patterns: Vec<String>,
+        root_only: bool,
     ) -> JaegerResult<SpanStream> {
         debug!(request=?request, "`find_traces` request");
 
@@ -212,6 +213,7 @@ impl JaegerService {
                 operation_name,
                 request_start,
                 index_id_patterns,
+                root_only,
             )
             .await?;
         Ok(response)
@@ -239,6 +241,7 @@ impl JaegerService {
                 operation_name,
                 request_start,
                 index_id_patterns,
+                false,
             )
             .await?;
         Ok(response)
@@ -302,6 +305,7 @@ impl JaegerService {
         operation_name: &'static str,
         request_start: Instant,
         index_id_patterns: Vec<String>,
+        root_only: bool,
     ) -> Result<SpanStream, Status> {
         if trace_ids.is_empty() {
             let (_tx, rx) = mpsc::channel(1);
@@ -318,6 +322,15 @@ impl JaegerService {
             };
             query.should.push(term_query.into());
         }
+        if root_only {
+            // TODO this isn't backward compatible. We could do NOT is_root:false with a lenient
+            // UserInputQuery once we support being lenient on missing fields
+            let term_query = TermQuery {
+                field: "is_root".to_string(),
+                value: "true".to_string(),
+            };
+            query.must.push(term_query.into());
+        }
 
         let query_ast: QueryAst = query.into();
         let query_ast =
@@ -525,6 +538,9 @@ impl SpanReaderPlugin for JaegerService {
             "find_traces",
             Instant::now(),
             index_id_patterns,
+            false, /* if we use true, Jaeger will display "1 Span", and display an empty trace
+                    * when clicking on the ui (but display the full trace after reloading the
+                    * page) */
         )
         .await
         .map(Response::new)
@@ -2162,6 +2178,7 @@ mod tests {
                 message: Some("An error occurred.".to_string()),
             },
             parent_span_id: Some(SpanId::new([3; 8])),
+            is_root: Some(false),
             events: vec![QwEvent {
                 event_timestamp_nanos: 1000500003,
                 event_name: "event_name".to_string(),
diff --git a/quickwit/quickwit-opentelemetry/src/otlp/traces.rs b/quickwit/quickwit-opentelemetry/src/otlp/traces.rs
@@ -51,7 +51,7 @@ use super::{
 use crate::otlp::metrics::OTLP_SERVICE_METRICS;
 use crate::otlp::{extract_attributes, SpanId, TraceId};
 
-pub const OTEL_TRACES_INDEX_ID: &str = "otel-traces-v0_7";
+pub const OTEL_TRACES_INDEX_ID: &str = "otel-traces-v0_9";
 pub const OTEL_TRACES_INDEX_ID_PATTERN: &str = "otel-traces-v0_*";
 
 const OTEL_TRACES_INDEX_CONFIG: &str = r#"
@@ -143,6 +143,10 @@ doc_mapping:
       input_format: hex
       output_format: hex
       indexed: false
+    - name: is_root
+      type: bool
+      indexed: true
+      stored: false
     - name: events
       type: array<json>
       tokenizer: raw
@@ -230,6 +234,8 @@ pub struct Span {
     pub span_status: SpanStatus,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub parent_span_id: Option<SpanId>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub is_root: Option<bool>,
     #[serde(default)]
     #[serde(skip_serializing_if = "Vec::is_empty")]
     pub events: Vec<Event>,
@@ -311,6 +317,7 @@ impl Span {
             span_dropped_events_count: span.dropped_events_count,
             span_dropped_links_count: span.dropped_links_count,
             span_status: span.status.map(SpanStatus::from_otlp).unwrap_or_default(),
+            is_root: Some(parent_span_id.is_none()),
             parent_span_id,
             events,
             event_names,
@@ -1267,6 +1274,7 @@ mod tests {
                 span_dropped_links_count: 0,
                 span_status: SpanStatus::default(),
                 parent_span_id: None,
+                is_root: Some(true),
                 events: Vec::new(),
                 event_names: Vec::new(),
                 links: Vec::new(),
@@ -1309,6 +1317,7 @@ mod tests {
                     message: None,
                 },
                 parent_span_id: Some(SpanId::new([3; 8])),
+                is_root: Some(false),
                 events: vec![Event {
                     event_timestamp_nanos: 1,
                     event_name: "event_name".to_string(),
@@ -1362,6 +1371,7 @@ mod tests {
             span_dropped_links_count: 0,
             span_status: SpanStatus::default(),
             parent_span_id: None,
+            is_root: Some(true),
             events: Vec::new(),
             event_names: Vec::new(),
             links: Vec::new(),
diff --git a/quickwit/quickwit-serve/src/jaeger_api/rest_handler.rs b/quickwit/quickwit-serve/src/jaeger_api/rest_handler.rs
@@ -56,7 +56,7 @@ pub(crate) struct JaegerApi;
 ///
 /// This is where all Jaeger handlers
 /// should be registered.
-/// Request are executed on the `otel traces v0_7` index.
+/// Request are executed on the `otel-traces-v0_*` indexes.
 pub(crate) fn jaeger_api_handlers(
     jaeger_service_opt: Option<JaegerService>,
 ) -> impl Filter<Extract = (impl warp::Reply,), Error = Rejection> + Clone {
@@ -259,6 +259,7 @@ async fn jaeger_traces_search(
             "find_traces",
             Instant::now(),
             index_id_patterns,
+            true,
         )
         .await
         .map_err(|error| {
@@ -351,7 +352,7 @@ mod tests {
     async fn test_when_jaeger_not_found() {
         let jaeger_api_handler = jaeger_api_handlers(None).recover(recover_fn);
         let resp = warp::test::request()
-            .path("/otel-traces-v0_7/jaeger/api/services")
+            .path("/otel-traces-v0_9/jaeger/api/services")
             .reply(&jaeger_api_handler)
             .await;
         let error_body = serde_json::from_slice::<HashMap<String, String>>(resp.body()).unwrap();
@@ -383,7 +384,7 @@ mod tests {
 
         let jaeger_api_handler = jaeger_api_handlers(Some(jaeger)).recover(recover_fn);
         let resp = warp::test::request()
-            .path("/otel-traces-v0_7/jaeger/api/services")
+            .path("/otel-traces-v0_9/jaeger/api/services")
             .reply(&jaeger_api_handler)
             .await;
         assert_eq!(resp.status(), 200);
@@ -419,7 +420,7 @@ mod tests {
         let jaeger = JaegerService::new(JaegerConfig::default(), mock_search_service);
         let jaeger_api_handler = jaeger_api_handlers(Some(jaeger)).recover(recover_fn);
         let resp = warp::test::request()
-            .path("/otel-traces-v0_7/jaeger/api/services/service1/operations")
+            .path("/otel-traces-v0_9/jaeger/api/services/service1/operations")
             .reply(&jaeger_api_handler)
             .await;
         assert_eq!(resp.status(), 200);
@@ -467,7 +468,7 @@ mod tests {
         let jaeger_api_handler = jaeger_api_handlers(Some(jaeger)).recover(recover_fn);
         let resp = warp::test::request()
             .path(
-                "/otel-traces-v0_7/jaeger/api/traces?service=quickwit&\
+                "/otel-traces-v0_9/jaeger/api/traces?service=quickwit&\
                  operation=delete_splits_marked_for_deletion&minDuration=500us&maxDuration=1.2s&\
                  tags=%7B%22tag.first%22%3A%22common%22%2C%22tag.second%22%3A%22true%22%7D&\
                  limit=1&start=1702352106016000&end=1702373706016000&lookback=custom",
@@ -498,7 +499,7 @@ mod tests {
 
         let jaeger_api_handler = jaeger_api_handlers(Some(jaeger)).recover(recover_fn);
         let resp = warp::test::request()
-            .path("/otel-traces-v0_7/jaeger/api/traces/1506026ddd216249555653218dc88a6c")
+            .path("/otel-traces-v0_9/jaeger/api/traces/1506026ddd216249555653218dc88a6c")
             .reply(&jaeger_api_handler)
             .await;
 
diff --git a/quickwit/rest-api-tests/scenarii/es_compatibility/0021-cat-indices.yaml b/quickwit/rest-api-tests/scenarii/es_compatibility/0021-cat-indices.yaml
@@ -18,7 +18,7 @@ expected:
   #uuid: gharchive:01HN2SDANHDN6WFAFNH7BBMQ8C
 - index: otel-logs-v0_7
   docs.count: '0'
-- index: otel-traces-v0_7
+- index: otel-traces-v0_9
   docs.count: '0'
 ---
 method: [GET]
