requests

The HTTP requests an application received, with the status, the method, the path and how long each took. It is the first place to look when an application is up and something is still failing.

status is what the client received and originStatus is what the application answered. A 502 with an origin status of 0 means the application never replied at all, which is a different problem from one it reported itself.

Usage

outplane requests [APP] [flags]

Arguments

Flags

The global flags apply as well.

Output

Streams as NDJSON: one object per line, flushed as it arrives.

Examples

The last hour of traffic, for every application

outplane requests

What is failing on one application

outplane requests checkout --status 5xx --since 24h

Watch traffic as it arrives

outplane requests checkout --follow

The slowest requests in the last hour

outplane requests --json --fields path,latencyMs,status

{
  "items": [
    {
      "latencyMs": 1240.7,
      "path": "/api/checkout",
      "status": 200
    },
    {
      "latencyMs": 1.2,
      "path": "/healthz",
      "status": 200
    }
  ],
  "total": 2,
  "truncated": false
}

One path, whatever it answered

outplane requests checkout --search /api/orders

What to Know

• Without --follow this returns {items, total, truncated} like any other list. With --follow it emits one object per line as requests arrive, in every format, because a stream that has no end cannot be one JSON document.
• --lines counts from the most recent, so raising it reaches further back rather than adding newer requests. There is no way to page: ask for a narrower window instead.
• status is what the client received and originStatus is what the application answered. A 502 with originStatus 0 means the application never replied, which is a different failure from one it returned itself.
• --search matches the raw record before it is parsed, so it finds a path, a host and a header alike. It cannot be anchored to one field; use --status and --method for those.
• Only HTTP is recorded. An app that serves a TCP port is forwarded rather than proxied and produces nothing here, which reads as no traffic rather than as an error.
• Without --follow the command returns what exists now and exits 0, even when that is nothing. An application nobody visited is not an error.
• --follow ends only on interruption, and exits 130 when it is.

Errors

Beyond 0 for success, this command exits with:

The code on the error object is one of logs.no_team_slug, app.not_found, usage.bad_status, usage.bad_method, usage.empty_argument, logs.bad_response, usage.bad_duration. Branch on that, or on the exit status. The message is prose and changes.

Related