Skip to content

Add observation hierarchies with groups and multi-part payloads #52

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

Closed
Dig-Doug wants to merge 1 commit into from
Closed

Add observation hierarchies with groups and multi-part payloads #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ observation-tools-macros = { path = "crates/observation-tools-macros", version =
observation-tools-server = { path = "crates/observation-tools-server", version = "0.0.14" }
observation-tools-shared = { path = "crates/observation-tools-shared", version = "0.0.14" }
openapiv3 = "2.2"
prost = "0.13"
prettyplease = "0.2"
progenitor = "0.11.2"
progenitor-client = "0.11.2"
Expand Down
147 changes: 122 additions & 25 deletions crates/observation-tools-client/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,15 @@
},
{
"properties": {
"payload": {
"$ref": "#/components/schemas/PayloadOrPointerResponse"
"payloads": {
"items": {
"$ref": "#/components/schemas/GetPayload"
},
"type": "array"
}
},
"required": [
"payload"
"payloads"
],
"type": "object"
}
Expand All @@ -105,6 +108,39 @@
],
"type": "object"
},
"GetPayload": {
"properties": {
"data": {
"$ref": "#/components/schemas/PayloadOrPointerResponse"
},
"id": {
"$ref": "#/components/schemas/PayloadId"
},
"mime_type": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"id",
"name",
"mime_type",
"size",
"data"
],
"type": "object"
},
"GroupId": {
"description": "Unique identifier for a group\n\nGroup IDs are user-provided strings. By default, a UUID v7 string is generated,\nbut any string value is accepted.",
"example": "018e9a3a2c1b7e3f8d2a4b5c6d7e8f9b",
"type": "string"
},
"ListExecutionsResponse": {
"description": "Response for listing executions",
"properties": {
Expand Down Expand Up @@ -170,17 +206,17 @@
"$ref": "#/components/schemas/ExecutionId",
"description": "ID of the execution this observation belongs to"
},
"id": {
"$ref": "#/components/schemas/ObservationId",
"description": "Unique identifier for this observation"
},
"labels": {
"description": "Hierarchical labels for grouping observations\nUses path convention (e.g., \"api/request/headers\")",
"group_ids": {
"description": "IDs of groups this observation belongs to",
"items": {
"type": "string"
"$ref": "#/components/schemas/GroupId"
},
"type": "array"
},
"id": {
"$ref": "#/components/schemas/ObservationId",
"description": "Unique identifier for this observation"
},
"log_level": {
"$ref": "#/components/schemas/LogLevel",
"description": "Log level for this observation"
Expand All @@ -195,10 +231,6 @@
},
"type": "object"
},
"mime_type": {
"description": "MIME type of the payload (e.g., \"text/plain\", \"application/json\")",
"type": "string"
},
"name": {
"description": "User-defined name for this observation",
"type": "string"
Expand All @@ -207,16 +239,16 @@
"$ref": "#/components/schemas/ObservationType",
"description": "Type of observation"
},
"parent_group_id": {
"$ref": "#/components/schemas/GroupId",
"description": "Parent group ID (used when observation_type == Group)",
"nullable": true
},
"parent_span_id": {
"description": "Parent span ID (for tracing integration)",
"nullable": true,
"type": "string"
},
"payload_size": {
"description": "Size of the payload in bytes",
"minimum": 0,
"type": "integer"
},
"source": {
"$ref": "#/components/schemas/SourceInfo",
"description": "Source location where this observation was created",
Expand All @@ -229,9 +261,7 @@
"name",
"observation_type",
"log_level",
"created_at",
"mime_type",
"payload_size"
"created_at"
],
"type": "object"
},
Expand All @@ -245,10 +275,16 @@
"enum": [
"LogEntry",
"Payload",
"Span"
"Span",
"Group"
],
"type": "string"
},
"PayloadId": {
"description": "Unique identifier for a payload (UUIDv7)",
"example": "018e9a3a2c1b7e3f8d2a4b5c6d7e8f9c",
"type": "string"
},
"PayloadOrPointerResponse": {
"oneOf": [
{
Expand Down Expand Up @@ -556,7 +592,7 @@
},
"/api/exe/{execution_id}/obs/{observation_id}/content": {
"get": {
"operationId": "get_observation_blob",
"operationId": "get_observation_blob_legacy",
"parameters": [
{
"description": "Execution ID",
Expand Down Expand Up @@ -600,7 +636,68 @@
"description": "Observation blob not found"
}
},
"summary": "Get observation blob content",
"summary": "Get observation blob content (legacy route for backward compat)\nThis is kept to support old URLs like /api/exe/{exec_id}/obs/{obs_id}/content",
"tags": [
"observations"
]
}
},
"/api/exe/{execution_id}/obs/{observation_id}/payload/{payload_id}/content": {
"get": {
"operationId": "get_observation_blob",
"parameters": [
{
"description": "Execution ID",
"in": "path",
"name": "execution_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Observation ID",
"in": "path",
"name": "observation_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Payload ID",
"in": "path",
"name": "payload_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/octet-stream": {
"schema": {
"items": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"type": "array"
}
}
},
"description": "Payload content"
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Payload not found"
}
},
"summary": "Get observation payload content",
"tags": [
"observations"
]
Expand Down
Loading
Loading