OrbitsDocs
esc
    Open Orbits
    API reference · ObserveLogs and observability

    Runtime logs and observability

    What a project's apps print and the requests they serve, and the totals behind the Observability page.

    Runtime logs are what a project's deployments write while they run, and its requests, kept for 7 days. Build logs are a deployment's: see Deployments. See Runtime logs and Observability.

    The runtime log object

    Fields

    • idstringrequired
    • atstringrequired

      With milliseconds.

    • sourcestringrequired

      One of requests, functions.

    • levelstringrequired

      One of info, warning, error.

    • statusinteger or nullrequired

      A request's HTTP status.

    • methodstring or nullrequired
    • pathstring or nullrequired

      Without the query string.

    • duration_msinteger or nullrequired

      From the edge receiving the request to the last byte of the answer.

    • messagestring or nullrequired

      An output line, without colour codes; at most 8192 characters.

    • streamstring or nullrequired

      One of stdout, stderr.

    • request_idstring or nullrequired

      The edge's ID for a request, also sent to the app as X-Request-Id.

    • hoststring or nullrequired
    • regionstringrequired
    • deploymentobject or nullrequired
      Show 2 child fields
      • idstringrequired
      • shastring or nullrequired
    • headersarray of array of stringrequired

      Some request headers, as [name, value] pairs: user-agent, accept, content-type, referer, and x-forwarded-for masked. Cookies and authorization are never stored.

    Runtime logs

    The Logs page: every request the edge sent to one of the project's deployments (source: requests), and every line its deployments printed while running (source: functions), newest first. Build logs are on each deployment (GET .../deployments/{deployment}/logs). Entries are kept for 7 days.

    A request has status, method, path and duration_ms, and no message. An output line has message and stream, and null status, method, path and duration_ms. Requests and output lines are not linked: an app's output is whatever it printed, whichever request it was serving. Client IP addresses are stored masked (102.89.x.x), and query strings are not stored.

    Permissions: Any team member. A non-member gets 404.

    GET/v1/teams/{team}/projects/{project}/logs
    Read or full tokenReturns200OK

    Headers

    • Authorizationstringrequired

      Bearer and your API token: Bearer orb_live_….

    Path parameters

    • teamstringrequired

      Team slug or team_ id.

    • projectstringrequired

      Project slug or prj_ id.

    Query parameters

    • qstring

      Matches a path or message (any case), or exactly a request ID, status or method. A request ID on its own (32 hex characters, as the edge makes them) matches only that request.

      At most 200 characters.

    • sourcestring

      One of requests, functions.

    • levelstring

      A request is error for 5xx and warning for 4xx. An output line is warning when it mentions a warning, and error when it was written to stderr or mentions an error.

      One of info, warning, error.

    • statusstring

      Requests only; output lines never match.

      One of 2xx, 3xx, 4xx, 5xx.

    • rangestring

      One of 1h, 24h, 7d. Defaults to 1h.

    • limitinteger

      From 1 to 500. Defaults to 50.

    • cursorstring

      next_cursor from the previous page.

    Response 200

    One page of entries, and how many match.
    • as_ofstringrequired

      The end of the range.

    • itemsarray of RuntimeLogrequired
      Show 15 child fields
      • idstringrequired
      • atstringrequired

        With milliseconds.

      • sourcestringrequired

        One of requests, functions.

      • levelstringrequired

        One of info, warning, error.

      • statusinteger or nullrequired

        A request's HTTP status.

      • methodstring or nullrequired
      • pathstring or nullrequired

        Without the query string.

      • duration_msinteger or nullrequired

        From the edge receiving the request to the last byte of the answer.

      • messagestring or nullrequired

        An output line, without colour codes; at most 8192 characters.

      • streamstring or nullrequired

        One of stdout, stderr.

      • request_idstring or nullrequired

        The edge's ID for a request, also sent to the app as X-Request-Id.

      • hoststring or nullrequired
      • regionstringrequired
      • deploymentobject or nullrequired
        Show 2 child fields
        • idstringrequired
        • shastring or nullrequired
      • headersarray of array of stringrequired

        Some request headers, as [name, value] pairs: user-agent, accept, content-type, referer, and x-forwarded-for masked. Cookies and authorization are never stored.

    • totalintegerrequired

      Entries in the range that match the filters, counted up to 10,000.

      At most 10000.

    • total_cappedbooleanrequired

      More than 10,000 entries match, so total is 10,000: show it as "10,000+".

    • next_cursorstring or nullrequired

    Errors

    • 404Not found, or not visible to the caller (the two are indistinguishable on purpose).
    • 422Validation failed, or the Idempotency-Key was reused with a different body.
    • 503A store this endpoint reads is unreachable. Try again shortly.

    Every code is explained in Errors.

    curl "https://api.theorbits.app/v1/teams/my-team/projects/my-app/logs" \
      -H "Authorization: Bearer $ORBITS_TOKEN"
    Response 200
    {
      "as_of": "2026-11-10T09:30:00Z",
      "items": [
        {
          "id": "log_019a16dc-3a1f-7c2e-9b1d-2f4e8a6b0c11",
          "at": "2026-11-10T09:30:00Z",
          "source": "requests",
          "level": "info",
          "status": null,
          "method": "GET",
          "path": "/checkout",
          "duration_ms": null,
          "message": null,
          "stream": "stdout",
          "request_id": null,
          "host": "shop.theorbits.app",
          "region": "abj-1",
          "deployment": {
            "id": "log_01jc8x6e4mq2v7r9y3t5b0zp8w",
            "sha": null
          },
          "headers": [
            [
              "headers"
            ]
          ]
        }
      ],
      "total": 1,
      "total_capped": false,
      "next_cursor": null
    }

    One runtime log entry

    One entry for the Logs inspector, when the one in the URL is not on the current page. 404 once it is older than 7 days.

    Permissions: Any team member. A non-member gets 404.

    GET/v1/teams/{team}/projects/{project}/logs/{log}
    Read or full tokenReturns200OK

    Headers

    • Authorizationstringrequired

      Bearer and your API token: Bearer orb_live_….

    Path parameters

    • teamstringrequired

      Team slug or team_ id.

    • projectstringrequired

      Project slug or prj_ id.

    • logstringrequired

      A log_ id from GET .../logs.

    Response 200

    The entry.
    • idstringrequired
    • atstringrequired

      With milliseconds.

    • sourcestringrequired

      One of requests, functions.

    • levelstringrequired

      One of info, warning, error.

    • statusinteger or nullrequired

      A request's HTTP status.

    • methodstring or nullrequired
    • pathstring or nullrequired

      Without the query string.

    • duration_msinteger or nullrequired

      From the edge receiving the request to the last byte of the answer.

    • messagestring or nullrequired

      An output line, without colour codes; at most 8192 characters.

    • streamstring or nullrequired

      One of stdout, stderr.

    • request_idstring or nullrequired

      The edge's ID for a request, also sent to the app as X-Request-Id.

    • hoststring or nullrequired
    • regionstringrequired
    • deploymentobject or nullrequired
      Show 2 child fields
      • idstringrequired
      • shastring or nullrequired
    • headersarray of array of stringrequired

      Some request headers, as [name, value] pairs: user-agent, accept, content-type, referer, and x-forwarded-for masked. Cookies and authorization are never stored.

    Errors

    • 404Not found, or not visible to the caller (the two are indistinguishable on purpose).
    • 503A store this endpoint reads is unreachable. Try again shortly.

    Every code is explained in Errors.

    curl "https://api.theorbits.app/v1/teams/my-team/projects/my-app/logs/log_01jc8x6e4mq2v7r9y3t5b0zp8w" \
      -H "Authorization: Bearer $ORBITS_TOKEN"
    Response 200
    {
      "id": "log_019a16dc-3a1f-7c2e-9b1d-2f4e8a6b0c11",
      "at": "2026-11-10T09:30:00Z",
      "source": "requests",
      "level": "info",
      "status": null,
      "method": "GET",
      "path": "/checkout",
      "duration_ms": null,
      "message": null,
      "stream": "stdout",
      "request_id": null,
      "host": "shop.theorbits.app",
      "region": "abj-1",
      "deployment": {
        "id": "log_01jc8x6e4mq2v7r9y3t5b0zp8w",
        "sha": null
      },
      "headers": [
        [
          "headers"
        ]
      ]
    }

    Production's requests, errors and latency

    The Observability page: production's traffic over a range, from the runtime logs (the edge's requests to the project's production builds, at its address or a build's own). Requests and server errors (5xx) per bucket with p75 and p99 response times, totals with p50, p75 and p99 against the period before, the busiest routes, requests by status class and by region, and the routes for the Route filter. Times are milliseconds from the edge receiving a request to its last byte. Routes group a path's ids (/products/8412 is /products/[id]) and a static folder's files (/_next/*). Percentiles are exact. Buckets are 12 x 5 minutes (1h), 24 x an hour (24h) or 7 x a day (7d), on Lagos's clock; the last is the one still filling.

    Permissions: Any team member. A non-member gets 404.

    GET/v1/teams/{team}/projects/{project}/observability
    Read or full tokenReturns200OK

    Headers

    • Authorizationstringrequired

      Bearer and your API token: Bearer orb_live_….

    Path parameters

    • teamstringrequired

      Team slug or team_ id.

    • projectstringrequired

      Project slug or prj_ id.

    Query parameters

    • rangestring

      Buckets: 12 x 5 minutes, 12 x 30 minutes (the project overview's health), 24 x an hour, 7 x a day.

      One of 1h, 6h, 24h, 7d. Defaults to 24h.

    • routestring

      A route from all_routes.

      At most 500 characters.

    • statusstring

      Narrows everything but statuses.

      One of 2xx, 3xx, 4xx, 5xx.

    • regionstring

      A region code; abj-1 is the only one with traffic.

    Response 200

    The page's numbers.
    • as_ofstringrequired
    • rangestringrequired

      One of 1h, 6h, 24h, 7d.

    • bucket_secondsintegerrequired
    • totalsObservabilityTotalsrequired
      Show 5 child fields
      • requestsintegerrequired
      • errorsintegerrequired

        Responses with a 5xx status.

      • p50_msintegerrequired
      • p75_msintegerrequired
      • p99_msintegerrequired
    • previousobjectrequired

      The same for the period before, for "on the hour before".

      Show 5 child fields
      • requestsintegerrequired
      • errorsintegerrequired

        Responses with a 5xx status.

      • p50_msintegerrequired
      • p75_msintegerrequired
      • p99_msintegerrequired
    • bucketsarray of objectrequired

      Oldest first; zeros where nothing came in. The last is still filling.

      Show 5 child fields
      • startstringrequired
      • requestsintegerrequired
      • errorsintegerrequired
      • p75_msintegerrequired
      • p99_msintegerrequired
    • routesarray of objectrequired

      The 20 busiest routes, busiest first.

      Show 5 child fields
      • routestringrequired
      • requestsintegerrequired
      • errorsintegerrequired
      • p75_msintegerrequired
      • p99_msintegerrequired
    • statusesobjectrequired

      Requests by status class, under every filter but status.

      Show 4 child fields
      • 2xxintegerrequired
      • 3xxintegerrequired
      • 4xxintegerrequired
      • 5xxintegerrequired
    • regionsarray of objectrequired
      Show 2 child fields
      • regionstringrequired
      • requestsintegerrequired
    • all_routesarray of stringrequired

      The 100 busiest routes in the range, for the Route filter.

    Errors

    • 404Not found, or not visible to the caller (the two are indistinguishable on purpose).
    • 422Validation failed, or the Idempotency-Key was reused with a different body.
    • 503A store this endpoint reads is unreachable. Try again shortly.

    Every code is explained in Errors.

    curl "https://api.theorbits.app/v1/teams/my-team/projects/my-app/observability" \
      -H "Authorization: Bearer $ORBITS_TOKEN"
    Response 200
    {
      "as_of": "2026-11-10T09:30:00Z",
      "range": "1h",
      "bucket_seconds": 3600,
      "totals": {
        "requests": 1,
        "errors": 1,
        "p50_ms": 1,
        "p75_ms": 1,
        "p99_ms": 1
      },
      "previous": {
        "requests": 1,
        "errors": 1,
        "p50_ms": 1,
        "p75_ms": 1,
        "p99_ms": 1
      },
      "buckets": [
        {
          "start": "2026-11-10T09:30:00Z",
          "requests": 1,
          "errors": 1,
          "p75_ms": 1,
          "p99_ms": 1
        }
      ],
      "routes": [
        {
          "route": "/products/[id]",
          "requests": 1,
          "errors": 1,
          "p75_ms": 1,
          "p99_ms": 1
        }
      ],
      "statuses": {
        "2xx": 1,
        "3xx": 1,
        "4xx": 1,
        "5xx": 1
      },
      "regions": [
        {
          "region": "abj-1",
          "requests": 1
        }
      ],
      "all_routes": [
        "all-routes"
      ]
    }

    Was this page helpful?

    Updated