Support/Developer Platform/Logs, diagnostics, and correlation tracing

Developer Platform

Logs, diagnostics, and correlation tracing

Tail and search bounded app logs, then follow one correlation ID across related operational evidence.

Scope
logs.read
Boundary
App-scoped
Primary key
Correlation ID

The Developer API exposes operational evidence without opening tenant log tables or returning infrastructure routes. Every query is bound to the authenticated SaaS app and returns bounded, sanitized results.

Current routes

GET /v1/apps/{saasAppId}/logs/tail
GET /v1/apps/{saasAppId}/logs/search
GET /v1/apps/{saasAppId}/logs/correlations/{logCorrelationId}

A practical incident workflow

  1. Capture the correlation ID from the failing API response, webhook delivery, CLI output, or user-visible error.
  2. Query the correlation route first; it is more precise than a broad text search.
  3. Use search for a known safe term, component, or error code when no correlation ID exists.
  4. Use tail only for a short live observation window.
  5. Record the correlation ID—not a copied secret or full customer payload—in the incident ticket.

What is intentionally absent

The log API returns bounded operational evidence and omits connection strings, database/server names, provider credentials, raw authorization headers, operator-only stack traces, and unrestricted tenant data.

Tip

Make correlation ID a first-class field in your integration logger. It turns support from timestamp guessing into one bounded lookup.