hatchet-dev
diff --git a/‎.github/workflows/sdk-python.yml‎
Lines changed: 1 addition & 0 deletions b/‎.github/workflows/sdk-python.yml‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎.golangci.yml‎
Lines changed: 2 additions & 0 deletions b/‎.golangci.yml‎
Lines changed: 2 additions & 0 deletions
diff --git a/‎.pre-commit-config.yaml‎
Lines changed: 1 addition & 1 deletion b/‎.pre-commit-config.yaml‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎api-contracts/openapi/components/schemas/_index.yaml‎
Lines changed: 8 additions & 0 deletions b/‎api-contracts/openapi/components/schemas/_index.yaml‎
Lines changed: 8 additions & 0 deletions
diff --git a/‎api-contracts/openapi/components/schemas/v1/otel.yaml‎
Lines changed: 82 additions & 0 deletions b/‎api-contracts/openapi/components/schemas/v1/otel.yaml‎
Lines changed: 82 additions & 0 deletions
diff --git a/‎api-contracts/openapi/openapi.yaml‎
Lines changed: 2 additions & 0 deletions b/‎api-contracts/openapi/openapi.yaml‎
Lines changed: 2 additions & 0 deletions
diff --git a/‎api-contracts/openapi/paths/v1/observability/traces.yaml‎
Lines changed: 66 additions & 0 deletions b/‎api-contracts/openapi/paths/v1/observability/traces.yaml‎
Lines changed: 66 additions & 0 deletions
diff --git a/‎api-contracts/openapi/paths/v1/workflow-runs/workflow_run.yaml‎
Lines changed: 1 addition & 0 deletions b/‎api-contracts/openapi/paths/v1/workflow-runs/workflow_run.yaml‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎api/v1/server/handlers/v1/observability/service.go‎
Lines changed: 16 additions & 0 deletions b/‎api/v1/server/handlers/v1/observability/service.go‎
Lines changed: 16 additions & 0 deletions
diff --git a/‎api/v1/server/handlers/v1/observability/traces.go‎
Lines changed: 56 additions & 0 deletions b/‎api/v1/server/handlers/v1/observability/traces.go‎
Lines changed: 56 additions & 0 deletions
@@ -102,6 +102,7 @@ jobs:
           export SERVER_DEFAULT_ENGINE_VERSION=V1
           export SERVER_MSGQUEUE_RABBITMQ_URL="amqp://user:password@localhost:5672/"
           export SERVER_OPTIMISTIC_SCHEDULING_ENABLED=${{ matrix.optimistic-scheduling }}
+          export SERVER_OBSERVABILITY_ENABLED=true
 
           go run ./cmd/hatchet-admin quickstart
 
 
@@ -56,6 +56,7 @@ linters:
       - third_party$
       - builtin$
       - ^examples/
+      - ^sdks/go/examples/
       - '(.+)_test\.go'
       - "cmd/hatchet-loadtest/rampup/(.+).go"
 formatters:
@@ -72,3 +73,4 @@ formatters:
       - third_party$
       - builtin$
       - ^examples/
+      - ^sdks/go/examples/
@@ -18,4 +18,4 @@ repos:
     hooks:
       - id: golangci-lint
         args: ["--config=.golangci.yml", "--allow-parallel-runners"]
-        exclude: ^(examples/|sdks/guides/go/)
+        exclude: ^(examples/|sdks/guides/go/|sdks/go/examples/)
@@ -414,3 +414,11 @@ V1CELDebugResponse:
   $ref: "./v1/cel.yaml#/V1CELDebugResponse"
 V1CELDebugResponseStatus:
   $ref: "./v1/cel.yaml#/V1CELDebugResponseStatus"
+OtelSpan:
+  $ref: "./v1/otel.yaml#/OtelSpan"
+OtelSpanKind:
+  $ref: "./v1/otel.yaml#/OtelSpanKind"
+OtelStatusCode:
+  $ref: "./v1/otel.yaml#/OtelStatusCode"
+OtelSpanList:
+  $ref: "./v1/otel.yaml#/OtelSpanList"
@@ -0,0 +1,82 @@
+OtelSpan:
+  type: object
+  properties:
+    traceId:
+      type: string
+    spanId:
+      type: string
+    parentSpanId:
+      type: string
+    spanName:
+      type: string
+    spanKind:
+      $ref: "#/OtelSpanKind"
+    serviceName:
+      type: string
+    statusCode:
+      $ref: "#/OtelStatusCode"
+    statusMessage:
+      type: string
+    durationNs:
+      type: integer
+      format: int64
+    createdAt:
+      type: string
+      format: date-time
+    resourceAttributes:
+      type: object
+      additionalProperties:
+        type: string
+    spanAttributes:
+      type: object
+      additionalProperties:
+        type: string
+    scopeName:
+      type: string
+    scopeVersion:
+      type: string
+    retryCount:
+      type: integer
+      format: int32
+  required:
+    - traceId
+    - spanId
+    - spanName
+    - spanKind
+    - serviceName
+    - statusCode
+    - durationNs
+    - createdAt
+    - retryCount
+
+OtelSpanKind:
+  type: string
+  enum:
+    - UNSPECIFIED
+    - INTERNAL
+    - SERVER
+    - CLIENT
+    - PRODUCER
+    - CONSUMER
+
+OtelStatusCode:
+  type: string
+  enum:
+    - UNSET
+    - OK
+    - ERROR
+
+OtelSpanList:
+  type: object
+  properties:
+    pagination:
+      $ref: "../metadata.yaml#/PaginationResponse"
+    retryCounts:
+      type: array
+      items:
+        type: integer
+        format: int32
+    rows:
+      type: array
+      items:
+        $ref: "#/OtelSpan"
@@ -57,6 +57,8 @@ paths:
     $ref: "./paths/v1/workflow-runs/workflow_run.yaml#/getWorkflowRunStatus"
   /api/v1/stable/workflow-runs/{v1-workflow-run}/task-events:
     $ref: "./paths/v1/workflow-runs/workflow_run.yaml#/listTaskEventsForWorkflowRun"
+  /api/v1/stable/tenants/{tenant}/traces:
+    $ref: "./paths/v1/observability/traces.yaml#/getTrace"
   /api/v1/stable/workflow-runs/{v1-workflow-run}/task-timings:
     $ref: "./paths/v1/workflow-runs/workflow_run.yaml#/getTimings"
   /api/v1/stable/tenants/{tenant}/task-metrics:
 
@@ -0,0 +1,66 @@
+getTrace:
+  get:
+    x-resources: ["tenant"]
+    description: Get OTel trace for a workflow run
+    operationId: v1-observability:get-trace
+    parameters:
+      - description: The tenant id
+        in: path
+        name: tenant
+        required: true
+        schema:
+          type: string
+          format: uuid
+          minLength: 36
+          maxLength: 36
+      - description: The workflow run external id
+        in: query
+        name: run_external_id
+        required: true
+        schema:
+          type: string
+          format: uuid
+          minLength: 36
+          maxLength: 36
+      - description: The number of spans to skip
+        in: query
+        name: offset
+        required: false
+        schema:
+          type: integer
+          format: int64
+      - description: The number of spans to limit by
+        in: query
+        name: limit
+        required: false
+        schema:
+          type: integer
+          format: int64
+    responses:
+      "200":
+        content:
+          application/json:
+            schema:
+              $ref: "../../../components/schemas/_index.yaml#/OtelSpanList"
+        description: Successfully retrieved the OTel trace
+      "400":
+        content:
+          application/json:
+            schema:
+              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
+        description: A malformed or bad request
+      "403":
+        content:
+          application/json:
+            schema:
+              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
+        description: Forbidden
+      "404":
+        content:
+          application/json:
+            schema:
+              $ref: "../../../components/schemas/_index.yaml#/APIErrors"
+        description: Trace not found
+    summary: Get OTel trace
+    tags:
+      - Observability
@@ -485,6 +485,7 @@ trigger:
     tags:
       - Workflow Runs
 
+
 branchDurableTask:
   post:
     x-resources: ["tenant"]
 
@@ -0,0 +1,16 @@
+package observability
+
+import (
+	"github.com/hatchet-dev/hatchet/pkg/config/server"
+)
+
+type V1ObservabilityService struct {
+	config *server.ServerConfig
+}
+
+func NewV1ObservabilityService(config *server.ServerConfig) *V1ObservabilityService {
+
+	return &V1ObservabilityService{
+		config: config,
+	}
+}
@@ -0,0 +1,56 @@
+package observability
+
+import (
+	"errors"
+
+	"github.com/jackc/pgx/v5"
+	"github.com/labstack/echo/v4"
+
+	"github.com/hatchet-dev/hatchet/api/v1/server/oas/gen"
+	transformers "github.com/hatchet-dev/hatchet/api/v1/server/oas/transformers/v1"
+	"github.com/hatchet-dev/hatchet/pkg/repository/sqlcv1"
+)
+
+func (t *V1ObservabilityService) V1ObservabilityGetTrace(ctx echo.Context, request gen.V1ObservabilityGetTraceRequestObject) (gen.V1ObservabilityGetTraceResponseObject, error) {
+	if !t.config.Observability.Enabled {
+		return gen.V1ObservabilityGetTrace200JSONResponse(gen.OtelSpanList{}), nil
+	}
+
+	tenant := ctx.Get("tenant").(*sqlcv1.Tenant)
+
+	limit := int64(1000)
+	offset := int64(0)
+
+	if request.Params.Limit != nil {
+		limit = *request.Params.Limit
+	}
+
+	if request.Params.Offset != nil {
+		offset = *request.Params.Offset
+	}
+
+	if limit < 1 {
+		limit = 1000
+	}
+
+	if offset < 0 {
+		offset = 0
+	}
+
+	traceId, err := t.config.V1.OTelLookup().LookUpTraceId(ctx.Request().Context(), tenant.ID, request.Params.RunExternalId)
+
+	if errors.Is(err, pgx.ErrNoRows) {
+		return gen.V1ObservabilityGetTrace404JSONResponse(gen.APIErrors{
+			Errors: []gen.APIError{{Description: "Trace not found"}},
+		}), nil
+	} else if err != nil {
+		return nil, err
+	}
+
+	result, err := t.config.V1.OTelCollector().ListSpansByTraceId(ctx.Request().Context(), tenant.ID, traceId, offset, limit)
+	if err != nil {
+		return nil, err
+	}
+
+	return gen.V1ObservabilityGetTrace200JSONResponse(transformers.ToV1OtelSpanList(result.Rows, nil, limit, offset, result.Total)), nil
+}