feat(server): add endpoint to search spans in a trace (#3611)

kubeshop · Feb 8, 2024 · 3bfdbab · 3bfdbab
1 parent 810b698
commit 3bfdbab
Show file tree

Hide file tree

Showing 16 changed files with 589 additions and 11 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -489,6 +489,34 @@ paths:
             application/json:
               schema:
                 $ref: "tests.yaml#/components/schemas/ExportedTestInformation"
+
+  /tests/{testId}/run/{runId}/search-spans:
+    post:
+      tags:
+        - api
+      parameters:
+        - $ref: "./parameters.yaml#/components/parameters/testId"
+        - $ref: "./parameters.yaml#/components/parameters/runId"
+      summary: get spans fileter by query
+      description: get spans fileter by query
+      operationId: searchSpans
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                query:
+                  type: string
+                  description: query to filter spans, can be either a full text search or a Span Query Language query
+      responses:
+        200:
+          description: trace containing matching spans only
+          content:
+            application/json:
+              schema:
+                $ref: "tests.yaml#/components/schemas/SearchSpansResult"
+
   /tests/import:
     post:
       tags:

diff --git a/api/tests.yaml b/api/tests.yaml
@@ -339,6 +339,14 @@ components:
           items:
             type: string
 
+    SearchSpansResult:
+      type: object
+      properties:
+        spansIds:
+          type: array
+          items:
+            type: string
+
     Selector:
       type: object
       properties:

diff --git a/api/trace.yaml b/api/trace.yaml
@@ -9,7 +9,7 @@ components:
         tree:
           $ref: "#/components/schemas/Span"
         flat:
-          description: falttened version, mapped as spanId -> span{}
+          description: flattened version, mapped as spanId -> span{}
           type: object
           additionalProperties:
             $ref: "#/components/schemas/Span"

diff --git a/cli/openapi/api_api.go b/cli/openapi/api_api.go
diff --git a/cli/openapi/model_search_spans_request.go b/cli/openapi/model_search_spans_request.go