Add: Sandbox Logs V2 endpoint #1647

ben-fornefeld · 2025-12-23T16:10:10Z

Removes sending redundant log arrays on each response
Adds a "direction" parameter, which is required to build a sophisticated logs viewer inside e2b-dev/dashboard
Renames "start" to "cursor"

Note

Adds a new logs API focused on structured entries and navigable ranges.

Introduces GET /v2/sandboxes/{sandboxID}/logs with cursor, limit, and direction (forward/backward); returns SandboxLogsV2Response (structured logs only)
Deprecates GET /sandboxes/{sandboxID}/logs in spec; keeps existing behavior for backward compatibility
Edge service: V1SandboxLogs now supports end and direction; default forward/backward handling wired through to Loki
Logger provider: QuerySandboxLogs now accepts direction and passes it to Loki
API handler (sandbox_logs_v2.go): maps request params to edge call with a max 7-day window around cursor
Updates OpenAPI specs, generated clients/types, enums, and routing to expose the new endpoint and parameters

^{Written by Cursor Bugbot for commit 7e0ef78. This will update automatically on new commits. Configure here.}

- Introduced new endpoint (GET /v2/sandboxes/{sandboxID}/logs) to fetch structured logs for a specific sandbox. - Added corresponding middleware and request handling in the server interface. - Defined new parameters and response types for the V2 sandbox logs. - Updated OpenAPI specifications to include the new endpoint and response structure.

- Merged QuerySandboxLogs and QuerySandboxLogsV2 into a single method with an updated signature to include the direction parameter. - Removed the old QuerySandboxLogs method implementation to streamline the logging query process.

- Consolidated V2 sandbox logs handling into V1 API, removing the deprecated V2 endpoint. - Updated method signatures to include optional parameters for start, end, limit, and direction. - Adjusted response structures to streamline log entries and improve consistency. - Enhanced OpenAPI specifications to reflect the changes in parameters and responses.

claude · 2025-12-23T16:11:25Z

packages/api/internal/handlers/sandbox_logs_v2.go

+		cursor := time.UnixMilli(*params.Cursor)
+		if direction == api.LogsDirectionForward {
+			start = cursor
+			end = cursor.Add(sandboxLogsMaxTimeRange)


When direction is forward and cursor is near the present, end can extend into the future (line 52). This could cause unexpected behavior. Consider capping end at time.Now() to prevent querying future timestamps.

invalid, template build logs uses the same pattern, querying future timestamps in loki is harmless

claude · 2025-12-23T16:11:33Z

packages/api/internal/handlers/sandbox_logs_v2.go

+
+	start, end := time.Now().Add(-sandboxLogsMaxTimeRange), time.Now()
+	if params.Cursor != nil {
+		cursor := time.UnixMilli(*params.Cursor)


The cursor timestamp is not validated before use. While the OpenAPI spec defines minimum: 0, consider adding validation to ensure the cursor is within a reasonable range (e.g., not older than 7 days, not in the future) to prevent excessive queries or invalid time ranges.

i think this is fine, it's handled the same in template build logs, excessive cursors just return empty results

claude · 2025-12-23T16:11:45Z

packages/api/internal/handlers/sandbox_logs_v2.go

+	}
+
+	if res.JSON200 == nil {
+		telemetry.ReportCriticalError(ctx, "error when returning logs for sandbox", fmt.Errorf("unexpected response for sandbox '%s': %s", sandboxID, string(res.Body)))


Converting the entire response body to string for error logging could expose sensitive data or cause memory issues with large responses. Consider logging just the HTTP status code and truncating the body, or using a structured error response if available.

taken from sandbox logs v1

dobrac

lgtm, just few nits

dobrac · 2025-12-23T17:13:24Z

spec/openapi.yml

        "500":
          $ref: "#/components/responses/500"

  /sandboxes/{sandboxID}/logs:


can you please make this endpoint deprecated?

dobrac · 2025-12-23T17:14:00Z

spec/openapi-edge.yml

      properties:
        logs:
          default: []
-          description: Sandbox logs


why removal of this?

slipped through, thanks

dobrac · 2025-12-23T17:15:12Z

packages/api/internal/handlers/sandbox_logs_v2.go

+	ctx := c.Request.Context()
+	sandboxID = utils.ShortID(sandboxID)
+
+	team := c.Value(auth.TeamContextKey).(*types.Team)


you can use GetTeamInfo instead

dobrac · 2025-12-23T17:15:29Z

packages/api/internal/handlers/sandbox_logs_v2.go

+	team := c.Value(auth.TeamContextKey).(*types.Team)
+
+	telemetry.SetAttributes(ctx,
+		attribute.String("instance.id", sandboxID),


use telemetry.WithSandboxID instead

dobrac · 2025-12-23T17:16:34Z

packages/api/internal/handlers/sandbox_logs_v2.go

+		d := apiedge.V1SandboxLogsParamsDirectionForward
+		edgeDirection = &d


you can use utils.ToPtr instead

packages/client-proxy/internal/edge/handlers/sandbox-logs.go

sitole · 2026-01-13T15:03:08Z

Main PR with API migration is merged, I would wait for this #1713 one, and then I will apply your changes to the current main.

ben-fornefeld added 3 commits December 19, 2025 15:59

Refactor QuerySandboxLogs method signature

c2a9843

- Merged QuerySandboxLogs and QuerySandboxLogsV2 into a single method with an updated signature to include the direction parameter. - Removed the old QuerySandboxLogs method implementation to streamline the logging query process.

ben-fornefeld added the improvement Improvement for current functionality label Dec 23, 2025

e2b-request-same-site-reviewers bot assigned dobrac Dec 23, 2025

claude bot reviewed Dec 23, 2025

View reviewed changes

refactor: direction forwards by default to stay back-compatible

77fc650

ben-fornefeld marked this pull request as ready for review December 23, 2025 16:35

ben-fornefeld requested review from ValentaTomas, dobrac and jakubno as code owners December 23, 2025 16:35

dobrac requested changes Dec 23, 2025

View reviewed changes

ben-fornefeld added 2 commits December 23, 2025 18:31

address nits

4724bea

mark old logs endpoint deprecated

a0abea5

cursor bot reviewed Dec 23, 2025

View reviewed changes

packages/client-proxy/internal/edge/handlers/sandbox-logs.go Show resolved Hide resolved

chore: edge api spec description

7e0ef78

sitole self-requested a review December 30, 2025 10:37

sitole self-assigned this Dec 30, 2025

		d := apiedge.V1SandboxLogsParamsDirectionForward
		edgeDirection = &d

Add: Sandbox Logs V2 endpoint #1647

Are you sure you want to change the base?

Add: Sandbox Logs V2 endpoint #1647

Uh oh!

Conversation

ben-fornefeld commented Dec 23, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

claude bot Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

claude bot Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

claude bot Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dobrac left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sitole commented Jan 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ben-fornefeld commented Dec 23, 2025 •

edited by cursor bot

Loading